← Back to branch summary

~ubuntu-branches/ubuntu/hoary/gimp/hoary

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-04-04 14:51:23 UTC
  • Revision ID: james.westby@ubuntu.com-20050404145123-9py049eeelfymur8
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcolornotebook.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="GimpColorNotebook">
 
6
<refmeta>
 
7
<refentrytitle>GimpColorNotebook</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpColorNotebook</refname><refpurpose>A <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
struct      <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>
 
24
                                            (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
 
25
                                             <link linkend="GType">GType</link> page_type,
 
26
                                             <link linkend="gboolean">gboolean</link> has_page);
 
27
 
 
28
</synopsis>
 
29
</refsynopsisdiv>
 
30
 
 
31
<refsect1>
 
32
<title>Object Hierarchy</title>
 
33
<synopsis>
 
34
 
 
35
  <link linkend="GObject">GObject</link>
 
36
   +----<link linkend="GtkObject">GtkObject</link>
 
37
         +----<link linkend="GtkWidget">GtkWidget</link>
 
38
               +----<link linkend="GtkContainer">GtkContainer</link>
 
39
                     +----<link linkend="GtkBox">GtkBox</link>
 
40
                           +----<link linkend="GtkVBox">GtkVBox</link>
 
41
                                 +----<link linkend="GimpColorSelector">GimpColorSelector</link>
 
42
                                       +----GimpColorNotebook
 
43
</synopsis>
 
44
 
 
45
</refsect1>
 
46
 
 
47
 
 
48
 
 
49
<refsect1>
 
50
<title>Implemented Interfaces</title>
 
51
<para>
 
52
GimpColorNotebook implements
 
53
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
54
 
 
55
</refsect1>
 
56
 
 
57
 
 
58
<refsect1>
 
59
<title>Style Properties</title>
 
60
<synopsis>
 
61
 
 
62
  &quot;<link linkend="GimpColorNotebook--tab-border">tab-border</link>&quot;           <link linkend="gint">gint</link>                 : Read
 
63
  &quot;<link linkend="GimpColorNotebook--tab-icon-size">tab-icon-size</link>&quot;        <link linkend="GtkIconSize">GtkIconSize</link>          : Read
 
64
</synopsis>
 
65
</refsect1>
 
66
 
 
67
 
 
68
 
 
69
<refsect1>
 
70
<title>Description</title>
 
71
<para>
 
72
The <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link> widget is an implementation of a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link>.
 
73
It serves as a container for <link linkend="GimpColorSelectors"><type>GimpColorSelectors</type></link>.
 
74
</para>
 
75
</refsect1>
 
76
 
 
77
<refsect1>
 
78
<title>Details</title>
 
79
<refsect2>
 
80
<title><anchor id="GimpColorNotebook-struct"/>struct GimpColorNotebook</title>
 
81
<indexterm><primary>GimpColorNotebook</primary></indexterm><programlisting>struct GimpColorNotebook;</programlisting>
 
82
<para>
 
83
 
 
84
</para></refsect2>
 
85
<refsect2>
 
86
<title><anchor id="gimp-color-notebook-set-has-page"/>gimp_color_notebook_set_has_page ()</title>
 
87
<indexterm><primary>gimp_color_notebook_set_has_page</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_notebook_set_has_page
 
88
                                            (<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
 
89
                                             <link linkend="GType">GType</link> page_type,
 
90
                                             <link linkend="gboolean">gboolean</link> has_page);</programlisting>
 
91
<para>
 
92
This function adds and removed pages to / from a <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link>.
 
93
The <parameter>page_type</parameter> passed must be a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> subtype.</para>
 
94
<para>
 
95
 
 
96
</para><variablelist role="params">
 
97
<varlistentry><term><parameter>notebook</parameter>&nbsp;:</term>
 
98
<listitem><simpara>  A <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link> widget.
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><parameter>page_type</parameter>&nbsp;:</term>
 
101
<listitem><simpara> The <link linkend="GType"><type>GType</type></link> of the notebook page to add or remove.
 
102
</simpara></listitem></varlistentry>
 
103
<varlistentry><term><parameter>has_page</parameter>&nbsp;:</term>
 
104
<listitem><simpara>  Whether the page should be added or removed.
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><emphasis>Returns</emphasis> :</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>
 
107
              if <parameter>has_page</parameter> was <link linkend="FALSE-CAPS"><type>FALSE</type></link>.
 
108
</simpara></listitem></varlistentry>
 
109
</variablelist></refsect2>
 
110
 
 
111
</refsect1>
 
112
<refsect1>
 
113
<title>Style Properties</title>
 
114
<variablelist>
 
115
<varlistentry><term><anchor id="GimpColorNotebook--tab-border"/>&quot;<literal>tab-border</literal>&quot; (<link linkend="gint">gint</link> : Read)</term>
 
116
<listitem>
 
117
<para>Width of the border around the tab contents.</para>
 
118
</listitem></varlistentry>
 
119
<varlistentry><term><anchor id="GimpColorNotebook--tab-icon-size"/>&quot;<literal>tab-icon-size</literal>&quot; (<link linkend="GtkIconSize">GtkIconSize</link> : Read)</term>
 
120
<listitem>
 
121
<para>Size for icons displayed in the tab.</para>
 
122
</listitem></varlistentry>
 
123
 
 
124
</variablelist>
 
125
</refsect1>
 
126
 
 
127
 
 
128
 
 
129
 
 
130
</refentry>