PluginUI Class Reference

Subclass of GenericPluginUI that instantiates and registers the UI elements (main menu and dialogs). More...

#include <PluginUI.h>

Inheritance diagram for PluginUI:

List of all members.

Static Public Member Functions
static PluginUI &	Instance ()
	Get the singleton instance of the UI manager.
Static Public Member Functions inherited from GenericPluginUI
static void	ErrorReportDialog (const char *title, const char *message)
	Generate an error dialog.
static void	WarningReportDialog (const char *title, const char *message)
	Generate a warning dialog.
static void	InfoReportDialog (const char *title, const char *message)
	Generate an info dialog.
static gint	DialogEventCallbackDispatch (GtkWidget *widget, GdkEvent *event, gpointer data)
	Generic event callback used to invoke the specific callback functions registered with this manager.
static void	DialogSignalCallbackDispatch (GtkWidget *widget, gpointer data)
	Generic signal callback used to invoke the specific callback functions registered with this manager.

Private Member Functions
Private to prevent external instantiation
	PluginUI ()
	Default constructor.
	~PluginUI ()
	Destructor.

Additional Inherited Members
Public Types inherited from GenericPluginUI
typedef Callback3< GtkWidget *, GdkEvent *, gpointer, gint >	DialogEventCallback
	Type for GTK+ event callbacks.
typedef Callback2< GtkWidget *, gpointer, void >	DialogSignalCallback
	Type for GTK+ signal callbacks.
Public Member Functions inherited from GenericPluginUI
void	RegisterMainMenu (SmartPointer< GenericMainMenu > &mainMenu)
	Register the command menu.
void	RegisterDialog (SmartPointer< GenericDialog > &dialog)
	Register a dialog window.
void	SetWindow (GtkWidget *window)
	Specify the main application window.
GenericMainMenu *	MainMenu ()
	Get the command menu.
GenericDialog *	Dialog (const std::string &key)
	Get the dialog identified by the specified key.
void	RegisterWidgetDependence (GtkWidget *controller, GtkWidget *controllee)
	Declare that the controllee widget should be active only when the controller widget is active.
void	RegisterWidgetAntiDependence (GtkWidget *controller, GtkWidget *controllee)
	Declare that the controllee widget should be active only when the controller widget is inactive.
void	WidgetControlCallback (GtkWidget *widget, gpointer callbackID)
	Manage the state of controllee widgets when a controller widget is clicked.
gpointer	RegisterDialogEventCallback (GtkWidget *widget, const gchar *name, const DialogEventCallback &callback)
	Register a function to be invoked when a widget generates an event.
gpointer	RegisterDialogSignalCallback (GtkWidget *widget, const gchar *name, const DialogSignalCallback &callback)
	Register a function to be invoked when a widget generates a signal.
Protected Member Functions inherited from GenericPluginUI
	GenericPluginUI ()
	Default constructor.
virtual	~GenericPluginUI ()
	Virtual destructor.
Related Functions inherited from GenericPluginUI
GenericPluginUI &	UIInstance ()
	Get the singleton instance of the UI manager.

---

Detailed Description

Subclass of GenericPluginUI that instantiates and registers the UI elements (main menu and dialogs).

---

Constructor & Destructor Documentation

PluginUI::PluginUI ( )

private

Default constructor.

Instantiate and register the UI elements (main menu and dialogs)

---

Member Function Documentation

PluginUI & PluginUI::Instance ( )

static

Get the singleton instance of the UI manager.

Note that callers should almost certainly invoke the UIInstance global function instead of using this method.

Returns:

Handle to the UI manager instance.

---

The documentation for this class was generated from the following files:

• PluginUI.h
• PluginUI.cpp