← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpbutton.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/gimpbutton.xml
12
12
<refnamediv>
13
13
<refname>GimpButton</refname>
14
14
<refpurpose>A <link linkend="GtkButton"><type>GtkButton</type></link> with a little extra functionality.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpButton.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpButton-struct">GimpButton</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-button-new">gimp_button_new</link>                     (void);
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-button-new">gimp_button_new</link>                     (void);
24
23
<link linkend="void">void</link>                <link linkend="gimp-button-extended-clicked">gimp_button_extended_clicked</link>        (<link linkend="GimpButton">GimpButton</link> *button,
25
24
                                                         <link linkend="GdkModifierType">GdkModifierType</link> state);
26
25
</synopsis>
39
38
                                       +----GimpButton
40
39
                                             +----<link linkend="GimpColorButton">GimpColorButton</link>
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
GimpButton 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="GtkActivatable">GtkActivatable</link>.</para>
53
50
</refsect1>
54
51
 
55
52
 
75
72
<title role="details.title">Details</title>
76
73
<refsect2 id="GimpButton-struct" role="struct">
77
74
<title>GimpButton</title>
78
 
<indexterm zone="GimpButton-struct"><primary>GimpButton</primary></indexterm><programlisting>typedef struct _GimpButton GimpButton;</programlisting>
 
75
<indexterm zone="GimpButton-struct"><primary sortas="GimpButton">GimpButton</primary></indexterm><programlisting>typedef struct _GimpButton GimpButton;</programlisting>
79
76
<para>
80
 
 
81
77
</para></refsect2>
82
78
<refsect2 id="gimp-button-new" role="function">
83
79
<title>gimp_button_new ()</title>
84
 
<indexterm zone="gimp-button-new"><primary>gimp_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_button_new                     (void);</programlisting>
 
80
<indexterm zone="gimp-button-new"><primary sortas="gimp_button_new">gimp_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_button_new                     (void);</programlisting>
85
81
<para>
86
82
Creates a new <link linkend="GimpButton"><type>GimpButton</type></link> widget.</para>
87
83
<para>
88
 
 
89
84
</para><variablelist role="params">
90
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GimpButton"><type>GimpButton</type></link> widget.
 
85
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GimpButton"><type>GimpButton</type></link> widget.
91
86
</simpara></listitem></varlistentry>
92
87
</variablelist></refsect2>
93
88
<refsect2 id="gimp-button-extended-clicked" role="function">
94
89
<title>gimp_button_extended_clicked ()</title>
95
 
<indexterm zone="gimp-button-extended-clicked"><primary>gimp_button_extended_clicked</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_button_extended_clicked        (<link linkend="GimpButton">GimpButton</link> *button,
 
90
<indexterm zone="gimp-button-extended-clicked"><primary sortas="gimp_button_extended_clicked">gimp_button_extended_clicked</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_button_extended_clicked        (<link linkend="GimpButton">GimpButton</link> *button,
96
91
                                                         <link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
97
92
<para>
98
93
Emits the button's "extended_clicked" signal.</para>
99
94
<para>
100
 
 
101
95
</para><variablelist role="params">
102
 
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
96
<varlistentry><term><parameter>button</parameter>&#160;:</term>
103
97
<listitem><simpara> a <link linkend="GimpButton"><type>GimpButton</type></link>.
104
98
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
106
 
<listitem><simpara>  a state as found in <link linkend="GdkEventButton-"><type>GdkEventButton-</type></link>>state, e.g. <link linkend="GDK-SHIFT-MASK:CAPS"><type>GDK_SHIFT_MASK</type></link>.
 
99
<varlistentry><term><parameter>state</parameter>&#160;:</term>
 
100
<listitem><simpara>  a state as found in <link linkend="GdkEventButton-"><type>GdkEventButton-</type></link>>state, e.g. <link linkend="GDK-SHIFT-MASK--CAPS"><type>GDK_SHIFT_MASK</type></link>.
107
101
</simpara></listitem></varlistentry>
108
102
</variablelist></refsect2>
109
103
 
111
105
 
112
106
<refsect1 id="GimpButton.signal-details" role="signals">
113
107
<title role="signals.title">Signal Details</title>
114
 
<refsect2 id="GimpButton-extended-clicked"><title>The <literal>&quot;extended-clicked&quot;</literal> signal</title>
115
 
<indexterm zone="GimpButton-extended-clicked"><primary>GimpButton::extended-clicked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpButton">GimpButton</link>     *gimpbutton,
 
108
<refsect2 id="GimpButton-extended-clicked" role="signal"><title>The <literal>&quot;extended-clicked&quot;</literal> signal</title>
 
109
<indexterm zone="GimpButton-extended-clicked"><primary sortas="GimpButton::extended-clicked">GimpButton::extended-clicked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpButton">GimpButton</link>     *gimpbutton,
116
110
                                                        <link linkend="GdkModifierType">GdkModifierType</link> arg1,
117
111
                                                        <link linkend="gpointer">gpointer</link>        user_data)       : Run First</programlisting>
118
112
<para>
119
 
 
120
113
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>gimpbutton</parameter>&nbsp;:</term>
 
114
<varlistentry><term><parameter>gimpbutton</parameter>&#160;:</term>
122
115
<listitem><simpara>the object which received the signal.
123
116
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
117
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
125
118
<listitem><simpara>the state of modifier keys when the button was clicked
126
 
 
127
119
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
120
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
129
121
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
130
122
</variablelist></refsect2>
131
123
</refsect1>