← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpcolornotebook.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcolornotebook.xml
12
12
<refnamediv>
13
13
<refname>GimpColorNotebook</refname>
14
14
<refpurpose>A <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpColorNotebook.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpColorNotebook-struct">GimpColorNotebook</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-color-notebook-set-has-page">gimp_color_notebook_set_has_page</link>    (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-color-notebook-set-has-page">gimp_color_notebook_set_has_page</link>    (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
24
23
                                                         <link linkend="GType">GType</link> page_type,
25
24
                                                         <link linkend="gboolean">gboolean</link> has_page);
26
25
</synopsis>
39
38
                                       +----<link linkend="GimpColorSelector">GimpColorSelector</link>
40
39
                                             +----GimpColorNotebook
41
40
</synopsis>
42
 
 
43
41
</refsect1>
44
42
 
45
43
 
48
46
<title role="impl_interfaces.title">Implemented Interfaces</title>
49
47
<para>
50
48
GimpColorNotebook implements
51
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
52
 
 
 
49
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
53
50
</refsect1>
54
51
 
55
52
 
56
53
<refsect1 id="GimpColorNotebook.style-properties" role="style_properties">
57
54
<title role="style_properties.title">Style Properties</title>
58
55
<synopsis>
59
 
  &quot;<link linkend="GimpColorNotebook--tab-border">tab-border</link>&quot;               <link linkend="gint">gint</link>                  : Read
60
 
  &quot;<link linkend="GimpColorNotebook--tab-icon-size">tab-icon-size</link>&quot;            <link linkend="GtkIconSize">GtkIconSize</link>           : Read
 
56
  &quot;<link linkend="GimpColorNotebook--s-tab-border">tab-border</link>&quot;               <link linkend="gint">gint</link>                  : Read
 
57
  &quot;<link linkend="GimpColorNotebook--s-tab-icon-size">tab-icon-size</link>&quot;            <link linkend="GtkIconSize">GtkIconSize</link>           : Read
61
58
</synopsis>
62
59
</refsect1>
63
60
 
75
72
<title role="details.title">Details</title>
76
73
<refsect2 id="GimpColorNotebook-struct" role="struct">
77
74
<title>GimpColorNotebook</title>
78
 
<indexterm zone="GimpColorNotebook-struct"><primary>GimpColorNotebook</primary></indexterm><programlisting>typedef struct _GimpColorNotebook GimpColorNotebook;</programlisting>
 
75
<indexterm zone="GimpColorNotebook-struct"><primary sortas="GimpColorNotebook">GimpColorNotebook</primary></indexterm><programlisting>typedef struct _GimpColorNotebook GimpColorNotebook;</programlisting>
79
76
<para>
80
 
 
81
77
</para></refsect2>
82
78
<refsect2 id="gimp-color-notebook-set-has-page" role="function">
83
79
<title>gimp_color_notebook_set_has_page ()</title>
84
 
<indexterm zone="gimp-color-notebook-set-has-page"><primary>gimp_color_notebook_set_has_page</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_color_notebook_set_has_page    (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
 
80
<indexterm zone="gimp-color-notebook-set-has-page"><primary sortas="gimp_color_notebook_set_has_page">gimp_color_notebook_set_has_page</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_color_notebook_set_has_page    (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
85
81
                                                         <link linkend="GType">GType</link> page_type,
86
82
                                                         <link linkend="gboolean">gboolean</link> has_page);</programlisting>
87
83
<para>
88
84
This function adds and removed pages to / from a <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link>.
89
85
The <parameter>page_type</parameter> passed must be a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> subtype.</para>
90
86
<para>
91
 
 
92
87
</para><variablelist role="params">
93
 
<varlistentry><term><parameter>notebook</parameter>&nbsp;:</term>
 
88
<varlistentry><term><parameter>notebook</parameter>&#160;:</term>
94
89
<listitem><simpara>  A <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link> widget.
95
90
</simpara></listitem></varlistentry>
96
 
<varlistentry><term><parameter>page_type</parameter>&nbsp;:</term>
 
91
<varlistentry><term><parameter>page_type</parameter>&#160;:</term>
97
92
<listitem><simpara> The <link linkend="GType"><type>GType</type></link> of the notebook page to add or remove.
98
93
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><parameter>has_page</parameter>&nbsp;:</term>
 
94
<varlistentry><term><parameter>has_page</parameter>&#160;:</term>
100
95
<listitem><simpara>  Whether the page should be added or removed.
101
96
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new page widget, if <parameter>has_page</parameter> was <link linkend="TRUE:CAPS"><type>TRUE</type></link>, or <link linkend="NULL:CAPS"><type>NULL</type></link>
103
 
              if <parameter>has_page</parameter> was <link linkend="FALSE:CAPS"><type>FALSE</type></link>.
 
97
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The new page widget, if <parameter>has_page</parameter> was <link linkend="TRUE--CAPS"><type>TRUE</type></link>, or <link linkend="NULL--CAPS"><type>NULL</type></link>
 
98
              if <parameter>has_page</parameter> was <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
104
99
</simpara></listitem></varlistentry>
105
100
</variablelist></refsect2>
106
101
 
107
102
</refsect1>
108
103
<refsect1 id="GimpColorNotebook.style-property-details" role="style_properties_details">
109
104
<title role="style_properties_details.title">Style Property Details</title>
110
 
<refsect2 id="GimpColorNotebook--tab-border"><title>The <literal>&quot;tab-border&quot;</literal> style property</title>
111
 
<indexterm zone="GimpColorNotebook--tab-border"><primary>GimpColorNotebook:tab-border</primary></indexterm><programlisting>  &quot;tab-border&quot;               <link linkend="gint">gint</link>                  : Read</programlisting>
 
105
<refsect2 id="GimpColorNotebook--s-tab-border" role="property"><title>The <literal>&quot;tab-border&quot;</literal> style property</title>
 
106
<indexterm zone="GimpColorNotebook--s-tab-border"><primary sortas="GimpColorNotebook:tab-border">GimpColorNotebook:tab-border</primary></indexterm><programlisting>  &quot;tab-border&quot;               <link linkend="gint">gint</link>                  : Read</programlisting>
112
107
<para>Width of the border around the tab contents.</para><para>Allowed values: &gt;= 0</para>
113
108
<para>Default value: 0</para>
114
109
</refsect2>
115
 
<refsect2 id="GimpColorNotebook--tab-icon-size"><title>The <literal>&quot;tab-icon-size&quot;</literal> style property</title>
116
 
<indexterm zone="GimpColorNotebook--tab-icon-size"><primary>GimpColorNotebook:tab-icon-size</primary></indexterm><programlisting>  &quot;tab-icon-size&quot;            <link linkend="GtkIconSize">GtkIconSize</link>           : Read</programlisting>
 
110
<refsect2 id="GimpColorNotebook--s-tab-icon-size" role="property"><title>The <literal>&quot;tab-icon-size&quot;</literal> style property</title>
 
111
<indexterm zone="GimpColorNotebook--s-tab-icon-size"><primary sortas="GimpColorNotebook:tab-icon-size">GimpColorNotebook:tab-icon-size</primary></indexterm><programlisting>  &quot;tab-icon-size&quot;            <link linkend="GtkIconSize">GtkIconSize</link>           : Read</programlisting>
117
112
<para>Size for icons displayed in the tab.</para><para>Default value: GTK_ICON_SIZE_BUTTON</para>
118
113
</refsect2>
119
 
 
120
114
</refsect1>
121
115
 
122
116