gtkcolorseldlg.sgml 2.73 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkColorSelectionDialog

<!-- ##### SECTION Short_Description ##### -->
5
A standard dialog box for selecting a color
Owen Taylor's avatar
Owen Taylor committed
6 7 8

<!-- ##### SECTION Long_Description ##### -->
<para>
9 10 11
The #GtkColorSelectionDialog provides a standard dialog which
allows the user to select a color much like the #GtkFileSelection
provides a standard dialog for file selection.
Owen Taylor's avatar
Owen Taylor committed
12 13
</para>

14 15 16 17 18 19 20 21 22 23
<refsect2 id="GtkColorSelectionDialog-BUILDER-UI">
<title>GtkColorSelectionDialog as GtkBuildable</title>
<para>
The GtkColorSelectionDialog implementation of the GtkBuildable interface
exposes the embedded #GtkColorSelection as internal child with the
name "color_selection". It also exposes the buttons with the names
"ok_button", "cancel_button" and "help_button".
</para>
</refsect2>

Owen Taylor's avatar
Owen Taylor committed
24 25 26 27 28
<!-- ##### SECTION See_Also ##### -->
<para>

</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
29 30 31
<!-- ##### SECTION Stability_Level ##### -->


32 33 34
<!-- ##### SECTION Image ##### -->


Owen Taylor's avatar
Owen Taylor committed
35 36
<!-- ##### STRUCT GtkColorSelectionDialog ##### -->
<para>
37 38 39
The #GtkColorSelectionDialog-struct struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)
Owen Taylor's avatar
Owen Taylor committed
40

Matthias Clasen's avatar
Matthias Clasen committed
41 42
<informaltable pgwide="1" frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
43
<tbody>
Owen Taylor's avatar
Owen Taylor committed
44

45 46 47
<row>
<entry>#GtkWidget *colorsel;</entry>
<entry>The #GtkColorSelection widget contained within the
48
dialog.  Use this widget and its gtk_color_selection_get_current_color()
49 50 51 52 53
function to gain access to the selected color.  Connect a handler 
for this widget's color_changed signal to be notified when the
color changes.
</entry>
</row>
Owen Taylor's avatar
Owen Taylor committed
54

55 56 57 58 59 60
<row>
<entry>#GtkWidget *ok_button;</entry>
<entry>The OK button widget contained within the dialog.  
Connect a handler for the clicked event.
</entry>
</row>
Owen Taylor's avatar
Owen Taylor committed
61

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
<row>
<entry>#GtkWidget *cancel_button;</entry>
<entry>The cancel button widget contained within the dialog.  
Connect a handler for the clicked event.
</entry>
</row>

<row>
<entry>#GtkWidget *help_button;</entry>
<entry>The help button widget contained within the dialog.  
Connect a handler for the clicked event.
</entry>
</row>

</tbody></tgroup></informaltable>
Owen Taylor's avatar
Owen Taylor committed
77 78 79
</para>


Matthias Clasen's avatar
2.13.4  
Matthias Clasen committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
<!-- ##### ARG GtkColorSelectionDialog:cancel-button ##### -->
<para>

</para>

<!-- ##### ARG GtkColorSelectionDialog:color-selection ##### -->
<para>

</para>

<!-- ##### ARG GtkColorSelectionDialog:help-button ##### -->
<para>

</para>

<!-- ##### ARG GtkColorSelectionDialog:ok-button ##### -->
<para>

</para>

100 101 102 103
<!-- ##### FUNCTION gtk_color_selection_dialog_new ##### -->
<para>
Creates a new #GtkColorSelectionDialog.
</para>
Owen Taylor's avatar
Owen Taylor committed
104

105 106
@title: a string containing the title text for the dialog.
@Returns: a #GtkColorSelectionDialog.
107 108


Matthias Clasen's avatar
2.13.5  
Matthias Clasen committed
109 110 111 112 113 114 115 116 117
<!-- ##### FUNCTION gtk_color_selection_dialog_get_color_selection ##### -->
<para>

</para>

@colorsel: 
@Returns: