CATApp Class Reference
[GUI Application library for CAT]

#include <CATApp.h>

Inheritance diagram for CATApp:

List of all members.

---

Detailed Description

Application parent class - derive from this for each app made.

CATApp is an attempt at virtualizing enough of the idea of an application that we don't have to rewrite our entrypoint code each time or ifdef code depending on whether we're in a VST, a console app, or whatever.

Definition at line 53 of file CATApp.h.

Public Types
enum	CATPROMPTTYPE {   CATPROMPT_YESNO,   CATPROMPT_OKCANCEL,   CATPROMPT_OK,   CATPROMPT_YESNOCANCEL }
Public Member Functions
	CATApp (CATINSTANCE instance, CATRunMode runMode, const CATString &appName)
virtual	~CATApp ()
virtual CATString	GetBaseDir ()
virtual CATString	GetDataDir ()
virtual CATString	GetSkinDir ()
virtual CATString	GetHelpDir ()
virtual CATResult	InitWaitDlg (CATInt32 bmpId, CATRect &textRect, CATInt32 progressOnId=0, CATInt32 progressOffId=0, CATInt32 progressLeft=0, CATInt32 progressTop=0)
virtual CATWaitDlg *	GetWaitDlg ()
virtual void	SetWaitString (const CATString &waitStr)
virtual void	SetWaitProgress (CATFloat32 progress)
virtual void	SetWaitStatus (const CATString &waitStr, CATFloat32 progress)
CATFileSystem *	GetAppFileSystem ()
CATFileSystem *	GetGlobalFileSystem ()
CATRunMode	GetRunMode ()
virtual CATResult	Run ()
virtual void	DisplayError (const CATResult &resultCode, CATWindow *wnd=0)
virtual void	DisplayMessage (const CATString &message, CATWindow *wnd=0)
virtual CATResult	DisplayPrompt (const CATString &message, CATPROMPTTYPE prompt, CATWindow *wnd=0)
virtual CATResult	OpenFileDialog (const CATString &title, std::vector< CATString > &filetypeList, CATString &returnPath, CATWindow *parentWnd=0)
virtual CATResult	SaveFileDialog (const CATString &title, std::vector< CATString > &filetypeList, CATString &returnPath, CATWindow *parentWnd=0, bool promptOverwrite=true, const CATString &fileExtension="")
CATString	GetString (CATUInt32 stringId)
CATString	GetAppName ()
CATString	GetAppExePath ()
CATPrefs *	GetPrefs ()
CATPrefs *	GetTempPrefs ()
CATINSTANCE	GetInstance ()
CATResult	LoadSkin (const CATString &skinPath)
CATGuiFactory *	GetGUIFactory ()
CATSkin *	GetSkin ()
virtual CATResult	OnStart ()
virtual CATResult	OnEnd (const CATResult &result)
virtual CATResult	OnEvent (const CATEvent &event, CATInt32 &retVal)
	OnEvent() is called as events are received that need to be processed by the application.
virtual void	OnCommand (CATCommand &command, CATControl *ctrl, CATWindow *wnd, CATSkin *skin)
virtual CATResult	MainLoop ()
virtual void	ExitApp ()
	ExitApp() requests an immediate exit.
virtual bool	IsExiting ()
	IsExiting() returns true if the application is in the process of exiting.
virtual void	OnHelp ()
	OnHelp() is called when the user requests help.
virtual CATString	GetVersionString ()
CATResult	AddResourceImage (const CATString &path, CATImage *image)
CATResult	GetResourceImage (const CATString &path, CATImage *&image)
CATResult	FlushResourceCache ()
virtual void	OSOnAppCreate ()
Static Protected Member Functions
static void	SkinLoadCB (CATFloat32 progress, const CATString &status, void *userParam)
Protected Attributes
bool	fExiting
CATPrefs *	fPrefs
CATPrefs *	fTempPrefs
CATMutex	fAppLock
CATStringTableCore	fStringTable
CATRunMode	fRunMode
CATFileSystem *	fGlobalFileSystem
CATString	fBaseDir
CATString	fDataDir
CATString	fHelpDir
CATString	fProgramPath
CATString	fAppName
CATINSTANCE	fAppInstance
CATString	fSkinDir
CATGuiFactory *	fGUIFactory
CATSkin *	fSkin
CATWaitDlg *	fWaitDlg
std::map< CATString, CATImage * >	fImageCache

---

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

• CATGUI/CATApp.h
• CATGUI/CATApp.cpp
• CATGUI/CATApp_Win32.cpp

---