callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libgimpwidgets: move docs from template files to inline comments

Browse Source 
but leave the template file for gimpstock there because its contents
would be too much for gimpstock.h.
This commit is contained in:
Michael Natterer
2010-07-05 18:01:28 +02:00
parent 597b255262
commit 1f7ff98c45
112 changed files with 845 additions and 5595 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
devel-docs/libgimpwidgets/tmpl/.gitignore vendored
View File

@ -1,2 +1,52 @@
/libgimpwidgets-unused.sgml /libgimpwidgets-unused.sgml
/*.bak /*.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

71
devel-docs/libgimpwidgets/tmpl/gimpbrowser.sgml
View File

@ -1,71 +0,0 @@
<!-- ##### 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:

52
devel-docs/libgimpwidgets/tmpl/gimpbutton.sgml
View File

@ -1,52 +0,0 @@
<!-- ##### 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:

91
devel-docs/libgimpwidgets/tmpl/gimpcairo-utils.sgml
View File

@ -1,91 +0,0 @@
<!-- ##### 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:

48
devel-docs/libgimpwidgets/tmpl/gimpcellrenderercolor.sgml
View File

@ -1,48 +0,0 @@
<!-- ##### 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:

63
devel-docs/libgimpwidgets/tmpl/gimpcellrenderertoggle.sgml
View File

@ -1,63 +0,0 @@
<!-- ##### 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:

86
devel-docs/libgimpwidgets/tmpl/gimpchainbutton.sgml
View File

@ -1,86 +0,0 @@
<!-- ##### 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:

117
devel-docs/libgimpwidgets/tmpl/gimpcolorarea.sgml
View File

@ -1,117 +0,0 @@
<!-- ##### 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:

126
devel-docs/libgimpwidgets/tmpl/gimpcolorbutton.sgml
View File

@ -1,126 +0,0 @@
<!-- ##### 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:
@type:

164
devel-docs/libgimpwidgets/tmpl/gimpcolordisplay.sgml
View File

@ -1,164 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorDisplay
<!-- ##### SECTION Short_Description ##### -->
Pluggable GIMP display color correction modules.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions and definitions for creating pluggable GIMP
display color correction modules.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<para>
#GTypeModule
</para>
<para>
#libgimp-gimpmodule
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorDisplay ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorDisplay::changed ##### -->
<para>
</para>
@gimpcolordisplay: the object which received the signal.
<!-- ##### ARG GimpColorDisplay:color-config ##### -->
<para>
</para>
<!-- ##### ARG GimpColorDisplay:color-managed ##### -->
<para>
</para>
<!-- ##### ARG GimpColorDisplay:enabled ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_display_new ##### -->
<para>
</para>
@display_type:
@Returns:
<!-- ##### FUNCTION gimp_color_display_clone ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_set_enabled ##### -->
<para>
</para>
@display:
@enabled:
<!-- ##### FUNCTION gimp_color_display_get_enabled ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_get_config ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_get_managed ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_convert ##### -->
<para>
</para>
@display:
@buf:
@width:
@height:
@bpp:
@bpl:
<!-- ##### FUNCTION gimp_color_display_load_state ##### -->
<para>
</para>
@display:
@state:
<!-- ##### FUNCTION gimp_color_display_save_state ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_configure ##### -->
<para>
</para>
@display:
@Returns:
<!-- ##### FUNCTION gimp_color_display_configure_reset ##### -->
<para>
</para>
@display:
<!-- ##### FUNCTION gimp_color_display_changed ##### -->
<para>
</para>
@display:

132
devel-docs/libgimpwidgets/tmpl/gimpcolordisplaystack.sgml
View File

@ -1,132 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorDisplayStack
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorDisplayStack ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorDisplayStack::added ##### -->
<para>
</para>
@gimpcolordisplaystack: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GimpColorDisplayStack::changed ##### -->
<para>
</para>
@gimpcolordisplaystack: the object which received the signal.
<!-- ##### SIGNAL GimpColorDisplayStack::removed ##### -->
<para>
</para>
@gimpcolordisplaystack: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GimpColorDisplayStack::reordered ##### -->
<para>
</para>
@gimpcolordisplaystack: the object which received the signal.
@arg1:
@arg2:
<!-- ##### FUNCTION gimp_color_display_stack_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_color_display_stack_clone ##### -->
<para>
</para>
@stack:
@Returns:
<!-- ##### FUNCTION gimp_color_display_stack_changed ##### -->
<para>
</para>
@stack:
<!-- ##### FUNCTION gimp_color_display_stack_add ##### -->
<para>
</para>
@stack:
@display:
<!-- ##### FUNCTION gimp_color_display_stack_remove ##### -->
<para>
</para>
@stack:
@display:
<!-- ##### FUNCTION gimp_color_display_stack_reorder_up ##### -->
<para>
</para>
@stack:
@display:
<!-- ##### FUNCTION gimp_color_display_stack_reorder_down ##### -->
<para>
</para>
@stack:
@display:
<!-- ##### FUNCTION gimp_color_display_stack_convert ##### -->
<para>
</para>
@stack:
@buf:
@width:
@height:
@bpp:
@bpl:

58
devel-docs/libgimpwidgets/tmpl/gimpcolorhexentry.sgml
View File

@ -1,58 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorHexEntry
<!-- ##### SECTION Short_Description ##### -->
Widget for entering a color's hex triplet.
<!-- ##### SECTION Long_Description ##### -->
<para>
Widget for entering a color's hex triplet.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorHexEntry ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorHexEntry::color-changed ##### -->
<para>
</para>
@gimpcolorhexentry: the object which received the signal.
<!-- ##### FUNCTION gimp_color_hex_entry_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_color_hex_entry_set_color ##### -->
<para>
</para>
@entry:
@color:
<!-- ##### FUNCTION gimp_color_hex_entry_get_color ##### -->
<para>
</para>
@entry:
@color:

47
devel-docs/libgimpwidgets/tmpl/gimpcolornotebook.sgml
View File

@ -1,47 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorNotebook
<!-- ##### SECTION Short_Description ##### -->
A #GimpColorSelector implementation.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GimpColorNotebook widget is an implementation of a #GimpColorSelector.
It serves as a container for #GimpColorSelectors.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorNotebook ##### -->
<para>
</para>
<!-- ##### ARG GimpColorNotebook:tab-border ##### -->
<para>
</para>
<!-- ##### ARG GimpColorNotebook:tab-icon-size ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_notebook_set_has_page ##### -->
<para>
</para>
@notebook:
@page_type:
@has_page:
@Returns:

84
devel-docs/libgimpwidgets/tmpl/gimpcolorprofilecombobox.sgml
View File

@ -1,84 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorProfileComboBox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorProfileComboBox ##### -->
<para>
</para>
<!-- ##### ARG GimpColorProfileComboBox:dialog ##### -->
<para>
</para>
<!-- ##### ARG GimpColorProfileComboBox:model ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_profile_combo_box_new ##### -->
<para>
</para>
@dialog:
@history:
@Returns:
<!-- ##### FUNCTION gimp_color_profile_combo_box_new_with_model ##### -->
<para>
</para>
@dialog:
@model:
@Returns:
<!-- ##### FUNCTION gimp_color_profile_combo_box_add ##### -->
<para>
</para>
@combo:
@filename:
@label:
<!-- ##### FUNCTION gimp_color_profile_combo_box_set_active ##### -->
<para>
</para>
@combo:
@filename:
@label:
<!-- ##### FUNCTION gimp_color_profile_combo_box_get_active ##### -->
<para>
</para>
@combo:
@Returns:

49
devel-docs/libgimpwidgets/tmpl/gimpcolorprofilestore.sgml
View File

@ -1,49 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorProfileStore
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorProfileStore ##### -->
<para>
</para>
<!-- ##### ARG GimpColorProfileStore:history ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_profile_store_new ##### -->
<para>
</para>
@history:
@Returns:
<!-- ##### FUNCTION gimp_color_profile_store_add ##### -->
<para>
</para>
@store:
@filename:
@label:

54
devel-docs/libgimpwidgets/tmpl/gimpcolorscale.sgml
View File

@ -1,54 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorScale
<!-- ##### SECTION Short_Description ##### -->
Fancy colored sliders.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorScale ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_scale_new ##### -->
<para>
</para>
@orientation:
@channel:
@Returns:
<!-- ##### FUNCTION gimp_color_scale_set_channel ##### -->
<para>
</para>
@scale:
@channel:
<!-- ##### FUNCTION gimp_color_scale_set_color ##### -->
<para>
</para>
@scale:
@rgb:
@hsv:

27
devel-docs/libgimpwidgets/tmpl/gimpcolorscales.sgml
View File

@ -1,27 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorScales
<!-- ##### SECTION Short_Description ##### -->
A #GimpColorSelector implementation.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorScales ##### -->
<para>
</para>

29
devel-docs/libgimpwidgets/tmpl/gimpcolorselect.sgml
View File

@ -1,29 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorSelect
<!-- ##### SECTION Short_Description ##### -->
A #GimpColorSelector implementation.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorSelect ##### -->
<para>
</para>

124
devel-docs/libgimpwidgets/tmpl/gimpcolorselection.sgml
View File

@ -1,124 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorSelection
<!-- ##### SECTION Short_Description ##### -->
Widget for doing a color selection.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorSelection ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorSelection::color-changed ##### -->
<para>
</para>
@gimpcolorselection: the object which received the signal.
<!-- ##### ARG GimpColorSelection:config ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_selection_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_color_selection_set_show_alpha ##### -->
<para>
</para>
@selection:
@show_alpha:
<!-- ##### FUNCTION gimp_color_selection_get_show_alpha ##### -->
<para>
</para>
@selection:
@Returns:
<!-- ##### FUNCTION gimp_color_selection_set_color ##### -->
<para>
</para>
@selection:
@color:
<!-- ##### FUNCTION gimp_color_selection_get_color ##### -->
<para>
</para>
@selection:
@color:
<!-- ##### FUNCTION gimp_color_selection_set_old_color ##### -->
<para>
</para>
@selection:
@color:
<!-- ##### FUNCTION gimp_color_selection_get_old_color ##### -->
<para>
</para>
@selection:
@color:
<!-- ##### FUNCTION gimp_color_selection_reset ##### -->
<para>
</para>
@selection:
<!-- ##### FUNCTION gimp_color_selection_color_changed ##### -->
<para>
</para>
@selection:
<!-- ##### FUNCTION gimp_color_selection_set_config ##### -->
<para>
</para>
@selection:
@config:

159
devel-docs/libgimpwidgets/tmpl/gimpcolorselector.sgml
View File

@ -1,159 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorSelector
<!-- ##### SECTION Short_Description ##### -->
Pluggable GIMP color selector modules.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions and definitions for creating pluggable GIMP color
selector modules.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<para>
#GTypeModule
</para>
<para>
#libgimp-gimpmodule
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorSelector ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpColorSelector::channel-changed ##### -->
<para>
</para>
@gimpcolorselector: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GimpColorSelector::color-changed ##### -->
<para>
</para>
@gimpcolorselector: the object which received the signal.
@arg1:
@arg2:
<!-- ##### MACRO GIMP_COLOR_SELECTOR_SIZE ##### -->
<para>
The suggested size for a color area in a #GimpColorSelector implementation.
</para>
<!-- ##### MACRO GIMP_COLOR_SELECTOR_BAR_SIZE ##### -->
<para>
The suggested width for a color bar in a #GimpColorSelector implementation.
</para>
<!-- ##### ENUM GimpColorSelectorChannel ##### -->
<para>
</para>
@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
<!-- ##### FUNCTION gimp_color_selector_new ##### -->
<para>
</para>
@selector_type:
@rgb:
@hsv:
@channel:
@Returns:
<!-- ##### FUNCTION gimp_color_selector_set_toggles_visible ##### -->
<para>
</para>
@selector:
@visible:
<!-- ##### FUNCTION gimp_color_selector_set_toggles_sensitive ##### -->
<para>
</para>
@selector:
@sensitive:
<!-- ##### FUNCTION gimp_color_selector_set_show_alpha ##### -->
<para>
</para>
@selector:
@show_alpha:
<!-- ##### FUNCTION gimp_color_selector_set_color ##### -->
<para>
</para>
@selector:
@rgb:
@hsv:
<!-- ##### FUNCTION gimp_color_selector_set_channel ##### -->
<para>
</para>
@selector:
@channel:
<!-- ##### FUNCTION gimp_color_selector_color_changed ##### -->
<para>
</para>
@selector:
<!-- ##### FUNCTION gimp_color_selector_channel_changed ##### -->
<para>
</para>
@selector:
<!-- ##### FUNCTION gimp_color_selector_set_config ##### -->
<para>
</para>
@selector:
@config:

134
devel-docs/libgimpwidgets/tmpl/gimpcontroller.sgml
View File

@ -1,134 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpController
<!-- ##### SECTION Short_Description ##### -->
Pluggable GIMP input controller modules.
<!-- ##### SECTION Long_Description ##### -->
<para>
An abstract interface for implementing arbitrary input controllers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GimpControllerEventType ##### -->
<para>
</para>
@GIMP_CONTROLLER_EVENT_TRIGGER:
@GIMP_CONTROLLER_EVENT_VALUE:
<!-- ##### STRUCT GimpControllerEventAny ##### -->
<para>
</para>
@type:
@source:
@event_id:
<!-- ##### STRUCT GimpControllerEventTrigger ##### -->
<para>
</para>
@type:
@source:
@event_id:
<!-- ##### STRUCT GimpControllerEventValue ##### -->
<para>
</para>
@type:
@source:
@event_id:
@value:
<!-- ##### UNION GimpControllerEvent ##### -->
<para>
</para>
<!-- ##### STRUCT GimpController ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpController::event ##### -->
<para>
</para>
@gimpcontroller: the object which received the signal.
@arg1:
@Returns:
<!-- ##### ARG GimpController:name ##### -->
<para>
</para>
<!-- ##### ARG GimpController:state ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_controller_new ##### -->
<para>
</para>
@controller_type:
@Returns:
<!-- ##### FUNCTION gimp_controller_get_n_events ##### -->
<para>
</para>
@controller:
@Returns:
<!-- ##### FUNCTION gimp_controller_get_event_name ##### -->
<para>
</para>
@controller:
@event_id:
@Returns:
<!-- ##### FUNCTION gimp_controller_get_event_blurb ##### -->
<para>
</para>
@controller:
@event_id:
@Returns:
<!-- ##### FUNCTION gimp_controller_event ##### -->
<para>
</para>
@controller:
@event:
@Returns:

112
devel-docs/libgimpwidgets/tmpl/gimpdialog.sgml
View File

@ -1,112 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpDialog
<!-- ##### SECTION Short_Description ##### -->
Constructors for #GtkDialog's and action_areas as well as other
dialog-related stuff.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpDialog ##### -->
<para>
</para>
<!-- ##### ARG GimpDialog:help-func ##### -->
<para>
</para>
<!-- ##### ARG GimpDialog:help-id ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_dialog_new ##### -->
<para>
</para>
@title:
@role:
@parent:
@flags:
@help_func:
@help_id:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_dialog_new_valist ##### -->
<para>
</para>
@title:
@role:
@parent:
@flags:
@help_func:
@help_id:
@args:
@Returns:
<!-- ##### FUNCTION gimp_dialog_add_button ##### -->
<para>
</para>
@dialog:
@button_text:
@response_id:
@Returns:
<!-- ##### FUNCTION gimp_dialog_add_buttons ##### -->
<para>
</para>
@dialog:
@Varargs:
<!-- ##### FUNCTION gimp_dialog_add_buttons_valist ##### -->
<para>
</para>
@dialog:
@args:
<!-- ##### FUNCTION gimp_dialog_run ##### -->
<para>
</para>
@dialog:
@Returns:
<!-- ##### FUNCTION gimp_dialogs_show_help_button ##### -->
<para>
</para>
@show:

57
devel-docs/libgimpwidgets/tmpl/gimpenumcombobox.sgml
View File

@ -1,57 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpEnumComboBox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpEnumComboBox ##### -->
<para>
</para>
<!-- ##### ARG GimpEnumComboBox:model ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_enum_combo_box_new ##### -->
<para>
</para>
@enum_type:
@Returns:
<!-- ##### FUNCTION gimp_enum_combo_box_new_with_model ##### -->
<para>
</para>
@enum_store:
@Returns:
<!-- ##### FUNCTION gimp_enum_combo_box_set_stock_prefix ##### -->
<para>
</para>
@combo_box:
@stock_prefix:

44
devel-docs/libgimpwidgets/tmpl/gimpenumlabel.sgml
View File

@ -1,44 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpEnumLabel
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpEnumLabel ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_enum_label_new ##### -->
<para>
</para>
@enum_type:
@value:
@Returns:
<!-- ##### FUNCTION gimp_enum_label_set_value ##### -->
<para>
</para>
@label:
@value:

81
devel-docs/libgimpwidgets/tmpl/gimpenumstore.sgml
View File

@ -1,81 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpEnumStore
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpEnumStore ##### -->
<para>
</para>
<!-- ##### ARG GimpEnumStore:enum-type ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_enum_store_new ##### -->
<para>
</para>
@enum_type:
@Returns:
<!-- ##### FUNCTION gimp_enum_store_new_with_range ##### -->
<para>
</para>
@enum_type:
@minimum:
@maximum:
@Returns:
<!-- ##### FUNCTION gimp_enum_store_new_with_values ##### -->
<para>
</para>
@enum_type:
@n_values:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_enum_store_new_with_values_valist ##### -->
<para>
</para>
@enum_type:
@n_values:
@args:
@Returns:
<!-- ##### FUNCTION gimp_enum_store_set_stock_prefix ##### -->
<para>
</para>
@store:
@stock_prefix:

113
devel-docs/libgimpwidgets/tmpl/gimpenumwidgets.sgml
View File

@ -1,113 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpEnumWidgets
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_enum_radio_box_new ##### -->
<para>
</para>
@enum_type:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_radio_box_new_with_range ##### -->
<para>
</para>
@enum_type:
@minimum:
@maximum:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_radio_frame_new ##### -->
<para>
</para>
@enum_type:
@label_widget:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_radio_frame_new_with_range ##### -->
<para>
</para>
@enum_type:
@minimum:
@maximum:
@label_widget:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_stock_box_new ##### -->
<para>
</para>
@enum_type:
@stock_prefix:
@icon_size:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_stock_box_new_with_range ##### -->
<para>
</para>
@enum_type:
@minimum:
@maximum:
@stock_prefix:
@icon_size:
@callback:
@callback_data:
@first_button:
@Returns:
<!-- ##### FUNCTION gimp_enum_stock_box_set_child_padding ##### -->
<para>
</para>
@stock_box:
@xpad:
@ypad:

79
devel-docs/libgimpwidgets/tmpl/gimpfileentry.sgml
View File

@ -1,79 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpFileEntry
<!-- ##### SECTION Short_Description ##### -->
Widget for entering a filename.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to enter filenames or directories.
</para>
<para>
There is a #GtkEntry for entering the filename manually and a "..."
button which will pop up a #GtkFileSelection dialog.
</para>
<para>
You can restrict the #GimpFileSelection to directories. In this case
the filename listbox of the #GtkFileSelection dialog will be hidden.
</para>
<para>
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.
</para>
<para>
Whenever the user changes the filename, the "filename_changed" signal
will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpPathEditor
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpFileEntry ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpFileEntry::filename-changed ##### -->
<para>
</para>
@gimpfileentry: the object which received the signal.
<!-- ##### FUNCTION gimp_file_entry_new ##### -->
<para>
</para>
@title:
@filename:
@dir_only:
@check_valid:
@Returns:
<!-- ##### FUNCTION gimp_file_entry_get_filename ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gimp_file_entry_set_filename ##### -->
<para>
</para>
@entry:
@filename:

44
devel-docs/libgimpwidgets/tmpl/gimpframe.sgml
View File

@ -1,44 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpFrame
<!-- ##### SECTION Short_Description ##### -->
A widget providing a HIG-compliant subclass of #GtkFrame.
<!-- ##### SECTION Long_Description ##### -->
<para>
A widget providing a HIG-compliant subclass of #GtkFrame.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpFrame ##### -->
<para>
</para>
<!-- ##### ARG GimpFrame:label-bold ##### -->
<para>
</para>
<!-- ##### ARG GimpFrame:label-spacing ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_frame_new ##### -->
<para>
</para>
@label:
@Returns:

117
devel-docs/libgimpwidgets/tmpl/gimphelpui.sgml
View File

@ -1,117 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpHelpUI
<!-- ##### SECTION Short_Description ##### -->
Functions for setting #GtkTooltips and help identifier used by GIMP help
system.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### USER_FUNCTION GimpHelpFunc ##### -->
<para>
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.
</para>
<para>
Help IDs are textual identifiers the help system uses to figure which
page to display.
</para>
<para>
All these dialog constructors functions call gimp_help_connect().
</para>
<para>
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.
</para>
@help_id:
@help_data:
<!-- ##### MACRO GIMP_HELP_ID ##### -->
<para>
Since: GIMP 2.2
</para>
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_disable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_standard_help_func ##### -->
<para>
</para>
@help_id:
@help_data:
<!-- ##### FUNCTION gimp_help_connect ##### -->
<para>
</para>
@widget:
@help_func:
@help_id:
@help_data:
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
<para>
</para>
@widget:
@tooltip:
@help_id:
<!-- ##### FUNCTION gimp_help_set_help_data_with_markup ##### -->
<para>
</para>
@widget:
@tooltip:
@help_id:
<!-- ##### FUNCTION gimp_context_help ##### -->
<para>
</para>
@widget:

28
devel-docs/libgimpwidgets/tmpl/gimphintbox.sgml
View File

@ -1,28 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpHintBox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_hint_box_new ##### -->
<para>
</para>
@hint:
@Returns:

133
devel-docs/libgimpwidgets/tmpl/gimpintcombobox.sgml
View File

@ -1,133 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpIntComboBox
<!-- ##### SECTION Short_Description ##### -->
A widget providing a popup menu of integer values (e.g. enums).
<!-- ##### SECTION Long_Description ##### -->
<para>
A widget providing a popup menu of integer values (e.g. enums).
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpIntComboBox ##### -->
<para>
</para>
<!-- ##### ARG GimpIntComboBox:ellipsize ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GimpIntSensitivityFunc ##### -->
<para>
</para>
@value:
@data:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_new ##### -->
<para>
</para>
@first_label:
@first_value:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_new_valist ##### -->
<para>
</para>
@first_label:
@first_value:
@values:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_new_array ##### -->
<para>
</para>
@n_values:
@labels:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_prepend ##### -->
<para>
</para>
@combo_box:
@Varargs:
<!-- ##### FUNCTION gimp_int_combo_box_append ##### -->
<para>
</para>
@combo_box:
@Varargs:
<!-- ##### FUNCTION gimp_int_combo_box_set_active ##### -->
<para>
</para>
@combo_box:
@value:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_get_active ##### -->
<para>
</para>
@combo_box:
@value:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_connect ##### -->
<para>
</para>
@combo_box:
@value:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_int_combo_box_set_sensitivity ##### -->
<para>
</para>
@combo_box:
@func:
@data:
@destroy:

61
devel-docs/libgimpwidgets/tmpl/gimpintstore.sgml
View File

@ -1,61 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpIntStore
<!-- ##### SECTION Short_Description ##### -->
A model for integer based name-value pairs (e.g. enums)
<!-- ##### SECTION Long_Description ##### -->
<para>
A model for integer based name-value pairs (e.g. enums)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpIntStore ##### -->
<para>
</para>
<!-- ##### ARG GimpIntStore:user-data-type ##### -->
<para>
</para>
<!-- ##### ENUM GimpIntStoreColumns ##### -->
<para>
</para>
@GIMP_INT_STORE_VALUE:
@GIMP_INT_STORE_LABEL:
@GIMP_INT_STORE_STOCK_ID:
@GIMP_INT_STORE_PIXBUF:
@GIMP_INT_STORE_USER_DATA:
@GIMP_INT_STORE_NUM_COLUMNS:
<!-- ##### FUNCTION gimp_int_store_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_int_store_lookup_by_value ##### -->
<para>
</para>
@model:
@value:
@iter:
@Returns:

63
devel-docs/libgimpwidgets/tmpl/gimpmemsizeentry.sgml
View File

@ -1,63 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpMemsizeEntry
<!-- ##### SECTION Short_Description ##### -->
A composite widget that allows to enter a memory size.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpMemsizeEntry ##### -->
<para>
The #GimpSizeEntry struct is considered private.
</para>
<!-- ##### SIGNAL GimpMemsizeEntry::value-changed ##### -->
<para>
</para>
@gimpmemsizeentry: the object which received the signal.
<!-- ##### FUNCTION gimp_memsize_entry_new ##### -->
<para>
</para>
@value:
@lower:
@upper:
@Returns:
<!-- ##### FUNCTION gimp_memsize_entry_set_value ##### -->
<para>
</para>
@entry:
@value:
<!-- ##### FUNCTION gimp_memsize_entry_get_value ##### -->
<para>
</para>
@entry:
@Returns:

232
devel-docs/libgimpwidgets/tmpl/gimpnumberpairentry.sgml
View File

@ -1,232 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpNumberPairEntry
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpNumberPairEntry ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpNumberPairEntry::numbers-changed ##### -->
<para>
</para>
@gimpnumberpairentry: the object which received the signal.
<!-- ##### SIGNAL GimpNumberPairEntry::ratio-changed ##### -->
<para>
</para>
@gimpnumberpairentry: the object which received the signal.
<!-- ##### ARG GimpNumberPairEntry:allow-simplification ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:aspect ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:default-left-number ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:default-right-number ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:default-text ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:left-number ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:max-valid-value ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:min-valid-value ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:ratio ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:right-number ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:separators ##### -->
<para>
</para>
<!-- ##### ARG GimpNumberPairEntry:user-override ##### -->
<para>
</para>
<!-- ##### ENUM GimpAspectType ##### -->
<para>
</para>
@GIMP_ASPECT_SQUARE:
@GIMP_ASPECT_PORTRAIT:
@GIMP_ASPECT_LANDSCAPE:
<!-- ##### FUNCTION gimp_number_pair_entry_new ##### -->
<para>
</para>
@separators:
@allow_simplification:
@min_valid_value:
@max_valid_value:
@Returns:
<!-- ##### FUNCTION gimp_number_pair_entry_set_default_values ##### -->
<para>
</para>
@entry:
@left:
@right:
<!-- ##### FUNCTION gimp_number_pair_entry_get_default_values ##### -->
<para>
</para>
@entry:
@left:
@right:
<!-- ##### FUNCTION gimp_number_pair_entry_set_values ##### -->
<para>
</para>
@entry:
@left:
@right:
<!-- ##### FUNCTION gimp_number_pair_entry_get_values ##### -->
<para>
</para>
@entry:
@left:
@right:
<!-- ##### FUNCTION gimp_number_pair_entry_get_aspect ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gimp_number_pair_entry_set_aspect ##### -->
<para>
</para>
@entry:
@aspect:
<!-- ##### FUNCTION gimp_number_pair_entry_get_ratio ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gimp_number_pair_entry_set_ratio ##### -->
<para>
</para>
@entry:
@ratio:
<!-- ##### FUNCTION gimp_number_pair_entry_get_user_override ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gimp_number_pair_entry_set_user_override ##### -->
<para>
</para>
@entry:
@user_override:
<!-- ##### FUNCTION gimp_number_pair_entry_get_default_text ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gimp_number_pair_entry_set_default_text ##### -->
<para>
</para>
@entry:
@string:

73
devel-docs/libgimpwidgets/tmpl/gimpoffsetarea.sgml
View File

@ -1,73 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpOffsetArea
<!-- ##### SECTION Short_Description ##### -->
Widget to control image offsets.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpOffsetArea ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpOffsetArea::offsets-changed ##### -->
<para>
</para>
@gimpoffsetarea: the object which received the signal.
@arg1:
@arg2:
<!-- ##### FUNCTION gimp_offset_area_new ##### -->
<para>
</para>
@orig_width:
@orig_height:
@Returns:
<!-- ##### FUNCTION gimp_offset_area_set_size ##### -->
<para>
</para>
@offset_area:
@width:
@height:
<!-- ##### FUNCTION gimp_offset_area_set_offsets ##### -->
<para>
</para>
@offset_area:
@offset_x:
@offset_y:
<!-- ##### FUNCTION gimp_offset_area_set_pixbuf ##### -->
<para>
</para>
@offset_area:
@pixbuf:

122
devel-docs/libgimpwidgets/tmpl/gimpoldwidgets.sgml
View File

@ -1,122 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpoldwidgets
<!-- ##### SECTION Short_Description ##### -->
Old API that is still available but declared as deprecated.
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions are not defined if you #define GIMP_DISABLE_DEPRECATED.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
GimpIntComboBox
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_int_option_menu_new ##### -->
<para>
</para>
@menu_only:
@menu_item_callback:
@menu_item_callback_data:
@initial:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_int_option_menu_set_history ##### -->
<para>
</para>
@option_menu:
@item_data:
<!-- ##### USER_FUNCTION GimpIntOptionMenuSensitivityCallback ##### -->
<para>
</para>
@item_data:
@callback_data:
@Returns:
<!-- ##### FUNCTION gimp_int_option_menu_set_sensitive ##### -->
<para>
</para>
@option_menu:
@callback:
@callback_data:
<!-- ##### FUNCTION gimp_option_menu_new ##### -->
<para>
</para>
@menu_only:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_option_menu_new2 ##### -->
<para>
</para>
@menu_only:
@menu_item_callback:
@menu_item_callback_data:
@initial:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_option_menu_set_history ##### -->
<para>
</para>
@option_menu:
@item_data:
<!-- ##### USER_FUNCTION GimpOptionMenuSensitivityCallback ##### -->
<para>
</para>
@item_data:
@callback_data:
@Returns:
<!-- ##### FUNCTION gimp_option_menu_set_sensitive ##### -->
<para>
</para>
@option_menu:
@callback:
@callback_data:
<!-- ##### FUNCTION gimp_menu_item_update ##### -->
<para>
</para>
@widget:
@data:

213
devel-docs/libgimpwidgets/tmpl/gimppageselector.sgml
View File

@ -1,213 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPageSelector
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPageSelector ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpPageSelector::activate ##### -->
<para>
</para>
@gimppageselector: the object which received the signal.
<!-- ##### SIGNAL GimpPageSelector::selection-changed ##### -->
<para>
</para>
@gimppageselector: the object which received the signal.
<!-- ##### ARG GimpPageSelector:n-pages ##### -->
<para>
</para>
<!-- ##### ARG GimpPageSelector:target ##### -->
<para>
</para>
<!-- ##### ENUM GimpPageSelectorTarget ##### -->
<para>
</para>
@GIMP_PAGE_SELECTOR_TARGET_LAYERS:
@GIMP_PAGE_SELECTOR_TARGET_IMAGES:
<!-- ##### FUNCTION gimp_page_selector_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_page_selector_set_n_pages ##### -->
<para>
</para>
@selector:
@n_pages:
<!-- ##### FUNCTION gimp_page_selector_get_n_pages ##### -->
<para>
</para>
@selector:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_set_target ##### -->
<para>
</para>
@selector:
@target:
<!-- ##### FUNCTION gimp_page_selector_get_target ##### -->
<para>
</para>
@selector:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_set_page_thumbnail ##### -->
<para>
</para>
@selector:
@page_no:
@thumbnail:
<!-- ##### FUNCTION gimp_page_selector_get_page_thumbnail ##### -->
<para>
</para>
@selector:
@page_no:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_set_page_label ##### -->
<para>
</para>
@selector:
@page_no:
@label:
<!-- ##### FUNCTION gimp_page_selector_get_page_label ##### -->
<para>
</para>
@selector:
@page_no:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_select_all ##### -->
<para>
</para>
@selector:
<!-- ##### FUNCTION gimp_page_selector_unselect_all ##### -->
<para>
</para>
@selector:
<!-- ##### FUNCTION gimp_page_selector_select_page ##### -->
<para>
</para>
@selector:
@page_no:
<!-- ##### FUNCTION gimp_page_selector_unselect_page ##### -->
<para>
</para>
@selector:
@page_no:
<!-- ##### FUNCTION gimp_page_selector_page_is_selected ##### -->
<para>
</para>
@selector:
@page_no:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_get_selected_pages ##### -->
<para>
</para>
@selector:
@n_selected_pages:
@Returns:
<!-- ##### FUNCTION gimp_page_selector_select_range ##### -->
<para>
</para>
@selector:
@range:
<!-- ##### FUNCTION gimp_page_selector_get_selected_range ##### -->
<para>
</para>
@selector:
@Returns:

121
devel-docs/libgimpwidgets/tmpl/gimppatheditor.sgml
View File

@ -1,121 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPathEditor
<!-- ##### SECTION Short_Description ##### -->
Widget for editing a file search path.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to edit file search paths.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
Whenever the user adds, deletes, changes or reorders a directory of
the search path, the "path_changed" signal will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpFileEntry
</para>
<para>
#G_SEARCHPATH_SEPARATOR
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPathEditor ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpPathEditor::path-changed ##### -->
<para>
</para>
@gimppatheditor: the object which received the signal.
<!-- ##### SIGNAL GimpPathEditor::writable-changed ##### -->
<para>
</para>
@gimppatheditor: the object which received the signal.
<!-- ##### FUNCTION gimp_path_editor_new ##### -->
<para>
</para>
@title:
@path:
@Returns:
<!-- ##### FUNCTION gimp_path_editor_get_path ##### -->
<para>
</para>
@editor:
@Returns:
<!-- ##### FUNCTION gimp_path_editor_set_path ##### -->
<para>
</para>
@editor:
@path:
<!-- ##### FUNCTION gimp_path_editor_get_writable_path ##### -->
<para>
</para>
@editor:
@Returns:
<!-- ##### FUNCTION gimp_path_editor_set_writable_path ##### -->
<para>
</para>
@editor:
@path:
<!-- ##### FUNCTION gimp_path_editor_get_dir_writable ##### -->
<para>
</para>
@editor:
@directory:
@Returns:
<!-- ##### FUNCTION gimp_path_editor_set_dir_writable ##### -->
<para>
</para>
@editor:
@directory:
@writable:

43
devel-docs/libgimpwidgets/tmpl/gimppickbutton.sgml
View File

@ -1,43 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPickButton
<!-- ##### SECTION Short_Description ##### -->
Widget to pick a color from screen.
<!-- ##### SECTION Long_Description ##### -->
<para>
#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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPickButton ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpPickButton::color-picked ##### -->
<para>
</para>
@gimppickbutton: the object which received the signal.
@arg1: pointer to a #GimpRGB structure that holds the picked color
<!-- ##### FUNCTION gimp_pick_button_new ##### -->
<para>
</para>
@Returns:

55
devel-docs/libgimpwidgets/tmpl/gimppixmap.sgml
View File

@ -1,55 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPixmap
<!-- ##### SECTION Short_Description ##### -->
Widget which creates a #GtkPixmap from XPM data.
<!-- ##### SECTION Long_Description ##### -->
<para>
Widget which creates a #GtkPixmap from XPM data.
</para>
<para>
Use this widget instead of #GtkPixmap if you don't want to worry about
the parent container's "realized" state.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
gimp_pixmap_button_new()
</para>
<para>
#GtkPixmap
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPixmap ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_pixmap_new ##### -->
<para>
</para>
@xpm_data:
@Returns:
<!-- ##### FUNCTION gimp_pixmap_set ##### -->
<para>
</para>
@pixmap:
@xpm_data:

169
devel-docs/libgimpwidgets/tmpl/gimppreview.sgml
View File

@ -1,169 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPreview
<!-- ##### SECTION Short_Description ##### -->
A widget providing a #GimpPreviewArea plus framework to update the preview.
<!-- ##### SECTION Long_Description ##### -->
<para>
A widget providing a #GimpPreviewArea plus framework to update the preview.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPreview ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpPreview::invalidated ##### -->
<para>
</para>
@gimppreview: the object which received the signal.
<!-- ##### ARG GimpPreview:update ##### -->
<para>
</para>
<!-- ##### ARG GimpPreview:size ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_preview_get_update ##### -->
<para>
</para>
@preview:
@Returns:
<!-- ##### FUNCTION gimp_preview_set_update ##### -->
<para>
</para>
@preview:
@update:
<!-- ##### FUNCTION gimp_preview_set_bounds ##### -->
<para>
</para>
@preview:
@xmin:
@ymin:
@xmax:
@ymax:
<!-- ##### FUNCTION gimp_preview_get_size ##### -->
<para>
</para>
@preview:
@width:
@height:
<!-- ##### FUNCTION gimp_preview_get_position ##### -->
<para>
</para>
@preview:
@x:
@y:
<!-- ##### FUNCTION gimp_preview_transform ##### -->
<para>
</para>
@preview:
@src_x:
@src_y:
@dest_x:
@dest_y:
<!-- ##### FUNCTION gimp_preview_untransform ##### -->
<para>
</para>
@preview:
@src_x:
@src_y:
@dest_x:
@dest_y:
<!-- ##### FUNCTION gimp_preview_get_area ##### -->
<para>
</para>
@preview:
@Returns:
<!-- ##### FUNCTION gimp_preview_draw ##### -->
<para>
</para>
@preview:
<!-- ##### FUNCTION gimp_preview_draw_buffer ##### -->
<para>
</para>
@preview:
@buffer:
@rowstride:
<!-- ##### FUNCTION gimp_preview_invalidate ##### -->
<para>
</para>
@preview:
<!-- ##### FUNCTION gimp_preview_set_default_cursor ##### -->
<para>
</para>
@preview:
@cursor:
<!-- ##### FUNCTION gimp_preview_get_controls ##### -->
<para>
</para>
@preview:
@Returns:

149
devel-docs/libgimpwidgets/tmpl/gimppreviewarea.sgml
View File

@ -1,149 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPreviewArea
<!-- ##### SECTION Short_Description ##### -->
A general purpose preview widget which caches its pixel data.
<!-- ##### SECTION Long_Description ##### -->
<para>
A general purpose preview widget which caches its pixel data.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpPreviewArea ##### -->
<para>
</para>
<!-- ##### ARG GimpPreviewArea:check-size ##### -->
<para>
</para>
<!-- ##### ARG GimpPreviewArea:check-type ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_preview_area_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_preview_area_draw ##### -->
<para>
</para>
@area:
@x:
@y:
@width:
@height:
@type:
@buf:
@rowstride:
<!-- ##### FUNCTION gimp_preview_area_fill ##### -->
<para>
</para>
@area:
@x:
@y:
@width:
@height:
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_preview_area_blend ##### -->
<para>
</para>
@area:
@x:
@y:
@width:
@height:
@type:
@buf1:
@rowstride1:
@buf2:
@rowstride2:
@opacity:
<!-- ##### FUNCTION gimp_preview_area_mask ##### -->
<para>
</para>
@area:
@x:
@y:
@width:
@height:
@type:
@buf1:
@rowstride1:
@buf2:
@rowstride2:
@mask:
@rowstride_mask:
<!-- ##### FUNCTION gimp_preview_area_set_offsets ##### -->
<para>
</para>
@area:
@x:
@y:
<!-- ##### FUNCTION gimp_preview_area_set_colormap ##### -->
<para>
</para>
@area:
@colormap:
@num_colors:
<!-- ##### FUNCTION gimp_preview_area_set_max_size ##### -->
<para>
</para>
@area:
@width:
@height:
<!-- ##### FUNCTION gimp_preview_area_menu_popup ##### -->
<para>
</para>
@area:
@event:

383
devel-docs/libgimpwidgets/tmpl/gimppropwidgets.sgml
View File

@ -1,383 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpPropWidgets
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_prop_boolean_combo_box_new ##### -->
<para>
</para>
@config:
@property_name:
@true_text:
@false_text:
@Returns:
<!-- ##### FUNCTION gimp_prop_boolean_radio_frame_new ##### -->
<para>
</para>
@config:
@property_name:
@title:
@true_text:
@false_text:
@Returns:
<!-- ##### FUNCTION gimp_prop_check_button_new ##### -->
<para>
</para>
@config:
@property_name:
@label:
@Returns:
<!-- ##### FUNCTION gimp_prop_color_area_new ##### -->
<para>
</para>
@config:
@property_name:
@width:
@height:
@type:
@Returns:
<!-- ##### FUNCTION gimp_prop_coordinates_connect ##### -->
<para>
</para>
@config:
@x_property_name:
@y_property_name:
@unit_property_name:
@sizeentry:
@chainbutton:
@xresolution:
@yresolution:
@Returns:
<!-- ##### FUNCTION gimp_prop_coordinates_new ##### -->
<para>
</para>
@config:
@x_property_name:
@y_property_name:
@unit_property_name:
@unit_format:
@update_policy:
@xresolution:
@yresolution:
@has_chainbutton:
@Returns:
<!-- ##### FUNCTION gimp_prop_entry_new ##### -->
<para>
</para>
@config:
@property_name:
@max_len:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_check_button_new ##### -->
<para>
</para>
@config:
@property_name:
@label:
@false_value:
@true_value:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_combo_box_new ##### -->
<para>
</para>
@config:
@property_name:
@minimum:
@maximum:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_label_new ##### -->
<para>
</para>
@config:
@property_name:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_radio_box_new ##### -->
<para>
</para>
@config:
@property_name:
@minimum:
@maximum:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_radio_frame_new ##### -->
<para>
</para>
@config:
@property_name:
@title:
@minimum:
@maximum:
@Returns:
<!-- ##### FUNCTION gimp_prop_enum_stock_box_new ##### -->
<para>
</para>
@config:
@property_name:
@stock_prefix:
@minimum:
@maximum:
@Returns:
<!-- ##### FUNCTION gimp_prop_expander_new ##### -->
<para>
</para>
@config:
@property_name:
@label:
@Returns:
<!-- ##### FUNCTION gimp_prop_file_chooser_button_new ##### -->
<para>
</para>
@config:
@property_name:
@title:
@action:
@Returns:
<!-- ##### FUNCTION gimp_prop_file_chooser_button_new_with_dialog ##### -->
<para>
</para>
@config:
@property_name:
@dialog:
@Returns:
<!-- ##### FUNCTION gimp_prop_hscale_new ##### -->
<para>
</para>
@config:
@property_name:
@step_increment:
@page_increment:
@digits:
@Returns:
<!-- ##### FUNCTION gimp_prop_int_combo_box_new ##### -->
<para>
</para>
@config:
@property_name:
@store:
@Returns:
<!-- ##### FUNCTION gimp_prop_label_new ##### -->
<para>
</para>
@config:
@property_name:
@Returns:
<!-- ##### FUNCTION gimp_prop_memsize_entry_new ##### -->
<para>
</para>
@config:
@property_name:
@Returns:
<!-- ##### FUNCTION gimp_prop_opacity_entry_new ##### -->
<para>
</para>
@config:
@property_name:
@table:
@column:
@row:
@label:
@Returns:
<!-- ##### FUNCTION gimp_prop_path_editor_new ##### -->
<para>
</para>
@config:
@path_property_name:
@writable_property_name:
@filesel_title:
@Returns:
<!-- ##### FUNCTION gimp_prop_scale_entry_new ##### -->
<para>
</para>
@config:
@property_name:
@table:
@column:
@row:
@label:
@step_increment:
@page_increment:
@digits:
@limit_scale:
@lower_limit:
@upper_limit:
@Returns:
<!-- ##### FUNCTION gimp_prop_size_entry_new ##### -->
<para>
</para>
@config:
@property_name:
@property_is_pixel:
@unit_property_name:
@unit_format:
@update_policy:
@resolution:
@Returns:
<!-- ##### FUNCTION gimp_prop_spin_button_new ##### -->
<para>
</para>
@config:
@property_name:
@step_increment:
@page_increment:
@digits:
@Returns:
<!-- ##### FUNCTION gimp_prop_stock_image_new ##### -->
<para>
</para>
@config:
@property_name:
@icon_size:
@Returns:
<!-- ##### FUNCTION gimp_prop_string_combo_box_new ##### -->
<para>
</para>
@config:
@property_name:
@model:
@id_column:
@label_column:
@Returns:
<!-- ##### FUNCTION gimp_prop_text_buffer_new ##### -->
<para>
</para>
@config:
@property_name:
@max_len:
@Returns:
<!-- ##### FUNCTION gimp_prop_unit_menu_new ##### -->
<para>
</para>
@config:
@property_name:
@unit_format:
@Returns:

196
devel-docs/libgimpwidgets/tmpl/gimpquerybox.sgml
View File

@ -1,196 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpQueryBox
<!-- ##### SECTION Short_Description ##### -->
Some simple dialogs to enter a single int, double, string or boolean value.
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions provide simple dialogs for entering a single string,
integer, double, boolean or pixel size value.
</para>
<para>
They return a pointer to a #GtkDialog which has to be shown with
gtk_widget_show() by the caller.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
GimpSizeEntry
</para>
<para>
GimpUnitMenu
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### USER_FUNCTION GimpQueryStringCallback ##### -->
<para>
Note that you have to g_free() the returned string.
</para>
@query_box: The query box.
@string: The entered string.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryIntCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered integer value.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryDoubleCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered double value.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQuerySizeCallback ##### -->
<para>
</para>
@query_box: The query box.
@size: The entered size in pixels.
@unit: The selected unit from the #GimpUnitMenu.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryBooleanCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered boolean value.
@data: The user data.
<!-- ##### FUNCTION gimp_query_string_box ##### -->
<para>
</para>
@title:
@parent:
@help_func:
@help_id:
@message:
@initial:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_int_box ##### -->
<para>
</para>
@title:
@parent:
@help_func:
@help_id:
@message:
@initial:
@lower:
@upper:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_double_box ##### -->
<para>
</para>
@title:
@parent:
@help_func:
@help_id:
@message:
@initial:
@lower:
@upper:
@digits:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_size_box ##### -->
<para>
</para>
@title:
@parent:
@help_func:
@help_id:
@message:
@initial:
@lower:
@upper:
@digits:
@unit:
@resolution:
@dot_for_dot:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_boolean_box ##### -->
<para>
</para>
@title:
@parent:
@help_func:
@help_id:
@stock_id:
@message:
@true_button:
@false_button:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### MACRO GIMP_QUERY_BOX_VBOX ##### -->
<para>
A macro to access the #GtkVBox in a #GimpQueryBox. Useful if you want to add
more widgets.
</para>
@qbox:

127
devel-docs/libgimpwidgets/tmpl/gimpruler.sgml
View File

@ -1,127 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpRuler
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpRuler ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:lower ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:max-size ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:orientation ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:position ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:unit ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:upper ##### -->
<para>
</para>
<!-- ##### ARG GimpRuler:font-scale ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_ruler_new ##### -->
<para>
</para>
@orientation:
@Returns:
<!-- ##### FUNCTION gimp_ruler_set_unit ##### -->
<para>
</para>
@ruler:
@unit:
<!-- ##### FUNCTION gimp_ruler_get_unit ##### -->
<para>
</para>
@ruler:
@Returns:
<!-- ##### FUNCTION gimp_ruler_set_position ##### -->
<para>
</para>
@ruler:
@position:
<!-- ##### FUNCTION gimp_ruler_get_position ##### -->
<para>
</para>
@ruler:
@Returns:
<!-- ##### FUNCTION gimp_ruler_set_range ##### -->
<para>
</para>
@ruler:
@lower:
@upper:
@max_size:
<!-- ##### FUNCTION gimp_ruler_get_range ##### -->
<para>
</para>
@ruler:
@lower:
@upper:
@max_size:

61
devel-docs/libgimpwidgets/tmpl/gimpscrolledpreview.sgml
View File

@ -1,61 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpScrolledPreview
<!-- ##### SECTION Short_Description ##### -->
A widget providing a #GimpPreview enhanced by scrolling capabilities.
<!-- ##### SECTION Long_Description ##### -->
<para>
A widget providing a #GimpPreview enhanced by scrolling capabilities.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpScrolledPreview ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_scrolled_preview_set_position ##### -->
<para>
</para>
@preview:
@x:
@y:
<!-- ##### FUNCTION gimp_scrolled_preview_set_policy ##### -->
<para>
</para>
@preview:
@hscrollbar_policy:
@vscrollbar_policy:
<!-- ##### FUNCTION gimp_scrolled_preview_freeze ##### -->
<para>
</para>
@preview:
<!-- ##### FUNCTION gimp_scrolled_preview_thaw ##### -->
<para>
</para>
@preview:

285
devel-docs/libgimpwidgets/tmpl/gimpsizeentry.sgml
View File

@ -1,285 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpSizeEntry
<!-- ##### SECTION Short_Description ##### -->
Widget for entering pixel values and resolutions.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to enter pixel distances/sizes and resolutions.
</para>
<para>
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 it's "value".
</para>
<para>
There is a #GimpUnitMenu right of the entry fields which lets you
specify the #GimpUnit of the displayed values.
</para>
<para>
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.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnit
</para>
<para>
#GimpUnitMenu
</para>
<para>
gimp_coordinates_new()
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpSizeEntry ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpSizeEntry::refval-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.
<!-- ##### SIGNAL GimpSizeEntry::unit-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.
<!-- ##### SIGNAL GimpSizeEntry::value-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.
<!-- ##### STRUCT GimpSizeEntryField ##### -->
<para>
</para>
<!-- ##### ENUM GimpSizeEntryUpdatePolicy ##### -->
<para>
</para>
@GIMP_SIZE_ENTRY_UPDATE_NONE:
@GIMP_SIZE_ENTRY_UPDATE_SIZE:
@GIMP_SIZE_ENTRY_UPDATE_RESOLUTION:
<!-- ##### FUNCTION gimp_size_entry_new ##### -->
<para>
</para>
@number_of_fields:
@unit:
@unit_format:
@menu_show_pixels:
@menu_show_percent:
@show_refval:
@spinbutton_width:
@update_policy:
@Returns:
<!-- ##### FUNCTION gimp_size_entry_add_field ##### -->
<para>
</para>
@gse:
@value_spinbutton:
@refval_spinbutton:
<!-- ##### FUNCTION gimp_size_entry_attach_label ##### -->
<para>
</para>
@gse:
@text:
@row:
@column:
@alignment:
@Returns:
<!-- ##### FUNCTION gimp_size_entry_set_resolution ##### -->
<para>
</para>
@gse:
@field:
@resolution:
@keep_size:
<!-- ##### FUNCTION gimp_size_entry_set_size ##### -->
<para>
</para>
@gse:
@field:
@lower:
@upper:
<!-- ##### FUNCTION gimp_size_entry_set_value_boundaries ##### -->
<para>
</para>
@gse:
@field:
@lower:
@upper:
<!-- ##### FUNCTION gimp_size_entry_get_value ##### -->
<para>
</para>
@gse:
@field:
@Returns:
<!-- ##### FUNCTION gimp_size_entry_set_value ##### -->
<para>
</para>
@gse:
@field:
@value:
<!-- ##### FUNCTION gimp_size_entry_set_refval_boundaries ##### -->
<para>
</para>
@gse:
@field:
@lower:
@upper:
<!-- ##### FUNCTION gimp_size_entry_set_refval_digits ##### -->
<para>
</para>
@gse:
@field:
@digits:
<!-- ##### FUNCTION gimp_size_entry_get_refval ##### -->
<para>
</para>
@gse:
@field:
@Returns:
<!-- ##### FUNCTION gimp_size_entry_set_refval ##### -->
<para>
</para>
@gse:
@field:
@refval:
<!-- ##### FUNCTION gimp_size_entry_get_unit ##### -->
<para>
</para>
@gse:
@Returns:
<!-- ##### FUNCTION gimp_size_entry_set_unit ##### -->
<para>
</para>
@gse:
@unit:
<!-- ##### FUNCTION gimp_size_entry_set_pixel_digits ##### -->
<para>
</para>
@gse:
@digits:
<!-- ##### FUNCTION gimp_size_entry_show_unit_menu ##### -->
<para>
</para>
@gse:
@show:
<!-- ##### FUNCTION gimp_size_entry_grab_focus ##### -->
<para>
</para>
@gse:
<!-- ##### FUNCTION gimp_size_entry_set_activates_default ##### -->
<para>
</para>
@gse:
@setting:
<!-- ##### FUNCTION gimp_size_entry_get_help_widget ##### -->
<para>
</para>
@gse:
@field:
@Returns:

15
devel-docs/libgimpwidgets/tmpl/gimpstock.sgml
View File

@ -2,18 +2,11 @@
GimpStock GimpStock
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Prebuilt common menu/toolbar items and corresponding icons
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <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> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@ -24,11 +17,15 @@ locales.
<!-- ##### SECTION Stability_Level ##### --> <!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gimp_stock_init ##### --> <!-- ##### FUNCTION gimp_stock_init ##### -->
<para> <para>
</para> </para>
@void:
<!-- ##### MACRO GIMP_STOCK_ANCHOR ##### --> <!-- ##### MACRO GIMP_STOCK_ANCHOR ##### -->

70
devel-docs/libgimpwidgets/tmpl/gimpstringcombobox.sgml
View File

@ -1,70 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpStringComboBox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpStringComboBox ##### -->
<para>
</para>
<!-- ##### ARG GimpStringComboBox:ellipsize ##### -->
<para>
</para>
<!-- ##### ARG GimpStringComboBox:id-column ##### -->
<para>
</para>
<!-- ##### ARG GimpStringComboBox:label-column ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_string_combo_box_new ##### -->
<para>
</para>
@model:
@id_column:
@label_column:
@Returns:
<!-- ##### FUNCTION gimp_string_combo_box_set_active ##### -->
<para>
</para>
@combo_box:
@id:
@Returns:
<!-- ##### FUNCTION gimp_string_combo_box_get_active ##### -->
<para>
</para>
@combo_box:
@Returns:

100
devel-docs/libgimpwidgets/tmpl/gimpunitmenu.sgml
View File

@ -1,100 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpUnitMenu
<!-- ##### SECTION Short_Description ##### -->
Widget for selecting a #GimpUnit.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget provides a #GtkOptionMenu which contains a list of #GimpUnit's.
</para>
<para>
You can specify the string that will be displayed for each unit by
passing a printf-like @format string to gimp_unit_menu_new().
</para>
<para>
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.
</para>
<para>
Whenever the user selects a unit from the menu or the dialog, the
"unit_changed" signal will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnit
</para>
<para>
#GimpSizeEntry
</para>
<para>
gimp_coordinates_new()
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpUnitMenu ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpUnitMenu::unit-changed ##### -->
<para>
</para>
@gimpunitmenu: the object which received the signal.
<!-- ##### FUNCTION gimp_unit_menu_new ##### -->
<para>
</para>
@format:
@unit:
@show_pixels:
@show_percent:
@show_custom:
@Returns:
<!-- ##### FUNCTION gimp_unit_menu_set_unit ##### -->
<para>
</para>
@menu:
@unit:
<!-- ##### FUNCTION gimp_unit_menu_get_unit ##### -->
<para>
</para>
@menu:
@Returns:
<!-- ##### FUNCTION gimp_unit_menu_get_pixel_digits ##### -->
<para>
</para>
@menu:
@Returns:
<!-- ##### FUNCTION gimp_unit_menu_set_pixel_digits ##### -->
<para>
</para>
@menu:
@digits:

394
devel-docs/libgimpwidgets/tmpl/gimpwidgets.sgml
View File

@ -1,394 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpWidgets
<!-- ##### SECTION Short_Description ##### -->
A collection of convenient widget constructors, standard callbacks and
helper functions.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_radio_group_new ##### -->
<para>
</para>
@in_frame:
@frame_title:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_radio_group_new2 ##### -->
<para>
</para>
@in_frame:
@frame_title:
@radio_button_callback:
@radio_button_callback_data:
@initial:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_radio_group_set_active ##### -->
<para>
</para>
@radio_button:
@item_data:
<!-- ##### FUNCTION gimp_int_radio_group_new ##### -->
<para>
</para>
@in_frame:
@frame_title:
@radio_button_callback:
@radio_button_callback_data:
@initial:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_int_radio_group_set_active ##### -->
<para>
</para>
@radio_button:
@item_data:
<!-- ##### FUNCTION gimp_spin_button_new ##### -->
<para>
</para>
@adjustment:
@value:
@lower:
@upper:
@step_increment:
@page_increment:
@page_size:
@climb_rate:
@digits:
@Returns:
<!-- ##### MACRO GIMP_SCALE_ENTRY_LABEL ##### -->
<para>
Returns the scale_entry's #GtkLabel.
</para>
@adj: The #GtkAdjustment returned by gimp_scale_entry_new().
<!-- ##### MACRO GIMP_SCALE_ENTRY_SCALE ##### -->
<para>
Returns the scale_entry's #GtkHScale.
</para>
@adj: The #GtkAdjustment returned by gimp_scale_entry_new().
<!-- ##### MACRO GIMP_SCALE_ENTRY_SCALE_ADJ ##### -->
<para>
Returns the #GtkAdjustment of the scale_entry's #GtkHScale.
</para>
@adj: The #GtkAdjustment returned by gimp_scale_entry_new().
<!-- ##### MACRO GIMP_SCALE_ENTRY_SPINBUTTON ##### -->
<para>
Returns the scale_entry's #GtkSpinButton.
</para>
@adj: The #GtkAdjustment returned by gimp_scale_entry_new().
<!-- ##### MACRO GIMP_SCALE_ENTRY_SPINBUTTON_ADJ ##### -->
<para>
Returns the #GtkAdjustment of the scale_entry's #GtkSpinButton.
</para>
@adj: The #GtkAdjustment returned by gimp_scale_entry_new().
<!-- ##### FUNCTION gimp_scale_entry_new ##### -->
<para>
</para>
@table:
@column:
@row:
@text:
@scale_width:
@spinbutton_width:
@value:
@lower:
@upper:
@step_increment:
@page_increment:
@digits:
@constrain:
@unconstrained_lower:
@unconstrained_upper:
@tooltip:
@help_id:
@Returns:
<!-- ##### FUNCTION gimp_scale_entry_set_sensitive ##### -->
<para>
</para>
@adjustment:
@sensitive:
<!-- ##### FUNCTION gimp_scale_entry_set_logarithmic ##### -->
<para>
</para>
@adjustment:
@logarithmic:
<!-- ##### FUNCTION gimp_scale_entry_get_logarithmic ##### -->
<para>
</para>
@adjustment:
@Returns:
<!-- ##### FUNCTION gimp_color_scale_entry_new ##### -->
<para>
</para>
@table:
@column:
@row:
@text:
@scale_width:
@spinbutton_width:
@value:
@lower:
@upper:
@step_increment:
@page_increment:
@digits:
@tooltip:
@help_id:
@Returns:
<!-- ##### MACRO GIMP_RANDOM_SEED_SPINBUTTON ##### -->
<para>
Returns the random_seed's #GtkSpinButton.
</para>
@hbox: The #GtkHBox returned by gimp_random_seed_new().
<!-- ##### MACRO GIMP_RANDOM_SEED_SPINBUTTON_ADJ ##### -->
<para>
Returns the #GtkAdjustment of the random_seed's #GtkSpinButton.
</para>
@hbox: The #GtkHBox returned by gimp_random_seed_new().
<!-- ##### MACRO GIMP_RANDOM_SEED_TOGGLE ##### -->
<para>
</para>
@hbox:
<!-- ##### FUNCTION gimp_random_seed_new ##### -->
<para>
</para>
@seed:
@random_seed:
@Returns:
<!-- ##### MACRO GIMP_COORDINATES_CHAINBUTTON ##### -->
<para>
Returns the #GimpChainButton which is attached to the #GimpSizeEntry.
</para>
@sizeentry: The #GimpSizeEntry returned by gimp_coordinates_new().
<!-- ##### FUNCTION gimp_coordinates_new ##### -->
<para>
</para>
@unit:
@unit_format:
@menu_show_pixels:
@menu_show_percent:
@spinbutton_width:
@update_policy:
@chainbutton_active:
@chain_constrains_ratio:
@xlabel:
@x:
@xres:
@lower_boundary_x:
@upper_boundary_x:
@xsize_0:
@xsize_100:
@ylabel:
@y:
@yres:
@lower_boundary_y:
@upper_boundary_y:
@ysize_0:
@ysize_100:
@Returns:
<!-- ##### FUNCTION gimp_pixmap_button_new ##### -->
<para>
</para>
@xpm_data:
@text:
@Returns:
<!-- ##### FUNCTION gimp_toggle_button_sensitive_update ##### -->
<para>
</para>
@toggle_button:
<!-- ##### FUNCTION gimp_toggle_button_update ##### -->
<para>
</para>
@widget:
@data:
<!-- ##### FUNCTION gimp_radio_button_update ##### -->
<para>
</para>
@widget:
@data:
<!-- ##### FUNCTION gimp_int_adjustment_update ##### -->
<para>
</para>
@adjustment:
@data:
<!-- ##### FUNCTION gimp_uint_adjustment_update ##### -->
<para>
</para>
@adjustment:
@data:
<!-- ##### FUNCTION gimp_float_adjustment_update ##### -->
<para>
</para>
@adjustment:
@data:
<!-- ##### FUNCTION gimp_double_adjustment_update ##### -->
<para>
</para>
@adjustment:
@data:
<!-- ##### FUNCTION gimp_unit_menu_update ##### -->
<para>
</para>
@widget:
@data:
<!-- ##### FUNCTION gimp_table_attach_aligned ##### -->
<para>
</para>
@table:
@column:
@row:
@label_text:
@xalign:
@yalign:
@widget:
@colspan:
@left_align:
@Returns:
<!-- ##### FUNCTION gimp_label_set_attributes ##### -->
<para>
</para>
@label:
@Varargs:
<!-- ##### MACRO GIMP_WIDGETS_ERROR ##### -->
<para>
</para>

140
devel-docs/libgimpwidgets/tmpl/gimpzoommodel.sgml
View File

@ -1,140 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpZoomModel
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpZoomModel ##### -->
<para>
</para>
<!-- ##### SIGNAL GimpZoomModel::zoomed ##### -->
<para>
</para>
@gimpzoommodel: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GimpZoomModel:fraction ##### -->
<para>
</para>
<!-- ##### ARG GimpZoomModel:maximum ##### -->
<para>
</para>
<!-- ##### ARG GimpZoomModel:minimum ##### -->
<para>
</para>
<!-- ##### ARG GimpZoomModel:percentage ##### -->
<para>
</para>
<!-- ##### ARG GimpZoomModel:value ##### -->
<para>
</para>
<!-- ##### ENUM GimpZoomType ##### -->
<para>
</para>
@GIMP_ZOOM_IN:
@GIMP_ZOOM_OUT:
@GIMP_ZOOM_IN_MORE:
@GIMP_ZOOM_OUT_MORE:
@GIMP_ZOOM_IN_MAX:
@GIMP_ZOOM_OUT_MAX:
@GIMP_ZOOM_TO:
<!-- ##### FUNCTION gimp_zoom_model_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gimp_zoom_model_set_range ##### -->
<para>
</para>
@model:
@min:
@max:
<!-- ##### FUNCTION gimp_zoom_model_zoom ##### -->
<para>
</para>
@model:
@zoom_type:
@scale:
<!-- ##### FUNCTION gimp_zoom_model_get_factor ##### -->
<para>
</para>
@model:
@Returns:
<!-- ##### FUNCTION gimp_zoom_model_get_fraction ##### -->
<para>
</para>
@model:
@numerator:
@denominator:
<!-- ##### FUNCTION gimp_zoom_button_new ##### -->
<para>
</para>
@model:
@zoom_type:
@icon_size:
@Returns:
<!-- ##### FUNCTION gimp_zoom_model_zoom_step ##### -->
<para>
</para>
@zoom_type:
@scale:
@Returns:

9
libgimpwidgets/gimpbrowser.c
View File

@ -33,6 +33,15 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
SEARCH, SEARCH,

19
libgimpwidgets/gimpbutton.c
View File

@ -28,6 +28,17 @@
#include "gimpbutton.h" #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 enum
{ {
EXTENDED_CLICKED, EXTENDED_CLICKED,
@ -53,6 +64,14 @@ gimp_button_class_init (GimpButtonClass *klass)
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass); GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
GtkButtonClass *button_class = GTK_BUTTON_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] = button_signals[EXTENDED_CLICKED] =
g_signal_new ("extended-clicked", g_signal_new ("extended-clicked",
G_TYPE_FROM_CLASS (klass), G_TYPE_FROM_CLASS (klass),

2
libgimpwidgets/gimpbutton.h
View File

@ -49,7 +49,7 @@ struct _GimpButtonClass
{ {
GtkButtonClass parent_class; GtkButtonClass parent_class;
void (* extended_clicked) (GimpButton *preview, void (* extended_clicked) (GimpButton *button,
GdkModifierType modifier_state); GdkModifierType modifier_state);
/* Padding for future expansion */ /* Padding for future expansion */

10
libgimpwidgets/gimpcairo-utils.c
View File

@ -31,6 +31,16 @@
#include "gimpcairo-utils.h" #include "gimpcairo-utils.h"
/**
* 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: * gimp_cairo_set_source_rgb:
* @cr: Cairo context * @cr: Cairo context

9
libgimpwidgets/gimpcellrenderercolor.c
View File

@ -32,6 +32,15 @@
#include "gimpcellrenderercolor.h" #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 #define DEFAULT_ICON_SIZE GTK_ICON_SIZE_MENU

10
libgimpwidgets/gimpcellrenderertoggle.c
View File

@ -29,6 +29,16 @@
#include "gimpcellrenderertoggle.h" #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 #define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON

22
libgimpwidgets/gimpchainbutton.c
View File

@ -29,6 +29,28 @@
#include "gimpstock.h" #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 enum
{ {
PROP_0, PROP_0,

10
libgimpwidgets/gimpcolorarea.c
View File

@ -31,6 +31,16 @@
#include "gimpcolorarea.h" #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_PREVIEW_SIZE 32
#define DRAG_ICON_OFFSET -8 #define DRAG_ICON_OFFSET -8

16
libgimpwidgets/gimpcolorbutton.c
View File

@ -41,6 +41,22 @@
#include "libgimp/libgimp-intl.h" #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 COLOR_SELECTION_KEY "gimp-color-selection"
#define RESPONSE_RESET 1 #define RESPONSE_RESET 1

11
libgimpwidgets/gimpcolordisplay.c
View File

@ -37,6 +37,17 @@
#include "gimpcolordisplay.h" #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 enum
{ {
PROP_0, PROP_0,

10
libgimpwidgets/gimpcolordisplaystack.c
View File

@ -32,6 +32,16 @@
#include "gimpwidgetsmarshal.h" #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 enum
{ {
CHANGED, CHANGED,

9
libgimpwidgets/gimpcolorhexentry.c
View File

@ -34,6 +34,15 @@
#include "gimpcolorhexentry.h" #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 enum
{ {
COLOR_CHANGED, COLOR_CHANGED,

11
libgimpwidgets/gimpcolornotebook.c
View File

@ -37,6 +37,17 @@
#include "libgimp/libgimp-intl.h" #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_BORDER 0
#define DEFAULT_TAB_ICON_SIZE GTK_ICON_SIZE_BUTTON #define DEFAULT_TAB_ICON_SIZE GTK_ICON_SIZE_BUTTON

9
libgimpwidgets/gimpcolorprofilecombobox.c
View File

@ -30,6 +30,15 @@
#include "gimpcolorprofilestore-private.h" #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 enum
{ {
PROP_0, PROP_0,

9
libgimpwidgets/gimpcolorprofilestore.c
View File

@ -36,6 +36,15 @@
#include "libgimp/libgimp-intl.h" #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 #define HISTORY_SIZE 8
enum enum

9
libgimpwidgets/gimpcolorscale.c
View File

@ -34,6 +34,15 @@
#include "gimpcolorscale.h" #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_destroy (GtkObject *object);
static void gimp_color_scale_size_allocate (GtkWidget *widget, static void gimp_color_scale_size_allocate (GtkWidget *widget,
GtkAllocation *allocation); GtkAllocation *allocation);

11
libgimpwidgets/gimpcolorscales.c
View File

@ -41,6 +41,17 @@
#include "libgimp/libgimp-intl.h" #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_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_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)) #define GIMP_COLOR_SCALES_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_COLOR_SCALES, GimpColorScalesClass))

14
libgimpwidgets/gimpcolorselect.c
View File

@ -41,6 +41,20 @@
#include "libgimp/libgimp-intl.h" #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 | \ #define COLOR_AREA_EVENT_MASK (GDK_EXPOSURE_MASK | \
GDK_BUTTON_PRESS_MASK | \ GDK_BUTTON_PRESS_MASK | \
GDK_BUTTON_RELEASE_MASK | \ GDK_BUTTON_RELEASE_MASK | \

9
libgimpwidgets/gimpcolorselection.c
View File

@ -43,6 +43,15 @@
#include "libgimp/libgimp-intl.h" #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 #define COLOR_AREA_SIZE 20

11
libgimpwidgets/gimpcolorselector.c
View File

@ -36,6 +36,17 @@
#include "gimpwidgetsmarshal.h" #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 enum
{ {
COLOR_CHANGED, COLOR_CHANGED,

17
libgimpwidgets/gimpcolorselector.h
View File

@ -31,8 +31,21 @@ G_BEGIN_DECLS
/* For information look at the html documentation */ /* 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 ()) #define GIMP_TYPE_COLOR_SELECTOR (gimp_color_selector_get_type ())

10
libgimpwidgets/gimpcontroller.c
View File

@ -34,6 +34,16 @@
#include "gimpcontroller.h" #include "gimpcontroller.h"
#include "gimpstock.h" #include "gimpstock.h"
/**
* SECTION: gimpcontroller
* @title: GimpController
* @short_description: Pluggable GIMP input controller modules.
*
* An abstract interface for implementing arbitrary input controllers.
**/
enum enum
{ {
PROP_0, PROP_0,

11
libgimpwidgets/gimpdialog.c
View File

@ -29,6 +29,17 @@
#include "gimphelpui.h" #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 enum
{ {
PROP_0, PROP_0,

9
libgimpwidgets/gimpenumcombobox.c
View File

@ -31,6 +31,15 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
PROP_0, PROP_0,

9
libgimpwidgets/gimpenumlabel.c
View File

@ -30,6 +30,15 @@
#include "gimpenumlabel.h" #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); static void gimp_enum_label_finalize (GObject *object);

9
libgimpwidgets/gimpenumstore.c
View File

@ -30,6 +30,15 @@
#include "gimpenumstore.h" #include "gimpenumstore.h"
/**
* SECTION: gimpenumstore
* @title: GimpEnumStore
* @short_description: A #GimpIntStore subclass that keeps enum values.
*
* A #GimpIntStore subclass that keeps enum values.
**/
enum enum
{ {
PROP_0, PROP_0,

10
libgimpwidgets/gimpenumwidgets.c
View File

@ -32,6 +32,16 @@
#include "gimphelpui.h" #include "gimphelpui.h"
/**
* 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: * gimp_enum_radio_box_new:
* @enum_type: the #GType of an enum. * @enum_type: the #GType of an enum.

24
libgimpwidgets/gimpfileentry.c
View File

@ -35,6 +35,30 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
FILENAME_CHANGED, FILENAME_CHANGED,

10
libgimpwidgets/gimpframe.c
View File

@ -32,6 +32,16 @@
#include "gimpframe.h" #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_SPACING 6
#define DEFAULT_LABEL_BOLD TRUE #define DEFAULT_LABEL_BOLD TRUE

11
libgimpwidgets/gimphelpui.c
View File

@ -30,6 +30,17 @@
#include "libgimp/libgimp-intl.h" #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 typedef enum
{ {
GIMP_WIDGET_HELP_TYPE_HELP = 0xff GIMP_WIDGET_HELP_TYPE_HELP = 0xff

7
libgimpwidgets/gimphelpui.h
View File

@ -55,6 +55,13 @@ void gimp_help_set_help_data_with_markup (GtkWidget *widget,
void gimp_context_help (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 ()) #define GIMP_HELP_ID (gimp_help_id_quark ())
GQuark gimp_help_id_quark (void) G_GNUC_CONST; GQuark gimp_help_id_quark (void) G_GNUC_CONST;

9
libgimpwidgets/gimphintbox.c
View File

@ -26,6 +26,15 @@
#include "gimpwidgets.h" #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 GtkHBoxClass GimpHintBoxClass;
typedef struct typedef struct

10
libgimpwidgets/gimpintcombobox.c
View File

@ -31,6 +31,16 @@
#include "gimpintstore.h" #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 enum
{ {
PROP_0, PROP_0,

10
libgimpwidgets/gimpintstore.c
View File

@ -32,6 +32,16 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
PROP_0, PROP_0,

12
libgimpwidgets/gimpmemsizeentry.c
View File

@ -31,6 +31,18 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
VALUE_CHANGED, VALUE_CHANGED,

1
libgimpwidgets/gimpmemsizeentry.h
View File

@ -39,6 +39,7 @@ struct _GimpMemsizeEntry
{ {
GtkHBox parent_instance; GtkHBox parent_instance;
/*< private >*/
guint64 value; guint64 value;
guint64 lower; guint64 lower;
guint64 upper; guint64 upper;

9
libgimpwidgets/gimpnumberpairentry.c
View File

@ -36,6 +36,15 @@
#include "gimpnumberpairentry.h" #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 #define EPSILON 0.000001

9
libgimpwidgets/gimpoffsetarea.c
View File

@ -29,6 +29,15 @@
#include "gimpoffsetarea.h" #include "gimpoffsetarea.h"
/**
* SECTION: gimpoffsetarea
* @title: GimpOffsetArea
* @short_description: Widget to control image offsets.
*
* Widget to control image offsets.
**/
#define DRAWING_AREA_SIZE 200 #define DRAWING_AREA_SIZE 200

11
libgimpwidgets/gimpoldwidgets.c
View File

@ -33,6 +33,17 @@
#include "gimpoldwidgets.h" #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 * Widget Constructors
*/ */

10
libgimpwidgets/gimppageselector.c
View File

@ -36,6 +36,16 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
SELECTION_CHANGED, SELECTION_CHANGED,

21
libgimpwidgets/gimppatheditor.c
View File

@ -37,6 +37,27 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
PATH_CHANGED, PATH_CHANGED,

18
libgimpwidgets/gimppickbutton.c
View File

@ -32,6 +32,17 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
COLOR_PICKED, COLOR_PICKED,
@ -75,6 +86,13 @@ gimp_pick_button_class_init (GimpPickButtonClass* klass)
GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass); GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
GtkButtonClass *button_class = GTK_BUTTON_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] = pick_button_signals[COLOR_PICKED] =
g_signal_new ("color-picked", g_signal_new ("color-picked",
G_TYPE_FROM_CLASS (klass), G_TYPE_FROM_CLASS (klass),

18
libgimpwidgets/gimppixmap.c
View File

@ -34,6 +34,24 @@
#include "gimppixmap.h" #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_realize (GtkWidget *widget);
static void gimp_pixmap_create_from_xpm_d (GimpPixmap *pixmap); static void gimp_pixmap_create_from_xpm_d (GimpPixmap *pixmap);

11
libgimpwidgets/gimppreview.c
View File

@ -31,6 +31,17 @@
#include "libgimp/libgimp-intl.h" #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 DEFAULT_SIZE 200
#define PREVIEW_TIMEOUT 200 #define PREVIEW_TIMEOUT 200

10
libgimpwidgets/gimppreviewarea.c
View File

@ -31,6 +31,16 @@
#include "libgimp/libgimp-intl.h" #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 enum
{ {
PROP_0, PROP_0,

9
libgimpwidgets/gimppropwidgets.c
View File

@ -31,6 +31,15 @@
#include "libgimp/libgimp-intl.h" #include "libgimp/libgimp-intl.h"
/**
* SECTION: gimppropwidgets
* @title: GimpPropWidgets
* @short_description: Editable views on #GObject properties.
*
* Editable views on #GObject properties.
**/
/* utility function prototypes */ /* utility function prototypes */
static void set_param_spec (GObject *object, static void set_param_spec (GObject *object,

21
libgimpwidgets/gimpquerybox.c
View File

@ -36,6 +36,27 @@
#include "libgimp/libgimp-intl.h" #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 * String, integer, double and size query boxes
*/ */

49
libgimpwidgets/gimpquerybox.h
View File

@ -27,29 +27,76 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */ /* 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, typedef void (* GimpQueryStringCallback) (GtkWidget *query_box,
const gchar *string, const gchar *string,
gpointer data); 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, typedef void (* GimpQueryIntCallback) (GtkWidget *query_box,
gint value, gint value,
gpointer data); 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, typedef void (* GimpQueryDoubleCallback) (GtkWidget *query_box,
gdouble value, gdouble value,
gpointer data); 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, typedef void (* GimpQuerySizeCallback) (GtkWidget *query_box,
gdouble size, gdouble size,
GimpUnit unit, GimpUnit unit,
gpointer data); 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, typedef void (* GimpQueryBooleanCallback) (GtkWidget *query_box,
gboolean value, gboolean value,
gpointer data); 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), \ #define GIMP_QUERY_BOX_VBOX(qbox) g_object_get_data (G_OBJECT (qbox), \
"gimp-query-box-vbox") "gimp-query-box-vbox")

Some files were not shown because too many files have changed in this diff Show More