GimpPageSelector

GimpPageSelector —

Synopsis




            GimpPageSelector;
enum        GimpPageSelectorTarget;
GtkWidget*  gimp_page_selector_new          (void);
void        gimp_page_selector_set_n_pages  (GimpPageSelector *selector,
                                             gint n_pages);
gint        gimp_page_selector_get_n_pages  (GimpPageSelector *selector);
void        gimp_page_selector_set_target   (GimpPageSelector *selector,
                                             GimpPageSelectorTarget target);
GimpPageSelectorTarget gimp_page_selector_get_target
                                            (GimpPageSelector *selector);
void        gimp_page_selector_set_page_thumbnail
                                            (GimpPageSelector *selector,
                                             gint page_no,
                                             GdkPixbuf *thumbnail);
GdkPixbuf*  gimp_page_selector_get_page_thumbnail
                                            (GimpPageSelector *selector,
                                             gint page_no);
void        gimp_page_selector_set_page_label
                                            (GimpPageSelector *selector,
                                             gint page_no,
                                             const gchar *label);
gchar*      gimp_page_selector_get_page_label
                                            (GimpPageSelector *selector,
                                             gint page_no);
void        gimp_page_selector_select_all   (GimpPageSelector *selector);
void        gimp_page_selector_unselect_all (GimpPageSelector *selector);
void        gimp_page_selector_select_page  (GimpPageSelector *selector,
                                             gint page_no);
void        gimp_page_selector_unselect_page
                                            (GimpPageSelector *selector,
                                             gint page_no);
gboolean    gimp_page_selector_page_is_selected
                                            (GimpPageSelector *selector,
                                             gint page_no);
gint*       gimp_page_selector_get_selected_pages
                                            (GimpPageSelector *selector,
                                             gint *n_selected_pages);
void        gimp_page_selector_select_range (GimpPageSelector *selector,
                                             const gchar *range);
gchar*      gimp_page_selector_get_selected_range
                                            (GimpPageSelector *selector);

Description

Details

GimpPageSelector

typedef struct {
  GtkVBox                 parent_instance;

  gint                    n_pages;
  GimpPageSelectorTarget  target;

  GtkListStore           *store;
  GtkWidget              *view;

  GtkWidget              *range_entry;

  GdkPixbuf              *thumbnail;
} GimpPageSelector;


enum GimpPageSelectorTarget

typedef enum
{
  GIMP_PAGE_SELECTOR_TARGET_LAYERS, /*< desc="Layers" >*/
  GIMP_PAGE_SELECTOR_TARGET_IMAGES  /*< desc="Images" >*/
} GimpPageSelectorTarget;


gimp_page_selector_new ()

GtkWidget*  gimp_page_selector_new          (void);

Creates a new GimpPageSelector widget.

Returns : Pointer to the new GimpPageSelector widget.

Since GIMP 2.4


gimp_page_selector_set_n_pages ()

void        gimp_page_selector_set_n_pages  (GimpPageSelector *selector,
                                             gint n_pages);

selector : Pointer to a GimpPageSelector.
n_pages :

Since GIMP 2.4


gimp_page_selector_get_n_pages ()

gint        gimp_page_selector_get_n_pages  (GimpPageSelector *selector);

selector : Pointer to a GimpPageSelector.
Returns : the number of pages in the document to open.

Since GIMP 2.4


gimp_page_selector_set_target ()

void        gimp_page_selector_set_target   (GimpPageSelector *selector,
                                             GimpPageSelectorTarget target);

selector :
target :

gimp_page_selector_get_target ()

GimpPageSelectorTarget gimp_page_selector_get_target
                                            (GimpPageSelector *selector);

selector :
Returns :

gimp_page_selector_set_page_thumbnail ()

void        gimp_page_selector_set_page_thumbnail
                                            (GimpPageSelector *selector,
                                             gint page_no,
                                             GdkPixbuf *thumbnail);

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to set the thumbnail for.
thumbnail : The thumbnail pixbuf.

Since GIMP 2.4


gimp_page_selector_get_page_thumbnail ()

GdkPixbuf*  gimp_page_selector_get_page_thumbnail
                                            (GimpPageSelector *selector,
                                             gint page_no);

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to get the thumbnail for.
Returns : The page's thumbnail, or NULL if none is set.

Since GIMP 2.4


gimp_page_selector_set_page_label ()

void        gimp_page_selector_set_page_label
                                            (GimpPageSelector *selector,
                                             gint page_no,
                                             const gchar *label);

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to set the label for.
label : The label.

Since GIMP 2.4


gimp_page_selector_get_page_label ()

gchar*      gimp_page_selector_get_page_label
                                            (GimpPageSelector *selector,
                                             gint page_no);

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to get the thumbnail for.
Returns : The page's label, or NULL if none is set.

Since GIMP 2.4


gimp_page_selector_select_all ()

void        gimp_page_selector_select_all   (GimpPageSelector *selector);

Selects all pages.

selector : Pointer to a GimpPageSelector.

Since GIMP 2.4


gimp_page_selector_unselect_all ()

void        gimp_page_selector_unselect_all (GimpPageSelector *selector);

Unselects all pages.

selector : Pointer to a GimpPageSelector.

Since GIMP 2.4


gimp_page_selector_select_page ()

void        gimp_page_selector_select_page  (GimpPageSelector *selector,
                                             gint page_no);

Adds a page to the selection.

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to select.

Since GIMP 2.4


gimp_page_selector_unselect_page ()

void        gimp_page_selector_unselect_page
                                            (GimpPageSelector *selector,
                                             gint page_no);

Removes a page from the selection.

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to unselect.

Since GIMP 2.4


gimp_page_selector_page_is_selected ()

gboolean    gimp_page_selector_page_is_selected
                                            (GimpPageSelector *selector,
                                             gint page_no);

selector : Pointer to a GimpPageSelector.
page_no : The number of the page to check.
Returns : TRUE if the page is selected, FALSE otherwise.

Since GIMP 2.4


gimp_page_selector_get_selected_pages ()

gint*       gimp_page_selector_get_selected_pages
                                            (GimpPageSelector *selector,
                                             gint *n_selected_pages);

selector : Pointer to a GimpPageSelector.
n_selected_pages : Returns the number of selected pages.
Returns : An array of page numbers of selected pages. Use g_free() if you don't need the array any longer.

Since GIMP 2.4


gimp_page_selector_select_range ()

void        gimp_page_selector_select_range (GimpPageSelector *selector,
                                             const gchar *range);

selector : Pointer to a GimpPageSelector.
range :

Since GIMP 2.4


gimp_page_selector_get_selected_range ()

gchar*      gimp_page_selector_get_selected_range
                                            (GimpPageSelector *selector);

selector : Pointer to a GimpPageSelector.
Returns : A newly allocated string.

Since GIMP 2.4