The Gnome Chemistry Utils  0.13.7
Public Member Functions | Static Public Member Functions | Protected Member Functions
gcugtk::Application Class Reference

#include <gcugtk/application.h>

Inheritance diagram for gcugtk::Application:
gcu::Application gcu::DialogOwner gcp::Application gcr::Application gcugtk::Chem3dApplication

List of all members.

Public Member Functions

 Application (std::string name, std::string datadir=DATADIR, char const *help_name=NULL, char const *icon_name=NULL, CmdContextGtk *cc=NULL)
virtual ~Application ()
GtkWidget * GetImageResolutionWidget ()
GtkWidget * GetImageSizeWidget ()
virtual void ReceiveTargets (G_GNUC_UNUSED GtkClipboard *clipboard, G_GNUC_UNUSED GtkSelectionData *selection_data)
void ShowURI (GdkScreen *screen, std::string &uri)
void OnBug (GdkScreen *screen, char const *uri=PACKAGE_BUGREPORT)
void OnWeb (GdkScreen *screen, char const *uri="http://gchemutils.nongnu.org/")
void OnMail (GdkScreen *screen, char const *MailAddress="mailto:gchemutils-main@nongnu.org")
void OnLiveAssistance (GdkScreen *screen)
GtkRecentManager * GetRecentManager (void) const

Static Public Member Functions

static WindowState GetDefaultWindowState ()
static void OnReceiveTargets (GtkClipboard *clipboard, GtkSelectionData *selection_data, Application *App)

Protected Member Functions

virtual void NoMoreDocsEvent ()
void CreateDefaultCmdContext ()
bool LoopRunning ()

Detailed Description

This class is a base class for applications. It provides some basic services.

Definition at line 86 of file gcugtk/application.h.


Constructor & Destructor Documentation

gcugtk::Application::Application ( std::string  name,
std::string  datadir = DATADIR,
char const *  help_name = NULL,
char const *  icon_name = NULL,
CmdContextGtk cc = NULL 
)
Parameters:
namethe name of the application.
datadirwhere data for the application are stored.
help_namethe name to use for the help file (with .xml extension). If NULL, the name parameter is used.
icon_namethe name to use for the default icon of all windows. If NULL, the help_name or name parameters will be used.
ccthe associated CmdContextGtk.

The datadir variable is used to build the full path to the help file: "file://"+datadir+"/gnome/help/"+name+"/"+LANG+"/"+name".xml".

virtual gcugtk::Application::~Application ( ) [virtual]

The destructor.

Reimplemented from gcu::Application.

Reimplemented in gcp::Application, and gcr::Application.


Member Function Documentation

void gcugtk::Application::CreateDefaultCmdContext ( ) [protected, virtual]

Creates a default GtkCmdContext instance for the application.

Reimplemented from gcu::Application.

Returns:
the default WindowState for the application. New window should use this setting.

Definition at line 111 of file gcugtk/application.h.

Returns:
a GtkWidget for managing pixmap resolution when saving as image. This widget is intended to be added to a GtkFileChooserDialog.
Returns:
a GtkWidget for managing pixmap width and height when saving as image. This widget is intended to be added to a GtkFileChooserDialog.
gcugtk::Application::GetRecentManager ( void  ) const [inline]
Returns:
the GtkRecentFileManager attached to the application.

Definition at line 213 of file gcugtk/application.h.

bool gcugtk::Application::LoopRunning ( ) [inline, protected, virtual]
Returns:
true if the main loop is running.

Reimplemented from gcu::Application.

Definition at line 205 of file gcugtk/application.h.

virtual void gcugtk::Application::NoMoreDocsEvent ( ) [inline, protected, virtual]

This method is called by the framework when all the documents have been removed from the set of opened documents. The default behavior is to call gtk_main_quit and exit the program. Derived class might overide this method to change this.

Reimplemented from gcu::Application.

Definition at line 195 of file gcugtk/application.h.

void gcugtk::Application::OnBug ( GdkScreen *  screen,
char const *  uri = PACKAGE_BUGREPORT 
) [inline]
Parameters:
screenthe screen where the uri should be displayed.
urithe uri to the package bugs database. Default value is PACKAGE_BUGREPORT.

Opens the bugs web page in the default browser if any.

Definition at line 162 of file gcugtk/application.h.

References ShowURI().

void gcugtk::Application::OnLiveAssistance ( GdkScreen *  screen)
Parameters:
screenthe screen where the IRC window should be displayed. Attempts to open the #gchemutils channel at irc.gimp.net.
void gcugtk::Application::OnMail ( GdkScreen *  screen,
char const *  MailAddress = "mailto:gchemutils-main@nongnu.org" 
)
Parameters:
screenthe screen where the uri should be displayed.
MailAddressthe mail adress to which a message will be sent. Defaults to the Gnome Chemistry Utils main list.

Creates a new empty message using the default mail if any.

static void gcugtk::Application::OnReceiveTargets ( GtkClipboard *  clipboard,
GtkSelectionData *  selection_data,
Application App 
) [inline, static]
Parameters:
clipboarda GtkClipboard
selection_datathe current GtkSelectionData
Appthe Application target

Static callback to pass as third argument to gtk_clipboard_request_contents(). App must be used as fourth argument (user_data).

Definition at line 143 of file gcugtk/application.h.

References ReceiveTargets().

void gcugtk::Application::OnWeb ( GdkScreen *  screen,
char const *  uri = "http://gchemutils.nongnu.org/" 
) [inline]
Parameters:
screenthe screen where the uri should be displayed.
urithe uri to the main web page of the program. Default value is "http://gchemutils.nongnu.org/".

Definition at line 170 of file gcugtk/application.h.

References ShowURI().

virtual void gcugtk::Application::ReceiveTargets ( G_GNUC_UNUSED GtkClipboard *  clipboard,
G_GNUC_UNUSED GtkSelectionData *  selection_data 
) [inline, virtual]
Parameters:
clipboarda GtkClipboard
selection_datathe current GtkSelectionData

The virtual member called by OnReceiveTargets(). The defaullt implementation does nothing. This method should be overriden for derived classes supporting clipboard operations.

Definition at line 133 of file gcugtk/application.h.

Referenced by OnReceiveTargets().

void gcugtk::Application::ShowURI ( GdkScreen *  screen,
std::string &  uri 
)
Parameters:
screenthe screen wher the uri should be displayed.
urithe uri to display.

Displays uri in the default web browser if any.

Referenced by OnBug(), and OnWeb().


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