gcu::Application Class Reference

#include <gcu/application.h>

List of all members.

Public Member Functions

 Application (string name, string datadir=DATADIR)
void OnHelp (string s="")
bool HasHelp ()
string & GetName ()


Detailed Description

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

Definition at line 37 of file application.h.


Constructor & Destructor Documentation

gcu::Application::Application ( string  name,
string  datadir = DATADIR 
)

Parameters:
name,: the name to use for the default icon of all windows and the help file (with .xml extension).
datadir,: where data for the application are stored.
The datadir variable is used to build the full path to the help file: datadir+"/gnome/help/"+name+"/"+LANG+"/"+name".xml".


Member Function Documentation

void gcu::Application::OnHelp ( 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.

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 67 of file application.h.


The documentation for this class was generated from the following file:
Generated on Sun Jan 14 15:28:02 2007 for The Gnome Chemistry Utils by  doxygen 1.5.1