GimpBrowser

GimpBrowser — A base class for a documentation browser.

Synopsis

                    GimpBrowser;
GtkWidget *         gimp_browser_new                    (void);
void                gimp_browser_add_search_types       (GimpBrowser *browser,
                                                         const gchar *first_type_label,
                                                         gint first_type_id,
                                                         ...);
void                gimp_browser_set_widget             (GimpBrowser *browser,
                                                         GtkWidget *widget);
void                gimp_browser_show_message           (GimpBrowser *browser,
                                                         const gchar *message);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkPaned
                                 +----GtkHPaned
                                       +----GimpBrowser

Implemented Interfaces

GimpBrowser implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Signals

  "search"                                         : Run Last

Description

A base class for a documentation browser.

Details

GimpBrowser

typedef struct _GimpBrowser GimpBrowser;

gimp_browser_new ()

GtkWidget *         gimp_browser_new                    (void);

Create a new GimpBrowser widget.

Returns :

 a newly created GimpBrowser.

Since GIMP 2.4

gimp_browser_add_search_types ()

void                gimp_browser_add_search_types       (GimpBrowser *browser,
                                                         const gchar *first_type_label,
                                                         gint first_type_id,
                                                         ...);

Populates the GtkComboBox with search types.

browser :

 a GimpBrowser widget

first_type_label :

 the label of the first search type

first_type_id :

 an integer that identifies the first search type

... :

 a NULL-terminated list of more labels and ids.

Since GIMP 2.4

gimp_browser_set_widget ()

void                gimp_browser_set_widget             (GimpBrowser *browser,
                                                         GtkWidget *widget);

Sets the widget to appear on the right side of the browser.

browser :

 a GimpBrowser widget

widget :

 a GtkWidget

Since GIMP 2.4

gimp_browser_show_message ()

void                gimp_browser_show_message           (GimpBrowser *browser,
                                                         const gchar *message);

Displays message in the right side of the browser. Unless the right side already contains a GtkLabel, the widget previously added with gimp_browser_set_widget() is removed and replaced by a GtkLabel.

browser :

 a GimpBrowser widget

message :

 text message

Since GIMP 2.4

Signal Details

The "search" signal

void                user_function                      (GimpBrowser *gimpbrowser,
                                                        gchar       *arg1,
                                                        gint         arg2,
                                                        gpointer     user_data)        : Run Last

gimpbrowser :

 the object which received the signal.

user_data :

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