GimpPatternSelectButton

GimpPatternSelectButton — A button which pops up a pattern select dialog.

Synopsis

                    GimpPatternSelectButton;
GtkWidget *         gimp_pattern_select_button_new      (const gchar *title,
                                                         const gchar *pattern_name);
const gchar *       gimp_pattern_select_button_get_pattern
                                                        (GimpPatternSelectButton *button);
void                gimp_pattern_select_button_set_pattern
                                                        (GimpPatternSelectButton *button,
                                                         const gchar *pattern_name);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GimpSelectButton
                                       +----GimpPatternSelectButton

Implemented Interfaces

GimpPatternSelectButton implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "pattern-name"             gchar*                : Read / Write
  "title"                    gchar*                : Read / Write / Construct Only

Signals

  "pattern-set"                                    : Run First

Description

A button which pops up a pattern select dialog.

Details

GimpPatternSelectButton

typedef struct _GimpPatternSelectButton GimpPatternSelectButton;

gimp_pattern_select_button_new ()

GtkWidget *         gimp_pattern_select_button_new      (const gchar *title,
                                                         const gchar *pattern_name);

Creates a new GtkWidget that completely controls the selection of a pattern. This widget is suitable for placement in a table in a plug-in dialog.

title :

 Title of the dialog to use or NULL to use the default title.

pattern_name :

 Initial pattern name or NULL to use current selection.

Returns :

 A GtkWidget that you can use in your UI.

Since GIMP 2.4

gimp_pattern_select_button_get_pattern ()

const gchar *       gimp_pattern_select_button_get_pattern
                                                        (GimpPatternSelectButton *button);

Retrieves the name of currently selected pattern.

button :

 A GimpPatternSelectButton

Returns :

 an internal copy of the pattern name which must not be freed.

Since GIMP 2.4

gimp_pattern_select_button_set_pattern ()

void                gimp_pattern_select_button_set_pattern
                                                        (GimpPatternSelectButton *button,
                                                         const gchar *pattern_name);

Sets the current pattern for the pattern select button.

button :

 A GimpPatternSelectButton

pattern_name :

 Pattern name to set; NULL means no change.

Since GIMP 2.4

Property Details

The "pattern-name" property

  "pattern-name"             gchar*                : Read / Write

The name of the currently selected pattern.

Default value: NULL

Since GIMP 2.4

The "title" property

  "title"                    gchar*                : Read / Write / Construct Only

The title to be used for the pattern selection popup dialog.

Default value: "Pattern Selection"

Since GIMP 2.4

Signal Details

The "pattern-set" signal

void                user_function                      (GimpPatternSelectButton *widget,
                                                        gchar                   *pattern_name,
                                                        gint                     width,
                                                        gint                     height,
                                                        gint                     bpp,
                                                        gpointer                 mask_data,
                                                        gboolean                 dialog_closing,
                                                        gpointer                 user_data)           : Run First

The ::pattern-set signal is emitted when the user selects a pattern.

widget :

 the object which received the signal.

pattern_name :

 the name of the currently selected pattern.

width :

 width of the pattern

height :

 height of the pattern

bpp :

 bpp of the pattern

mask_data :

 pattern mask data

dialog_closing :

 whether the dialog was closed or not.

user_data :

 user data set when the signal handler was connected.

Since GIMP 2.4

Generated by GTK-Doc V1.18