libgimp*: lots of doc fixes and new docs for structs and enums
(cherry picked from commit aca5f806c4
)
This commit is contained in:
@ -268,7 +268,7 @@ static gchar *pdb_error_message = NULL;
|
||||
* and the 'argc' and 'argv' that are passed to "main".
|
||||
*
|
||||
* Returns: an exit status as defined by the C library,
|
||||
* on success %EXIT_SUCCESS.
|
||||
* on success EXIT_SUCCESS.
|
||||
**/
|
||||
gint
|
||||
gimp_main (const GimpPlugInInfo *info,
|
||||
|
@ -313,8 +313,8 @@ gimp_brush_select_button_init (GimpBrushSelectButton *button)
|
||||
* @paint_mode: Initial paint mode. -1 means to use current paint mode.
|
||||
*
|
||||
* Creates a new #GtkWidget that completely controls the selection of
|
||||
* a #GimpBrush. This widget is suitable for placement in a table in
|
||||
* a plug-in dialog.
|
||||
* a brush. This widget is suitable for placement in a table in a
|
||||
* plug-in dialog.
|
||||
*
|
||||
* Returns: A #GtkWidget that you can use in your UI.
|
||||
*
|
||||
|
@ -31,6 +31,20 @@ G_BEGIN_DECLS
|
||||
/* For information look into the C source or the html documentation */
|
||||
|
||||
|
||||
/**
|
||||
* GimpExportCapabilities:
|
||||
* @GIMP_EXPORT_CAN_HANDLE_RGB: Handles RGB images
|
||||
* @GIMP_EXPORT_CAN_HANDLE_GRAY: Handles grayscale images
|
||||
* @GIMP_EXPORT_CAN_HANDLE_INDEXED: Handles indexed images
|
||||
* @GIMP_EXPORT_CAN_HANDLE_BITMAP: Handles two-color indexed images
|
||||
* @GIMP_EXPORT_CAN_HANDLE_ALPHA: Handles alpha channels
|
||||
* @GIMP_EXPORT_CAN_HANDLE_LAYERS: Hanldes layers
|
||||
* @GIMP_EXPORT_CAN_HANDLE_LAYERS_AS_ANIMATION: Handles aminations of layers
|
||||
* @GIMP_EXPORT_CAN_HANDLE_LAYER_MASKS: Handles layer masks
|
||||
* @GIMP_EXPORT_NEEDS_ALPHA: Needs alpha channels
|
||||
*
|
||||
* The types of images and layers an export procedure can handle
|
||||
**/
|
||||
typedef enum
|
||||
{
|
||||
GIMP_EXPORT_CAN_HANDLE_RGB = 1 << 0,
|
||||
@ -44,6 +58,15 @@ typedef enum
|
||||
GIMP_EXPORT_NEEDS_ALPHA = 1 << 8
|
||||
} GimpExportCapabilities;
|
||||
|
||||
|
||||
/**
|
||||
* GimpExportReturn:
|
||||
* @GIMP_EXPORT_CANCEL: The export was cancelled
|
||||
* @GIMP_EXPORT_IGNORE: The image is unmodified but export shall continue anyway
|
||||
* @GIMP_EXPORT_EXPORT: The chosen transforms were applied to the image
|
||||
*
|
||||
* Possible return values of gimp_export_image().
|
||||
**/
|
||||
typedef enum
|
||||
{
|
||||
GIMP_EXPORT_CANCEL,
|
||||
@ -51,10 +74,12 @@ typedef enum
|
||||
GIMP_EXPORT_EXPORT
|
||||
} GimpExportReturn;
|
||||
|
||||
|
||||
GimpExportReturn gimp_export_image (gint32 *image_ID,
|
||||
gint32 *drawable_ID,
|
||||
const gchar *format_name,
|
||||
GimpExportCapabilities capabilities);
|
||||
|
||||
GtkWidget * gimp_export_dialog_new (const gchar *format_name,
|
||||
const gchar *role,
|
||||
const gchar *help_id);
|
||||
|
@ -31,6 +31,15 @@ G_BEGIN_DECLS
|
||||
/* For information look into the C source or the html documentation */
|
||||
|
||||
|
||||
/**
|
||||
* GimpPixbufTransparency:
|
||||
* @GIMP_PIXBUF_KEEP_ALPHA: Create a pixbuf with alpha
|
||||
* @GIMP_PIXBUF_SMALL_CHECKS: Show transparency as small checks
|
||||
* @GIMP_PIXBUF_LARGE_CHECKS: Show transparency as large checks
|
||||
*
|
||||
* How to deal with transparency when creating thubnail pixbufs from
|
||||
* images and drawables.
|
||||
**/
|
||||
typedef enum
|
||||
{
|
||||
GIMP_PIXBUF_KEEP_ALPHA,
|
||||
|
@ -209,7 +209,7 @@ gimp_ui_get_foreign_window (guint32 window)
|
||||
|
||||
/**
|
||||
* gimp_ui_get_display_window:
|
||||
* @gdisp_ID: a #GimpDisplay ID.
|
||||
* @gdisp_ID: a GimpDisplay ID.
|
||||
*
|
||||
* Returns the #GdkWindow of a display window. The purpose is to allow
|
||||
* to make plug-in dialogs transient to the image display as explained
|
||||
|
Reference in New Issue
Block a user