[gimp] libgimpwidgets: move docs from template files to inline comments
- From: Michael Natterer <mitch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimpwidgets: move docs from template files to inline comments
- Date: Mon, 5 Jul 2010 16:03:02 +0000 (UTC)
commit 1f7ff98c4529d80a73568afc181bc4e0ee170a5c
Author: Michael Natterer <mitch gimp org>
Date: Mon Jul 5 18:01:28 2010 +0200
libgimpwidgets: move docs from template files to inline comments
but leave the template file for gimpstock there because its contents
would be too much for gimpstock.h.
devel-docs/libgimpwidgets/tmpl/.gitignore | 50 +++
devel-docs/libgimpwidgets/tmpl/gimpbrowser.sgml | 71 ----
devel-docs/libgimpwidgets/tmpl/gimpbutton.sgml | 52 ---
.../libgimpwidgets/tmpl/gimpcairo-utils.sgml | 91 -----
.../libgimpwidgets/tmpl/gimpcellrenderercolor.sgml | 48 ---
.../tmpl/gimpcellrenderertoggle.sgml | 63 ---
.../libgimpwidgets/tmpl/gimpchainbutton.sgml | 86 -----
devel-docs/libgimpwidgets/tmpl/gimpcolorarea.sgml | 117 ------
.../libgimpwidgets/tmpl/gimpcolorbutton.sgml | 126 -------
.../libgimpwidgets/tmpl/gimpcolordisplay.sgml | 164 --------
.../libgimpwidgets/tmpl/gimpcolordisplaystack.sgml | 132 -------
.../libgimpwidgets/tmpl/gimpcolorhexentry.sgml | 58 ---
.../libgimpwidgets/tmpl/gimpcolornotebook.sgml | 47 ---
.../tmpl/gimpcolorprofilecombobox.sgml | 84 -----
.../libgimpwidgets/tmpl/gimpcolorprofilestore.sgml | 49 ---
devel-docs/libgimpwidgets/tmpl/gimpcolorscale.sgml | 54 ---
.../libgimpwidgets/tmpl/gimpcolorscales.sgml | 27 --
.../libgimpwidgets/tmpl/gimpcolorselect.sgml | 29 --
.../libgimpwidgets/tmpl/gimpcolorselection.sgml | 124 ------
.../libgimpwidgets/tmpl/gimpcolorselector.sgml | 159 --------
devel-docs/libgimpwidgets/tmpl/gimpcontroller.sgml | 134 -------
devel-docs/libgimpwidgets/tmpl/gimpdialog.sgml | 112 ------
.../libgimpwidgets/tmpl/gimpenumcombobox.sgml | 57 ---
devel-docs/libgimpwidgets/tmpl/gimpenumlabel.sgml | 44 ---
devel-docs/libgimpwidgets/tmpl/gimpenumstore.sgml | 81 ----
.../libgimpwidgets/tmpl/gimpenumwidgets.sgml | 113 ------
devel-docs/libgimpwidgets/tmpl/gimpfileentry.sgml | 79 ----
devel-docs/libgimpwidgets/tmpl/gimpframe.sgml | 44 ---
devel-docs/libgimpwidgets/tmpl/gimphelpui.sgml | 117 ------
devel-docs/libgimpwidgets/tmpl/gimphintbox.sgml | 28 --
.../libgimpwidgets/tmpl/gimpintcombobox.sgml | 133 -------
devel-docs/libgimpwidgets/tmpl/gimpintstore.sgml | 61 ---
.../libgimpwidgets/tmpl/gimpmemsizeentry.sgml | 63 ---
.../libgimpwidgets/tmpl/gimpnumberpairentry.sgml | 232 ------------
devel-docs/libgimpwidgets/tmpl/gimpoffsetarea.sgml | 73 ----
devel-docs/libgimpwidgets/tmpl/gimpoldwidgets.sgml | 122 ------
.../libgimpwidgets/tmpl/gimppageselector.sgml | 213 -----------
devel-docs/libgimpwidgets/tmpl/gimppatheditor.sgml | 121 ------
devel-docs/libgimpwidgets/tmpl/gimppickbutton.sgml | 43 ---
devel-docs/libgimpwidgets/tmpl/gimppixmap.sgml | 55 ---
devel-docs/libgimpwidgets/tmpl/gimppreview.sgml | 169 ---------
.../libgimpwidgets/tmpl/gimppreviewarea.sgml | 149 --------
.../libgimpwidgets/tmpl/gimppropwidgets.sgml | 383 -------------------
devel-docs/libgimpwidgets/tmpl/gimpquerybox.sgml | 196 ----------
devel-docs/libgimpwidgets/tmpl/gimpruler.sgml | 127 -------
.../libgimpwidgets/tmpl/gimpscrolledpreview.sgml | 61 ---
devel-docs/libgimpwidgets/tmpl/gimpsizeentry.sgml | 285 --------------
devel-docs/libgimpwidgets/tmpl/gimpstock.sgml | 15 +-
.../libgimpwidgets/tmpl/gimpstringcombobox.sgml | 70 ----
devel-docs/libgimpwidgets/tmpl/gimpunitmenu.sgml | 100 -----
devel-docs/libgimpwidgets/tmpl/gimpwidgets.sgml | 394 --------------------
devel-docs/libgimpwidgets/tmpl/gimpzoommodel.sgml | 140 -------
libgimpwidgets/gimpbrowser.c | 9 +
libgimpwidgets/gimpbutton.c | 19 +
libgimpwidgets/gimpbutton.h | 2 +-
libgimpwidgets/gimpcairo-utils.c | 10 +
libgimpwidgets/gimpcellrenderercolor.c | 9 +
libgimpwidgets/gimpcellrenderertoggle.c | 10 +
libgimpwidgets/gimpchainbutton.c | 22 ++
libgimpwidgets/gimpcolorarea.c | 10 +
libgimpwidgets/gimpcolorbutton.c | 16 +
libgimpwidgets/gimpcolordisplay.c | 11 +
libgimpwidgets/gimpcolordisplaystack.c | 10 +
libgimpwidgets/gimpcolorhexentry.c | 9 +
libgimpwidgets/gimpcolornotebook.c | 11 +
libgimpwidgets/gimpcolorprofilecombobox.c | 9 +
libgimpwidgets/gimpcolorprofilestore.c | 9 +
libgimpwidgets/gimpcolorscale.c | 9 +
libgimpwidgets/gimpcolorscales.c | 11 +
libgimpwidgets/gimpcolorselect.c | 14 +
libgimpwidgets/gimpcolorselection.c | 9 +
libgimpwidgets/gimpcolorselector.c | 11 +
libgimpwidgets/gimpcolorselector.h | 17 +-
libgimpwidgets/gimpcontroller.c | 10 +
libgimpwidgets/gimpdialog.c | 11 +
libgimpwidgets/gimpenumcombobox.c | 9 +
libgimpwidgets/gimpenumlabel.c | 9 +
libgimpwidgets/gimpenumstore.c | 9 +
libgimpwidgets/gimpenumwidgets.c | 10 +
libgimpwidgets/gimpfileentry.c | 24 ++
libgimpwidgets/gimpframe.c | 10 +
libgimpwidgets/gimphelpui.c | 11 +
libgimpwidgets/gimphelpui.h | 7 +
libgimpwidgets/gimphintbox.c | 9 +
libgimpwidgets/gimpintcombobox.c | 10 +
libgimpwidgets/gimpintstore.c | 10 +
libgimpwidgets/gimpmemsizeentry.c | 12 +
libgimpwidgets/gimpmemsizeentry.h | 1 +
libgimpwidgets/gimpnumberpairentry.c | 9 +
libgimpwidgets/gimpoffsetarea.c | 9 +
libgimpwidgets/gimpoldwidgets.c | 11 +
libgimpwidgets/gimppageselector.c | 10 +
libgimpwidgets/gimppatheditor.c | 21 +
libgimpwidgets/gimppickbutton.c | 18 +
libgimpwidgets/gimppixmap.c | 18 +
libgimpwidgets/gimppreview.c | 11 +
libgimpwidgets/gimppreviewarea.c | 10 +
libgimpwidgets/gimppropwidgets.c | 9 +
libgimpwidgets/gimpquerybox.c | 21 +
libgimpwidgets/gimpquerybox.h | 49 +++-
libgimpwidgets/gimpruler.c | 9 +
libgimpwidgets/gimpscaleentry.h | 34 ++-
libgimpwidgets/gimpscrolledpreview.c | 10 +
libgimpwidgets/gimpsizeentry.c | 29 ++
libgimpwidgets/gimpstock.c | 16 +
libgimpwidgets/gimpstringcombobox.c | 9 +
libgimpwidgets/gimpunitmenu.c | 21 +
libgimpwidgets/gimpwidgets.c | 11 +
libgimpwidgets/gimpwidgets.h | 29 ++-
libgimpwidgets/gimpwidgetsenums.h | 13 +
libgimpwidgets/gimpwidgetstypes.h | 20 +
libgimpwidgets/gimpzoommodel.c | 9 +
112 files changed, 845 insertions(+), 5595 deletions(-)
---
diff --git a/devel-docs/libgimpwidgets/tmpl/.gitignore b/devel-docs/libgimpwidgets/tmpl/.gitignore
index 907999a..57e2de8 100644
--- a/devel-docs/libgimpwidgets/tmpl/.gitignore
+++ b/devel-docs/libgimpwidgets/tmpl/.gitignore
@@ -1,2 +1,52 @@
/libgimpwidgets-unused.sgml
/*.bak
+/gimpbrowser.sgml
+/gimpbutton.sgml
+/gimpcairo-utils.sgml
+/gimpcellrenderercolor.sgml
+/gimpcellrenderertoggle.sgml
+/gimpchainbutton.sgml
+/gimpcolorarea.sgml
+/gimpcolorbutton.sgml
+/gimpcolordisplay.sgml
+/gimpcolordisplaystack.sgml
+/gimpcolorhexentry.sgml
+/gimpcolornotebook.sgml
+/gimpcolorprofilecombobox.sgml
+/gimpcolorprofilestore.sgml
+/gimpcolorscale.sgml
+/gimpcolorscales.sgml
+/gimpcolorselect.sgml
+/gimpcolorselection.sgml
+/gimpcolorselector.sgml
+/gimpcontroller.sgml
+/gimpdialog.sgml
+/gimpenumcombobox.sgml
+/gimpenumlabel.sgml
+/gimpenumstore.sgml
+/gimpenumwidgets.sgml
+/gimpfileentry.sgml
+/gimpframe.sgml
+/gimphelpui.sgml
+/gimphintbox.sgml
+/gimpintcombobox.sgml
+/gimpintstore.sgml
+/gimpmemsizeentry.sgml
+/gimpnumberpairentry.sgml
+/gimpoffsetarea.sgml
+/gimpoldwidgets.sgml
+/gimppageselector.sgml
+/gimppatheditor.sgml
+/gimppickbutton.sgml
+/gimppixmap.sgml
+/gimppreview.sgml
+/gimppreviewarea.sgml
+/gimppropwidgets.sgml
+/gimpquerybox.sgml
+/gimpruler.sgml
+/gimpscrolledpreview.sgml
+/gimpsizeentry.sgml
+/gimpstringcombobox.sgml
+/gimpunitmenu.sgml
+/gimpwidgets.sgml
+/gimpzoommodel.sgml
diff --git a/devel-docs/libgimpwidgets/tmpl/gimpstock.sgml b/devel-docs/libgimpwidgets/tmpl/gimpstock.sgml
index bcbf1b6..329c6d6 100644
--- a/devel-docs/libgimpwidgets/tmpl/gimpstock.sgml
+++ b/devel-docs/libgimpwidgets/tmpl/gimpstock.sgml
@@ -2,18 +2,11 @@
GimpStock
<!-- ##### SECTION Short_Description ##### -->
-Prebuilt common menu/toolbar items and corresponding icons
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-GIMP registers a set of menu/toolbar items and corresponding icons in
-addition to the standard GTK+ stock items. These can be used just like
-GTK+ stock items. GIMP also overrides a few of the GTK+ icons (namely
-the ones in dialog size).
-</para>
-<para>
-Stock icons may have a RTL variant which gets used for right-to-left
-locales.
+
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -24,11 +17,15 @@ locales.
<!-- ##### SECTION Stability_Level ##### -->
+<!-- ##### SECTION Image ##### -->
+
+
<!-- ##### FUNCTION gimp_stock_init ##### -->
<para>
</para>
+ void:
<!-- ##### MACRO GIMP_STOCK_ANCHOR ##### -->
diff --git a/libgimpwidgets/gimpbrowser.c b/libgimpwidgets/gimpbrowser.c
index 327ba43..5873dbc 100644
--- a/libgimpwidgets/gimpbrowser.c
+++ b/libgimpwidgets/gimpbrowser.c
@@ -33,6 +33,15 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpbrowser
+ * @title: GimpBrowser
+ * @short_description: A base class for a documentation browser.
+ *
+ * A base class for a documentation browser.
+ **/
+
+
enum
{
SEARCH,
diff --git a/libgimpwidgets/gimpbutton.c b/libgimpwidgets/gimpbutton.c
index 7062e0e..92b4403 100644
--- a/libgimpwidgets/gimpbutton.c
+++ b/libgimpwidgets/gimpbutton.c
@@ -28,6 +28,17 @@
#include "gimpbutton.h"
+/**
+ * SECTION: gimpbutton
+ * @title: GimpButton
+ * @short_description: A #GtkButton with a little extra functionality.
+ *
+ * #GimpButton adds an extra signal to the #GtkButton widget that
+ * allows to distinguish a normal click from a click that was
+ * performed with modifier keys pressed.
+ **/
+
+
enum
{
EXTENDED_CLICKED,
@@ -53,6 +64,14 @@ gimp_button_class_init (GimpButtonClass *klass)
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
GtkButtonClass *button_class = GTK_BUTTON_CLASS (klass);
+ /**
+ * GimpButton::extended-clicked:
+ * @gimpbutton: the object that received the signal.
+ * @arg1: the state of modifier keys when the button was clicked
+ *
+ * This signal is emitted when the button is clicked with a modifier
+ * key pressed.
+ **/
button_signals[EXTENDED_CLICKED] =
g_signal_new ("extended-clicked",
G_TYPE_FROM_CLASS (klass),
diff --git a/libgimpwidgets/gimpbutton.h b/libgimpwidgets/gimpbutton.h
index b89e49a..4df78b1 100644
--- a/libgimpwidgets/gimpbutton.h
+++ b/libgimpwidgets/gimpbutton.h
@@ -49,7 +49,7 @@ struct _GimpButtonClass
{
GtkButtonClass parent_class;
- void (* extended_clicked) (GimpButton *preview,
+ void (* extended_clicked) (GimpButton *button,
GdkModifierType modifier_state);
/* Padding for future expansion */
diff --git a/libgimpwidgets/gimpcairo-utils.c b/libgimpwidgets/gimpcairo-utils.c
index 9bb72e7..d55ab39 100644
--- a/libgimpwidgets/gimpcairo-utils.c
+++ b/libgimpwidgets/gimpcairo-utils.c
@@ -32,6 +32,16 @@
/**
+ * SECTION: gimpcairo-utils
+ * @title: GimpCairo-utils
+ * @short_description: Utility functions for cairo
+ *
+ * Utility functions that make cairo easier to use with common
+ * GIMP data types.
+ **/
+
+
+/**
* gimp_cairo_set_source_rgb:
* @cr: Cairo context
* @color: GimpRGB color
diff --git a/libgimpwidgets/gimpcellrenderercolor.c b/libgimpwidgets/gimpcellrenderercolor.c
index 10fdc1a..dc1f66a 100644
--- a/libgimpwidgets/gimpcellrenderercolor.c
+++ b/libgimpwidgets/gimpcellrenderercolor.c
@@ -32,6 +32,15 @@
#include "gimpcellrenderercolor.h"
+/**
+ * SECTION: gimpcellrenderercolor
+ * @title: GimpCellRendererColor
+ * @short_description: A #GtkCellRenderer to display a #GimpRGB color.
+ *
+ * A #GtkCellRenderer to display a #GimpRGB color.
+ **/
+
+
#define DEFAULT_ICON_SIZE GTK_ICON_SIZE_MENU
diff --git a/libgimpwidgets/gimpcellrenderertoggle.c b/libgimpwidgets/gimpcellrenderertoggle.c
index 1234e10..d9c4550 100644
--- a/libgimpwidgets/gimpcellrenderertoggle.c
+++ b/libgimpwidgets/gimpcellrenderertoggle.c
@@ -29,6 +29,16 @@
#include "gimpcellrenderertoggle.h"
+/**
+ * SECTION: gimpcellrenderertoggle
+ * @title: GimpCellRendererToggle
+ * @short_description: A #GtkCellRendererToggle that displays icons instead
+ * of a checkbox.
+ *
+ * A #GtkCellRendererToggle that displays icons instead of a checkbox.
+ **/
+
+
#define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON
diff --git a/libgimpwidgets/gimpchainbutton.c b/libgimpwidgets/gimpchainbutton.c
index c60e276..54bccc4 100644
--- a/libgimpwidgets/gimpchainbutton.c
+++ b/libgimpwidgets/gimpchainbutton.c
@@ -29,6 +29,28 @@
#include "gimpstock.h"
+/**
+ * SECTION: gimpchainbutton
+ * @title: GimpChainButton
+ * @short_description: Widget to visually connect two entry widgets.
+ * @see_also: You may want to use the convenience function
+ * gimp_coordinates_new() to set up two GimpSizeEntries
+ * (see #GimpSizeEntry) linked with a #GimpChainButton.
+ *
+ * This widget provides a button showing either a linked or a broken
+ * chain that can be used to link two entries, spinbuttons, colors or
+ * other GUI elements and show that they may be locked. Use it for
+ * example to connect X and Y ratios to provide the possibility of a
+ * constrained aspect ratio.
+ *
+ * The #GimpChainButton only gives visual feedback, it does not really
+ * connect widgets. You have to take care of locking the values
+ * yourself by checking the state of the #GimpChainButton whenever a
+ * value changes in one of the connected widgets and adjusting the
+ * other value if necessary.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpcolorarea.c b/libgimpwidgets/gimpcolorarea.c
index 7ca9b2f..340f500 100644
--- a/libgimpwidgets/gimpcolorarea.c
+++ b/libgimpwidgets/gimpcolorarea.c
@@ -31,6 +31,16 @@
#include "gimpcolorarea.h"
+/**
+ * SECTION: gimpcolorarea
+ * @title: GimpColorArea
+ * @short_description: Displays a #GimpRGB color, optionally with
+ * alpha-channel.
+ *
+ * Displays a #GimpRGB color, optionally with alpha-channel.
+ **/
+
+
#define DRAG_PREVIEW_SIZE 32
#define DRAG_ICON_OFFSET -8
diff --git a/libgimpwidgets/gimpcolorbutton.c b/libgimpwidgets/gimpcolorbutton.c
index 21a3a79..1a3be71 100644
--- a/libgimpwidgets/gimpcolorbutton.c
+++ b/libgimpwidgets/gimpcolorbutton.c
@@ -41,6 +41,22 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolorbutton
+ * @title: GimpColorButton
+ * @short_description: Widget for selecting a color from a simple button.
+ * @see_also: #libgimpcolor-gimpcolorspace
+ *
+ * This widget provides a simple button with a preview showing the
+ * color.
+ *
+ * On click a color selection dialog is opened. Additionally the
+ * button supports Drag and Drop and has a right-click menu that
+ * allows to choose the color from the current FG or BG color. If the
+ * user changes the color, the "color-changed" signal is emitted.
+ **/
+
+
#define COLOR_SELECTION_KEY "gimp-color-selection"
#define RESPONSE_RESET 1
diff --git a/libgimpwidgets/gimpcolordisplay.c b/libgimpwidgets/gimpcolordisplay.c
index edca582..f6d7d92 100644
--- a/libgimpwidgets/gimpcolordisplay.c
+++ b/libgimpwidgets/gimpcolordisplay.c
@@ -37,6 +37,17 @@
#include "gimpcolordisplay.h"
+/**
+ * SECTION: gimpcolordisplay
+ * @title: GimpColorDisplay
+ * @short_description: Pluggable GIMP display color correction modules.
+ * @see_also: #GModule, #GTypeModule, #GimpModule
+ *
+ * Functions and definitions for creating pluggable GIMP
+ * display color correction modules.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpcolordisplaystack.c b/libgimpwidgets/gimpcolordisplaystack.c
index 2017777..8b32fa4 100644
--- a/libgimpwidgets/gimpcolordisplaystack.c
+++ b/libgimpwidgets/gimpcolordisplaystack.c
@@ -32,6 +32,16 @@
#include "gimpwidgetsmarshal.h"
+/**
+ * SECTION: gimpcolordisplaystack
+ * @title: GimpColorDisplayStack
+ * @short_description: A stack of color correction modules.
+ * @see_also: #GimpColorDisplay
+ *
+ * A stack of color correction modules.
+ **/
+
+
enum
{
CHANGED,
diff --git a/libgimpwidgets/gimpcolorhexentry.c b/libgimpwidgets/gimpcolorhexentry.c
index b02ddfc..746dfcc 100644
--- a/libgimpwidgets/gimpcolorhexentry.c
+++ b/libgimpwidgets/gimpcolorhexentry.c
@@ -34,6 +34,15 @@
#include "gimpcolorhexentry.h"
+/**
+ * SECTION: gimpcolorhexentry
+ * @title: GimpColorHexEntry
+ * @short_description: Widget for entering a color's hex triplet.
+ *
+ * Widget for entering a color's hex triplet.
+ **/
+
+
enum
{
COLOR_CHANGED,
diff --git a/libgimpwidgets/gimpcolornotebook.c b/libgimpwidgets/gimpcolornotebook.c
index 63eac65..55b2d3d 100644
--- a/libgimpwidgets/gimpcolornotebook.c
+++ b/libgimpwidgets/gimpcolornotebook.c
@@ -37,6 +37,17 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolornotebook
+ * @title: GimpColorNotebook
+ * @short_description: A #GimpColorSelector implementation.
+ *
+ * The #GimpColorNotebook widget is an implementation of a
+ * #GimpColorSelector. It serves as a container for
+ * #GimpColorSelectors.
+ **/
+
+
#define DEFAULT_TAB_BORDER 0
#define DEFAULT_TAB_ICON_SIZE GTK_ICON_SIZE_BUTTON
diff --git a/libgimpwidgets/gimpcolorprofilecombobox.c b/libgimpwidgets/gimpcolorprofilecombobox.c
index 9a7db4a..10bde3a 100644
--- a/libgimpwidgets/gimpcolorprofilecombobox.c
+++ b/libgimpwidgets/gimpcolorprofilecombobox.c
@@ -30,6 +30,15 @@
#include "gimpcolorprofilestore-private.h"
+/**
+ * SECTION: gimpcolorprofilecombobox
+ * @title: GimpColorProfileComboBox
+ * @short_description: A combo box for selecting color profiles.
+ *
+ * A combo box for selecting color profiles.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpcolorprofilestore.c b/libgimpwidgets/gimpcolorprofilestore.c
index d405844..2337fb9 100644
--- a/libgimpwidgets/gimpcolorprofilestore.c
+++ b/libgimpwidgets/gimpcolorprofilestore.c
@@ -36,6 +36,15 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolorprofilestore
+ * @title: GimpColorProfileStore
+ * @short_description: A #GtklistStore subclass that keep color profiles.
+ *
+ * A #GtklistStore subclass that keep color profiles.
+ **/
+
+
#define HISTORY_SIZE 8
enum
diff --git a/libgimpwidgets/gimpcolorscale.c b/libgimpwidgets/gimpcolorscale.c
index 3e9e1e5..a74b54e 100644
--- a/libgimpwidgets/gimpcolorscale.c
+++ b/libgimpwidgets/gimpcolorscale.c
@@ -34,6 +34,15 @@
#include "gimpcolorscale.h"
+/**
+ * SECTION: gimpcolorscale
+ * @title: GimpColorScale
+ * @short_description: Fancy colored sliders.
+ *
+ * Fancy colored sliders.
+ **/
+
+
static void gimp_color_scale_destroy (GtkObject *object);
static void gimp_color_scale_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
diff --git a/libgimpwidgets/gimpcolorscales.c b/libgimpwidgets/gimpcolorscales.c
index f905360..751a5e5 100644
--- a/libgimpwidgets/gimpcolorscales.c
+++ b/libgimpwidgets/gimpcolorscales.c
@@ -41,6 +41,17 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolorscales
+ * @title: GimpColorScales
+ * @short_description: A #GimpColorSelector implementation.
+ *
+ * The #GimpColorScales widget is an implementation of a
+ * #GimpColorSelector. It shows a group of #GimpColorScale widgets
+ * that allow to adjust the HSV and RGB color channels.
+ **/
+
+
#define GIMP_COLOR_SCALES_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_COLOR_SCALES, GimpColorScalesClass))
#define GIMP_IS_COLOR_SCALES_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_COLOR_SCALES))
#define GIMP_COLOR_SCALES_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_COLOR_SCALES, GimpColorScalesClass))
diff --git a/libgimpwidgets/gimpcolorselect.c b/libgimpwidgets/gimpcolorselect.c
index 4c374a7..fa23bdd 100644
--- a/libgimpwidgets/gimpcolorselect.c
+++ b/libgimpwidgets/gimpcolorselect.c
@@ -41,6 +41,20 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolorselect
+ * @title: GimpColorSelect
+ * @short_description: A #GimpColorSelector implementation.
+ *
+ * The #GimpColorSelect widget is an implementation of a
+ * #GimpColorSelector. It shows a square area that allows to
+ * interactively change two color channels and a smaller area to
+ * change the third channel. You can select which channel should be
+ * the third by calling gimp_color_selector_set_channel(). The widget
+ * will then change the other two channels accordingly.
+ **/
+
+
#define COLOR_AREA_EVENT_MASK (GDK_EXPOSURE_MASK | \
GDK_BUTTON_PRESS_MASK | \
GDK_BUTTON_RELEASE_MASK | \
diff --git a/libgimpwidgets/gimpcolorselection.c b/libgimpwidgets/gimpcolorselection.c
index 2e8f23b..6d979c5 100644
--- a/libgimpwidgets/gimpcolorselection.c
+++ b/libgimpwidgets/gimpcolorselection.c
@@ -43,6 +43,15 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpcolorselection
+ * @title: GimpColorSelection
+ * @short_description: Widget for doing a color selection.
+ *
+ * Widget for doing a color selection.
+ **/
+
+
#define COLOR_AREA_SIZE 20
diff --git a/libgimpwidgets/gimpcolorselector.c b/libgimpwidgets/gimpcolorselector.c
index d362cbf..e13d643 100644
--- a/libgimpwidgets/gimpcolorselector.c
+++ b/libgimpwidgets/gimpcolorselector.c
@@ -36,6 +36,17 @@
#include "gimpwidgetsmarshal.h"
+/**
+ * SECTION: gimpcolorselector
+ * @title: GimpColorSelector
+ * @short_description: Pluggable GIMP color selector modules.
+ * @see_also: #GModule, #GTypeModule, #GimpModule
+ *
+ * Functions and definitions for creating pluggable GIMP color
+ * selector modules.
+ **/
+
+
enum
{
COLOR_CHANGED,
diff --git a/libgimpwidgets/gimpcolorselector.h b/libgimpwidgets/gimpcolorselector.h
index abe68f3..338a549 100644
--- a/libgimpwidgets/gimpcolorselector.h
+++ b/libgimpwidgets/gimpcolorselector.h
@@ -31,8 +31,21 @@ G_BEGIN_DECLS
/* For information look at the html documentation */
-#define GIMP_COLOR_SELECTOR_SIZE 150
-#define GIMP_COLOR_SELECTOR_BAR_SIZE 15
+/**
+ * GIMP_COLOR_SELECTOR_SIZE:
+ *
+ * The suggested size for a color area in a #GimpColorSelector
+ * implementation.
+ **/
+#define GIMP_COLOR_SELECTOR_SIZE 150
+
+/**
+ * GIMP_COLOR_SELECTOR_BAR_SIZE:
+ *
+ * The suggested width for a color bar in a #GimpColorSelector
+ * implementation.
+ **/
+#define GIMP_COLOR_SELECTOR_BAR_SIZE 15
#define GIMP_TYPE_COLOR_SELECTOR (gimp_color_selector_get_type ())
diff --git a/libgimpwidgets/gimpcontroller.c b/libgimpwidgets/gimpcontroller.c
index 0734fd1..8ce412d 100644
--- a/libgimpwidgets/gimpcontroller.c
+++ b/libgimpwidgets/gimpcontroller.c
@@ -34,6 +34,16 @@
#include "gimpcontroller.h"
#include "gimpstock.h"
+
+/**
+ * SECTION: gimpcontroller
+ * @title: GimpController
+ * @short_description: Pluggable GIMP input controller modules.
+ *
+ * An abstract interface for implementing arbitrary input controllers.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpdialog.c b/libgimpwidgets/gimpdialog.c
index 0e55f79..00cf2ae 100644
--- a/libgimpwidgets/gimpdialog.c
+++ b/libgimpwidgets/gimpdialog.c
@@ -29,6 +29,17 @@
#include "gimphelpui.h"
+/**
+ * SECTION: gimpdialog
+ * @title: GimpDialog
+ * @short_description: Constructors for #GtkDialog's and action_areas as
+ * well as other dialog-related stuff.
+ *
+ * Constructors for #GtkDialog's and action_areas as well as other
+ * dialog-related stuff.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpenumcombobox.c b/libgimpwidgets/gimpenumcombobox.c
index b512676..d3d7986 100644
--- a/libgimpwidgets/gimpenumcombobox.c
+++ b/libgimpwidgets/gimpenumcombobox.c
@@ -31,6 +31,15 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpenumcombobox
+ * @title: GimpEnumComboBox
+ * @short_description: A #GimpIntComboBox subclass for selecting an enum value.
+ *
+ * A #GtkComboBox subclass for selecting an enum value.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpenumlabel.c b/libgimpwidgets/gimpenumlabel.c
index 47a454f..e196795 100644
--- a/libgimpwidgets/gimpenumlabel.c
+++ b/libgimpwidgets/gimpenumlabel.c
@@ -30,6 +30,15 @@
#include "gimpenumlabel.h"
+/**
+ * SECTION: gimpenumlabel
+ * @title: GimpEnumLabel
+ * @short_description: A #GtkLabel subclass that displays an enum value.
+ *
+ * A #GtkLabel subclass that displays an enum value.
+ **/
+
+
static void gimp_enum_label_finalize (GObject *object);
diff --git a/libgimpwidgets/gimpenumstore.c b/libgimpwidgets/gimpenumstore.c
index a9b08a4..9882888 100644
--- a/libgimpwidgets/gimpenumstore.c
+++ b/libgimpwidgets/gimpenumstore.c
@@ -30,6 +30,15 @@
#include "gimpenumstore.h"
+/**
+ * SECTION: gimpenumstore
+ * @title: GimpEnumStore
+ * @short_description: A #GimpIntStore subclass that keeps enum values.
+ *
+ * A #GimpIntStore subclass that keeps enum values.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpenumwidgets.c b/libgimpwidgets/gimpenumwidgets.c
index cb12c41..abaf973 100644
--- a/libgimpwidgets/gimpenumwidgets.c
+++ b/libgimpwidgets/gimpenumwidgets.c
@@ -33,6 +33,16 @@
/**
+ * SECTION: gimpenumwidgets
+ * @title: GimpEnumWidgets
+ * @short_description: A set of utility functions to create widgets
+ * based on enums.
+ *
+ * A set of utility functions to create widgets based on enums.
+ **/
+
+
+/**
* gimp_enum_radio_box_new:
* @enum_type: the #GType of an enum.
* @callback: a callback to connect to the "toggled" signal of each
diff --git a/libgimpwidgets/gimpfileentry.c b/libgimpwidgets/gimpfileentry.c
index 2ddd039..6992374 100644
--- a/libgimpwidgets/gimpfileentry.c
+++ b/libgimpwidgets/gimpfileentry.c
@@ -35,6 +35,30 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpfileentry
+ * @title: GimpFileEntry
+ * @short_description: Widget for entering a filename.
+ * @see_also: #GimpPathEditor
+ *
+ * This widget is used to enter filenames or directories.
+ *
+ * There is a #GtkEntry for entering the filename manually and a "..."
+ * button which will pop up a #GtkFileSelection dialog.
+ *
+ * You can restrict the #GimpFileSelection to directories. In this
+ * case the filename listbox of the #GtkFileChooser dialog will be
+ * hidden.
+ *
+ * If you specify @check_valid as #TRUE in gimp_file_entry_new() the
+ * entered filename will be checked for validity and a pixmap will be
+ * shown which indicates if the file exists or not.
+ *
+ * Whenever the user changes the filename, the "filename_changed"
+ * signal will be emitted.
+ **/
+
+
enum
{
FILENAME_CHANGED,
diff --git a/libgimpwidgets/gimpframe.c b/libgimpwidgets/gimpframe.c
index e809d52..8495052 100644
--- a/libgimpwidgets/gimpframe.c
+++ b/libgimpwidgets/gimpframe.c
@@ -32,6 +32,16 @@
#include "gimpframe.h"
+/**
+ * SECTION: gimpframe
+ * @title: GimpFrame
+ * @short_description: A widget providing a HIG-compliant subclass
+ * of #GtkFrame.
+ *
+ * A widget providing a HIG-compliant subclass of #GtkFrame.
+ **/
+
+
#define DEFAULT_LABEL_SPACING 6
#define DEFAULT_LABEL_BOLD TRUE
diff --git a/libgimpwidgets/gimphelpui.c b/libgimpwidgets/gimphelpui.c
index 66e0564..ff3fd96 100644
--- a/libgimpwidgets/gimphelpui.c
+++ b/libgimpwidgets/gimphelpui.c
@@ -30,6 +30,17 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimphelpui
+ * @title: GimpHelpUI
+ * @short_description: Functions for setting tooltip and help identifier
+ * used by the GIMP help system.
+ *
+ * Functions for setting tooltip and help identifier used by the GIMP
+ * help system.
+ **/
+
+
typedef enum
{
GIMP_WIDGET_HELP_TYPE_HELP = 0xff
diff --git a/libgimpwidgets/gimphelpui.h b/libgimpwidgets/gimphelpui.h
index 85d33d9..f01f272 100644
--- a/libgimpwidgets/gimphelpui.h
+++ b/libgimpwidgets/gimphelpui.h
@@ -55,6 +55,13 @@ void gimp_help_set_help_data_with_markup (GtkWidget *widget,
void gimp_context_help (GtkWidget *widget);
+/**
+ * GIMP_HELP_ID:
+ *
+ * The #GQuark used to attach GIMP help IDs to widgets.
+ *
+ * Since: GIMP 2.2
+ **/
#define GIMP_HELP_ID (gimp_help_id_quark ())
GQuark gimp_help_id_quark (void) G_GNUC_CONST;
diff --git a/libgimpwidgets/gimphintbox.c b/libgimpwidgets/gimphintbox.c
index eab10bd..69e1972 100644
--- a/libgimpwidgets/gimphintbox.c
+++ b/libgimpwidgets/gimphintbox.c
@@ -26,6 +26,15 @@
#include "gimpwidgets.h"
+/**
+ * SECTION: gimphintbox
+ * @title: GimpHintBox
+ * @short_description: Displays a wilber icon and a text.
+ *
+ * Displays a wilber icon and a text.
+ **/
+
+
typedef GtkHBoxClass GimpHintBoxClass;
typedef struct
diff --git a/libgimpwidgets/gimpintcombobox.c b/libgimpwidgets/gimpintcombobox.c
index cac98ac..eddf6ef 100644
--- a/libgimpwidgets/gimpintcombobox.c
+++ b/libgimpwidgets/gimpintcombobox.c
@@ -31,6 +31,16 @@
#include "gimpintstore.h"
+/**
+ * SECTION: gimpintcombobox
+ * @title: GimpIntComboBox
+ * @short_description: A widget providing a popup menu of integer
+ * values (e.g. enums).
+ *
+ * A widget providing a popup menu of integer values (e.g. enums).
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpintstore.c b/libgimpwidgets/gimpintstore.c
index 2ca0d5c..68ef970 100644
--- a/libgimpwidgets/gimpintstore.c
+++ b/libgimpwidgets/gimpintstore.c
@@ -32,6 +32,16 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpintstore
+ * @title: GimpIntStore
+ * @short_description: A model for integer based name-value pairs
+ * (e.g. enums)
+ *
+ * A model for integer based name-value pairs (e.g. enums)
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpmemsizeentry.c b/libgimpwidgets/gimpmemsizeentry.c
index 71c3ead..47eb942 100644
--- a/libgimpwidgets/gimpmemsizeentry.c
+++ b/libgimpwidgets/gimpmemsizeentry.c
@@ -31,6 +31,18 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpmemsizeentry
+ * @title: GimpMemSizeEntry
+ * @short_description: A composite widget that allows to enter a memory size.
+ *
+ * Similar to a #GimpSizeEntry but instead of lengths, this widget is
+ * used to let the user enter memory sizes. An option menu allows to
+ * switch between Kilobytes, Megabytes and Gigabytes. Used in the GIMP
+ * preferences dialog.
+ **/
+
+
enum
{
VALUE_CHANGED,
diff --git a/libgimpwidgets/gimpmemsizeentry.h b/libgimpwidgets/gimpmemsizeentry.h
index 87cbaa3..6475724 100644
--- a/libgimpwidgets/gimpmemsizeentry.h
+++ b/libgimpwidgets/gimpmemsizeentry.h
@@ -39,6 +39,7 @@ struct _GimpMemsizeEntry
{
GtkHBox parent_instance;
+ /*< private >*/
guint64 value;
guint64 lower;
guint64 upper;
diff --git a/libgimpwidgets/gimpnumberpairentry.c b/libgimpwidgets/gimpnumberpairentry.c
index c62f50a..f2f301e 100644
--- a/libgimpwidgets/gimpnumberpairentry.c
+++ b/libgimpwidgets/gimpnumberpairentry.c
@@ -36,6 +36,15 @@
#include "gimpnumberpairentry.h"
+/**
+ * SECTION: gimpnumberpairentry
+ * @title: GimpNumberPairEntry
+ * @short_description: A #GtkEntry subclass to enter ratios.
+ *
+ * A #GtkEntry subclass to enter ratios.
+ **/
+
+
#define EPSILON 0.000001
diff --git a/libgimpwidgets/gimpoffsetarea.c b/libgimpwidgets/gimpoffsetarea.c
index 3802fdc..54ec431 100644
--- a/libgimpwidgets/gimpoffsetarea.c
+++ b/libgimpwidgets/gimpoffsetarea.c
@@ -29,6 +29,15 @@
#include "gimpoffsetarea.h"
+/**
+ * SECTION: gimpoffsetarea
+ * @title: GimpOffsetArea
+ * @short_description: Widget to control image offsets.
+ *
+ * Widget to control image offsets.
+ **/
+
+
#define DRAWING_AREA_SIZE 200
diff --git a/libgimpwidgets/gimpoldwidgets.c b/libgimpwidgets/gimpoldwidgets.c
index b6bee2a..94d45b3 100644
--- a/libgimpwidgets/gimpoldwidgets.c
+++ b/libgimpwidgets/gimpoldwidgets.c
@@ -33,6 +33,17 @@
#include "gimpoldwidgets.h"
+/**
+ * SECTION: gimpoldwidgets
+ * @title: GimpOldWidgets
+ * @short_description: Old API that is still available but declared
+ * as deprecated.
+ * @see_also: #GimpIntComboBox
+ *
+ * These functions are not defined if you #define GIMP_DISABLE_DEPRECATED.
+ **/
+
+
/*
* Widget Constructors
*/
diff --git a/libgimpwidgets/gimppageselector.c b/libgimpwidgets/gimppageselector.c
index c56c3d7..79475b8 100644
--- a/libgimpwidgets/gimppageselector.c
+++ b/libgimpwidgets/gimppageselector.c
@@ -36,6 +36,16 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppageselector
+ * @title: GimpPageSelector
+ * @short_description: A widget to select pages from multi-page things.
+ *
+ * Use this for example for specifying what pages to import from
+ * a PDF or PS document.
+ **/
+
+
enum
{
SELECTION_CHANGED,
diff --git a/libgimpwidgets/gimppatheditor.c b/libgimpwidgets/gimppatheditor.c
index 611fb4c..1c24e85 100644
--- a/libgimpwidgets/gimppatheditor.c
+++ b/libgimpwidgets/gimppatheditor.c
@@ -37,6 +37,27 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppatheditor
+ * @title: GimpPathEditor
+ * @short_description: Widget for editing a file search path.
+ * @see_also: #GimpFileEntry, #G_SEARCHPATH_SEPARATOR
+ *
+ * This widget is used to edit file search paths.
+ *
+ * It shows a list of all directories which are in the search
+ * path. You can click a directory to select it. The widget provides a
+ * #GimpFileEntry to change the currently selected directory.
+ *
+ * There are buttons to add or delete directories as well as "up" and
+ * "down" buttons to change the order in which the directories will be
+ * searched.
+ *
+ * Whenever the user adds, deletes, changes or reorders a directory of
+ * the search path, the "path_changed" signal will be emitted.
+ **/
+
+
enum
{
PATH_CHANGED,
diff --git a/libgimpwidgets/gimppickbutton.c b/libgimpwidgets/gimppickbutton.c
index a7111d8..3d848c9 100644
--- a/libgimpwidgets/gimppickbutton.c
+++ b/libgimpwidgets/gimppickbutton.c
@@ -32,6 +32,17 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppickbutton
+ * @title: GimpPickButton
+ * @short_description: Widget to pick a color from screen.
+ *
+ * #GimpPickButton is a specialized button. When clicked, it changes
+ * the cursor to a color-picker pipette and allows the user to pick a
+ * color from any point on the screen.
+ **/
+
+
enum
{
COLOR_PICKED,
@@ -75,6 +86,13 @@ gimp_pick_button_class_init (GimpPickButtonClass* klass)
GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
GtkButtonClass *button_class = GTK_BUTTON_CLASS (klass);
+ /**
+ * GimpPickButton::color-picked:
+ * @gimppickbutton: the object which received the signal.
+ * @arg1: pointer to a #GimpRGB structure that holds the picked color
+ *
+ * This signal is emitted when the user has picked a color.
+ **/
pick_button_signals[COLOR_PICKED] =
g_signal_new ("color-picked",
G_TYPE_FROM_CLASS (klass),
diff --git a/libgimpwidgets/gimppixmap.c b/libgimpwidgets/gimppixmap.c
index 34408ef..ac357c5 100644
--- a/libgimpwidgets/gimppixmap.c
+++ b/libgimpwidgets/gimppixmap.c
@@ -34,6 +34,24 @@
#include "gimppixmap.h"
+/**
+ * SECTION: gimppixmap
+ * @title: GimpPixmap
+ * @short_description: Widget which creates a #GtkPixmap from XPM data.
+ * @see_also: gimp_pixmap_button_new(), #GtkPixmap
+ *
+ * Widget which creates a #GtkPixmap from XPM data.
+ *
+ * Use this widget instead of #GtkPixmap if you don't want to worry
+ * about the parent container's "realized" state.
+ *
+ * Note that the drawback of the easy interface is that the actual
+ * #GdkPixmap and it's mask have to be constructed every time you call
+ * gimp_pixmap_new() and cannot be cached in memory without doing bad
+ * hacks.
+ **/
+
+
static void gimp_pixmap_realize (GtkWidget *widget);
static void gimp_pixmap_create_from_xpm_d (GimpPixmap *pixmap);
diff --git a/libgimpwidgets/gimppreview.c b/libgimpwidgets/gimppreview.c
index c5bcea0..45170d8 100644
--- a/libgimpwidgets/gimppreview.c
+++ b/libgimpwidgets/gimppreview.c
@@ -31,6 +31,17 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppreview
+ * @title: GimpPreview
+ * @short_description: A widget providing a #GimpPreviewArea plus
+ * framework to update the preview.
+ *
+ * A widget providing a #GimpPreviewArea plus framework to update the
+ * preview.
+ **/
+
+
#define DEFAULT_SIZE 200
#define PREVIEW_TIMEOUT 200
diff --git a/libgimpwidgets/gimppreviewarea.c b/libgimpwidgets/gimppreviewarea.c
index 3d72030..fa9a1d8 100644
--- a/libgimpwidgets/gimppreviewarea.c
+++ b/libgimpwidgets/gimppreviewarea.c
@@ -31,6 +31,16 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppreviewarea
+ * @title: GimpPreviewArea
+ * @short_description: A general purpose preview widget which caches
+ * its pixel data.
+ *
+ * A general purpose preview widget which caches its pixel data.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimppropwidgets.c b/libgimpwidgets/gimppropwidgets.c
index ce320a4..196cbb0 100644
--- a/libgimpwidgets/gimppropwidgets.c
+++ b/libgimpwidgets/gimppropwidgets.c
@@ -31,6 +31,15 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimppropwidgets
+ * @title: GimpPropWidgets
+ * @short_description: Editable views on #GObject properties.
+ *
+ * Editable views on #GObject properties.
+ **/
+
+
/* utility function prototypes */
static void set_param_spec (GObject *object,
diff --git a/libgimpwidgets/gimpquerybox.c b/libgimpwidgets/gimpquerybox.c
index 84ac870..94b9ae8 100644
--- a/libgimpwidgets/gimpquerybox.c
+++ b/libgimpwidgets/gimpquerybox.c
@@ -36,6 +36,27 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpquerybox
+ * @title: GimpQueryBox
+ * @short_description: Some simple dialogs to enter a single int,
+ * double, string or boolean value.
+ * @see_also: #GimpSizeEntry, #GimpUnitMenu
+ *
+ * These functions provide simple dialogs for entering a single
+ * string, integer, double, boolean or pixel size value.
+ *
+ * They return a pointer to a #GtkDialog which has to be shown with
+ * gtk_widget_show() by the caller.
+ *
+ * The dialogs contain an entry widget for the kind of value they ask
+ * for and "OK" and "Cancel" buttons. On "Cancel", all query boxes
+ * except the boolean one silently destroy themselves. On "OK" the
+ * user defined callback function is called and returns the entered
+ * value.
+ **/
+
+
/*
* String, integer, double and size query boxes
*/
diff --git a/libgimpwidgets/gimpquerybox.h b/libgimpwidgets/gimpquerybox.h
index 3cbe4ba..6fa4b5c 100644
--- a/libgimpwidgets/gimpquerybox.h
+++ b/libgimpwidgets/gimpquerybox.h
@@ -27,29 +27,76 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
-/* query box callback prototypes */
+/**
+ * GimpQueryStringCallback:
+ * @query_box: The query box.
+ * @string: The entered string.
+ * @data: The user data.
+ *
+ * Note that you must not g_free() the passed string.
+ **/
typedef void (* GimpQueryStringCallback) (GtkWidget *query_box,
const gchar *string,
gpointer data);
+/**
+ * GimpQueryIntCallback:
+ * @query_box: The query box.
+ * @value: The entered integer value.
+ * @data: The user data.
+ *
+ * The callback for an int query box.
+ **/
typedef void (* GimpQueryIntCallback) (GtkWidget *query_box,
gint value,
gpointer data);
+/**
+ * GimpQueryDoubleCallback:
+ * @query_box: The query box.
+ * @value: The entered double value.
+ * @data: The user data.
+ *
+ * The callback for a double query box.
+ **/
typedef void (* GimpQueryDoubleCallback) (GtkWidget *query_box,
gdouble value,
gpointer data);
+/**
+ * GimpQuerySizeCallback:
+ * @query_box: The query box.
+ * @size: The entered size in pixels.
+ * @unit: The selected unit from the #GimpUnitMenu.
+ * @data: The user data.
+ *
+ * The callback for a size query box.
+ **/
typedef void (* GimpQuerySizeCallback) (GtkWidget *query_box,
gdouble size,
GimpUnit unit,
gpointer data);
+/**
+ * GimpQueryBooleanCallback:
+ * @query_box: The query box.
+ * @value: The entered boolean value.
+ * @data: The user data.
+ *
+ * The callback for a boolean query box.
+ **/
typedef void (* GimpQueryBooleanCallback) (GtkWidget *query_box,
gboolean value,
gpointer data);
+/**
+ * GIMP_QUERY_BOX_VBOX:
+ * @qbox: The query box.
+ *
+ * A macro to access the #GtkVBox in a #GimpQueryBox. Useful if you
+ * want to add more widgets.
+ **/
#define GIMP_QUERY_BOX_VBOX(qbox) g_object_get_data (G_OBJECT (qbox), \
"gimp-query-box-vbox")
diff --git a/libgimpwidgets/gimpruler.c b/libgimpwidgets/gimpruler.c
index be5b356..6df4865 100644
--- a/libgimpwidgets/gimpruler.c
+++ b/libgimpwidgets/gimpruler.c
@@ -30,6 +30,15 @@
#include "gimpruler.h"
+/**
+ * SECTION: gimpruler
+ * @title: GimpRuler
+ * @short_description: A ruler widget with configurable unit and orientation.
+ *
+ * A ruler widget with configurable unit and orientation.
+ **/
+
+
#define DEFAULT_RULER_FONT_SCALE PANGO_SCALE_SMALL
#define MINIMUM_INCR 5
diff --git a/libgimpwidgets/gimpscaleentry.h b/libgimpwidgets/gimpscaleentry.h
index 4a57d8e..6993a17 100644
--- a/libgimpwidgets/gimpscaleentry.h
+++ b/libgimpwidgets/gimpscaleentry.h
@@ -26,17 +26,49 @@
G_BEGIN_DECLS
+/**
+ * GIMP_SCALE_ENTRY_LABEL:
+ * @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
+ *
+ * Returns the scale_entry's #GtkLabel.
+ **/
#define GIMP_SCALE_ENTRY_LABEL(adj) \
(g_object_get_data (G_OBJECT (adj), "label"))
+/**
+ * GIMP_SCALE_ENTRY_SCALE:
+ * @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
+ *
+ * Returns the scale_entry's #GtkHScale.
+ **/
#define GIMP_SCALE_ENTRY_SCALE(adj) \
(g_object_get_data (G_OBJECT (adj), "scale"))
-#define GIMP_SCALE_ENTRY_SCALE_ADJ(adj) \
+
+/**
+ * GIMP_SCALE_ENTRY_SCALE_ADJ:
+ * @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
+ *
+ * Returns the #GtkAdjustment of the scale_entry's #GtkHScale.
+ **/
+#define GIMP_SCALE_ENTRY_SCALE_ADJ(adj) \
gtk_range_get_adjustment \
(GTK_RANGE (g_object_get_data (G_OBJECT (adj), "scale")))
+/**
+ * GIMP_SCALE_ENTRY_SPINBUTTON:
+ * @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
+ *
+ * Returns the scale_entry's #GtkSpinButton.
+ **/
#define GIMP_SCALE_ENTRY_SPINBUTTON(adj) \
(g_object_get_data (G_OBJECT (adj), "spinbutton"))
+
+/**
+ * GIMP_SCALE_ENTRY_SPINBUTTON_ADJ:
+ * @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
+ *
+ * Returns the #GtkAdjustment of the scale_entry's #GtkSpinButton.
+ **/
#define GIMP_SCALE_ENTRY_SPINBUTTON_ADJ(adj) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (g_object_get_data (G_OBJECT (adj), "spinbutton")))
diff --git a/libgimpwidgets/gimpscrolledpreview.c b/libgimpwidgets/gimpscrolledpreview.c
index 4c5134e..eff5d05 100644
--- a/libgimpwidgets/gimpscrolledpreview.c
+++ b/libgimpwidgets/gimpscrolledpreview.c
@@ -31,6 +31,16 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpscrolledpreview
+ * @title: GimpScrolledPreview
+ * @short_description: A widget providing a #GimpPreview enhanced by
+ * scrolling capabilities.
+ *
+ * A widget providing a #GimpPreview enhanced by scrolling capabilities.
+ **/
+
+
#define POPUP_SIZE 100
diff --git a/libgimpwidgets/gimpsizeentry.c b/libgimpwidgets/gimpsizeentry.c
index d545eaf..eccd7d0 100644
--- a/libgimpwidgets/gimpsizeentry.c
+++ b/libgimpwidgets/gimpsizeentry.c
@@ -36,6 +36,35 @@
#include "gimpsizeentry.h"
+/**
+ * SECTION: gimpsizeentry
+ * @title: GimpSizeEntry
+ * @short_description: Widget for entering pixel values and resolutions.
+ * @see_also: #GimpUnit, #GimpUnitMenu, gimp_coordinates_new()
+ *
+ * This widget is used to enter pixel distances/sizes and resolutions.
+ *
+ * You can specify the number of fields the widget should provide. For
+ * each field automatic mappings are performed between the field's
+ * "reference value" and its "value".
+ *
+ * There is a #GimpUnitMenu right of the entry fields which lets you
+ * specify the #GimpUnit of the displayed values.
+ *
+ * For each field, there can be one or two #GtkSpinButton's to enter
+ * "value" and "reference value". If you specify @show_refval as
+ * #FALSE in gimp_size_entry_new() there will be only one
+ * #GtkSpinButton and the #GimpUnitMenu will contain an item for
+ * selecting GIMP_UNIT_PIXEL.
+ *
+ * The "reference value" is either of GIMP_UNIT_PIXEL or dpi,
+ * depending on which #GimpSizeEntryUpdatePolicy you specify in
+ * gimp_size_entry_new(). The "value" is either the size in pixels
+ * mapped to the size in a real-world-unit (see #GimpUnit) or the dpi
+ * value mapped to pixels per real-world-unit.
+ **/
+
+
#define SIZE_MAX_VALUE 500000.0
#define GIMP_SIZE_ENTRY_DIGITS(unit) (MIN (gimp_unit_get_digits (unit), 5) + 1)
diff --git a/libgimpwidgets/gimpstock.c b/libgimpwidgets/gimpstock.c
index 8aaf949..73e6598 100644
--- a/libgimpwidgets/gimpstock.c
+++ b/libgimpwidgets/gimpstock.c
@@ -30,6 +30,22 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpstock
+ * @title: GimpStock
+ * @short_description: Prebuilt common menu/toolbar items and
+ * corresponding icons
+ *
+ * GIMP registers a set of menu/toolbar items and corresponding icons
+ * in addition to the standard GTK+ stock items. These can be used
+ * just like GTK+ stock items. GIMP also overrides a few of the GTK+
+ * icons (namely the ones in dialog size).
+ *
+ * Stock icons may have a RTL variant which gets used for
+ * right-to-left locales.
+ **/
+
+
#define LIBGIMP_DOMAIN GETTEXT_PACKAGE "-libgimp"
#define GIMP_TOILET_PAPER "gimp-toilet-paper"
diff --git a/libgimpwidgets/gimpstringcombobox.c b/libgimpwidgets/gimpstringcombobox.c
index b7af9c2..1826d2e 100644
--- a/libgimpwidgets/gimpstringcombobox.c
+++ b/libgimpwidgets/gimpstringcombobox.c
@@ -30,6 +30,15 @@
#include "gimpstringcombobox.h"
+/**
+ * SECTION: gimpstringcombobox
+ * @title: GimpStringComboBox
+ * @short_description: A #GtkComboBox subclass to select strings.
+ *
+ * A #GtkComboBox subclass to select strings.
+ **/
+
+
enum
{
PROP_0,
diff --git a/libgimpwidgets/gimpunitmenu.c b/libgimpwidgets/gimpunitmenu.c
index b721960..a407d03 100644
--- a/libgimpwidgets/gimpunitmenu.c
+++ b/libgimpwidgets/gimpunitmenu.c
@@ -37,6 +37,27 @@
#include "libgimp/libgimp-intl.h"
+/**
+ * SECTION: gimpunitmenu
+ * @title: GimpUnitMenu
+ * @short_description: Widget for selecting a #GimpUnit.
+ * @see_also: #GimpUnit, #GimpSizeEntry, gimp_coordinates_new()
+ *
+ * This widget provides a #GtkOptionMenu which contains a list of
+ * #GimpUnit's.
+ *
+ * You can specify the string that will be displayed for each unit by
+ * passing a printf-like @format string to gimp_unit_menu_new().
+ *
+ * The constructor also lets you choose if the menu should contain
+ * items for GIMP_UNIT_PIXEL, GIMP_UNIT_PERCENT and a "More..." item
+ * which will pop up a dialog for selecting user-defined units.
+ *
+ * Whenever the user selects a unit from the menu or the dialog, the
+ * "unit_changed" signal will be emitted.
+ **/
+
+
enum
{
UNIT_CHANGED,
diff --git a/libgimpwidgets/gimpwidgets.c b/libgimpwidgets/gimpwidgets.c
index 7a3c22b..8b1ed44 100644
--- a/libgimpwidgets/gimpwidgets.c
+++ b/libgimpwidgets/gimpwidgets.c
@@ -42,6 +42,17 @@
/**
+ * SECTION: gimpwidgets
+ * @title: GimpWidgets
+ * @short_description: A collection of convenient widget constructors,
+ * standard callbacks and helper functions.
+ *
+ * A collection of convenient widget constructors, standard callbacks
+ * and helper functions.
+ **/
+
+
+/**
* gimp_radio_group_new:
* @in_frame: %TRUE if you want a #GtkFrame around the radio button group.
* @frame_title: The title of the Frame or %NULL if you don't want a title.
diff --git a/libgimpwidgets/gimpwidgets.h b/libgimpwidgets/gimpwidgets.h
index 455f16d..f32f062 100644
--- a/libgimpwidgets/gimpwidgets.h
+++ b/libgimpwidgets/gimpwidgets.h
@@ -149,17 +149,44 @@ GtkWidget * gimp_spin_button_new (/* return value: */
gdouble climb_rate,
guint digits);
+/**
+ * GIMP_RANDOM_SEED_SPINBUTTON:
+ * @hbox: The #GtkHBox returned by gimp_random_seed_new().
+ *
+ * Returns the random_seed's #GtkSpinButton.
+ **/
#define GIMP_RANDOM_SEED_SPINBUTTON(hbox) \
(g_object_get_data (G_OBJECT (hbox), "spinbutton"))
-#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox) \
+
+/**
+ * GIMP_RANDOM_SEED_SPINBUTTON_ADJ:
+ * @hbox: The #GtkHBox returned by gimp_random_seed_new().
+ *
+ * Returns the #GtkAdjustment of the random_seed's #GtkSpinButton.
+ **/
+#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (g_object_get_data (G_OBJECT (hbox), "spinbutton")))
+
+/**
+ * GIMP_RANDOM_SEED_TOGGLE:
+ * @hbox: The #GtkHBox returned by gimp_random_seed_new().
+ *
+ * Returns the random_seed's #GtkToggleButton.
+ **/
#define GIMP_RANDOM_SEED_TOGGLE(hbox) \
(g_object_get_data (G_OBJECT(hbox), "toggle"))
GtkWidget * gimp_random_seed_new (guint32 *seed,
gboolean *random_seed);
+/**
+ * GIMP_COORDINATES_CHAINBUTTON:
+ * @sizeentry: The #GimpSizeEntry returned by gimp_coordinates_new().
+ *
+ * Returns the #GimpChainButton which is attached to the
+ * #GimpSizeEntry.
+ **/
#define GIMP_COORDINATES_CHAINBUTTON(sizeentry) \
(g_object_get_data (G_OBJECT (sizeentry), "chainbutton"))
diff --git a/libgimpwidgets/gimpwidgetsenums.h b/libgimpwidgets/gimpwidgetsenums.h
index d777477..c3d45d1 100644
--- a/libgimpwidgets/gimpwidgetsenums.h
+++ b/libgimpwidgets/gimpwidgetsenums.h
@@ -62,6 +62,19 @@ typedef enum
} GimpColorAreaType;
+/**
+ * GimpColorSelectorChannel:
+ * @GIMP_COLOR_SELECTOR_HUE: the hue channel
+ * @GIMP_COLOR_SELECTOR_SATURATION: the saturation channel
+ * @GIMP_COLOR_SELECTOR_VALUE: the value channel
+ * @GIMP_COLOR_SELECTOR_RED: the red channel
+ * @GIMP_COLOR_SELECTOR_GREEN: the green channel
+ * @GIMP_COLOR_SELECTOR_BLUE: the blue channel
+ * @GIMP_COLOR_SELECTOR_ALPHA: the alpha channel
+ *
+ * An enum to specify the types of color channels edited in
+ * #GimpColorSelector widgets.
+ **/
#define GIMP_TYPE_COLOR_SELECTOR_CHANNEL (gimp_color_selector_channel_get_type ())
GType gimp_color_selector_channel_get_type (void) G_GNUC_CONST;
diff --git a/libgimpwidgets/gimpwidgetstypes.h b/libgimpwidgets/gimpwidgetstypes.h
index be00357..4301814 100644
--- a/libgimpwidgets/gimpwidgetstypes.h
+++ b/libgimpwidgets/gimpwidgetstypes.h
@@ -74,6 +74,26 @@ typedef struct _GimpUnitMenu GimpUnitMenu;
typedef struct _GimpZoomModel GimpZoomModel;
+/**
+ * GimpHelpFunc:
+ * @help_id: the help ID
+ * @help_data: the help user data
+ *
+ * This is the prototype for all functions you pass as @help_func to
+ * the various GIMP dialog constructors like gimp_dialog_new(),
+ * gimp_query_int_box() etc.
+ *
+ * Help IDs are textual identifiers the help system uses to figure
+ * which page to display.
+ *
+ * All these dialog constructors functions call gimp_help_connect().
+ *
+ * In most cases it will be ok to use gimp_standard_help_func() which
+ * does nothing but passing the @help_id string to gimp_help(). If
+ * your plug-in needs some more sophisticated help handling you can
+ * provide your own @help_func which has to call gimp_help() to
+ * actually display the help.
+ **/
typedef void (* GimpHelpFunc) (const gchar *help_id,
gpointer help_data);
diff --git a/libgimpwidgets/gimpzoommodel.c b/libgimpwidgets/gimpzoommodel.c
index cdcc1cd..1dff08c 100644
--- a/libgimpwidgets/gimpzoommodel.c
+++ b/libgimpwidgets/gimpzoommodel.c
@@ -33,6 +33,15 @@
#include "gimpzoommodel.h"
+/**
+ * SECTION: gimpzoommodel
+ * @title: GimpZoomModel
+ * @short_description: A model for zoom values.
+ *
+ * A model for zoom values.
+ **/
+
+
#define ZOOM_MIN (1.0 / 256.0)
#define ZOOM_MAX (256.0)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
