PeasUIPluginManagerView

PeasUIPluginManagerView — Management tree view for plugins.

Synopsis

                    PeasUIPluginManagerView;
                    PeasUIPluginManagerViewClass;
GtkWidget *         peas_ui_plugin_manager_view_new     (PeasEngine *engine);
void                peas_ui_plugin_manager_view_set_show_builtin
                                                        (PeasUIPluginManagerView *view,
                                                         gboolean show_builtin);
gboolean            peas_ui_plugin_manager_view_get_show_builtin
                                                        (PeasUIPluginManagerView *view);
void                peas_ui_plugin_manager_view_set_selected_iter
                                                        (PeasUIPluginManagerView *view,
                                                         GtkTreeIter *iter);
gboolean            peas_ui_plugin_manager_view_get_selected_iter
                                                        (PeasUIPluginManagerView *view,
                                                         GtkTreeIter *iter);
void                peas_ui_plugin_manager_view_set_selected_plugin
                                                        (PeasUIPluginManagerView *view,
                                                         PeasPluginInfo *info);
PeasPluginInfo *    peas_ui_plugin_manager_view_get_selected_plugin
                                                        (PeasUIPluginManagerView *view);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkTreeView
                                 +----PeasUIPluginManagerView

Implemented Interfaces

PeasUIPluginManagerView implements AtkImplementorIface, GtkBuildable and GtkSizeRequest.

Properties

  "engine"                   PeasEngine*           : Read / Write / Construct Only
  "show-builtin"             gboolean              : Read / Write

Signals

  "populate-popup"                                 : Run Last

Description

The PeasUIPluginManagerView is a tree view that can be used to manage plugins, i.e. load or unload them, and see some pieces of information.

The only thing you need to do as an application writer if you wish to use the view to configure your plugins is to instantiate it using peas_ui_plugin_manager_view_new() and pack it into another widget or a window.

Note: Changing the model of the view is not supported.

Details

PeasUIPluginManagerView

typedef struct _PeasUIPluginManagerView PeasUIPluginManagerView;

PeasUIPluginManagerViewClass

typedef struct {
  GtkTreeViewClass parent_class;

  void  (*populate_popup)  (PeasUIPluginManagerView *view,
                            GtkMenu                 *menu);
} PeasUIPluginManagerViewClass;

peas_ui_plugin_manager_view_new ()

GtkWidget *         peas_ui_plugin_manager_view_new     (PeasEngine *engine);

Creates a new plugin manager view for the given PeasEngine.

engine :

A PeasEngine.

Returns :

the new PeasUIPluginManagerView.

peas_ui_plugin_manager_view_set_show_builtin ()

void                peas_ui_plugin_manager_view_set_show_builtin
                                                        (PeasUIPluginManagerView *view,
                                                         gboolean show_builtin);

Sets if builtin plugins should be shown.

view :

A PeasUIPluginManagerView.

show_builtin :

If builtin plugins should be shown.

peas_ui_plugin_manager_view_get_show_builtin ()

gboolean            peas_ui_plugin_manager_view_get_show_builtin
                                                        (PeasUIPluginManagerView *view);

Returns if builtin plugins should be shown.

view :

A PeasUIPluginManagerView.

Returns :

if builtin plugins should be shown.

peas_ui_plugin_manager_view_set_selected_iter ()

void                peas_ui_plugin_manager_view_set_selected_iter
                                                        (PeasUIPluginManagerView *view,
                                                         GtkTreeIter *iter);

Selects iter.

view :

A PeasUIPluginManagerView.

iter :

A GtkTreeIter.

peas_ui_plugin_manager_view_get_selected_iter ()

gboolean            peas_ui_plugin_manager_view_get_selected_iter
                                                        (PeasUIPluginManagerView *view,
                                                         GtkTreeIter *iter);

Returns if iter was set to the selected plugin.

view :

A PeasUIPluginManagerView.

iter :

A GtkTreeIter.

Returns :

if iter was set.

peas_ui_plugin_manager_view_set_selected_plugin ()

void                peas_ui_plugin_manager_view_set_selected_plugin
                                                        (PeasUIPluginManagerView *view,
                                                         PeasPluginInfo *info);

Selects the given plugin.

view :

A PeasUIPluginManagerView.

info :

A PeasPluginInfo.

peas_ui_plugin_manager_view_get_selected_plugin ()

PeasPluginInfo *    peas_ui_plugin_manager_view_get_selected_plugin
                                                        (PeasUIPluginManagerView *view);

Returns the currently selected plugin, or NULL if a plugin is not selected.

view :

A PeasUIPluginManagerView.

Returns :

the selected plugin.

Property Details

The "engine" property

  "engine"                   PeasEngine*           : Read / Write / Construct Only

The PeasEngine this view is attached to.


The "show-builtin" property

  "show-builtin"             gboolean              : Read / Write

If builtin plugins should be shown.

Default value: FALSE

Signal Details

The "populate-popup" signal

void                user_function                      (PeasUIPluginManagerView *view,
                                                        GtkMenu                 *menu,
                                                        gpointer                 user_data)      : Run Last

The populate-popup signal is emitted before showing the context menu of the view. If you need to add items to the context menu, connect to this signal and add your menuitems to the menu.

view :

A PeasUIPluginManagerView.

menu :

A GtkMenu.

user_data :

user data set when the signal handler was connected.