<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
      "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-canvas-image">

	<refnamediv>
		<refname>goocanvas.Image</refname>
		<refpurpose>An Image item.</refpurpose>
	</refnamediv>
	
	<refsect1>
		<title>Synopsis</title>
	
		<classsynopsis language="python">
			<ooclass><classname>goocanvas.Image</classname></ooclass>
			<ooclass><classname>goocanvas.ItemSimple</classname></ooclass>
			
			<constructorsynopsis language="python">
				<methodname><link linkend="constructor-canvas-image">goocanvas.Image</link></methodname>
				<methodparam><parameter role="keyword">properties</parameter><initializer>None</initializer></methodparam>
			</constructorsynopsis>
		</classsynopsis>
	</refsect1>

	<refsect1>
		<title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
	+-- <link linkend="class-canvas-item-simple">goocanvas.ItemSimple</link>
		+-- <link linkend="class-canvas-image">goocanvas.Image</link>
</synopsis>

	</refsect1>
	
	<refsect1 id="properties-goocanvasimage">
		<title>goocanvas.Image Properties</title>
	
		<blockquote role="properties">
			<informaltable pgwide="1" frame="none">
				<tgroup cols="3">
					<colspec column="1" colwidth="1in"/>
					<colspec column="2" colwidth="1in"/>
					<colspec column="3" colwidth="3.5in"/>
						<tbody>
						<row valign="top">
							<entry>"height"</entry>
							<entry>Read/Write</entry>
							<entry>The height of the image. Allowed values: >= 0. Default value: 0.</entry>
						</row>

						<row valign="top">
							<entry>"pattern"</entry>
							<entry>Read/Write</entry>
							<entry>The cairo pattern to paint.</entry>
						</row>

						<row valign="top">
							<entry>"pixbuf"</entry>
							<entry>Write</entry>
							<entry>The GdkPixbuf to display.</entry>
						</row>

						<row valign="top">
							<entry>"width"</entry>
							<entry>Read/Write</entry>
							<entry>The width of the image. Allowed values: >= 0 Default value: 0.</entry>
						</row>

						<row valign="top">
							<entry>"x"</entry>
							<entry>Read/Write</entry>
							<entry>The x coordinate of the image. Default value: 0.</entry>
						</row>

						<row valign="top">
							<entry>"y"</entry>
							<entry>Read/Write</entry>
							<entry>The y coordinate of the image. Default value: 0.</entry>
						</row>
					</tbody>
				</tgroup>
			</informaltable>
		</blockquote>
	</refsect1>

	<refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-canvas-image"><classname>goocanvas.Image</classname></link>
			implements 
			<link linkend="class-canvas-item"><classname>goocanvas.Item</classname></link>
		</para>
	</refsect1>

	<refsect1>
		<title>Description</title>
			<link linkend="class-canvas-image"><classname>goocanvas.Image</classname></link> 
			represents an image item. It is a subclass of 
			<link linkend="class-canvas-item-simple"><classname>goocanvas.ItemSimple</classname></link> 
			and so inherits all of the style properties such as "operator" and "pointer-events". 
			It also implements the <link linkend="class-canvas-item"><classname>goocanvas.Item</classname></link> 
			interface, so you can use the <link linkend="class-canvas-item"><classname>goocanvas.Item</classname></link> 
			functions such as <methodname><link linkend="method-goocanvasitem--raise-">goocanvas.Item.raise_()</link></methodname> 
			and <methodname><link linkend="method-goocanvasitem--rotate-">goocanvas.Item.rotate()</link></methodname> 
	</refsect1>

	<refsect1 id="constructor-canvas-image">
		<title>Constructor</title>
		
		<programlisting><constructorsynopsis language="python">
				<methodname>goocanvas.Image</methodname>
				<methodparam><parameter role="keyword">properties</parameter><initializer>None</initializer></methodparam>
			</constructorsynopsis></programlisting>
		
		<variablelist>
			<varlistentry>
				<term><parameter role="keyword">properties</parameter>&nbsp;:</term>
				<listitem><simpara>A comma separated list of properties.</simpara></listitem>
			</varlistentry>
			<varlistentry>
				<term><emphasis>Returns</emphasis>&nbsp;:</term>
				<listitem><simpara>A new 
						<link linkend="class-canvas-image"><classname>goocanvas.Image</classname></link>
					</simpara></listitem>
			</varlistentry>
		</variablelist>
		<para>
			Creates a new canvas image item.
		</para>
		<para>
			Here's an example showing how to create an image at (100.0, 100.0), 
			using the given pixbuf at its natural width and height:
		</para>
<programlisting>
image = goocanvas.Image(pixbuf=pixbuf, x=100, y=100)
</programlisting>
	</refsect1>

</refentry>
