← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpcolorscale.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/gimpcolorscale.xml
12
12
<refnamediv>
13
13
<refname>GimpColorScale</refname>
14
14
<refpurpose>Fancy colored sliders.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpColorScale.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpColorScale-struct">GimpColorScale</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-color-scale-new">gimp_color_scale_new</link>                (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-color-scale-new">gimp_color_scale_new</link>                (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
24
23
                                                         <link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
25
24
<link linkend="void">void</link>                <link linkend="gimp-color-scale-set-channel">gimp_color_scale_set_channel</link>        (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
26
25
                                                         <link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
41
40
                           +----<link linkend="GtkScale">GtkScale</link>
42
41
                                 +----GimpColorScale
43
42
</synopsis>
44
 
 
45
43
</refsect1>
46
44
 
47
45
 
50
48
<title role="impl_interfaces.title">Implemented Interfaces</title>
51
49
<para>
52
50
GimpColorScale implements
53
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
54
 
 
 
51
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
55
52
</refsect1>
56
53
 
57
54
 
61
58
<refsect1 id="GimpColorScale.description" role="desc">
62
59
<title role="desc.title">Description</title>
63
60
<para>
64
 
 
65
61
</para>
66
62
</refsect1>
67
63
 
69
65
<title role="details.title">Details</title>
70
66
<refsect2 id="GimpColorScale-struct" role="struct">
71
67
<title>GimpColorScale</title>
72
 
<indexterm zone="GimpColorScale-struct"><primary>GimpColorScale</primary></indexterm><programlisting>typedef struct _GimpColorScale GimpColorScale;</programlisting>
 
68
<indexterm zone="GimpColorScale-struct"><primary sortas="GimpColorScale">GimpColorScale</primary></indexterm><programlisting>typedef struct _GimpColorScale GimpColorScale;</programlisting>
73
69
<para>
74
 
 
75
70
</para></refsect2>
76
71
<refsect2 id="gimp-color-scale-new" role="function">
77
72
<title>gimp_color_scale_new ()</title>
78
 
<indexterm zone="gimp-color-scale-new"><primary>gimp_color_scale_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_color_scale_new                (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
 
73
<indexterm zone="gimp-color-scale-new"><primary sortas="gimp_color_scale_new">gimp_color_scale_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_color_scale_new                (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
79
74
                                                         <link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
80
75
<para>
81
76
Creates a new <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget.</para>
82
77
<para>
83
 
 
84
78
</para><variablelist role="params">
85
 
<varlistentry><term><parameter>orientation</parameter>&nbsp;:</term>
 
79
<varlistentry><term><parameter>orientation</parameter>&#160;:</term>
86
80
<listitem><simpara> the scale's orientation (horizontal or vertical)
87
81
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><parameter>channel</parameter>&nbsp;:</term>
 
82
<varlistentry><term><parameter>channel</parameter>&#160;:</term>
89
83
<listitem><simpara> the scale's color channel
90
84
</simpara></listitem></varlistentry>
91
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
 
85
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
92
86
</simpara></listitem></varlistentry>
93
87
</variablelist></refsect2>
94
88
<refsect2 id="gimp-color-scale-set-channel" role="function">
95
89
<title>gimp_color_scale_set_channel ()</title>
96
 
<indexterm zone="gimp-color-scale-set-channel"><primary>gimp_color_scale_set_channel</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_scale_set_channel        (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
 
90
<indexterm zone="gimp-color-scale-set-channel"><primary sortas="gimp_color_scale_set_channel">gimp_color_scale_set_channel</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_scale_set_channel        (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
97
91
                                                         <link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
98
92
<para>
99
93
Changes the color channel displayed by the <parameter>scale</parameter>.</para>
100
94
<para>
101
 
 
102
95
</para><variablelist role="params">
103
 
<varlistentry><term><parameter>scale</parameter>&nbsp;:</term>
 
96
<varlistentry><term><parameter>scale</parameter>&#160;:</term>
104
97
<listitem><simpara> a <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
105
98
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><parameter>channel</parameter>&nbsp;:</term>
 
99
<varlistentry><term><parameter>channel</parameter>&#160;:</term>
107
100
<listitem><simpara> the new color channel
108
101
</simpara></listitem></varlistentry>
109
102
</variablelist></refsect2>
110
103
<refsect2 id="gimp-color-scale-set-color" role="function">
111
104
<title>gimp_color_scale_set_color ()</title>
112
 
<indexterm zone="gimp-color-scale-set-color"><primary>gimp_color_scale_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_scale_set_color          (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
 
105
<indexterm zone="gimp-color-scale-set-color"><primary sortas="gimp_color_scale_set_color">gimp_color_scale_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_scale_set_color          (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
113
106
                                                         const <link linkend="GimpRGB">GimpRGB</link> *rgb,
114
107
                                                         const <link linkend="GimpHSV">GimpHSV</link> *hsv);</programlisting>
115
108
<para>
116
109
Changes the color value of the <parameter>scale</parameter>.</para>
117
110
<para>
118
 
 
119
111
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>scale</parameter>&nbsp;:</term>
 
112
<varlistentry><term><parameter>scale</parameter>&#160;:</term>
121
113
<listitem><simpara> a <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
122
114
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>rgb</parameter>&nbsp;:</term>
 
115
<varlistentry><term><parameter>rgb</parameter>&#160;:</term>
124
116
<listitem><simpara> the new color as <link linkend="GimpRGB"><type>GimpRGB</type></link>
125
117
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>hsv</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>hsv</parameter>&#160;:</term>
127
119
<listitem><simpara> the new color as <link linkend="GimpHSV"><type>GimpHSV</type></link>
128
120
</simpara></listitem></varlistentry>
129
121
</variablelist></refsect2>