GApp Class Reference

Singleton class for handling application wide settings and methods. More...

#include <LgiClasses.h>

List of all members.

Public Member Functions
bool	IsOk ()
	Returns true if the GApp object initialized correctly.
OsProcessId	GetProcessId ()
	Returns this processes ID.
OsThreadId	GetGuiThread ()
	Returns the thread currently running the active message loop.
	GApp (char *MimeType, OsAppArguments &AppArgs, GAppArguments *ObjArgs=0)
	Construct the object.
virtual	~GApp ()
	Destroys the object.
void	SetAppArgs (OsAppArguments &AppArgs)
	Resets the arguments.
OsAppArguments *	GetAppArgs ()
	Returns the arguemnts.
char *	GetArgumentAt (int n)
	Returns the n'th argument as a heap string. Free with DeleteArray(...).
bool	Run (bool Loop=true)
	Enters the message loop.
void	OnCommandLine ()
	Event called to process the command line.
void	OnReceiveFiles (GArray< char * > &Files)
	Event called to process files dropped on the application.
void	Exit (int Code=0)
	Exits the event loop with the code specified.
bool	GetOption (char *Option, GArray< char > &Buf)
	Parses the command line for a switch.
bool	GetOption (char *Option, char *Dst=0, int DstSize=0)
	Parses the command line for a switch.
GXmlTag *	GetConfig (char *Tag)
	Gets the application conf stored in lgi.conf.
void	SetConfig (GXmlTag *Tag)
	Sets a single tag in the config. (Not written to disk).
GViewI *	GetFocus ()
	Gets the control with the keyboard focus.
bool	GetFileMimeType (char *File, char *Mime, int BufLen)
	Gets the MIME type of a file.
int32	GetMetric (int Metric)
	Get a system metric.
GMouseHook *	GetMouseHook ()
	Get the mouse hook instance.
Static Public Member Functions
static GApp *	ObjInstance ()
	Use 'LgiApp' to return a pointer to the GApp object.
Public Attributes
GFont *	SystemNormal
	The system font.
GFont *	SystemBold
	The system font in bold.
GWindow *	AppWnd
	Pointer to the applications main window.
Friends
class	GView
class	GMouseHook

---

Detailed Description

Singleton class for handling application wide settings and methods.

This should be the first class you create, passing in the arguments from the operating system. And once your initialization is complete the 'Run' method is called to enter the main application loop that processes messages for the life time of the application.

---

Constructor & Destructor Documentation

GApp::GApp (  char *  MimeType, OsAppArguments &  AppArgs, GAppArguments *  ObjArgs = 0 )

Construct the object. Parameters: MimeType  The application's mime type. Typically 'application/x-[appname]'. This is mostly ignored on Win32 and Linux, but is useful on BeOS. AppArgs  The arguments passed in by the OS. ObjArgs  Optional args

---

Member Function Documentation

void GApp::Exit (  int  Code = 0  )

Exits the event loop with the code specified. Parameters: Code  The application exit code.

bool GApp::GetFileMimeType (  char *  File, char *  Mime, int  BufLen )

Gets the MIME type of a file. Parameters: File  The file to identify Mime  The detected MIME type. BufLen  The size of Mime

int32 GApp::GetMetric (  int  Metric  )

Get a system metric. Parameters: Metric  One of LGI_MET_DECOR_X, LGI_MET_DECOR_Y

bool GApp::GetOption (  char *  Option, char *  Dst = 0, int  DstSize = 0 )

Parses the command line for a switch. Returns: true if the option exists. Parameters: Option  The option to look for. Dest  The buffer to receive the value of the command line parameter or NULL if you don't care. DestLen  The buffer size in bytes

bool GApp::GetOption (  char *  Option, GArray< char > &  Buf )

Parses the command line for a switch. Returns: true if the option exists. Parameters: Option  The option to look for. Buf  The buffer to receive the value.

bool GApp::Run (  bool  Loop = true  )

Enters the message loop. Parameters: Loop  If true this function will return when the application exits (with LgiCloseApp()). Otherwise if false only pending events will be processed and then the function returns.

---

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

• LgiClasses.h
• linux/Lgi/GApp.cpp
• mac/Lgi/GApp.cpp
• win32/Lgi/GApp.cpp

---