]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcolorseldlg.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkcolorseldlg.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkColorSelectionDialog
3
4 <!-- ##### SECTION Short_Description ##### -->
5 A standard dialog box for selecting a color
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 The #GtkColorSelectionDialog provides a standard dialog which
10 allows the user to select a color much like the #GtkFileSelection
11 provides a standard dialog for file selection.
12 </para>
13
14 <refsect2 id="GtkColorSelectionDialog-BUILDER-UI">
15 <title>GtkColorSelectionDialog as GtkBuildable</title>
16 <para>
17 The GtkColorSelectionDialog implementation of the GtkBuildable interface
18 exposes the embedded #GtkColorSelection as internal child with the
19 name "color_selection". It also exposes the buttons with the names
20 "ok_button", "cancel_button" and "help_button".
21 </para>
22 </refsect2>
23
24 <!-- ##### SECTION See_Also ##### -->
25 <para>
26
27 </para>
28
29 <!-- ##### SECTION Stability_Level ##### -->
30
31
32 <!-- ##### SECTION Image ##### -->
33
34
35 <!-- ##### STRUCT GtkColorSelectionDialog ##### -->
36 <para>
37 The #GtkColorSelectionDialog-struct struct contains the following fields.
38 (These fields should be considered read-only. They should never be set by
39 an application.)
40
41 <informaltable pgwide="1" frame="none" role="struct">
42 <tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
43 <tbody>
44
45 <row>
46 <entry>#GtkWidget *colorsel;</entry>
47 <entry>The #GtkColorSelection widget contained within the
48 dialog.  Use this widget and its gtk_color_selection_get_current_color()
49 function to gain access to the selected color.  Connect a handler 
50 for this widget's color_changed signal to be notified when the
51 color changes.
52 </entry>
53 </row>
54
55 <row>
56 <entry>#GtkWidget *ok_button;</entry>
57 <entry>The OK button widget contained within the dialog.  
58 Connect a handler for the clicked event.
59 </entry>
60 </row>
61
62 <row>
63 <entry>#GtkWidget *cancel_button;</entry>
64 <entry>The cancel button widget contained within the dialog.  
65 Connect a handler for the clicked event.
66 </entry>
67 </row>
68
69 <row>
70 <entry>#GtkWidget *help_button;</entry>
71 <entry>The help button widget contained within the dialog.  
72 Connect a handler for the clicked event.
73 </entry>
74 </row>
75
76 </tbody></tgroup></informaltable>
77 </para>
78
79
80 <!-- ##### ARG GtkColorSelectionDialog:cancel-button ##### -->
81 <para>
82
83 </para>
84
85 <!-- ##### ARG GtkColorSelectionDialog:color-selection ##### -->
86 <para>
87
88 </para>
89
90 <!-- ##### ARG GtkColorSelectionDialog:help-button ##### -->
91 <para>
92
93 </para>
94
95 <!-- ##### ARG GtkColorSelectionDialog:ok-button ##### -->
96 <para>
97
98 </para>
99
100 <!-- ##### FUNCTION gtk_color_selection_dialog_new ##### -->
101 <para>
102 Creates a new #GtkColorSelectionDialog.
103 </para>
104
105 @title: a string containing the title text for the dialog.
106 @Returns: a #GtkColorSelectionDialog.
107
108
109 <!-- ##### FUNCTION gtk_color_selection_dialog_get_color_selection ##### -->
110 <para>
111
112 </para>
113
114 @colorsel: 
115 @Returns: 
116
117