Commit 1f7ff98c authored by Michael Natterer's avatar Michael Natterer 😴

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.
parent 597b2552
/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
<!-- ##### SECTION Title ##### -->
GimpBrowser
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpBrowser ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpBrowser::search ##### -->
<para>
</para>
@gimpbrowser: the object which received the signal.
@arg1:
@arg2:
<!-- ##### FUNCTION gimp_browser_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_browser_add_search_types ##### -->
<para>
</para>
@browser:
@first_type_label:
@first_type_id:
@Varargs:
<!-- ##### FUNCTION gimp_browser_set_widget ##### -->
<para>
</para>
@browser:
@widget:
<!-- ##### FUNCTION gimp_browser_show_message ##### -->
<para>
</para>
@browser:
@message:
<!-- ##### SECTION Title ##### -->
GimpButton
<!-- ##### SECTION Short_Description ##### -->
A #GtkButton with a little extra functionality.
<!-- ##### SECTION Long_Description ##### -->
<para>
#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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpButton ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpButton::extended-clicked ##### -->
<para>
</para>
@gimpbutton: the object which received the signal.
@arg1: the state of modifier keys when the button was clicked
<!-- ##### FUNCTION gimp_button_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_button_extended_clicked ##### -->
<para>
</para>
@button:
@state:
<!-- ##### SECTION Title ##### -->
gimpcairo-utils
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_cairo_set_source_rgb ##### -->
<para>
</para>
@cr:
@color:
<!-- ##### FUNCTION gimp_cairo_set_source_rgba ##### -->
<para>
</para>
@cr:
@color:
<!-- ##### FUNCTION gimp_cairo_set_focus_line_pattern ##### -->
<para>
</para>
@cr:
@widget:
@Returns:
<!-- ##### FUNCTION gimp_cairo_checkerboard_create ##### -->
<para>
</para>
@cr:
@size:
@light:
@dark:
@Returns:
<!-- ##### FUNCTION gimp_cairo_surface_create_from_pixbuf ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### MACRO GIMP_CAIRO_RGB24_SET_PIXEL ##### -->
<para>
</para>
@d:
@r:
@g:
@b:
<!-- ##### MACRO GIMP_CAIRO_ARGB32_SET_PIXEL ##### -->
<para>
</para>
@d:
@r:
@g:
@b:
@a:
<!-- ##### SECTION Title ##### -->
GimpCellRendererColor
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpCellRendererColor ##### -->
<para>
</para>
<!-- ##### ARG GimpCellRendererColor:color ##### -->
<para>
</para>
<!-- ##### ARG GimpCellRendererColor:icon-size ##### -->
<para>
</para>
<!-- ##### ARG GimpCellRendererColor:opaque ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_cell_renderer_color_new ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
GimpCellRendererToggle
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpCellRendererToggle ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpCellRendererToggle::clicked ##### -->
<para>
</para>
@gimpcellrenderertoggle: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GimpCellRendererToggle:stock-id ##### -->
<para>
</para>
<!-- ##### ARG GimpCellRendererToggle:stock-size ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_cell_renderer_toggle_new ##### -->
<para>
</para>
@stock_id:
@Returns:
<!-- ##### FUNCTION gimp_cell_renderer_toggle_clicked ##### -->
<para>
</para>
@cell:
@path:
@state:
<!-- ##### SECTION Title ##### -->
GimpChainButton
<!-- ##### SECTION Short_Description ##### -->
Widget to visually connect two entry widgets.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
You may want to use the convenience function gimp_coordinates_new() to set
up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpChainButton ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpChainButton::toggled ##### -->
<para>
</para>
@gimpchainbutton: the object which received the signal.
<!-- ##### ARG GimpChainButton:position ##### -->
<para>
</para>
<!-- ##### ENUM GimpChainPosition ##### -->
<para>
</para>
@GIMP_CHAIN_TOP:
@GIMP_CHAIN_LEFT:
@GIMP_CHAIN_BOTTOM:
@GIMP_CHAIN_RIGHT:
<!-- ##### FUNCTION gimp_chain_button_new ##### -->
<para>
</para>
@position:
@Returns:
<!-- ##### FUNCTION gimp_chain_button_set_active ##### -->
<para>
</para>
@button:
@active:
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### SECTION Title ##### -->
GimpColorArea
<!-- ##### SECTION Short_Description ##### -->
Displays a GimpRGB color, optionally with alpha-channel.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorArea ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorArea::color-changed ##### -->
<para>
</para>
@gimpcolorarea: the object which received the signal.
<!-- ##### ARG GimpColorArea:color ##### -->
<para>
</para>
<!-- ##### ARG GimpColorArea:drag-mask ##### -->
<para>
</para>
<!-- ##### ARG GimpColorArea:draw-border ##### -->
<para>
</para>
<!-- ##### ARG GimpColorArea:type ##### -->
<para>
</para>
<!-- ##### ENUM GimpColorAreaType ##### -->
<para>
</para>
@GIMP_COLOR_AREA_FLAT:
@GIMP_COLOR_AREA_SMALL_CHECKS:
@GIMP_COLOR_AREA_LARGE_CHECKS:
<!-- ##### FUNCTION gimp_color_area_new ##### -->
<para>
</para>
@color:
@type:
@drag_mask:
@Returns:
<!-- ##### FUNCTION gimp_color_area_set_color ##### -->
<para>
</para>
@area:
@color:
<!-- ##### FUNCTION gimp_color_area_get_color ##### -->
<para>
</para>
@area:
@color:
<!-- ##### FUNCTION gimp_color_area_has_alpha ##### -->
<para>
</para>
@area:
@Returns:
<!-- ##### FUNCTION gimp_color_area_set_type ##### -->
<para>
</para>
@area:
@type:
<!-- ##### FUNCTION gimp_color_area_set_draw_border ##### -->
<para>
</para>
@area:
@draw_border:
<!-- ##### SECTION Title ##### -->
GimpColorButton
<!-- ##### SECTION Short_Description ##### -->
Widget for selecting a color from a simple button.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget provides a simple button with a preview showing the
color.
</para>
<para>
On click a GtkColorSelectionDialog 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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimpcolor-gimpcolorspace
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorButton ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorButton::color-changed ##### -->
<para>
</para>
@gimpcolorbutton: the object which received the signal.
<!-- ##### ARG GimpColorButton:color ##### -->
<para>
</para>
<!-- ##### ARG GimpColorButton:continuous-update ##### -->
<para>
</para>
<!-- ##### ARG GimpColorButton:title ##### -->
<para>
</para>
<!-- ##### ARG GimpColorButton:type ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_button_new ##### -->
<para>
</para>
@title:
@width:
@height:
@color:
@type:
@Returns:
<!-- ##### FUNCTION gimp_color_button_set_color ##### -->
<para>
</para>
@button:
@color:
<!-- ##### FUNCTION gimp_color_button_get_color ##### -->
<para>
</para>
@button:
@color:
<!-- ##### FUNCTION gimp_color_button_set_update ##### -->
<para>
</para>
@button:
@continuous:
<!-- ##### FUNCTION gimp_color_button_get_update ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gimp_color_button_has_alpha ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gimp_color_button_set_type ##### -->
<para>
</para>
@button: