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

configure.in devel-docs/Makefile.am devel-docs/libgimpcolor/*

Browse Source 
2001-05-04  Michael Natterer  <mitch@gimp.org>

	* configure.in
	* devel-docs/Makefile.am
	* devel-docs/libgimpcolor/*
	* devel-docs/libgimpmath/*
	* devel-docs/libgimpwidgets/*: added new gtk-doc modules for
	libgimpcolor, libgimpmath and libgimpwidgets. Moved existing
	documentation from the old files to the new templates.

	* devel-docs/libgimp/*: regenerated all files and removed the
	stuff which is in the new modules now.

	* libgimpwidgets/gimpcolorarea.c
	* libgimpwidgets/gimpcolorbutton.[ch]: some documentation fixes.

	* po-libgimp/Makefile.in.in
	* po-plug-ins/Makefile.in.in
	* po-script-fu/Makefile.in.in: updated.
This commit is contained in:
Michael Natterer
2001-05-04 20:39:29 +00:00
committed by Michael Natterer
parent f5f8acf34e
commit b4ad2ab05b
95 changed files with 4597 additions and 4709 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
devel-docs/libgimpwidgets/.cvsignore Normal file
View File

@ -0,0 +1,7 @@
Makefile
Makefile.in
libgimpwidgets.html
libgimpwidgets-decl-list.txt
libgimpwidgets-unused.txt
html
sgml

91
devel-docs/libgimpwidgets/Makefile.am Normal file
View File

@ -0,0 +1,91 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libgimpwidgets
# The top-level SGML file.
DOC_MAIN_SGML_FILE=libgimpwidgets-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/libgimpwidgets
CFLAGS=`gimptool-1.4 --cflags`
LDFLAGS=`gimptool-1.4 --libs`
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
libgimpwidgets_docdir = $(HTML_DIR)
EXTRA_DIST = \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).signals \
$(DOC_MODULE).types \
$(DOC_MODULE)-include.c \
$(DOC_MODULE)-decl.txt \
$(DOC_MODULE)-sections.txt
if ENABLE_GTK_DOC
html/index.html: sgml/libgimpwidgets-doc.bottom
$(MAKE) html
else
html/index.html:
endif
sgml/libgimpwidgets-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
scan:
-(cd $(srcdir) \
&& env \
CFLAGS="$(CFLAGS)" \
CPPFLAGS="$(CPPFLAGS)" \
LDFLAGS="$(LDFLAGS)" \
gtkdoc-scanobj --module=$(DOC_MODULE) \
&& gtkdoc-scan \
--module=$(DOC_MODULE) \
--source-dir=$(DOC_SOURCE_DIR))
templates: scan
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *-unused.txt
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/index.sgml $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
.PHONY : html sgml templates scan

893
devel-docs/libgimpwidgets/libgimpwidgets-decl.txt Normal file
View File

@ -0,0 +1,893 @@
<MACRO>
<NAME>GIMP_TYPE_CHAIN_BUTTON</NAME>
#define GIMP_TYPE_CHAIN_BUTTON (gimp_chain_button_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_CHAIN_BUTTON</NAME>
#define GIMP_CHAIN_BUTTON(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_CHAIN_BUTTON, GimpChainButton))
</MACRO>
<MACRO>
<NAME>GIMP_CHAIN_BUTTON_CLASS</NAME>
#define GIMP_CHAIN_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_CHAIN_BUTTON, GimpChainButtonClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_CHAIN_BUTTON</NAME>
#define GIMP_IS_CHAIN_BUTTON(obj) (GTK_CHECK_TYPE ((obj), GIMP_TYPE_CHAIN_BUTTON))
</MACRO>
<MACRO>
<NAME>GIMP_IS_CHAIN_BUTTON_CLASS</NAME>
#define GIMP_IS_CHAIN_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_CHAIN_BUTTON))
</MACRO>
<STRUCT>
<NAME>GimpChainButton</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpChainButtonClass</NAME>
</STRUCT>
<ENUM>
<NAME>GimpChainPosition</NAME>
typedef enum
{
GIMP_CHAIN_TOP,
GIMP_CHAIN_LEFT,
GIMP_CHAIN_BOTTOM,
GIMP_CHAIN_RIGHT
} GimpChainPosition;
</ENUM>
<STRUCT>
<NAME>GimpChainButton</NAME>
struct GimpChainButton
{
GtkTable table;
GimpChainPosition position;
GtkWidget *button;
GtkWidget *line1;
GtkWidget *line2;
GtkWidget *pixmap;
GdkPixmap *broken;
GdkBitmap *broken_mask;
GdkPixmap *chain;
GdkBitmap *chain_mask;
gboolean active;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_chain_button_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_chain_button_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
GimpChainPosition position
</FUNCTION>
<FUNCTION>
<NAME>gimp_chain_button_set_active</NAME>
<RETURNS>void </RETURNS>
GimpChainButton *gcb,gboolean is_active
</FUNCTION>
<FUNCTION>
<NAME>gimp_chain_button_get_active</NAME>
<RETURNS>gboolean </RETURNS>
GimpChainButton *gcb
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_COLOR_AREA</NAME>
#define GIMP_TYPE_COLOR_AREA (gimp_color_area_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_COLOR_AREA</NAME>
#define GIMP_COLOR_AREA(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_COLOR_AREA, GimpColorArea))
</MACRO>
<MACRO>
<NAME>GIMP_COLOR_AREA_CLASS</NAME>
#define GIMP_COLOR_AREA_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_COLOR_AREA, GimpColorAreaClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_COLOR_AREA</NAME>
#define GIMP_IS_COLOR_AREA(obj) (GTK_CHECK_TYPE ((obj), GIMP_TYPE_COLOR_AREA))
</MACRO>
<MACRO>
<NAME>GIMP_IS_COLOR_AREA_CLASS</NAME>
#define GIMP_IS_COLOR_AREA_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_COLOR_AREA))
</MACRO>
<ENUM>
<NAME>GimpColorAreaType</NAME>
typedef enum
{
GIMP_COLOR_AREA_FLAT = 0,
GIMP_COLOR_AREA_SMALL_CHECKS,
GIMP_COLOR_AREA_LARGE_CHECKS
} GimpColorAreaType;
</ENUM>
<STRUCT>
<NAME>GimpColorAreaClass</NAME>
</STRUCT>
<FUNCTION>
<NAME>gimp_color_area_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_area_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const GimpRGB *color,GimpColorAreaType type,GdkModifierType drag_mask
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_area_set_color</NAME>
<RETURNS>void </RETURNS>
GimpColorArea *gca,const GimpRGB *color
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_area_get_color</NAME>
<RETURNS>void </RETURNS>
GimpColorArea *gca,GimpRGB *color
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_area_has_alpha</NAME>
<RETURNS>gboolean </RETURNS>
GimpColorArea *gca
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_area_set_type</NAME>
<RETURNS>void </RETURNS>
GimpColorArea *gca,GimpColorAreaType type
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_COLOR_BUTTON</NAME>
#define GIMP_TYPE_COLOR_BUTTON (gimp_color_button_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_COLOR_BUTTON</NAME>
#define GIMP_COLOR_BUTTON(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_COLOR_BUTTON, GimpColorButton))
</MACRO>
<MACRO>
<NAME>GIMP_COLOR_BUTTON_CLASS</NAME>
#define GIMP_COLOR_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_COLOR_BUTTON, GimpColorButtonClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_COLOR_BUTTON</NAME>
#define GIMP_IS_COLOR_BUTTON(obj) (GTK_CHECK_TYPE ((obj), GIMP_TYPE_COLOR_BUTTON))
</MACRO>
<MACRO>
<NAME>GIMP_IS_COLOR_BUTTON_CLASS</NAME>
#define GIMP_IS_COLOR_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_COLOR_BUTTON))
</MACRO>
<STRUCT>
<NAME>GimpColorButtonClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpColorButton</NAME>
struct GimpColorButton
{
GtkButton button;
gchar *title;
GtkWidget *color_area;
GtkWidget *dialog;
GtkItemFactory *item_factory;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_color_button_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_button_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,gint width,gint height,const GimpRGB *color,GimpColorAreaType type
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_button_set_color</NAME>
<RETURNS>void </RETURNS>
GimpColorButton *gcb,const GimpRGB *color
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_button_get_color</NAME>
<RETURNS>void </RETURNS>
GimpColorButton *gcb,GimpRGB *color
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_button_has_alpha</NAME>
<RETURNS>gboolean </RETURNS>
GimpColorButton *gcb
</FUNCTION>
<FUNCTION>
<NAME>gimp_color_button_set_type</NAME>
<RETURNS>void </RETURNS>
GimpColorButton *gcb,GimpColorAreaType alpha
</FUNCTION>
<FUNCTION>
<NAME>gimp_dialog_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,const gchar *wmclass_name,GimpHelpFunc help_func,const gchar *help_data,GtkWindowPosition position,gint allow_shrink,gint allow_grow,gint auto_shrink,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_dialog_newv</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,const gchar *wmclass_name,GimpHelpFunc help_func,const gchar *help_data,GtkWindowPosition position,gint allow_shrink,gint allow_grow,gint auto_shrink,va_list args
</FUNCTION>
<FUNCTION>
<NAME>gimp_dialog_set_icon</NAME>
<RETURNS>void </RETURNS>
GtkWindow *dialog
</FUNCTION>
<FUNCTION>
<NAME>gimp_dialog_create_action_area</NAME>
<RETURNS>void </RETURNS>
GtkDialog *dialog,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_dialog_create_action_areav</NAME>
<RETURNS>void </RETURNS>
GtkDialog *dialog,va_list args
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_FILE_SELECTION</NAME>
#define GIMP_TYPE_FILE_SELECTION (gimp_file_selection_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_FILE_SELECTION</NAME>
#define GIMP_FILE_SELECTION(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_FILE_SELECTION, GimpFileSelection))
</MACRO>
<MACRO>
<NAME>GIMP_FILE_SELECTION_CLASS</NAME>
#define GIMP_FILE_SELECTION_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_FILE_SELECTION, GimpFileSelectionClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_FILE_SELECTION</NAME>
#define GIMP_IS_FILE_SELECTION(obj) (GTK_CHECK_TYPE (obj, GIMP_TYPE_FILE_SELECTION))
</MACRO>
<MACRO>
<NAME>GIMP_IS_FILE_SELECTION_CLASS</NAME>
#define GIMP_IS_FILE_SELECTION_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_FILE_SELECTION))
</MACRO>
<STRUCT>
<NAME>GimpFileSelection</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpFileSelectionClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpFileSelection</NAME>
struct GimpFileSelection
{
GtkHBox hbox;
GtkWidget *file_exists;
GtkWidget *entry;
GtkWidget *browse_button;
GtkWidget *file_selection;
GdkPixmap *yes_pixmap;
GdkBitmap *yes_mask;
GdkPixmap *no_pixmap;
GdkBitmap *no_mask;
gchar *title;
gboolean dir_only;
gboolean check_valid;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_file_selection_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_file_selection_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,const gchar *filename,gboolean dir_only,gboolean check_valid
</FUNCTION>
<FUNCTION>
<NAME>gimp_file_selection_get_filename</NAME>
<RETURNS>gchar *</RETURNS>
GimpFileSelection *gfs
</FUNCTION>
<FUNCTION>
<NAME>gimp_file_selection_set_filename</NAME>
<RETURNS>void </RETURNS>
GimpFileSelection *gfs,const gchar *filename
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_init</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_free</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_enable_tooltips</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_disable_tooltips</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_standard_help_func</NAME>
<RETURNS>void </RETURNS>
const gchar *help_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_connect_help_accel</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,GimpHelpFunc help_func,const gchar *help_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_help_set_help_data</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,const gchar *tooltip,const gchar *help_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_context_help</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_PATH_EDITOR</NAME>
#define GIMP_TYPE_PATH_EDITOR (gimp_path_editor_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_PATH_EDITOR</NAME>
#define GIMP_PATH_EDITOR(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_PATH_EDITOR, GimpPathEditor))
</MACRO>
<MACRO>
<NAME>GIMP_PATH_EDITOR_CLASS</NAME>
#define GIMP_PATH_EDITOR_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_PATH_EDITOR, GimpPathEditorClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_PATH_EDITOR</NAME>
#define GIMP_IS_PATH_EDITOR(obj) (GTK_CHECK_TYPE (obj, GIMP_TYPE_PATH_EDITOR))
</MACRO>
<MACRO>
<NAME>GIMP_IS_PATH_EDITOR_CLASS</NAME>
#define GIMP_IS_PATH_EDITOR_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_PATH_EDITOR))
</MACRO>
<STRUCT>
<NAME>GimpPathEditorClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpPathEditor</NAME>
struct GimpPathEditor
{
GtkVBox vbox;
GtkWidget *upper_hbox;
GtkWidget *new_button;
GtkWidget *up_button;
GtkWidget *down_button;
GtkWidget *delete_button;
GtkWidget *file_selection;
GtkWidget *dir_list;
GtkWidget *selected_item;
gint number_of_items;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_path_editor_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_editor_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *filesel_title,const gchar *path
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_editor_get_path</NAME>
<RETURNS>gchar *</RETURNS>
GimpPathEditor *gpe
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_PIXMAP</NAME>
#define GIMP_TYPE_PIXMAP (gimp_pixmap_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_PIXMAP</NAME>
#define GIMP_PIXMAP(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_PIXMAP, GimpPixmap))
</MACRO>
<MACRO>
<NAME>GIMP_PIXMAP_CLASS</NAME>
#define GIMP_PIXMAP_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_PIXMAP, GimpPixmapClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_PIXMAP</NAME>
#define GIMP_IS_PIXMAP(obj) (GTK_CHECK_TYPE ((obj), GIMP_TYPE_PIXMAP))
</MACRO>
<MACRO>
<NAME>GIMP_IS_PIXMAP_CLASS</NAME>
#define GIMP_IS_PIXMAP_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_PIXMAP))
</MACRO>
<STRUCT>
<NAME>GimpPixmap</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpPixmapClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpPixmap</NAME>
struct GimpPixmap
{
GtkPixmap pixmap;
gchar **xpm_data;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_pixmap_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_pixmap_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gchar **xpm_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_pixmap_set</NAME>
<RETURNS>void </RETURNS>
GimpPixmap *pixmap,gchar **xpm_data
</FUNCTION>
<USER_FUNCTION>
<NAME>GimpQueryStringCallback</NAME>
<RETURNS>void </RETURNS>
GtkWidget *query_box,
gchar *string,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpQueryIntCallback</NAME>
<RETURNS>void </RETURNS>
GtkWidget *query_box,
gint value,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpQueryDoubleCallback</NAME>
<RETURNS>void </RETURNS>
GtkWidget *query_box,
gdouble value,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpQuerySizeCallback</NAME>
<RETURNS>void </RETURNS>
GtkWidget *query_box,
gdouble size,
GimpUnit unit,
gpointer data
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GimpQueryBooleanCallback</NAME>
<RETURNS>void </RETURNS>
GtkWidget *query_box,
gboolean value,
gpointer data
</USER_FUNCTION>
<FUNCTION>
<NAME>gimp_query_string_box</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,GimpHelpFunc help_func,const gchar *help_data,const gchar *message,const gchar *initial,GtkObject *object,const gchar *signal,GimpQueryStringCallback callback,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_query_int_box</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,GimpHelpFunc help_func,const gchar *help_data,const gchar *message,gint initial,gint lower,gint upper,GtkObject *object,const gchar *signal,GimpQueryIntCallback callback,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_query_double_box</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,GimpHelpFunc help_func,const gchar *help_data,const gchar *message,gdouble initial,gdouble lower,gdouble upper,gint digits,GtkObject *object,const gchar *signal,GimpQueryDoubleCallback callback,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_query_size_box</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,GimpHelpFunc help_func,const gchar *help_data,const gchar *message,gdouble initial,gdouble lower,gdouble upper,gint digits,GimpUnit unit,gdouble resolution,gboolean dot_for_dot,GtkObject *object,const gchar *signal,GimpQuerySizeCallback callback,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_query_boolean_box</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *title,GimpHelpFunc help_func,const gchar *help_data,gboolean eek,const gchar *message,const gchar *true_button,const gchar *false_button,GtkObject *object,const gchar *signal,GimpQueryBooleanCallback callback,gpointer data
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_SIZE_ENTRY</NAME>
#define GIMP_TYPE_SIZE_ENTRY (gimp_size_entry_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_SIZE_ENTRY</NAME>
#define GIMP_SIZE_ENTRY(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_SIZE_ENTRY, GimpSizeEntry))
</MACRO>
<MACRO>
<NAME>GIMP_SIZE_ENTRY_CLASS</NAME>
#define GIMP_SIZE_ENTRY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_SIZE_ENTRY, GimpSizeEntryClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_SIZE_ENTRY</NAME>
#define GIMP_IS_SIZE_ENTRY(obj) (GTK_CHECK_TYPE (obj, GIMP_TYPE_SIZE_ENTRY))
</MACRO>
<MACRO>
<NAME>GIMP_IS_SIZE_ENTRY_CLASS</NAME>
#define GIMP_IS_SIZE_ENTRY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_SIZE_ENTRY))
</MACRO>
<STRUCT>
<NAME>GimpSizeEntryClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpSizeEntryField</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpSizeEntry</NAME>
struct GimpSizeEntry
{
GtkTable table;
GSList *fields;
gint number_of_fields;
GtkWidget *unitmenu;
GimpUnit unit;
gboolean menu_show_pixels;
gboolean menu_show_percent;
gboolean show_refval;
GimpSizeEntryUpdatePolicy update_policy;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_size_entry_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gint number_of_fields,GimpUnit unit,const gchar *unit_format,gboolean menu_show_pixels,gboolean menu_show_percent,gboolean show_refval,gint spinbutton_usize,GimpSizeEntryUpdatePolicy update_policy
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_add_field</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,GtkSpinButton *value_spinbutton,GtkSpinButton *refval_spinbutton
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_attach_label</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,const gchar *text,gint row,gint column,gfloat alignment
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_resolution</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble resolution,gboolean keep_size
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_size</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble lower,gdouble upper
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_value_boundaries</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble lower,gdouble upper
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_get_value</NAME>
<RETURNS>gdouble </RETURNS>
GimpSizeEntry *gse,gint field
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_value</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble value
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_refval_boundaries</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble lower,gdouble upper
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_refval_digits</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gint digits
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_get_refval</NAME>
<RETURNS>gdouble </RETURNS>
GimpSizeEntry *gse,gint field
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_refval</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,gint field,gdouble refval
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_get_unit</NAME>
<RETURNS>GimpUnit </RETURNS>
GimpSizeEntry *gse
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_set_unit</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse,GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_size_entry_grab_focus</NAME>
<RETURNS>void </RETURNS>
GimpSizeEntry *gse
</FUNCTION>
<MACRO>
<NAME>GIMP_TYPE_UNIT_MENU</NAME>
#define GIMP_TYPE_UNIT_MENU (gimp_unit_menu_get_type ())
</MACRO>
<MACRO>
<NAME>GIMP_UNIT_MENU</NAME>
#define GIMP_UNIT_MENU(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_UNIT_MENU, GimpUnitMenu))
</MACRO>
<MACRO>
<NAME>GIMP_UNIT_MENU_CLASS</NAME>
#define GIMP_UNIT_MENU_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_UNIT_MENU, GimpUnitMenuClass))
</MACRO>
<MACRO>
<NAME>GIMP_IS_UNIT_MENU</NAME>
#define GIMP_IS_UNIT_MENU(obj) (GTK_CHECK_TYPE (obj, GIMP_TYPE_UNIT_MENU))
</MACRO>
<MACRO>
<NAME>GIMP_IS_UNIT_MENU_CLASS</NAME>
#define GIMP_IS_UNIT_MENU_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_UNIT_MENU))
</MACRO>
<STRUCT>
<NAME>GimpUnitMenuClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpUnitMenu</NAME>
struct GimpUnitMenu
{
GtkOptionMenu optionmenu;
/* public (read only) */
gchar *format;
GimpUnit unit;
gboolean show_pixels;
gboolean show_percent;
/* private */
GtkWidget *selection;
GtkWidget *clist;
};
</STRUCT>
<FUNCTION>
<NAME>gimp_unit_menu_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_menu_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
const gchar *format,GimpUnit unit,gboolean show_pixels,gboolean show_percent,gboolean show_custom
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_menu_set_unit</NAME>
<RETURNS>void </RETURNS>
GimpUnitMenu *gum,GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_menu_get_unit</NAME>
<RETURNS>GimpUnit </RETURNS>
GimpUnitMenu *gum
</FUNCTION>
<FUNCTION>
<NAME>gimp_option_menu_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gboolean menu_only,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_option_menu_new2</NAME>
<RETURNS>GtkWidget *</RETURNS>
gboolean menu_only,GtkSignalFunc menu_item_callback,gpointer data,gpointer initial,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_option_menu_set_history</NAME>
<RETURNS>void </RETURNS>
GtkOptionMenu *option_menu,gpointer user_data
</FUNCTION>
<FUNCTION>
<NAME>gimp_radio_group_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gboolean in_frame,const gchar *frame_title,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_radio_group_new2</NAME>
<RETURNS>GtkWidget *</RETURNS>
gboolean in_frame,const gchar *frame_title,GtkSignalFunc radio_button_callback,gpointer data,gpointer initial,...
</FUNCTION>
<FUNCTION>
<NAME>gimp_spin_button_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
GtkObject **adjustment,gfloat value,gfloat lower,gfloat upper,gfloat step_increment,gfloat page_increment,gfloat page_size,gfloat climb_rate,guint digits
</FUNCTION>
<MACRO>
<NAME>GIMP_SCALE_ENTRY_LABEL</NAME>
#define GIMP_SCALE_ENTRY_LABEL(adj) \
GTK_LABEL (gtk_object_get_data (GTK_OBJECT(adj), "label"))
</MACRO>
<MACRO>
<NAME>GIMP_SCALE_ENTRY_SCALE</NAME>
#define GIMP_SCALE_ENTRY_SCALE(adj) \
GTK_HSCALE (gtk_object_get_data (GTK_OBJECT(adj), "scale"))
</MACRO>
<MACRO>
<NAME>GIMP_SCALE_ENTRY_SCALE_ADJ</NAME>
#define GIMP_SCALE_ENTRY_SCALE_ADJ(adj) \
gtk_range_get_adjustment \
(GTK_RANGE (gtk_object_get_data (GTK_OBJECT (adj), "scale")))
</MACRO>
<MACRO>
<NAME>GIMP_SCALE_ENTRY_SPINBUTTON</NAME>
#define GIMP_SCALE_ENTRY_SPINBUTTON(adj) \
GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT (adj), "spinbutton"))
</MACRO>
<MACRO>
<NAME>GIMP_SCALE_ENTRY_SPINBUTTON_ADJ</NAME>
#define GIMP_SCALE_ENTRY_SPINBUTTON_ADJ(adj) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT (adj), "spinbutton")))
</MACRO>
<FUNCTION>
<NAME>gimp_scale_entry_new</NAME>
<RETURNS>GtkObject *</RETURNS>
GtkTable *table,gint column,gint row,const gchar *text,gint scale_usize,gint spinbutton_usize,gfloat value,gfloat lower,gfloat upper,gfloat step_increment,gfloat page_increment,guint digits,gboolean constrain,gfloat unconstrained_lower,gfloat unconstrained_upper,const gchar *tooltip,const gchar *help_data
</FUNCTION>
<MACRO>
<NAME>GIMP_RANDOM_SEED_SPINBUTTON</NAME>
#define GIMP_RANDOM_SEED_SPINBUTTON(hbox) \
GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT( hbox), "spinbutton"))
</MACRO>
<MACRO>
<NAME>GIMP_RANDOM_SEED_SPINBUTTON_ADJ</NAME>
#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT (hbox), "spinbutton")))
</MACRO>
<MACRO>
<NAME>GIMP_RANDOM_SEED_TOGGLEBUTTON</NAME>
#define GIMP_RANDOM_SEED_TOGGLEBUTTON(hbox) \
GTK_TOGGLE_BUTTON (gtk_object_get_data (GTK_OBJECT (hbox), \
"togglebutton"))
</MACRO>
<FUNCTION>
<NAME>gimp_random_seed_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gint *seed,gint *use_time,gint time_true,gint time_false
</FUNCTION>
<MACRO>
<NAME>GIMP_COORDINATES_CHAINBUTTON</NAME>
#define GIMP_COORDINATES_CHAINBUTTON(sizeentry) \
GIMP_CHAIN_BUTTON (gtk_object_get_data (GTK_OBJECT (sizeentry), \
"chainbutton"))
</MACRO>
<FUNCTION>
<NAME>gimp_coordinates_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
GimpUnit unit,const gchar *unit_format,gboolean menu_show_pixels,gboolean menu_show_percent,gint spinbutton_usize,GimpSizeEntryUpdatePolicy update_policy,gboolean chainbutton_active,gboolean chain_constrains_ratio,const gchar *xlabel,gdouble x,gdouble xres,gdouble lower_boundary_x,gdouble upper_boundary_x,gdouble xsize_0,gdouble xsize_100,const gchar *ylabel,gdouble y,gdouble yres,gdouble lower_boundary_y,gdouble upper_boundary_y,gdouble ysize_0,gdouble ysize_100
</FUNCTION>
<MACRO>
<NAME>GIMP_MEM_SIZE_ENTRY_SPINBUTTON</NAME>
#define GIMP_MEM_SIZE_ENTRY_SPINBUTTON(memsize) \
GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT (memsize), \
"spinbutton"))
</MACRO>
<MACRO>
<NAME>GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ</NAME>
#define GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ(memsize) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (gtk_object_get_data (GTK_OBJECT (memsize), \
"spinbutton")))
</MACRO>
<MACRO>
<NAME>GIMP_MEM_SIZE_ENTRY_OPTIONMENU</NAME>
#define GIMP_MEM_SIZE_ENTRY_OPTIONMENU(memsize) \
GTK_OPTION_MENU (gtk_object_get_data (GTK_OBJECT (memsize), \
"optionmenu"))
</MACRO>
<FUNCTION>
<NAME>gimp_mem_size_entry_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
GtkAdjustment *adjustment
</FUNCTION>
<FUNCTION>
<NAME>gimp_pixmap_button_new</NAME>
<RETURNS>GtkWidget *</RETURNS>
gchar **xpm_data,const gchar *text
</FUNCTION>
<FUNCTION>
<NAME>gimp_toggle_button_sensitive_update</NAME>
<RETURNS>void </RETURNS>
GtkToggleButton *toggle_button
</FUNCTION>
<FUNCTION>
<NAME>gimp_toggle_button_update</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_radio_button_update</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_menu_item_update</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_int_adjustment_update</NAME>
<RETURNS>void </RETURNS>
GtkAdjustment *adjustment,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_uint_adjustment_update</NAME>
<RETURNS>void </RETURNS>
GtkAdjustment *adjustment,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_float_adjustment_update</NAME>
<RETURNS>void </RETURNS>
GtkAdjustment *adjustment,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_double_adjustment_update</NAME>
<RETURNS>void </RETURNS>
GtkAdjustment *adjustment,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_menu_update</NAME>
<RETURNS>void </RETURNS>
GtkWidget *widget,gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_table_attach_aligned</NAME>
<RETURNS>void </RETURNS>
GtkTable *table,gint column,gint row,const gchar *label_text,gfloat xalign,gfloat yalign,GtkWidget *widget,gint colspan,gboolean left_align
</FUNCTION>
<ENUM>
<NAME>GimpSizeEntryUpdatePolicy</NAME>
typedef enum
{
GIMP_SIZE_ENTRY_UPDATE_NONE = 0,
GIMP_SIZE_ENTRY_UPDATE_SIZE = 1,
GIMP_SIZE_ENTRY_UPDATE_RESOLUTION = 2
} GimpSizeEntryUpdatePolicy;
</ENUM>
<STRUCT>
<NAME>GimpColorArea</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpColorButton</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpPathEditor</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpSizeEntry</NAME>
</STRUCT>
<STRUCT>
<NAME>GimpUnitMenu</NAME>
</STRUCT>
<USER_FUNCTION>
<NAME>GimpHelpFunc</NAME>
<RETURNS>void </RETURNS>
const gchar *help_data
</USER_FUNCTION>

35
devel-docs/libgimpwidgets/libgimpwidgets-docs.sgml Normal file
View File

@ -0,0 +1,35 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity libgimpwidgets-gimpwidgetstypes SYSTEM "sgml/gimpwidgetstypes.sgml">
<!entity GimpChainButton SYSTEM "sgml/gimpchainbutton.sgml">
<!entity GimpColorButton SYSTEM "sgml/gimpcolorbutton.sgml">
<!entity GimpFileSelection SYSTEM "sgml/gimpfileselection.sgml">
<!entity GimpPathEditor SYSTEM "sgml/gimppatheditor.sgml">
<!entity GimpPixmap SYSTEM "sgml/gimppixmap.sgml">
<!entity GimpSizeEntry SYSTEM "sgml/gimpsizeentry.sgml">
<!entity GimpUnitMenu SYSTEM "sgml/gimpunitmenu.sgml">
<!entity libgimpwidgets-gimpdialog SYSTEM "sgml/gimpdialog.sgml">
<!entity libgimpwidgets-gimphelpui SYSTEM "sgml/gimphelpui.sgml">
<!entity libgimpwidgets-gimpquerybox SYSTEM "sgml/gimpquerybox.sgml">
<!entity libgimpwidgets-gimpwidgets SYSTEM "sgml/gimpwidgets.sgml">
]>
<book id="index">
<bookinfo>
<title>GIMP Widgets Library Reference Manual</title>
</bookinfo>
<chapter id="libgimpwidgets">
<title>GIMP Widgets Library</title>
&libgimpwidgets-gimpwidgetstypes;
&GimpChainButton;
&GimpColorButton;
&GimpFileSelection;
&GimpPathEditor;
&GimpPixmap;
&GimpSizeEntry;
&GimpUnitMenu;
&libgimpwidgets-gimpdialog;
&libgimpwidgets-gimphelpui;
&libgimpwidgets-gimpquerybox;
&libgimpwidgets-gimpwidgets;
</chapter>
</book>

15
devel-docs/libgimpwidgets/libgimpwidgets-include.c Normal file
View File

@ -0,0 +1,15 @@
/*
* gtk-doc can't build libgimpwidgets-scan.c without PLUG_IN_INFO being defined
* so we include this file as a workaround
*/
#include <glib.h>
#include <libgimp/gimp.h>
GimpPlugInInfo PLUG_IN_INFO =
{
NULL,
NULL,
NULL,
NULL,
};

223
devel-docs/libgimpwidgets/libgimpwidgets-sections.txt Normal file
View File

@ -0,0 +1,223 @@
<SECTION>
<FILE>gimpchainbutton</FILE>
GimpChainPosition
<TITLE>GimpChainButton</TITLE>
gimp_chain_button_new
gimp_chain_button_set_active
gimp_chain_button_get_active
<SUBSECTION Standard>
GIMP_CHAIN_BUTTON
GIMP_IS_CHAIN_BUTTON
GIMP_TYPE_CHAIN_BUTTON
gimp_chain_button_get_type
GIMP_CHAIN_BUTTON_CLASS
GIMP_IS_CHAIN_BUTTON_CLASS
</SECTION>
<SECTION>
<FILE>gimpcolorarea</FILE>
GimpColorAreaType
<TITLE>GimpColorArea</TITLE>
gimp_color_area_new
gimp_color_area_set_color
gimp_color_area_get_color
gimp_color_area_has_alpha
gimp_color_area_set_type
<SUBSECTION Standard>
GIMP_COLOR_AREA
GIMP_IS_COLOR_AREA
GIMP_TYPE_COLOR_AREA
gimp_color_area_get_type
GIMP_COLOR_AREA_CLASS
GIMP_IS_COLOR_AREA_CLASS
</SECTION>
<SECTION>
<FILE>gimpcolorbutton</FILE>
<TITLE>GimpColorButton</TITLE>
gimp_color_button_new
gimp_color_button_set_color
gimp_color_button_get_color
gimp_color_button_has_alpha
gimp_color_button_set_type
<SUBSECTION Standard>
GIMP_COLOR_BUTTON
GIMP_IS_COLOR_BUTTON
GIMP_TYPE_COLOR_BUTTON
gimp_color_button_get_type
GIMP_COLOR_BUTTON_CLASS
GIMP_IS_COLOR_BUTTON_CLASS
</SECTION>
<SECTION>
<FILE>gimpfileselection</FILE>
<TITLE>GimpFileSelection</TITLE>
gimp_file_selection_new
gimp_file_selection_get_filename
gimp_file_selection_set_filename
<SUBSECTION Standard>
GIMP_FILE_SELECTION
GIMP_IS_FILE_SELECTION
GIMP_TYPE_FILE_SELECTION
gimp_file_selection_get_type
GIMP_FILE_SELECTION_CLASS
GIMP_IS_FILE_SELECTION_CLASS
</SECTION>
<SECTION>
<FILE>gimppatheditor</FILE>
<TITLE>GimpPathEditor</TITLE>
gimp_path_editor_new
gimp_path_editor_get_path
<SUBSECTION Standard>
GIMP_PATH_EDITOR
GIMP_IS_PATH_EDITOR
GIMP_TYPE_PATH_EDITOR
gimp_path_editor_get_type
GIMP_PATH_EDITOR_CLASS
GIMP_IS_PATH_EDITOR_CLASS
</SECTION>
<SECTION>
<FILE>gimppixmap</FILE>
<TITLE>GimpPixmap</TITLE>
gimp_pixmap_new
gimp_pixmap_set
<SUBSECTION Standard>
GIMP_PIXMAP
GIMP_IS_PIXMAP
GIMP_TYPE_PIXMAP
gimp_pixmap_get_type
GIMP_PIXMAP_CLASS
GIMP_IS_PIXMAP_CLASS
</SECTION>
<SECTION>
<FILE>gimpsizeentry</FILE>
GimpSizeEntryField
<TITLE>GimpSizeEntry</TITLE>
gimp_size_entry_new
gimp_size_entry_add_field
gimp_size_entry_attach_label
gimp_size_entry_set_resolution
gimp_size_entry_set_size
gimp_size_entry_set_value_boundaries
gimp_size_entry_get_value
gimp_size_entry_set_value
gimp_size_entry_set_refval_boundaries
gimp_size_entry_set_refval_digits
gimp_size_entry_get_refval
gimp_size_entry_set_refval
gimp_size_entry_get_unit
gimp_size_entry_set_unit
gimp_size_entry_grab_focus
<SUBSECTION Standard>
GIMP_SIZE_ENTRY
GIMP_IS_SIZE_ENTRY
GIMP_TYPE_SIZE_ENTRY
gimp_size_entry_get_type
GIMP_SIZE_ENTRY_CLASS
GIMP_IS_SIZE_ENTRY_CLASS
</SECTION>
<SECTION>
<FILE>gimpunitmenu</FILE>
<TITLE>GimpUnitMenu</TITLE>
gimp_unit_menu_new
gimp_unit_menu_set_unit
gimp_unit_menu_get_unit
<SUBSECTION Standard>
GIMP_UNIT_MENU
GIMP_IS_UNIT_MENU
GIMP_TYPE_UNIT_MENU
gimp_unit_menu_get_type
GIMP_UNIT_MENU_CLASS
GIMP_IS_UNIT_MENU_CLASS
</SECTION>
<SECTION>
<FILE>gimpdialog</FILE>
gimp_dialog_new
gimp_dialog_newv
gimp_dialog_set_icon
gimp_dialog_create_action_area
gimp_dialog_create_action_areav
</SECTION>
<SECTION>
<FILE>gimphelpui</FILE>
gimp_help_init
gimp_help_free
gimp_help_enable_tooltips
gimp_help_disable_tooltips
gimp_standard_help_func
gimp_help_connect_help_accel
gimp_help_set_help_data
gimp_context_help
</SECTION>
<SECTION>
<FILE>gimpquerybox</FILE>
GimpQueryStringCallback
GimpQueryIntCallback
GimpQueryDoubleCallback
GimpQuerySizeCallback
GimpQueryBooleanCallback
gimp_query_string_box
gimp_query_int_box
gimp_query_double_box
gimp_query_size_box
gimp_query_boolean_box
</SECTION>
<SECTION>
<FILE>gimpwidgets</FILE>
gimp_option_menu_new
gimp_option_menu_new2
gimp_option_menu_set_history
gimp_radio_group_new
gimp_radio_group_new2
gimp_spin_button_new
GIMP_SCALE_ENTRY_LABEL
GIMP_SCALE_ENTRY_SCALE
GIMP_SCALE_ENTRY_SCALE_ADJ
GIMP_SCALE_ENTRY_SPINBUTTON
GIMP_SCALE_ENTRY_SPINBUTTON_ADJ
gimp_scale_entry_new
GIMP_RANDOM_SEED_SPINBUTTON
GIMP_RANDOM_SEED_SPINBUTTON_ADJ
GIMP_RANDOM_SEED_TOGGLEBUTTON
gimp_random_seed_new
GIMP_COORDINATES_CHAINBUTTON
gimp_coordinates_new
GIMP_MEM_SIZE_ENTRY_SPINBUTTON
GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ
GIMP_MEM_SIZE_ENTRY_OPTIONMENU
gimp_mem_size_entry_new
gimp_pixmap_button_new
gimp_toggle_button_sensitive_update
gimp_toggle_button_update
gimp_radio_button_update
gimp_menu_item_update
gimp_int_adjustment_update
gimp_uint_adjustment_update
gimp_float_adjustment_update
gimp_double_adjustment_update
gimp_unit_menu_update
gimp_table_attach_aligned
</SECTION>
<SECTION>
<FILE>gimpwidgetstypes</FILE>
GimpSizeEntryUpdatePolicy
GimpChainButton
GimpColorArea
GimpColorButton
GimpFileSelection
GimpPathEditor
GimpPixmap
GimpSizeEntry
GimpUnitMenu
GimpHelpFunc
</SECTION>

0
devel-docs/libgimpwidgets/libgimpwidgets.args Normal file
View File

19
devel-docs/libgimpwidgets/libgimpwidgets.hierarchy Normal file
View File

@ -0,0 +1,19 @@
GtkObject
GtkWidget
GtkContainer
GtkTable
GimpChainButton
GimpSizeEntry
GtkBin
GtkButton
GimpColorButton
GtkOptionMenu
GimpUnitMenu
GtkBox
GtkHBox
GimpFileSelection
GtkVBox
GimpPathEditor
GtkMisc
GtkPixmap
GimpPixmap

48
devel-docs/libgimpwidgets/libgimpwidgets.signals Normal file
View File

@ -0,0 +1,48 @@
<SIGNAL>
<NAME>GimpChainButton::toggled</NAME>
<RETURNS>void</RETURNS>
GimpChainButton *gimpchainbutton
</SIGNAL>
<SIGNAL>
<NAME>GimpColorButton::color-changed</NAME>
<RETURNS>void</RETURNS>
GimpColorButton *gimpcolorbutton
</SIGNAL>
<SIGNAL>
<NAME>GimpFileSelection::filename-changed</NAME>
<RETURNS>void</RETURNS>
GimpFileSelection *gimpfileselection
</SIGNAL>
<SIGNAL>
<NAME>GimpPathEditor::path-changed</NAME>
<RETURNS>void</RETURNS>
GimpPathEditor *gimppatheditor
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::value-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::refval-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpSizeEntry::unit-changed</NAME>
<RETURNS>void</RETURNS>
GimpSizeEntry *gimpsizeentry
</SIGNAL>
<SIGNAL>
<NAME>GimpUnitMenu::unit-changed</NAME>
<RETURNS>void</RETURNS>
GimpUnitMenu *gimpunitmenu
</SIGNAL>

12
devel-docs/libgimpwidgets/libgimpwidgets.types Normal file
View File

@ -0,0 +1,12 @@
#include <gtk/gtk.h>
#include <libgimp/gimp.h>
#include "libgimpwidgets-include.c"
gimp_chain_button_get_type
gimp_color_button_get_type
gimp_file_selection_get_type
gimp_path_editor_get_type
gimp_pixmap_get_type
gimp_size_entry_get_type
gimp_unit_menu_get_type

1
devel-docs/libgimpwidgets/tmpl/.cvsignore Normal file
View File

@ -0,0 +1 @@
libgimpwidgets-unused.sgml

72
devel-docs/libgimpwidgets/tmpl/gimpchainbutton.sgml Normal file
View File

@ -0,0 +1,72 @@
<!-- ##### 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>
<!-- ##### 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>
@gcb:
@is_active:
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
<para>
</para>
@gcb:
@Returns:
<!-- ##### SIGNAL GimpChainButton::toggled ##### -->
<para>
</para>
@gimpchainbutton: the object which received the signal.

72
devel-docs/libgimpwidgets/tmpl/gimpcolorarea.sgml Normal file
View File

@ -0,0 +1,72 @@
<!-- ##### SECTION Title ##### -->
GimpColorArea
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<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>
@gca:
@color:
<!-- ##### FUNCTION gimp_color_area_get_color ##### -->
<para>
</para>
@gca:
@color:
<!-- ##### FUNCTION gimp_color_area_has_alpha ##### -->
<para>
</para>
@gca:
@Returns:
<!-- ##### FUNCTION gimp_color_area_set_type ##### -->
<para>
</para>
@gca:
@type:

81
devel-docs/libgimpwidgets/tmpl/gimpcolorbutton.sgml Normal file
View File

@ -0,0 +1,81 @@
<!-- ##### SECTION Title ##### -->
GimpColorButton
<!-- ##### SECTION Short_Description ##### -->
Widget for selecting a color.
<!-- ##### 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>
<!-- ##### FUNCTION gimp_color_button_new ##### -->
<para>
</para>
@title:
@width:
@height:
@color:
@type:
@Returns:
<!-- # Unused Parameters # -->
@alpha:
<!-- ##### FUNCTION gimp_color_button_set_color ##### -->
<para>
</para>
@gcb:
@color:
<!-- ##### FUNCTION gimp_color_button_get_color ##### -->
<para>
</para>
@gcb:
@color:
<!-- ##### FUNCTION gimp_color_button_has_alpha ##### -->
<para>
</para>
@gcb:
@Returns:
<!-- ##### FUNCTION gimp_color_button_set_type ##### -->
<para>
</para>
@gcb:
@alpha:
<!-- ##### SIGNAL GimpColorButton::color-changed ##### -->
<para>
</para>
@gimpcolorbutton: the object which received the signal.

132
devel-docs/libgimpwidgets/tmpl/gimpdialog.sgml Normal file
View File

@ -0,0 +1,132 @@
<!-- ##### 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>
<!-- ##### FUNCTION gimp_dialog_new ##### -->
<para>
</para>
@title:
@wmclass_name:
@help_func:
@help_data:
@position:
@allow_shrink:
@allow_grow:
@auto_shrink:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_dialog_newv ##### -->
<para>
</para>
@title:
@wmclass_name:
@help_func:
@help_data:
@position:
@allow_shrink:
@allow_grow:
@auto_shrink:
@args:
@Returns:
<!-- ##### FUNCTION gimp_dialog_set_icon ##### -->
<para>
</para>
@dialog:
<!-- ##### FUNCTION gimp_dialog_create_action_area ##### -->
<para>
</para>
@dialog:
@Varargs:
<!-- ##### FUNCTION gimp_dialog_create_action_areav ##### -->
<para>
The @va_list describing the action_area #GtkButton's has the following format:
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
<tbody>
<row>
<entry>#gchar *label,</entry>
<entry>The button's label.</entry>
</row>
<row>
<entry>#GtkSignalFunc callback,</entry>
<entry>The callback which will be connected to the button's
"clicked" signal</entry>
</row>
<row>
<entry>#gpointer data,</entry>
<entry>The callback data which will be used in
gtk_signal_connect(). If you pass #NULL, then the dialog itself will
by passed as @data.</entry>
</row>
<row>
<entry>#GtkObject *slot_object,</entry>
<entry>If you pass a pointer other than #NULL, then the button's "clicked"
signal will be connected with gtk_signal_connect_object() instead of
gtk_signal_connect(). If you want the dialog itself to be the
@slot_object, pass "1".</entry>
</row>
<row>
<entry>#GtkWidget **widget_ptr,</entry>
<entry>A pointer to store the created button in.</entry>
</row>
<row>
<entry>#gboolean default_action,</entry>
<entry>#TRUE if this button should grab the default dialog action with
gtk_widget_grab_default().</entry>
</row>
<row>
<entry>#gboolean connect_delete,</entry>
<entry>#TRUE if the dialog's "delete_event" should be connected to
this button's callback. Usually you will connect to the dialog's
"Cancel" callback. Note that the callback will be called indirectly,
so you don't have to worry about the #GdkEvent pointer which comes
with the "delete_event", as it will be stripped away before your
"Cancel" callback is called.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@dialog:
@args:

70
devel-docs/libgimpwidgets/tmpl/gimpfileselection.sgml Normal file
View File

@ -0,0 +1,70 @@
<!-- ##### SECTION Title ##### -->
GimpFileSelection
<!-- ##### 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_selection_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>
<!-- ##### FUNCTION gimp_file_selection_new ##### -->
<para>
</para>
@title:
@filename:
@dir_only:
@check_valid:
@Returns:
<!-- ##### FUNCTION gimp_file_selection_get_filename ##### -->
<para>
</para>
@gfs:
@Returns:
<!-- ##### FUNCTION gimp_file_selection_set_filename ##### -->
<para>
</para>
@gfs:
@filename:
<!-- ##### SIGNAL GimpFileSelection::filename-changed ##### -->
<para>
This signal is emitted whenever the user changes the filename.
</para>
@gimpfileselection: the object which received the signal.

92
devel-docs/libgimpwidgets/tmpl/gimphelpui.sgml Normal file
View File

@ -0,0 +1,92 @@
<!-- ##### SECTION Title ##### -->
gimphelpui
<!-- ##### SECTION Short_Description ##### -->
Functions for setting #GtkTooltips and HTML links into the GIMP help
system.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_free ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_help_disable_tooltips ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_standard_help_func ##### -->
<para>
This is the standard GIMP help function which does nothing but calling
gimp_help(). Please use gimp_plugin_help_func() for your plug-in's
help links.
</para>
<para>
Currently, gimp_standard_help_func() and gimp_plugin_help_func() do
exactly the same. The latter one was introduced to ensure future
flexibility.
</para>
<para>
See #GimpHelpFunc for the naming conventions of HTML help files.
</para>
@help_data: A string containing the path to a HTML page.
<!-- ##### FUNCTION gimp_help_connect_help_accel ##### -->
<para>
</para>
@widget:
@help_func:
@help_data:
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
<para>
</para>
@widget:
@tooltip:
@help_data:
<!-- ##### FUNCTION gimp_context_help ##### -->
<para>
</para>

59
devel-docs/libgimpwidgets/tmpl/gimppatheditor.sgml Normal file
View File

@ -0,0 +1,59 @@
<!-- ##### 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
#GimpFileSelection 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>
#GimpFileSelection
</para>
<para>
#G_SEARCHPATH_SEPARATOR
</para>
<!-- ##### FUNCTION gimp_path_editor_new ##### -->
<para>
</para>
@filesel_title:
@path:
@Returns:
<!-- ##### FUNCTION gimp_path_editor_get_path ##### -->
<para>
</para>
@gpe:
@Returns:
<!-- ##### SIGNAL GimpPathEditor::path-changed ##### -->
<para>
This signal is emitted whenever the user adds, deletes, modifies or
reorders an element of the search path.
</para>
@gimppatheditor: the object which received the signal.

46
devel-docs/libgimpwidgets/tmpl/gimppixmap.sgml Normal file
View File

@ -0,0 +1,46 @@
<!-- ##### 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>
<!-- ##### FUNCTION gimp_pixmap_new ##### -->
<para>
</para>
@xpm_data:
@Returns:
<!-- ##### FUNCTION gimp_pixmap_set ##### -->
<para>
</para>
@pixmap:
@xpm_data:

179
devel-docs/libgimpwidgets/tmpl/gimpquerybox.sgml Normal file
View File

@ -0,0 +1,179 @@
<!-- ##### 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>
<!-- ##### 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:
@help_func:
@help_data:
@message:
@initial:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_int_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_double_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@digits:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_size_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@digits:
@unit:
@resolution:
@dot_for_dot:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_boolean_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@eek:
@message:
@true_button:
@false_button:
@object:
@signal:
@callback:
@data:
@Returns:

229
devel-docs/libgimpwidgets/tmpl/gimpsizeentry.sgml Normal file
View File

@ -0,0 +1,229 @@
<!-- ##### 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>
<!-- ##### STRUCT GimpSizeEntryField ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_size_entry_new ##### -->
<para>
</para>
@number_of_fields:
@unit:
@unit_format:
@menu_show_pixels:
@menu_show_percent:
@show_refval:
@spinbutton_usize:
@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:
<!-- ##### 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_grab_focus ##### -->
<para>
</para>
@gse:
<!-- ##### SIGNAL GimpSizeEntry::value-changed ##### -->
<para>
</para>
@gimpsizeentry: the object which received the signal.
<!-- ##### 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.

110
devel-docs/libgimpwidgets/tmpl/gimpunitmenu.sgml Normal file
View File

@ -0,0 +1,110 @@
<!-- ##### 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>
<!-- ##### FUNCTION gimp_unit_menu_new ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="1*"><colspec colwidth="8*">
<tbody>
<row>
<entry>% f</entry>
<entry>Factor (how many units make up an inch)</entry>
</row>
<row>
<entry>% y</entry>
<entry>Symbol (e.g. "''" for GIMP_UNIT_INCH)</entry>
</row>
<row>
<entry>% a</entry>
<entry>Abbreviation</entry>
</row>
<row>
<entry>% s</entry>
<entry>Singular</entry>
</row>
<row>
<entry>% p</entry>
<entry>Plural</entry>
</row>
<row>
<entry>%%</entry>
<entry>Literal percent</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@format:
@unit:
@show_pixels:
@show_percent:
@show_custom:
@Returns:
<!-- ##### FUNCTION gimp_unit_menu_set_unit ##### -->
<para>
</para>
@gum:
@unit:
<!-- ##### FUNCTION gimp_unit_menu_get_unit ##### -->
<para>
</para>
@gum:
@Returns:
<!-- ##### SIGNAL GimpUnitMenu::unit-changed ##### -->
<para>
This signal is emitted whenever the user selects a #GimpUnit from the
#GimpUnitMenu.
</para>
@gimpunitmenu: the object which received the signal.

497
devel-docs/libgimpwidgets/tmpl/gimpwidgets.sgml Normal file
View File

@ -0,0 +1,497 @@
<!-- ##### 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>
<!-- ##### FUNCTION gimp_option_menu_new ##### -->
<para>
The @va_list describing the #GtkMenuItem's has the following format:
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
<tbody>
<row>
<entry>#gchar *label,</entry>
<entry>The menu item's label.</entry>
</row>
<row>
<entry>#GtkSignalFunc callback,</entry>
<entry>The callback which will be connected to the menu item's
"activate" signal</entry>
</row>
<row>
<entry>#gpointer data,</entry>
<entry>The callback data which will be used in gtk_signal_connect().</entry>
</row>
<row>
<entry>#gpointer user_data,</entry>
<entry>The menu item's @user_data which will be set with
gtk_object_set_user_data().</entry>
</row>
<row>
<entry>#GtkWidget **widget_ptr,</entry>
<entry>A pointer to store the created menu item in.</entry>
</row>
<row>
<entry>#gboolean active,</entry>
<entry>#TRUE if this should be the initially selected menu item.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@menu_only:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_option_menu_new2 ##### -->
<para>
The @va_list describing the #GtkMenuItem's has the following format:
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
<tbody>
<row>
<entry>#gchar *label,</entry>
<entry>The menu item's label.</entry>
</row>
<row>
<entry>#gpointer user_data,</entry>
<entry>The menu item's @user_data which will be set with
gtk_object_set_user_data().</entry>
</row>
<row>
<entry>#GtkWidget **widget_ptr,</entry>
<entry>A pointer to store the created menu item in.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@menu_only:
@menu_item_callback:
@data:
@initial:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_option_menu_set_history ##### -->
<para>
</para>
@option_menu:
@user_data:
<!-- ##### FUNCTION gimp_radio_group_new ##### -->
<para>
The @va_list describing the #GtkRadioButton's has the following format:
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
<tbody>
<row>
<entry>#gchar *label,</entry>
<entry>The radio button's label.</entry>
</row>
<row>
<entry>#GtkSignalFunc callback,</entry>
<entry>The callback which will be connected to the radio button's
"toggled" signal</entry>
</row>
<row>
<entry>#gpointer data,</entry>
<entry>The callback data which will be used in gtk_signal_connect().</entry>
</row>
<row>
<entry>#gpointer user_data,</entry>
<entry>The radio button's @user_data which will be set with
gtk_object_set_user_data().</entry>
</row>
<row>
<entry>#GtkWidget **widget_ptr,</entry>
<entry>A pointer to store the created radio button in.</entry>
</row>
<row>
<entry>#gboolean active,</entry>
<entry>#TRUE if this should be the initially pressed radio button.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@in_frame:
@frame_title:
@Varargs:
@Returns:
<!-- ##### FUNCTION gimp_radio_group_new2 ##### -->
<para>
The @va_list describing the #GtkRadioButton's has the following format:
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
<tbody>
<row>
<entry>#gchar *label,</entry>
<entry>The radio button's label.</entry>
</row>
<row>
<entry>#gpointer user_data,</entry>
<entry>The radio button's @user_data which will be set with
gtk_object_set_user_data().</entry>
</row>
<row>
<entry>#GtkWidget **widget_ptr,</entry>
<entry>A pointer to store the created radio button in.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@in_frame:
@frame_title:
@radio_button_callback:
@data:
@initial:
@Varargs:
@Returns:
<!-- ##### 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_usize:
@spinbutton_usize:
@value:
@lower:
@upper:
@step_increment:
@page_increment:
@digits:
@constrain:
@unconstrained_lower:
@unconstrained_upper:
@tooltip:
@help_data:
@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_TOGGLEBUTTON ##### -->
<para>
Returns the random_seed's #GtkToggleButton.
</para>
@hbox: The #GtkHBox returned by gimp_random_seed_new().
<!-- ##### FUNCTION gimp_random_seed_new ##### -->
<para>
</para>
@seed:
@use_time:
@time_true:
@time_false:
@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_usize:
@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:
<!-- ##### MACRO GIMP_MEM_SIZE_ENTRY_SPINBUTTON ##### -->
<para>
</para>
@memsize:
<!-- ##### MACRO GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ ##### -->
<para>
</para>
@memsize:
<!-- ##### MACRO GIMP_MEM_SIZE_ENTRY_OPTIONMENU ##### -->
<para>
</para>
@memsize:
<!-- ##### FUNCTION gimp_mem_size_entry_new ##### -->
<para>
</para>
@adjustment:
@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_menu_item_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:

103
devel-docs/libgimpwidgets/tmpl/gimpwidgetstypes.sgml Normal file
View File

@ -0,0 +1,103 @@
<!-- ##### SECTION Title ##### -->
gimpwidgetstypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GimpSizeEntryUpdatePolicy ##### -->
<para>
</para>
@GIMP_SIZE_ENTRY_UPDATE_NONE:
@GIMP_SIZE_ENTRY_UPDATE_SIZE:
@GIMP_SIZE_ENTRY_UPDATE_RESOLUTION:
<!-- ##### STRUCT GimpChainButton ##### -->
<para>
</para>
<!-- ##### STRUCT GimpColorArea ##### -->
<para>
</para>
<!-- ##### STRUCT GimpColorButton ##### -->
<para>
</para>
<!-- ##### STRUCT GimpFileSelection ##### -->
<para>
</para>
<!-- ##### STRUCT GimpPathEditor ##### -->
<para>
</para>
<!-- ##### STRUCT GimpPixmap ##### -->
<para>
</para>
<!-- ##### STRUCT GimpSizeEntry ##### -->
<para>
</para>
<!-- ##### STRUCT GimpUnitMenu ##### -->
<para>
</para>
<!-- ##### 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>
Note that all help paths are relative to the root of the help system
in the current language. So if your language is "C", a help path of
"filters/foo_bar.html" will expand to
"${gimp_data_dir}/help/C/filters/foo_bar.html".
</para>
<para>
All these functions finally call gimp_help_connect_help_accel() which
does the work of installing the "F1" accelerator.
</para>
<para>
In most cases it will be ok to use gimp_plugin_help_func() which does
nothing but passing the @help_data 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_data: A string containing the path to a HTML page.