OGMRipChooserList

OGMRipChooserList — A widget that displays a list of source choosers

Synopsis


#include <ogmrip-chooser-list.h>

                    OGMRipChooserListPriv;
                    OGMRipChooserList;
GtkWidget*          ogmrip_chooser_list_new             (GType type);
void                ogmrip_chooser_list_add             (OGMRipChooserList *list,
                                                         GtkWidget *chooser);
void                ogmrip_chooser_list_remove          (OGMRipChooserList *list,
                                                         GtkWidget *chooser);
void                ogmrip_chooser_list_clear           (OGMRipChooserList *list);
void                ogmrip_chooser_list_foreach         (OGMRipChooserList *list,
                                                         OGMRipSourceType type,
                                                         GFunc func,
                                                         gpointer data);
gint                ogmrip_chooser_list_length          (OGMRipChooserList *list);
GtkWidget*          ogmrip_chooser_list_nth             (OGMRipChooserList *list,
                                                         guint n);
void                ogmrip_chooser_list_set_max         (OGMRipChooserList *list,
                                                         guint max);
gint                ogmrip_chooser_list_get_max         (OGMRipChooserList *list);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkVBox
                                       +----OGMRipChooserList

Implemented Interfaces

OGMRipChooserList implements GtkBuildable, AtkImplementorIface and GtkOrientable.

Signals

  "more-clicked"                                   : Run Last / No Recursion / No Hooks

Description

Details

OGMRipChooserListPriv

typedef struct _OGMRipChooserListPriv OGMRipChooserListPriv;

OGMRipChooserList

typedef struct _OGMRipChooserList OGMRipChooserList;

ogmrip_chooser_list_new ()

GtkWidget*          ogmrip_chooser_list_new             (GType type);

Creates a new OGMRipChooserList.

type :

 the type of the children

Returns :

 The new OGMRipChooserList

ogmrip_chooser_list_add ()

void                ogmrip_chooser_list_add             (OGMRipChooserList *list,
                                                         GtkWidget *chooser);

Adds chooser to list.

list :

 An OGMRipChooserList

chooser :

 A chooser to be placed inside list

ogmrip_chooser_list_remove ()

void                ogmrip_chooser_list_remove          (OGMRipChooserList *list,
                                                         GtkWidget *chooser);

Removes chooser from list.

list :

 An OGMRipChooserList

chooser :

 Â current child of list

ogmrip_chooser_list_clear ()

void                ogmrip_chooser_list_clear           (OGMRipChooserList *list);

Removes all children of list.

list :

 An OGMRipChooserList

ogmrip_chooser_list_foreach ()

void                ogmrip_chooser_list_foreach         (OGMRipChooserList *list,
                                                         OGMRipSourceType type,
                                                         GFunc func,
                                                         gpointer data);

Invokes func on each non-internal type child of list.

list :

 An OGMRipChooserList

type :

 The type of the children

func :

 A callback

data :

 Callback user data

ogmrip_chooser_list_length ()

gint                ogmrip_chooser_list_length          (OGMRipChooserList *list);

Returns the number of valid source choosers contained in list.

list :

 An OGMRipChooserList

Returns :

 The number of valid choosers, or -1

ogmrip_chooser_list_nth ()

GtkWidget*          ogmrip_chooser_list_nth             (OGMRipChooserList *list,
                                                         guint n);

Gets the chooser at the given position.

list :

 An OGMRipChooserList

n :

 the position of the chooser, counting from 0

Returns :

 the chooser, or NULL

ogmrip_chooser_list_set_max ()

void                ogmrip_chooser_list_set_max         (OGMRipChooserList *list,
                                                         guint max);

Creates a new OGMRipChooserList.

list :

 An OGMRipChooserList

max :

 the maximum number of children

ogmrip_chooser_list_get_max ()

gint                ogmrip_chooser_list_get_max         (OGMRipChooserList *list);

Returns the maximum number of children.

list :

 An OGMRipChooserList

Returns :

 the maximum number of children, or -1

Signal Details

The "more-clicked" signal

void                user_function                      (OGMRipChooserList   *list,
                                                        OGMRipSourceChooser *chooser,
                                                        gpointer             user_data)      : Run Last / No Recursion / No Hooks

Emitted each time a 'more' button is clicked

list :

 the widget that received the signal

chooser :

 the selected source chooser

user_data :

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