Commit c15dc68d authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

libgimp/gimpdrawablecombobox.c libgimp/gimpimagecombobox.c

2004-04-21  Sven Neumann  <sven@gimp.org>

	* libgimp/gimpdrawablecombobox.c
	* libgimp/gimpimagecombobox.c
	* libgimp/gimppixbuf.c
	* libgimpwidgets/gimpintcombobox.c
	* libgimpwidgets/gimpintstore.c: API documentation.
parent 7d965d42
2004-04-21 Sven Neumann <sven@gimp.org>
* libgimp/gimpdrawablecombobox.c
* libgimp/gimpimagecombobox.c
* libgimp/gimppixbuf.c
* libgimpwidgets/gimpintcombobox.c
* libgimpwidgets/gimpintstore.c: API documentation.
2004-04-21 Sven Neumann <sven@gimp.org>
* libgimpwidgets/gimpintcombobox.[ch]: added new functions
......
2004-04-21 Sven Neumann <sven@gimp.org>
* libgimp/libgimp-docs.sgml
* libgimp/libgimp-sections.txt
* libgimp/tmpl/gimpdrawablecombobox.sgml
* libgimp/tmpl/gimpimagecombobox.sgml
* libgimp/tmpl/gimppixbuf.sgml: added docs for new functions.
2004-04-21 Sven Neumann <sven@gimp.org>
* libgimpwidgets/libgimpwidgets-sections.txt
......
......@@ -68,6 +68,9 @@
<title>GIMP User Interface Library</title>
<xi:include href="xml/gimpui.xml" />
<xi:include href="xml/gimpexport.xml" />
<xi:include href="xml/gimpdrawablecombobox.xml" />
<xi:include href="xml/gimpimagecombobox.xml" />
<xi:include href="xml/gimppixbuf.xml" />
<xi:include href="xml/gimpmenu.xml" />
<xi:include href="xml/gimpbrushmenu.xml" />
<xi:include href="xml/gimpfontmenu.xml" />
......
......@@ -622,6 +622,27 @@ gimp_image_undo_freeze
gimp_image_undo_thaw
</SECTION>
<SECTION>
<FILE>gimppixbuf</FILE>
GimpPixbufTransparency
gimp_image_get_thumbnail
gimp_drawable_get_thumbnail
</SECTION>
<SECTION>
<FILE>gimpdrawablecombobox</FILE>
GimpDrawableConstraintFunc
gimp_drawable_combo_box_new
gimp_channel_combo_box_new
gimp_layer_combo_box_new
</SECTION>
<SECTION>
<FILE>gimpimagecombobox</FILE>
GimpImageConstraintFunc
gimp_image_combo_box_new
</SECTION>
<SECTION>
<FILE>gimpmenu</FILE>
GimpConstraintFunc
......
<!-- ##### SECTION Title ##### -->
gimpdrawablecombobox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GimpDrawableConstraintFunc ##### -->
<para>
</para>
@image_id:
@drawable_id:
@data:
@Returns:
<!-- ##### FUNCTION gimp_drawable_combo_box_new ##### -->
<para>
</para>
@constraint:
@data:
@Returns:
<!-- ##### FUNCTION gimp_channel_combo_box_new ##### -->
<para>
</para>
@constraint:
@data:
@Returns:
<!-- ##### FUNCTION gimp_layer_combo_box_new ##### -->
<para>
</para>
@constraint:
@data:
@Returns:
<!-- ##### SECTION Title ##### -->
gimpimagecombobox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GimpImageConstraintFunc ##### -->
<para>
</para>
@image_id:
@data:
@Returns:
<!-- ##### FUNCTION gimp_image_combo_box_new ##### -->
<para>
</para>
@constraint:
@data:
@Returns:
<!-- ##### SECTION Title ##### -->
gimppixbuf
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GimpPixbufTransparency ##### -->
<para>
</para>
@GIMP_PIXBUF_KEEP_ALPHA:
@GIMP_PIXBUF_SMALL_CHECKS:
@GIMP_PIXBUF_LARGE_CHECKS:
<!-- ##### FUNCTION gimp_image_get_thumbnail ##### -->
<para>
</para>
@image_ID:
@width:
@height:
@alpha:
@Returns:
<!-- ##### FUNCTION gimp_drawable_get_thumbnail ##### -->
<para>
</para>
@drawable_ID:
@width:
@height:
@alpha:
@Returns:
......@@ -46,6 +46,24 @@ static gint gimp_drawable_combo_box_model_add (GtkListStore
static void gimp_drawable_combo_box_model_add_none (GtkListStore *store);
/**
* gimp_drawable_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* drawables. If a @constraint function is specified, it is called for
* each drawable and only if the function returns %TRUE, the drawable
* is added to the combobox.
*
* Use gimp_int_combo_box_set_active() to get the active drawable ID
* and gimp_int_combo_box_get_active() to retrieve the ID of the
* selected drawable.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_drawable_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......@@ -95,6 +113,18 @@ gimp_drawable_combo_box_new (GimpDrawableConstraintFunc constraint,
return combo_box;
}
/**
* gimp_channel_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* channels. See gimp_drawable_combo_box() for more info.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_channel_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......@@ -137,6 +167,18 @@ gimp_channel_combo_box_new (GimpDrawableConstraintFunc constraint,
return combo_box;
}
/**
* gimp_layer_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* layers. See gimp_drawable_combo_box() for more info.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_layer_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......
......@@ -45,6 +45,24 @@ static void gimp_image_combo_box_model_add (GtkListStore *store
static void gimp_image_combo_box_model_add_none (GtkListStore *store);
/**
* gimp_image_combo_box_new:
* @constraint: a #GimpImageConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* images. If a @constraint function is specified, it is called for
* each image and only if the function returns %TRUE, the image is
* added to the combobox.
*
* Use gimp_int_combo_box_set_active() to get the active image ID and
* gimp_int_combo_box_get_active() to retrieve the ID of the selected
* image.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_image_combo_box_new (GimpImageConstraintFunc constraint,
gpointer data)
......
......@@ -46,6 +46,24 @@ static gint gimp_drawable_combo_box_model_add (GtkListStore
static void gimp_drawable_combo_box_model_add_none (GtkListStore *store);
/**
* gimp_drawable_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* drawables. If a @constraint function is specified, it is called for
* each drawable and only if the function returns %TRUE, the drawable
* is added to the combobox.
*
* Use gimp_int_combo_box_set_active() to get the active drawable ID
* and gimp_int_combo_box_get_active() to retrieve the ID of the
* selected drawable.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_drawable_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......@@ -95,6 +113,18 @@ gimp_drawable_combo_box_new (GimpDrawableConstraintFunc constraint,
return combo_box;
}
/**
* gimp_channel_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* channels. See gimp_drawable_combo_box() for more info.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_channel_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......@@ -137,6 +167,18 @@ gimp_channel_combo_box_new (GimpDrawableConstraintFunc constraint,
return combo_box;
}
/**
* gimp_layer_combo_box_new:
* @constraint: a #GimpDrawableConstraintFunc or %NULL
* @data: a pointer that is passed to @constraint
*
* Creates a new #GimpIntComboBox filled with all currently opened
* layers. See gimp_drawable_combo_box() for more info.
*
* Return value: a new #GimpIntComboBox.
*
* Since: GIMP 2.2
**/
GtkWidget *
gimp_layer_combo_box_new (GimpDrawableConstraintFunc constraint,
gpointer data)
......
......@@ -36,6 +36,20 @@ static GdkPixbuf * gimp_pixbuf_from_data (guchar *data,
GimpPixbufTransparency alpha);
/**
* gimp_image_get_thumbnail:
* @image_ID: the image ID
* @width: the requested thumbnail width (<= 256 pixels)
* @height: the requested thumbnail height (<= 256 pixels)
* @alpha: how to handle an alpha channel
*
* Retrieves a thumbnail pixbuf for the image identified by @image_ID.
* The thumbnail will be not larger than the requested size.
*
* Return value: a new #GdkPixbuf
*
* Since: GIMP 2.2
**/
GdkPixbuf *
gimp_image_get_thumbnail (gint32 image_ID,
gint width,
......@@ -65,6 +79,21 @@ gimp_image_get_thumbnail (gint32 image_ID,
alpha);
}
/**
* gimp_drawable_get_thumbnail:
* @drawable_ID: the drawable ID
* @width: the requested thumbnail width (<= 256 pixels)
* @height: the requested thumbnail height (<= 256 pixels)
* @alpha: how to handle an alpha channel
*
* Retrieves a thumbnail pixbuf for the drawable identified by
* @drawable_ID. The thumbnail will be not larger than the requested
* size.
*
* Return value: a new #GdkPixbuf
*
* Since: GIMP 2.2
**/
GdkPixbuf *
gimp_drawable_get_thumbnail (gint32 drawable_ID,
gint width,
......
......@@ -227,6 +227,8 @@ gimp_int_combo_box_new_array (gint n_values,
* and calls gtk_list_store_set() for you.
*
* The column number must be taken from the enum #GimpIntStoreColumns.
*
* Since: GIMP 2.2
**/
void
gimp_int_combo_box_prepend (GimpIntComboBox *combo_box,
......@@ -258,6 +260,8 @@ gimp_int_combo_box_prepend (GimpIntComboBox *combo_box,
* and calls gtk_list_store_set() for you.
*
* The column number must be taken from the enum #GimpIntStoreColumns.
*
* Since: GIMP 2.2
**/
void
gimp_int_combo_box_append (GimpIntComboBox *combo_box,
......
......@@ -103,6 +103,8 @@ gimp_int_store_new (void)
*
* Return value: %TRUE if the value has been located and @iter is
* valid, %FALSE otherwise.
*
* Since: GIMP 2.2
**/
gboolean
gimp_int_store_lookup_by_value (GtkTreeModel *model,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment