gcu::Application Class Reference

#include <gcu/application.h>

Inheritance diagram for gcu::Application:

gcu::DialogOwner

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)
void OnHelp (std::string s="")
bool HasHelp ()
std::string & GetName ()
virtual GtkWindow * GetWindow ()
virtual bool FileProcess (const gchar *filename, const gchar *mime_type, bool bSave, GtkWindow *window, Document *pDoc=NULL)
char const * GetCurDir ()
void SetCurDir (char const *dir)
void SetCurDir (std::string const &dir)
void ShowURI (std::string &uri)
void OnBug (char const *uri=PACKAGE_BUGREPORT)
void OnWeb (char const *uri="http://gchemutils.nongnu.org/")
void OnMail (char const *MailAddress="mailto:gchemutils-main@nongnu.org")
bool HasMailAgent ()
bool HasWebBrowser ()
GtkWidget * GetImageResolutionWidget ()
GtkWidget * GetImageSizeWidget ()
std::map< std::string,
GdkPixbufFormat * > & 
GetSupportedPixbufFormats ()
char const * GetPixbufTypeName (std::string &filename, char const *mime_type)

Protected Member Functions

virtual void NoMoreDocsEvent ()

Protected Attributes

std::map< std::string,
GdkPixbufFormat * > 
m_SupportedPixbufFormats


Detailed Description

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

Definition at line 45 of file gcu/application.h.


Constructor & Destructor Documentation

gcu::Application::Application ( std::string  name,
std::string  datadir = DATADIR,
char const *  help_name = NULL,
char const *  icon_name = NULL 
)

Parameters:
name the name of the application.
datadir where data for the application are stored.
help_name the name to use for the help file (with .xml extension). If NULL, the name parameter is used.
icon_name the name to use for the default icon of all windows. If NULL, the help_name or name parameters will be used.
The datadir variable is used to build the full path to the help file: "file://"+datadir+"/gnome/help/"+name+"/"+LANG+"/"+name".xml".


Member Function Documentation

void gcu::Application::OnHelp ( std::string  s = ""  ) 

Parameters:
s an optional tag in the help file. Displays the help file using the file browser retrieved from GConf using the "/desktop/gnome/applications/help_viewer/exec" key. If a tag is given, it will be added to the help uri. For an application named "myapp" and a tag "mytag", the uri will be: helpfilename#myapp-mytag.

bool gcu::Application::HasHelp (  ) 

Returns:
true if both a help browser and a help file are available, false otherwise.

std::string& gcu::Application::GetName (  )  [inline]

Returns:
the name of the application. Mostly useful to set the icon name of a new window.

Definition at line 80 of file gcu/application.h.

virtual GtkWindow* gcu::Application::GetWindow (  )  [inline, virtual]

Returns:
a GtkWindow if any. Should be overloaded by children classes.

Definition at line 85 of file gcu/application.h.

virtual bool gcu::Application::FileProcess ( const gchar *  filename,
const gchar *  mime_type,
bool  bSave,
GtkWindow *  window,
Document pDoc = NULL 
) [inline, virtual]

Parameters:
filename the uri of the file.
mime_type the mime type of the file if known.
bSave true if saving, and false if loading.
window the current top level window.
pDoc an optional document.
Called by the FileChooser when a file name has been selected. This method does nothing in the parent class and must be implemented in children classes if they use the FileChooser.

Returns:
true if no error occured.

Definition at line 100 of file gcu/application.h.

char const* gcu::Application::GetCurDir (  )  [inline]

Returns:
the path to the current directory.

Definition at line 106 of file gcu/application.h.

void gcu::Application::SetCurDir ( char const *  dir  ) 

Parameters:
dir the path to the new current directory.

void gcu::Application::SetCurDir ( std::string const &  dir  ) 

Parameters:
dir the path to the new current directory.

void gcu::Application::ShowURI ( std::string &  uri  ) 

Parameters:
uri the uri to display.
Displays uri in the default web browser if any.

Referenced by OnBug(), and OnWeb().

void gcu::Application::OnBug ( char const *  uri = PACKAGE_BUGREPORT  )  [inline]

Parameters:
uri the 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 130 of file gcu/application.h.

References ShowURI().

void gcu::Application::OnWeb ( char const *  uri = "http://gchemutils.nongnu.org/"  )  [inline]

Parameters:
uri the uri to the main web page of the program. Default value is "http://gchemutils.nongnu.org/".

Definition at line 137 of file gcu/application.h.

References ShowURI().

void gcu::Application::OnMail ( char const *  MailAddress = "mailto:gchemutils-main@nongnu.org"  ) 

Parameters:
MailAddress the 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.

bool gcu::Application::HasMailAgent (  )  [inline]

Returns:
true if the default mail agent is known, false otherwise.

Definition at line 151 of file gcu/application.h.

bool gcu::Application::HasWebBrowser (  )  [inline]

Returns:
true if the default web browser is known, false otherwise.

Definition at line 156 of file gcu/application.h.

GtkWidget* gcu::Application::GetImageResolutionWidget (  ) 

Returns:
a GtkWidget for managing pixmap resolution when saving as image. This widget is intended to be added to a GtkFileChooserDialog.

GtkWidget* gcu::Application::GetImageSizeWidget (  ) 

Returns:
a GtkWidget for managing pixmap width and height when saving as image. This widget is intended to be added to a GtkFileChooserDialog.

std::map<std::string, GdkPixbufFormat*>& gcu::Application::GetSupportedPixbufFormats (  )  [inline]

Returns:
a std::map of the supported pixbuf formats. Keys are the mime type names.

Definition at line 173 of file gcu/application.h.

References m_SupportedPixbufFormats.

char const* gcu::Application::GetPixbufTypeName ( std::string &  filename,
char const *  mime_type 
)

Parameters:
filename the file name.
mime_type the file mime type.
A default extension is appended to filename if none is detected.

Returns:
the GdkPixbuf name associated to mime_type or NULL if the file type is not supported by GdkPixbuf.

virtual void gcu::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.

Definition at line 193 of file gcu/application.h.


Member Data Documentation

std::map<std::string, GdkPixbufFormat*> gcu::Application::m_SupportedPixbufFormats [protected]

std::map of the supported pixbuf formats. Keys are the mime type names.

Definition at line 212 of file gcu/application.h.

Referenced by GetSupportedPixbufFormats().


The documentation for this class was generated from the following file:
Generated on Thu Dec 20 11:20:46 2007 for The Gnome Chemistry Utils by  doxygen 1.5.4