Gimp

Gimp

Synopsis

                    Gimp;
Gimp*               gimp_new                            (const gchar *name,
                                                         const gchar *session_name,
                                                         gboolean be_verbose,
                                                         gboolean no_data,
                                                         gboolean no_fonts,
                                                         gboolean no_interface,
                                                         gboolean use_shm,
                                                         gboolean console_messages,
                                                         GimpStackTraceMode stack_trace_mode,
                                                         GimpPDBCompatMode pdb_compat_mode);
void                gimp_initialize                     (Gimp *gimp,
                                                         GimpInitStatusFunc status_callback);
void                gimp_restore                        (Gimp *gimp,
                                                         GimpInitStatusFunc status_callback);
gboolean            gimp_is_restored                    (Gimp *gimp);
void                gimp_exit                           (Gimp *gimp,
                                                         gboolean force);
void                gimp_load_config                    (Gimp *gimp,
                                                         const gchar *alternate_system_gimprc,
                                                         const gchar *alternate_gimprc);
GimpImage*          gimp_create_image                   (Gimp *gimp,
                                                         gint width,
                                                         gint height,
                                                         GimpImageBaseType type,
                                                         gboolean attach_comment);
void                gimp_set_default_context            (Gimp *gimp,
                                                         GimpContext *context);
GimpContext*        gimp_get_default_context            (Gimp *gimp);
void                gimp_set_user_context               (Gimp *gimp,
                                                         GimpContext *context);
GimpContext*        gimp_get_user_context               (Gimp *gimp);
GimpToolInfo*       gimp_get_tool_info                  (Gimp *gimp,
                                                         const gchar *tool_name);
void                gimp_set_global_buffer              (Gimp *gimp,
                                                         GimpBuffer *buffer);
void                gimp_message                        (Gimp *gimp,
                                                         GObject *handler,
                                                         GimpMessageSeverity severity,
                                                         const gchar *format,
                                                         ...);
void                gimp_message_valist                 (Gimp *gimp,
                                                         GObject *handler,
                                                         GimpMessageSeverity severity,
                                                         const gchar *format,
                                                         va_list args);
gboolean            gimp_use_gegl                       (Gimp *gimp);

Object Hierarchy

  GObject
   +----GimpObject
         +----Gimp

Signals

  "buffer-changed"                                 : Run Last
  "exit"                                           : Run Last
  "initialize"                                     : Run Last
  "restore"                                        : Run Last

Description

Details

Gimp

typedef struct _Gimp Gimp;

gimp_new ()

Gimp*               gimp_new                            (const gchar *name,
                                                         const gchar *session_name,
                                                         gboolean be_verbose,
                                                         gboolean no_data,
                                                         gboolean no_fonts,
                                                         gboolean no_interface,
                                                         gboolean use_shm,
                                                         gboolean console_messages,
                                                         GimpStackTraceMode stack_trace_mode,
                                                         GimpPDBCompatMode pdb_compat_mode);

name :

session_name :

be_verbose :

no_data :

no_fonts :

no_interface :

use_shm :

console_messages :

stack_trace_mode :

pdb_compat_mode :

Returns :

gimp_initialize ()

void                gimp_initialize                     (Gimp *gimp,
                                                         GimpInitStatusFunc status_callback);

gimp :

status_callback :

gimp_restore ()

void                gimp_restore                        (Gimp *gimp,
                                                         GimpInitStatusFunc status_callback);

gimp :

status_callback :

gimp_is_restored ()

gboolean            gimp_is_restored                    (Gimp *gimp);

gimp :

 a Gimp object

Returns :

 TRUE if GIMP is completely started, FALSE otherwise.

gimp_exit ()

void                gimp_exit                           (Gimp *gimp,
                                                         gboolean force);

Exit this GIMP session. Unless force is TRUE, the user is queried whether unsaved images should be saved and can cancel the operation.

gimp :

 a Gimp object

force :

 whether to force the application to quit

gimp_load_config ()

void                gimp_load_config                    (Gimp *gimp,
                                                         const gchar *alternate_system_gimprc,
                                                         const gchar *alternate_gimprc);

gimp :

alternate_system_gimprc :

alternate_gimprc :

gimp_create_image ()

GimpImage*          gimp_create_image                   (Gimp *gimp,
                                                         gint width,
                                                         gint height,
                                                         GimpImageBaseType type,
                                                         gboolean attach_comment);

gimp :

width :

height :

type :

attach_comment :

Returns :

gimp_set_default_context ()

void                gimp_set_default_context            (Gimp *gimp,
                                                         GimpContext *context);

gimp :

context :

gimp_get_default_context ()

GimpContext*        gimp_get_default_context            (Gimp *gimp);

gimp :

Returns :

gimp_set_user_context ()

void                gimp_set_user_context               (Gimp *gimp,
                                                         GimpContext *context);

gimp :

context :

gimp_get_user_context ()

GimpContext*        gimp_get_user_context               (Gimp *gimp);

gimp :

Returns :

gimp_get_tool_info ()

GimpToolInfo*       gimp_get_tool_info                  (Gimp *gimp,
                                                         const gchar *tool_name);

gimp :

tool_name :

Returns :

gimp_set_global_buffer ()

void                gimp_set_global_buffer              (Gimp *gimp,
                                                         GimpBuffer *buffer);

gimp :

buffer :

gimp_message ()

void                gimp_message                        (Gimp *gimp,
                                                         GObject *handler,
                                                         GimpMessageSeverity severity,
                                                         const gchar *format,
                                                         ...);

Present a message to the user. How exactly the message is displayed depends on the severity, the handler object and user preferences.

gimp :

 a pointer to the Gimp object

handler :

 either a GimpProgress or a GtkWidget pointer

severity :

 severity of the message

format :

 printf-like format string

... :

 arguments to use with format

gimp_message_valist ()

void                gimp_message_valist                 (Gimp *gimp,
                                                         GObject *handler,
                                                         GimpMessageSeverity severity,
                                                         const gchar *format,
                                                         va_list args);

See documentation for gimp_message().

gimp :

 a pointer to the Gimp object

handler :

 either a GimpProgress or a GtkWidget pointer

severity :

 severity of the message

format :

 printf-like format string

args :

 arguments to use with format

gimp_use_gegl ()

gboolean            gimp_use_gegl                       (Gimp *gimp);

gimp :

Returns :

Signal Details

The "buffer-changed" signal

void                user_function                      (Gimp    *gimp,
                                                        gpointer user_data)      : Run Last

gimp :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "exit" signal

gboolean            user_function                      (Gimp    *gimp,
                                                        gboolean arg1,
                                                        gpointer user_data)      : Run Last

gimp :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

Returns :

The "initialize" signal

void                user_function                      (Gimp    *gimp,
                                                        gpointer arg1,
                                                        gpointer user_data)      : Run Last

gimp :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "restore" signal

void                user_function                      (Gimp    *gimp,
                                                        gpointer arg1,
                                                        gpointer user_data)      : Run Last

gimp :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.10