Commit 9e261027 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkColorSelectionDialog

parent b0977dce
......@@ -24,6 +24,7 @@ gtkcheckmenuitem.sgml
gtkclipboard.sgml
gtkcolorbutton.sgml
gtkcolorsel.sgml
gtkcolorseldlg.sgml
gtkcombobox.sgml
gtkcomboboxentry.sgml
gtkcontainer.sgml
......
<!-- ##### SECTION Title ##### -->
GtkColorSelectionDialog
<!-- ##### SECTION Short_Description ##### -->
A standard dialog box for selecting a color
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<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>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkColorSelectionDialog ##### -->
<para>
The #GtkColorSelectionDialog-struct struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)
<informaltable pgwide="1" frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>
<row>
<entry>#GtkWidget *colorsel;</entry>
<entry>The #GtkColorSelection widget contained within the
dialog. Use this widget and its gtk_color_selection_get_current_color()
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>
<row>
<entry>#GtkWidget *ok_button;</entry>
<entry>The OK button widget contained within the dialog.
Connect a handler for the clicked event.
</entry>
</row>
<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>
</para>
<!-- ##### ARG GtkColorSelectionDialog:cancel-button ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelectionDialog:color-selection ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelectionDialog:help-button ##### -->
<para>
</para>
<!-- ##### ARG GtkColorSelectionDialog:ok-button ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_color_selection_dialog_new ##### -->
<para>
Creates a new #GtkColorSelectionDialog.
</para>
@title: a string containing the title text for the dialog.
@Returns: a #GtkColorSelectionDialog.
<!-- ##### FUNCTION gtk_color_selection_dialog_get_color_selection ##### -->
<para>
</para>
@colorsel:
@Returns:
......@@ -35,6 +35,31 @@
#include "gtkbuildable.h"
/**
* SECTION:gtkcolorseldlg
* @Short_description: A standard dialog box for selecting a color
* @Title: GtkColorSelectionDialog
*
* 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.
*
* Use gtk_color_selection_dialog_get_color_selection() to get the
* #GtkColorSelection widget contained within the dialog. Use this widget
* and its gtk_color_selection_get_current_color()
* function to gain access to the selected color. Connect a handler
* for this widget's #GtkColorSelection::color-changed signal to be notified
* when the color changes.
*
* <refsect2 id="GtkColorSelectionDialog-BUILDER-UI">
* <title>GtkColorSelectionDialog as GtkBuildable</title>
* 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".
* </refsect2>
*/
struct _GtkColorSelectionDialogPrivate
{
......@@ -189,6 +214,14 @@ gtk_color_selection_dialog_init (GtkColorSelectionDialog *colorseldiag)
_("Color Selection"));
}
/**
* gtk_color_selection_dialog_new:
* @title: a string containing the title text for the dialog.
*
* Creates a new #GtkColorSelectionDialog.
*
* Returns: a #GtkColorSelectionDialog.
*/
GtkWidget*
gtk_color_selection_dialog_new (const gchar *title)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment