~bratsche/ubuntu/maverick/gtk+2.0/menu-activation-fix

« back to all changes in this revision

Viewing changes to docs/reference/gtk/xml/gtkimage.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-06-13 10:00:13 UTC
  • mto: (72.2.1 lenny) (1.5.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: james.westby@ubuntu.com-20070613100013-qstao3cwpm6xdlxc
Tags: upstream-2.11.2
ImportĀ upstreamĀ versionĀ 2.11.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
118
118
<title role="properties.title">Properties</title>
119
119
<synopsis>
120
120
 
121
 
  &quot;<link linkend="GtkImage--file">file</link>&quot;                     <link linkend="gchararray">gchararray</link>            : Read / Write
122
 
  &quot;<link linkend="GtkImage--icon-name">icon-name</link>&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write
123
 
  &quot;<link linkend="GtkImage--icon-set">icon-set</link>&quot;                 <link linkend="GtkIconSet">GtkIconSet</link>            : Read / Write
124
 
  &quot;<link linkend="GtkImage--icon-size">icon-size</link>&quot;                <link linkend="gint">gint</link>                  : Read / Write
125
 
  &quot;<link linkend="GtkImage--image">image</link>&quot;                    <link linkend="GdkImage">GdkImage</link>              : Read / Write
126
 
  &quot;<link linkend="GtkImage--mask">mask</link>&quot;                     <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write
127
 
  &quot;<link linkend="GtkImage--pixbuf">pixbuf</link>&quot;                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write
128
 
  &quot;<link linkend="GtkImage--pixbuf-animation">pixbuf-animation</link>&quot;         <link linkend="GdkPixbufAnimation">GdkPixbufAnimation</link>    : Read / Write
129
 
  &quot;<link linkend="GtkImage--pixel-size">pixel-size</link>&quot;               <link linkend="gint">gint</link>                  : Read / Write
130
 
  &quot;<link linkend="GtkImage--pixmap">pixmap</link>&quot;                   <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write
131
 
  &quot;<link linkend="GtkImage--stock">stock</link>&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write
132
 
  &quot;<link linkend="GtkImage--storage-type">storage-type</link>&quot;             <link linkend="GtkImageType">GtkImageType</link>          : Read
 
121
  <link linkend="GtkImage--file">file</link>                     <link linkend="gchararray">gchararray</link>            : Read / Write
 
122
  <link linkend="GtkImage--icon-name">icon-name</link>                <link linkend="gchararray">gchararray</link>            : Read / Write
 
123
  <link linkend="GtkImage--icon-set">icon-set</link>                 <link linkend="GtkIconSet">GtkIconSet</link>            : Read / Write
 
124
  <link linkend="GtkImage--icon-size">icon-size</link>                <link linkend="gint">gint</link>                  : Read / Write
 
125
  <link linkend="GtkImage--image">image</link>                    <link linkend="GdkImage">GdkImage</link>              : Read / Write
 
126
  <link linkend="GtkImage--mask">mask</link>                     <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write
 
127
  <link linkend="GtkImage--pixbuf">pixbuf</link>                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write
 
128
  <link linkend="GtkImage--pixbuf-animation">pixbuf-animation</link>         <link linkend="GdkPixbufAnimation">GdkPixbufAnimation</link>    : Read / Write
 
129
  <link linkend="GtkImage--pixel-size">pixel-size</link>               <link linkend="gint">gint</link>                  : Read / Write
 
130
  <link linkend="GtkImage--pixmap">pixmap</link>                   <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write
 
131
  <link linkend="GtkImage--stock">stock</link>                    <link linkend="gchararray">gchararray</link>            : Read / Write
 
132
  <link linkend="GtkImage--storage-type">storage-type</link>             <link linkend="GtkImageType">GtkImageType</link>          : Read
133
133
</synopsis>
134
134
</refsect1>
135
135
 
543
543
<para>
544
544
Creates a <link linkend="GtkImage"><type>GtkImage</type></link> widget displaying a <parameter>image</parameter> with a <parameter>mask</parameter>.
545
545
A <link linkend="GdkImage"><type>GdkImage</type></link> is a client-side image buffer in the pixel format of the
546
 
current display.
547
 
The <link linkend="GtkImage"><type>GtkImage</type></link> does not assume a reference to the
 
546
current display. The <link linkend="GtkImage"><type>GtkImage</type></link> does not assume a reference to the
548
547
image or mask; you still need to unref them if you own references.
549
548
<link linkend="GtkImage"><type>GtkImage</type></link> will add its own reference rather than adopting yours.</para>
550
549
<para>
569
568
<link linkend="GtkImage"><type>GtkImage</type></link> will add its own reference rather than adopting yours.
570
569
</para>
571
570
<para>
572
 
Note that this function just creates an <link linkend="GtkImage"><type>GtkImage</type></link> from the pixbuf.  The
573
 
<link linkend="GtkImage"><type>GtkImage</type></link> created will not react to state changes.  Should you want that, you
574
 
should use <link linkend="gtk-image-new-from-icon-set"><function>gtk_image_new_from_icon_set()</function></link>.</para>
 
571
Note that this function just creates an <link linkend="GtkImage"><type>GtkImage</type></link> from the pixbuf. The
 
572
<link linkend="GtkImage"><type>GtkImage</type></link> created will not react to state changes. Should you want that, 
 
573
you should use <link linkend="gtk-image-new-from-icon-set"><function>gtk_image_new_from_icon_set()</function></link>.</para>
575
574
<para>
576
575
 
577
576
</para><variablelist role="params">
927
926
</refsect1>
928
927
<refsect1 role="property_details">
929
928
<title role="property_details.title">Property Details</title>
930
 
<refsect2><title><anchor id="GtkImage--file"/>The &quot;<literal>file</literal>&quot; property</title>
931
 
<indexterm><primary>GtkImage:file</primary></indexterm><programlisting>  &quot;file&quot;                     <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
929
<refsect2><title><anchor id="GtkImage--file"/>The :<literal>file</literal> property</title>
 
930
<indexterm><primary>GtkImage:file</primary></indexterm><programlisting>  file                     <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
932
931
<para>Filename to load and display.</para><para>Default value: NULL</para>
933
932
</refsect2>
934
 
<refsect2><title><anchor id="GtkImage--icon-name"/>The &quot;<literal>icon-name</literal>&quot; property</title>
935
 
<indexterm role="2.6"><primary>GtkImage:icon-name</primary></indexterm><programlisting>  &quot;icon-name&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
933
<refsect2><title><anchor id="GtkImage--icon-name"/>The :<literal>icon-name</literal> property</title>
 
934
<indexterm role="2.6"><primary>GtkImage:icon-name</primary></indexterm><programlisting>  icon-name                <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
936
935
<para>
937
 
The name of the icon in the icon theme.  If the icon theme is
 
936
The name of the icon in the icon theme. If the icon theme is
938
937
changed, the image will be updated automatically.</para>
939
938
<para>
940
939
 
942
941
<para>Since  2.6
943
942
</para>
944
943
</refsect2>
945
 
<refsect2><title><anchor id="GtkImage--icon-set"/>The &quot;<literal>icon-set</literal>&quot; property</title>
946
 
<indexterm><primary>GtkImage:icon-set</primary></indexterm><programlisting>  &quot;icon-set&quot;                 <link linkend="GtkIconSet">GtkIconSet</link>            : Read / Write</programlisting>
 
944
<refsect2><title><anchor id="GtkImage--icon-set"/>The :<literal>icon-set</literal> property</title>
 
945
<indexterm><primary>GtkImage:icon-set</primary></indexterm><programlisting>  icon-set                 <link linkend="GtkIconSet">GtkIconSet</link>            : Read / Write</programlisting>
947
946
<para>Icon set to display.</para></refsect2>
948
 
<refsect2><title><anchor id="GtkImage--icon-size"/>The &quot;<literal>icon-size</literal>&quot; property</title>
949
 
<indexterm><primary>GtkImage:icon-size</primary></indexterm><programlisting>  &quot;icon-size&quot;                <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
947
<refsect2><title><anchor id="GtkImage--icon-size"/>The :<literal>icon-size</literal> property</title>
 
948
<indexterm><primary>GtkImage:icon-size</primary></indexterm><programlisting>  icon-size                <link linkend="gint">gint</link>                  : Read / Write</programlisting>
950
949
<para>Symbolic size to use for stock icon, icon set or named icon.</para><para>Allowed values: &gt;= 0</para>
951
950
<para>Default value: 4</para>
952
951
</refsect2>
953
 
<refsect2><title><anchor id="GtkImage--image"/>The &quot;<literal>image</literal>&quot; property</title>
954
 
<indexterm><primary>GtkImage:image</primary></indexterm><programlisting>  &quot;image&quot;                    <link linkend="GdkImage">GdkImage</link>              : Read / Write</programlisting>
 
952
<refsect2><title><anchor id="GtkImage--image"/>The :<literal>image</literal> property</title>
 
953
<indexterm><primary>GtkImage:image</primary></indexterm><programlisting>  image                    <link linkend="GdkImage">GdkImage</link>              : Read / Write</programlisting>
955
954
<para>A GdkImage to display.</para></refsect2>
956
 
<refsect2><title><anchor id="GtkImage--mask"/>The &quot;<literal>mask</literal>&quot; property</title>
957
 
<indexterm><primary>GtkImage:mask</primary></indexterm><programlisting>  &quot;mask&quot;                     <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write</programlisting>
 
955
<refsect2><title><anchor id="GtkImage--mask"/>The :<literal>mask</literal> property</title>
 
956
<indexterm><primary>GtkImage:mask</primary></indexterm><programlisting>  mask                     <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write</programlisting>
958
957
<para>Mask bitmap to use with GdkImage or GdkPixmap.</para></refsect2>
959
 
<refsect2><title><anchor id="GtkImage--pixbuf"/>The &quot;<literal>pixbuf</literal>&quot; property</title>
960
 
<indexterm><primary>GtkImage:pixbuf</primary></indexterm><programlisting>  &quot;pixbuf&quot;                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write</programlisting>
 
958
<refsect2><title><anchor id="GtkImage--pixbuf"/>The :<literal>pixbuf</literal> property</title>
 
959
<indexterm><primary>GtkImage:pixbuf</primary></indexterm><programlisting>  pixbuf                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write</programlisting>
961
960
<para>A GdkPixbuf to display.</para></refsect2>
962
 
<refsect2><title><anchor id="GtkImage--pixbuf-animation"/>The &quot;<literal>pixbuf-animation</literal>&quot; property</title>
963
 
<indexterm><primary>GtkImage:pixbuf-animation</primary></indexterm><programlisting>  &quot;pixbuf-animation&quot;         <link linkend="GdkPixbufAnimation">GdkPixbufAnimation</link>    : Read / Write</programlisting>
 
961
<refsect2><title><anchor id="GtkImage--pixbuf-animation"/>The :<literal>pixbuf-animation</literal> property</title>
 
962
<indexterm><primary>GtkImage:pixbuf-animation</primary></indexterm><programlisting>  pixbuf-animation         <link linkend="GdkPixbufAnimation">GdkPixbufAnimation</link>    : Read / Write</programlisting>
964
963
<para>GdkPixbufAnimation to display.</para></refsect2>
965
 
<refsect2><title><anchor id="GtkImage--pixel-size"/>The &quot;<literal>pixel-size</literal>&quot; property</title>
966
 
<indexterm role="2.6"><primary>GtkImage:pixel-size</primary></indexterm><programlisting>  &quot;pixel-size&quot;               <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
964
<refsect2><title><anchor id="GtkImage--pixel-size"/>The :<literal>pixel-size</literal> property</title>
 
965
<indexterm role="2.6"><primary>GtkImage:pixel-size</primary></indexterm><programlisting>  pixel-size               <link linkend="gint">gint</link>                  : Read / Write</programlisting>
967
966
<para>
968
 
The :pixel-size property can be used to specify a fixed size
969
 
overriding the :icon-size property for images of type 
 
967
The "pixel-size" property can be used to specify a fixed size
 
968
overriding the <link linkend="GtkImage--icon-size"><type>:icon-size</type></link> property for images of type 
970
969
<link linkend="GTK-IMAGE-ICON-NAME:CAPS"><literal>GTK_IMAGE_ICON_NAME</literal></link>.</para>
971
970
<para>
972
971
 
975
974
<para>Since  2.6
976
975
</para>
977
976
</refsect2>
978
 
<refsect2><title><anchor id="GtkImage--pixmap"/>The &quot;<literal>pixmap</literal>&quot; property</title>
979
 
<indexterm><primary>GtkImage:pixmap</primary></indexterm><programlisting>  &quot;pixmap&quot;                   <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write</programlisting>
 
977
<refsect2><title><anchor id="GtkImage--pixmap"/>The :<literal>pixmap</literal> property</title>
 
978
<indexterm><primary>GtkImage:pixmap</primary></indexterm><programlisting>  pixmap                   <link linkend="GdkPixmap">GdkPixmap</link>             : Read / Write</programlisting>
980
979
<para>A GdkPixmap to display.</para></refsect2>
981
 
<refsect2><title><anchor id="GtkImage--stock"/>The &quot;<literal>stock</literal>&quot; property</title>
982
 
<indexterm><primary>GtkImage:stock</primary></indexterm><programlisting>  &quot;stock&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
980
<refsect2><title><anchor id="GtkImage--stock"/>The :<literal>stock</literal> property</title>
 
981
<indexterm><primary>GtkImage:stock</primary></indexterm><programlisting>  stock                    <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
983
982
<para>Stock ID for a stock image to display.</para><para>Default value: NULL</para>
984
983
</refsect2>
985
 
<refsect2><title><anchor id="GtkImage--storage-type"/>The &quot;<literal>storage-type</literal>&quot; property</title>
986
 
<indexterm><primary>GtkImage:storage-type</primary></indexterm><programlisting>  &quot;storage-type&quot;             <link linkend="GtkImageType">GtkImageType</link>          : Read</programlisting>
 
984
<refsect2><title><anchor id="GtkImage--storage-type"/>The :<literal>storage-type</literal> property</title>
 
985
<indexterm><primary>GtkImage:storage-type</primary></indexterm><programlisting>  storage-type             <link linkend="GtkImageType">GtkImageType</link>          : Read</programlisting>
987
986
<para>The representation being used for image data.</para><para>Default value: GTK_IMAGE_EMPTY</para>
988
987
</refsect2>
989
988