← Back to branch summary

~ubuntu-branches/ubuntu/karmic/exo/karmic

« back to all changes in this revision

Viewing changes to docs/reference/xml/exo-icon-chooser-dialog.xml

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2009-08-21 14:28:56 UTC
  • mfrom: (1.1.22 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821142856-xp7o7hl7x9xa2213
Tags: 0.3.102-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/rules:
    + Removed mangling of helpers.rc
    + Add --enable-gtk-doc switch to configure
  - debian/control:
    + Add build-dep on gtk-doc-tools
    + Update Vcs-* fields
  - debian/patches:
    + 04_update_helpers.patch: patched libexo's firefox helper desktop file
      to use firefox-3.0 icon instead of firefox icon
    + xubuntu-default-mount-options.patch: change default mount options for
      vfat, iso9660, ntfs
    + series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/exo-icon-chooser-dialog.xml
8
8
<refnamediv>
9
9
<refname>ExoIconChooserDialog</refname>
10
10
<refpurpose>Dialog to select icons</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
13
<refsynopsisdiv id="ExoIconChooserDialog.synopsis" role="synopsis">
19
18
#include &lt;exo/exo.h&gt;
20
19
 
21
20
                    <link linkend="ExoIconChooserDialog-struct">ExoIconChooserDialog</link>;
22
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="exo-icon-chooser-dialog-new">exo_icon_chooser_dialog_new</link>         (const <link linkend="gchar">gchar</link> *title,
 
21
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="exo-icon-chooser-dialog-new">exo_icon_chooser_dialog_new</link>         (const <link linkend="gchar">gchar</link> *title,
23
22
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
24
23
                                                         const <link linkend="gchar">gchar</link> *first_button_text,
25
24
                                                         ...);
26
 
<link linkend="gchar">gchar</link>*              <link linkend="exo-icon-chooser-dialog-get-icon">exo_icon_chooser_dialog_get_icon</link>    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog);
 
25
<link linkend="gchar">gchar</link> *             <link linkend="exo-icon-chooser-dialog-get-icon">exo_icon_chooser_dialog_get_icon</link>    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog);
27
26
<link linkend="gboolean">gboolean</link>            <link linkend="exo-icon-chooser-dialog-set-icon">exo_icon_chooser_dialog_set_icon</link>    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog,
28
27
                                                         const <link linkend="gchar">gchar</link> *icon);
29
28
</synopsis>
42
41
                                       +----<link linkend="GtkDialog">GtkDialog</link>
43
42
                                             +----ExoIconChooserDialog
44
43
</synopsis>
45
 
 
46
44
</refsect1>
47
45
 
48
46
 
51
49
<title role="impl_interfaces.title">Implemented Interfaces</title>
52
50
<para>
53
51
ExoIconChooserDialog implements
54
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
55
 
 
 
52
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
56
53
</refsect1>
57
54
 
58
55
 
71
68
<title role="details.title">Details</title>
72
69
<refsect2 id="ExoIconChooserDialog-struct" role="struct">
73
70
<title>ExoIconChooserDialog</title>
74
 
<indexterm zone="ExoIconChooserDialog-struct"><primary>ExoIconChooserDialog</primary></indexterm><programlisting>typedef struct _ExoIconChooserDialog ExoIconChooserDialog;</programlisting>
 
71
<indexterm zone="ExoIconChooserDialog-struct"><primary sortas="ExoIconChooserDialog">ExoIconChooserDialog</primary></indexterm><programlisting>typedef struct _ExoIconChooserDialog ExoIconChooserDialog;</programlisting>
75
72
<para>
76
73
  The <structname>ExoIconChooserDialog</structname> struct contains only private fields and should not be directly accessed.
77
74
</para></refsect2>
78
75
<refsect2 id="exo-icon-chooser-dialog-new" role="function" condition="since:0.3.1.9">
79
76
<title>exo_icon_chooser_dialog_new ()</title>
80
 
<indexterm zone="exo-icon-chooser-dialog-new" role="0.3.1.9"><primary>exo_icon_chooser_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          exo_icon_chooser_dialog_new         (const <link linkend="gchar">gchar</link> *title,
 
77
<indexterm zone="exo-icon-chooser-dialog-new" role="0.3.1.9"><primary sortas="exo_icon_chooser_dialog_new">exo_icon_chooser_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         exo_icon_chooser_dialog_new         (const <link linkend="gchar">gchar</link> *title,
81
78
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
82
79
                                                         const <link linkend="gchar">gchar</link> *first_button_text,
83
80
                                                         ...);</programlisting>
84
81
<para>
85
82
Creates a new <link linkend="ExoIconChooserDialog"><type>ExoIconChooserDialog</type></link>. This function is analogous to <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
86
83
<para>
87
 
 
88
84
</para><variablelist role="params">
89
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
90
 
<listitem><simpara> title of the dialog, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
91
 
</simpara></listitem></varlistentry>
92
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
93
 
<listitem><simpara> transient parent of the dialog, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><parameter>first_button_text</parameter>&nbsp;:</term>
96
 
<listitem><simpara> stock-id or text to go in the first button, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
85
<varlistentry><term><parameter>title</parameter>&#160;:</term>
 
86
<listitem><simpara> title of the dialog, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
 
87
</simpara></listitem></varlistentry>
 
88
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
 
89
<listitem><simpara> transient parent of the dialog, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><parameter>first_button_text</parameter>&#160;:</term>
 
92
<listitem><simpara> stock-id or text to go in the first button, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
 
93
</simpara></listitem></varlistentry>
 
94
<varlistentry><term><parameter>...</parameter>&#160;:</term>
99
95
<listitem><simpara> response-id for the first button, then additional (button, id) pairs,
100
 
                     ending with <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
96
                     ending with <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
101
97
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="ExoIconChooserDialog"><type>ExoIconChooserDialog</type></link>.
 
98
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="ExoIconChooserDialog"><type>ExoIconChooserDialog</type></link>.
103
99
 
104
100
</simpara></listitem></varlistentry>
105
 
</variablelist><para role="since">Since  0.3.1.9
106
 
</para></refsect2>
 
101
</variablelist><para role="since">Since 0.3.1.9</para></refsect2>
107
102
<refsect2 id="exo-icon-chooser-dialog-get-icon" role="function" condition="since:0.3.1.9">
108
103
<title>exo_icon_chooser_dialog_get_icon ()</title>
109
 
<indexterm zone="exo-icon-chooser-dialog-get-icon" role="0.3.1.9"><primary>exo_icon_chooser_dialog_get_icon</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              exo_icon_chooser_dialog_get_icon    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog);</programlisting>
 
104
<indexterm zone="exo-icon-chooser-dialog-get-icon" role="0.3.1.9"><primary sortas="exo_icon_chooser_dialog_get_icon">exo_icon_chooser_dialog_get_icon</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             exo_icon_chooser_dialog_get_icon    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog);</programlisting>
110
105
<para>
111
106
Returns the currently selected icon for the <parameter>icon_chooser_dialog</parameter>. The selected icon can be either
112
107
a named icon (from the active icon theme) or the absolute path to an image file in the file system.
113
108
You can distinguish between those two icon types using the <link linkend="g-path-is-absolute"><function>g_path_is_absolute()</function></link> function. If no
114
 
icon is currently selected, <link linkend="NULL:CAPS"><literal>NULL</literal></link> will be returned.
 
109
icon is currently selected, <link linkend="NULL--CAPS"><literal>NULL</literal></link> will be returned.
115
110
</para>
116
111
<para>
117
112
The caller is responsible to free the returned string using <link linkend="g-free"><function>g_free()</function></link> when no longer needed.</para>
118
113
<para>
119
 
 
120
114
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>icon_chooser_dialog</parameter>&nbsp;:</term>
 
115
<varlistentry><term><parameter>icon_chooser_dialog</parameter>&#160;:</term>
122
116
<listitem><simpara> an <link linkend="ExoIconChooserDialog"><type>ExoIconChooserDialog</type></link>.
123
117
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the currently selected icon for <parameter>icon_chooser_dialog</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no icon is selected.
 
118
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the currently selected icon for <parameter>icon_chooser_dialog</parameter> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no icon is selected.
125
119
 
126
120
</simpara></listitem></varlistentry>
127
 
</variablelist><para role="since">Since  0.3.1.9
128
 
</para></refsect2>
 
121
</variablelist><para role="since">Since 0.3.1.9</para></refsect2>
129
122
<refsect2 id="exo-icon-chooser-dialog-set-icon" role="function" condition="since:0.3.1.9">
130
123
<title>exo_icon_chooser_dialog_set_icon ()</title>
131
 
<indexterm zone="exo-icon-chooser-dialog-set-icon" role="0.3.1.9"><primary>exo_icon_chooser_dialog_set_icon</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            exo_icon_chooser_dialog_set_icon    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog,
 
124
<indexterm zone="exo-icon-chooser-dialog-set-icon" role="0.3.1.9"><primary sortas="exo_icon_chooser_dialog_set_icon">exo_icon_chooser_dialog_set_icon</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            exo_icon_chooser_dialog_set_icon    (<link linkend="ExoIconChooserDialog">ExoIconChooserDialog</link> *icon_chooser_dialog,
132
125
                                                         const <link linkend="gchar">gchar</link> *icon);</programlisting>
133
126
<para>
134
 
Preselects the specified <parameter>icon</parameter> in the <parameter>icon_chooser_dialog</parameter>, and returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the
 
127
Preselects the specified <parameter>icon</parameter> in the <parameter>icon_chooser_dialog</parameter>, and returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the
135
128
<parameter>icon</parameter> was successfully selected.</para>
136
129
<para>
137
 
 
138
130
</para><variablelist role="params">
139
 
<varlistentry><term><parameter>icon_chooser_dialog</parameter>&nbsp;:</term>
 
131
<varlistentry><term><parameter>icon_chooser_dialog</parameter>&#160;:</term>
140
132
<listitem><simpara> an <link linkend="ExoIconChooserDialog"><type>ExoIconChooserDialog</type></link>.
141
133
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><parameter>icon</parameter>&nbsp;:</term>
 
134
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
143
135
<listitem><simpara> the themed icon or the absolute path to an image file to select.
144
136
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>icon</parameter> was successfully preselected in the <parameter>icon_chooser_dialog</parameter>,
146
 
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
 
137
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the <parameter>icon</parameter> was successfully preselected in the <parameter>icon_chooser_dialog</parameter>,
 
138
              <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
147
139
 
148
140
</simpara></listitem></varlistentry>
149
 
</variablelist><para role="since">Since  0.3.1.9
150
 
</para></refsect2>
 
141
</variablelist><para role="since">Since 0.3.1.9</para></refsect2>
151
142
 
152
143
</refsect1>
153
144