← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpbutton.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="GimpButton">
 
6
<refmeta>
 
7
<refentrytitle>GimpButton</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpButton</refname><refpurpose>A <link linkend="GtkButton"><type>GtkButton</type></link> with a little extra functionality.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
            <link linkend="GimpButton-struct">GimpButton</link>;
 
23
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-button-new">gimp_button_new</link>                 (void);
 
24
<link linkend="void">void</link>        <link linkend="gimp-button-extended-clicked">gimp_button_extended_clicked</link>    (<link linkend="GimpButton">GimpButton</link> *button,
 
25
                                             <link linkend="GdkModifierType">GdkModifierType</link> state);
 
26
 
 
27
</synopsis>
 
28
</refsynopsisdiv>
 
29
 
 
30
<refsect1>
 
31
<title>Object Hierarchy</title>
 
32
<synopsis>
 
33
 
 
34
  <link linkend="GObject">GObject</link>
 
35
   +----<link linkend="GtkObject">GtkObject</link>
 
36
         +----<link linkend="GtkWidget">GtkWidget</link>
 
37
               +----<link linkend="GtkContainer">GtkContainer</link>
 
38
                     +----<link linkend="GtkBin">GtkBin</link>
 
39
                           +----<link linkend="GtkButton">GtkButton</link>
 
40
                                 +----GimpButton
 
41
                                       +----<link linkend="GimpColorButton">GimpColorButton</link>
 
42
</synopsis>
 
43
 
 
44
</refsect1>
 
45
 
 
46
 
 
47
 
 
48
<refsect1>
 
49
<title>Implemented Interfaces</title>
 
50
<para>
 
51
GimpButton implements
 
52
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
53
 
 
54
</refsect1>
 
55
 
 
56
 
 
57
 
 
58
<refsect1>
 
59
<title>Signal Prototypes</title>
 
60
<synopsis>
 
61
 
 
62
&quot;<link linkend="GimpButton-extended-clicked">extended-clicked</link>&quot;
 
63
            <link linkend="void">void</link>        user_function      (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
 
64
                                            <link linkend="GdkModifierType">GdkModifierType</link> arg1,
 
65
                                            <link linkend="gpointer">gpointer</link> user_data);
 
66
</synopsis>
 
67
</refsect1>
 
68
 
 
69
 
 
70
<refsect1>
 
71
<title>Description</title>
 
72
<para>
 
73
<link linkend="GimpButton"><type>GimpButton</type></link> adds an extra signal to the <link linkend="GtkButton"><type>GtkButton</type></link> widget that allows
 
74
to distinguish a normal click from a click that was performed with
 
75
modifier keys pressed.
 
76
</para>
 
77
</refsect1>
 
78
 
 
79
<refsect1>
 
80
<title>Details</title>
 
81
<refsect2>
 
82
<title><anchor id="GimpButton-struct"/>GimpButton</title>
 
83
<indexterm><primary>GimpButton</primary></indexterm><programlisting>typedef struct _GimpButton GimpButton;</programlisting>
 
84
<para>
 
85
 
 
86
</para></refsect2>
 
87
<refsect2>
 
88
<title><anchor id="gimp-button-new"/>gimp_button_new ()</title>
 
89
<indexterm><primary>gimp_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_button_new                 (void);</programlisting>
 
90
<para>
 
91
Creates a new <link linkend="GimpButton"><type>GimpButton</type></link> widget.</para>
 
92
<para>
 
93
 
 
94
</para><variablelist role="params">
 
95
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GimpButton"><type>GimpButton</type></link> widget.
 
96
</simpara></listitem></varlistentry>
 
97
</variablelist></refsect2>
 
98
<refsect2>
 
99
<title><anchor id="gimp-button-extended-clicked"/>gimp_button_extended_clicked ()</title>
 
100
<indexterm><primary>gimp_button_extended_clicked</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_button_extended_clicked    (<link linkend="GimpButton">GimpButton</link> *button,
 
101
                                             <link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
 
102
<para>
 
103
Emits the button's "extended_clicked" signal.</para>
 
104
<para>
 
105
 
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
108
<listitem><simpara> a <link linkend="GimpButton"><type>GimpButton</type></link>.
 
109
</simpara></listitem></varlistentry>
 
110
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
 
111
<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>.
 
112
</simpara></listitem></varlistentry>
 
113
</variablelist></refsect2>
 
114
 
 
115
</refsect1>
 
116
 
 
117
<refsect1>
 
118
<title>Signals</title>
 
119
<refsect2><title><anchor id="GimpButton-extended-clicked"/>The &quot;extended-clicked&quot; signal</title>
 
120
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
 
121
                                            <link linkend="GdkModifierType">GdkModifierType</link> arg1,
 
122
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
123
<para>
 
124
 
 
125
</para><variablelist role="params">
 
126
<varlistentry><term><parameter>gimpbutton</parameter>&nbsp;:</term>
 
127
<listitem><simpara>the object which received the signal.
 
128
</simpara></listitem></varlistentry>
 
129
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
130
<listitem><simpara>the state of modifier keys when the button was clicked
 
131
 
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
134
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
135
</variablelist></refsect2>
 
136
</refsect1>
 
137
 
 
138
 
 
139
 
 
140
</refentry>