Application Class Reference

Represents an instance of the Camelot application. More...

#include <app.h>

List of all members.

Public Member Functions
	Application ()
	Initialise the application.
	~Application ()
	Destroys any documents associated with this object.
BOOL	Init ()
	Initialise the application, including the user preferences system. This is the earliest kernel-level code to be called - do NOT ADD THINGS HERE. Almost everything that needs to be initialised should go in InitKernel, which gets called after this and some OIL initialisation. If you think you qualify to add something here, speak to Andy first.
BOOL	LateInit ()
	Initialise the application object bits that require the preferences system to be fully up & running. Currently that means the pen only.
void	Deinit ()
	Close down the kernel application object, including the user preferences system.
BOOL	CreateDragTargets (DragInformation *DragInfo)
void	AddRenderRegion (RenderRegion *)
	To add a RenderRegion object to the RenderList. Automatically sets a flag to do immediate rendering if the render region is an immediate one.
BOOL	DeleteRenderRegion (RenderRegion *)
	To remove a RenderRegion object from the RenderList. If the region in not in the list, no errors occur. The RenderRegion object will be destroyed (i.e. delete will be called on it).
void	DeleteRenderRegions (Document *pDoc)
void	DeleteRenderRegions (View *pView)
RenderRegionList *	GetRegionList ()
	Gets a pointer to the Applications RenderRegion list.
BOOL	IsRenderingComplete ()
BOOL	ServiceRendering (BOOL bImmediate=FALSE)
	Render some objects! This function will either render any outstanding 'immediate' render regions to completion, or render a background render regions for one time-slice.
BOOL	IsBgRendering ()
	Find out if there is Background rendering in progress or not.
ColourManager *	FindTheColourManager (void)
void	UpdateSelection ()
SelRange *	FindSelection ()
BlobManager *	GetBlobManager ()
ATMIniCache *	GetATMIniCache ()
FontManager *	GetFontManager ()
XaraCMS *	GetCMSManager () const
PrintMarksMan *	GetMarksManager () const
PlugInManager *	GetPlugInManager () const
FilterManager *	GetFilterManager () const
APIObject *	GetAPIObject () const
NoiseMan *	GetNoiseManager () const
HandleManager *	GetHandleManager () const
WizOps *	GetWizOps () const
CBitmapCache *	GetBitmapCache () const
GlobalBitmapList *	GetGlobalBitmapList ()
GlobalFractalList *	GetGlobalFractalList ()
void	RegisterDocComponent (DocComponentClass *)
	Register a new Document Component class with the application. This class will be asked to add an instance to a document every time a new document is created.
DocComponentClass *	EnumerateDocComponents (DocComponentClass *)
	Allow the caller to examine/use all the registered document components. pContext should be NULL for the first call, which will return the first registered document component. After that, the returned pointer should be passed back in to this function, which will return the next one, and so on. For example: MonoOn DocComponentClass *pDocComp = NULL; do { pDocComp = Camelot.EnumerateDocComponents(pDocComp);.
BOOL	ApplyDocComponents (BaseDocument *)
	Given a document, apply all the currently registered document components to it. i.e., add a colour table, units information, etc.
BOOL	OnKeyPress (KeyPress *pKeyPress)
	This is where key presses are handled in Camelot. It does the following in this order -.
BOOL	OnIdle (BOOL IdleRedraw)
	This is where idle events are recived by the kernel.
void	RemoveIdleProcessor (INT32 Priority, Operation *pOp)
	Stops an operation from receiving idle events.
void	RegisterIdleProcessor (INT32 Priority, Operation *pOp)
	If an operation wants to do processing on idle events then it must register to receive them. It registers by calling this function with a pointer to itself. On idle events the operations OnIdle function is called.
void	NeedMoreIdles ()
	Tells the application we need more idles.
void	DumpAllOps (Document *pDoc)
	To find the single 'global' ColourManager instance in Camelot Dumps information about all the operations in the history list to the debugger.
void	DumpLastOp (Document *pDoc)
	Dumps information about the last operation in the history list to the debugger.
void	DumpTree (BaseDocument *pDoc)
	Dumps information about the document tree to the debugger.
void	DumpAllOps ()
void	DumpLastOp ()
void	DumpTree ()
CTemplateManager &	GetTemplateManager ()
ObjectCache *	GetObjectCache ()
	Dumps information about the document tree to the debugger return a pointer to the cache object so that external objects can add object in the cache.
void	ShowViewScrollers (BOOL fIsVisible)
void	WritePreferences ()
void	WipePreferenceFile ()
void	WipeDangerousPrefs ()
BOOL	DeclareSection (LPTCHAR Section, UINT32 InitialSize)
BOOL	DeclarePref (LPTCHAR Section, LPTCHAR Pref, INT32 *PrefVar, INT32 Min=INT_MIN, INT32 Max=INT_MAX)
BOOL	DeclarePref (LPTCHAR Section, LPTCHAR Pref, UINT32 *PrefVar, UINT32 Min=0, UINT32 Max=UINT_MAX)
BOOL	DeclarePref (LPTCHAR Section, LPTCHAR Pref, double *PrefVar, double Min=DBL_MIN, double Max=DBL_MAX)
BOOL	DeclarePref (LPTCHAR Section, LPTCHAR Pref, StringBase *PrefVar)
BOOL	GetPrefValue (LPTCHAR Section, LPTCHAR Pref, INT32 *PrefVar)
BOOL	GetPrefValue (LPTCHAR Section, LPTCHAR Pref, UINT32 *PrefVar)
BOOL	GetPrefValue (LPTCHAR Section, LPTCHAR Pref, double *PrefVar)
BOOL	SetPrefValue (LPTCHAR Section, LPTCHAR Pref, INT32 *PrefVar)
BOOL	SetPrefValue (LPTCHAR Section, LPTCHAR Pref, UINT32 *PrefVar)
BOOL	SetPrefValue (LPTCHAR Section, LPTCHAR Pref, double *PrefVar)
BOOL	SetPrefDirect (LPTCHAR Section, LPTCHAR Pref, const TCHAR *pValue, BOOL Force=FALSE)
BOOL	SetPrefDirect (LPTCHAR Section, LPTCHAR Pref, INT32 *pValue)
BOOL	SetPrefDirect (LPTCHAR Section, LPTCHAR Pref, UINT32 *pValue)
BOOL	SetPrefDirect (LPTCHAR Section, LPTCHAR Pref, double *pValue)
BOOL	GetPrefDirect (LPTCHAR Section, LPTCHAR Pref, StringBase *pValue)
BOOL	GetPrefDirect (LPTCHAR Section, LPTCHAR Pref, INT32 *pValue)
BOOL	GetPrefDirect (LPTCHAR Section, LPTCHAR Pref, UINT32 *pValue)
BOOL	GetPrefDirect (LPTCHAR Section, LPTCHAR Pref, double *pValue)
BOOL	GetConvertToEditableShapesDPI (INT32 *pValue)
	Wrapper function for gaining access to convert to editable shapes DPI (as requested by karim).
BOOL	CamelotIsDying ()
void	ShuttingDown (BOOL fState=TRUE)
void	CheckRealDownload ()
	Disables RealDownload browser integration if necessary - to prevent camelot from dying when downloading files that are registered with RealDownload.
void	ResetRealDownload ()
	Re-enables RealDownload browser integration if we disabled it.
BOOL	UpdateStatusBarText (String_256 *text, BOOL PrefixSelDesc=TRUE)
	Just interfaces to similar StatusLine funtion Notes: This has been bodged by Jason to return without an error if the status line has not yet been initialised as the progress system is tries to use it in this state!
BOOL	LockOutControlHelp ()
	Just interfaces to similar StatusLine funtion Notes: This is really a bodge to fix the annoying features of camelot that persist in infinitely updating the status bar with different text. At present, this occurs in two places (known to me): the transparency slider and when typing text within the text tool. This function locks the status bar to prevent these guys such annoying things. NOTE: if one calls this - then you MUST also have a matching Application::UnlockControlHelp () somewhere; cause otherwise camelots status bar will never again update itself ....
BOOL	UnlockControlHelp ()
	Just interfaces to similar StatusLine funtion Notes: See Application::LockOutControlHelp () See Also: Application::LockOutControlHelp ().
CCStatusBar *	GetpCCStatusBar ()
	return pointer to CMainFrame::CCStatusBar
StatusLine *	GetpStatusLine ()
void	RegenerateNodesInList ()
	Calls all of the regeneration functions of the nodes in the list.
BOOL	AddNodeToRegenList (Node *pNode)
	Adds a node to the regeneration list.
Public Attributes
List	Documents
BOOL	BgRendering
SelRange *	Selection
Protected Member Functions
BOOL	InitFilterManager ()
	Support function to initialize this Application's FilterManager.
BOOL	DeinitFilterManager ()
	Support function to deinitialize & destruct this Application's FilterManager.
BOOL	InitWizOps ()
	Support function to initialize this Application's WizardOfOps from the local registry.
BOOL	DeinitWizOps ()
	Support function to deinitialize & destruct this Application's WizOps.
Private Member Functions
	CC_DECLARE_MEMDUMP (Application)
BOOL	CallIdleProcessors ()
	To call registered operations OnIdle functions.
BOOL	ChangeRealDownloadBrowserOtion (HKEY rootKey, HKEY key, BOOL changeVal)
	Change the RealDownload "EnableBrowserWatch" key value.
Private Attributes
RenderRegionList	RenderList
BOOL	ImmediateRenderPending
Preferences *	CamelotPrefs
ColourManager *	TheColourManager
BlobManager *	BlobMgr
List *	DocComponentClasses
GlobalBitmapList	GlobalBitmaps
GlobalFractalList	GlobalFractals
List	IdleHighPriorityOps
List	IdleLowPriorityOps
ATMIniCache *	pATMIniCache
FontManager *	FontMgr
XaraCMS *	CMSManager
PrintMarksMan *	TheMarksManager
PlugInManager *	ThePlugInManager
FilterManager *	TheFilterManager
APIObject *	TheAPIObject
HandleManager *	TheHandleManager
NoiseMan *	TheNoiseManager
ObjectCache *	m_pObjCache
CBitmapCache *	TheBitmapCache
WizOps *	TheWizardOfOps
StatusLine *	m_pStatusLine
std::auto_ptr< CTemplateManager >	m_pTemplateManager
BOOL	CamelotShuttingDown
BOOL	DisabledRealDownload
HKEY	key
HKEY	key2
List	RegenList

---

Detailed Description

Represents an instance of the Camelot application.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

20/5/1993 Base Class: None

General

There is only one Application object; it is a global, and it is called Camelot.

The data member 'Documents' is a list of 'Document' objects associated with this instance of the application. Any documents left in this list are deleted by the Application's destructor.

The data member 'RenderRegions' is a RenderRegionList object, and is the list of RenderRegions outstanding for this instance of the application.

The data member 'Selection' is a SelRange object which caches information about the current selection for quick access. NOTE: There is only one Selection object and it is used by all documents because the selection follows the input focus - when the user selects something in a document any existing selection in any other document is cleared. So that the inline functions get fast access to the SelRange object the Application class is a friend of the SelRange class.

User Preferences

The Camelot object is responsible for controlling the application preferences.

When a client wishes to use a preference, they should allocate some space to hold its value, and then use DeclarePref to inform the preferences system of its existence.

e.g. MonoOn INT32 AutoSaveDelay; Camelot.DeclarePref("Global", "AutoSaveDelay", &AutoSaveDelay); MonoOff

This will inform the preferences system that there is a preference called AutoSaveDelay in the section called Global (the names of the sections and preferences are always case-insensitive). The DeclarePref call will also attempt to read this preference from the application's preference file - if it exists, it will read the value and store it in the AutoSaveDelay variable. The DeclarePref function is currently overloaded for INTs, UINTs, doubles, and Camelot String objects.

NB! You should NOT pass the address of an auto variable to DeclarePref, because this will obviously be invalid as soon as your function exits, and will cause interesting values to be written to the .ini file - hence all preference variables should be declared as static . (This should be fairly obvious though, because actually using a preference variable that isn't static wouldn't really work all that well.)

Another effect of declaring a preference is that when the application saves the preferences out (e.g. on normal application close-down), the preference is automatically saved out under its correct name and section, using the value contained in (assuming the above example) AutoSaveDelay when the save occurs.

Note that before a preference can be declared, its parent section must have been declared via a call to DeclareSection :

MonoOn Application::DeclareSection("Global", 100); MonoOff

The value of 100 indicates that the caller expects there to about 100 preferences stored in this section - this is used as a guideline by the preferences system when allocating memory for preferences. This is not an absolute limit - the section is automatically extended when necessary, but the more accurate the initial estimate, the more efficient the memory usage will be. Obviously for some sections, the accuracy is limited - for example, it may depend on how many tools the user loads/uses.

Returns:

Errors: None.

Definition at line 229 of file app.h.

---

Constructor & Destructor Documentation

Application::Application (   )

Initialise the application. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 20/5/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: None. Definition at line 188 of file app.cpp. : m_pTemplateManager( new CTemplateManager ) { // WEBSTER - markn 25/4/97 // No pen stuff required in Webster // Now taken out via vector stroking code Neville 2/10/97 #ifdef VECTOR_STROKING PressurePen = NULL; PenInitialised = FALSE; #endif // VECTOR_STROKING CamelotPrefs = NULL; Selection = NULL; TheColourManager = NULL; BlobMgr = NULL; DocComponentClasses = NULL; pATMIniCache = NULL; FontMgr = NULL; CMSManager = NULL; TheMarksManager = NULL; ThePlugInManager = NULL; TheFilterManager = NULL; TheAPIObject = NULL; TheHandleManager = NULL; TheNoiseManager = NULL; TheWizardOfOps = NULL; DisabledRealDownload = FALSE; PORTNOTE("other","Removed HKEY usage") #ifndef EXCLUDE_FROM_XARALX key = NULL; key2 = NULL; #endif #ifdef AUTOMATION TheConcurrencyController = NULL; #endif // This variable will get set to TRUE when Camelot starts to shut down CamelotShuttingDown = FALSE; BgRendering = FALSE; // Temporary: Remove when Kernel StatusLine is actually created by Oil statusline m_pStatusLine = NULL; }

Application::~Application (   )

Destroys any documents associated with this object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 20/5/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: None. Definition at line 249 of file app.cpp. { // Delete any documents still associated with this application Document *pDocument = (Document *) Documents.GetHead(); while (pDocument != NULL) { delete Documents.RemoveItem(pDocument); pDocument = (Document *) Documents.GetHead(); } // ERROR3IF(DocComponentClasses != NULL, // "Application was not properly de-initialised"); if (DocComponentClasses != 0) TRACE( wxT("WARNING: Application was not properly de-initialised\n") ); RegenList.DeleteAll(); }

---

Member Function Documentation

BOOL Application::AddNodeToRegenList (  Node *  pNode  )

Adds a node to the regeneration list. Author: David_McClarnon (Xara Group Ltd) <camelotdev@xara.com> Date: 1/6/99 Parameters: The  node to add to the list [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1878 of file app.cpp. { // check to see if the node is already in the list NodeListItem * pItem = (NodeListItem *)RegenList.GetHead(); BOOL bAdd = TRUE; while (pItem) { if (pItem->pNode == pNode) { bAdd = FALSE; break; } pItem = (NodeListItem *)RegenList.GetNext(pItem); } if (!bAdd) return TRUE; pItem = new NodeListItem(pNode); ERROR2IF(!pItem, FALSE, "Memory Error !"); RegenList.AddTail(pItem); return TRUE; }

void Application::AddRenderRegion (  RenderRegion *  pRegion  )

To add a RenderRegion object to the RenderList. Automatically sets a flag to do immediate rendering if the render region is an immediate one. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 27/5/93 Parameters: pRegion  - pointer to the RenderRegion to add to the list. [INPUTS] Returns: Region - the render region to add. See also: RenderRegion; List Definition at line 916 of file app.cpp. { // Is this render region an immediate one? View *pView = pRegion->GetRenderView(); ENSURE(pView != NULL, "No View in AddRenderRegion!"); if (!pView->GetForeBackMode()) { // TRACE(_T("ImmediateRender\n")); // Yes - set the flag to indicate we should do some immediate rendering on the // next redraw event. ImmediateRenderPending = TRUE; } // Add this render region to the list. RenderList.Merge(pRegion); }

BOOL Application::ApplyDocComponents (  BaseDocument *  pDocument  )

Given a document, apply all the currently registered document components to it. i.e., add a colour table, units information, etc. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/08/94 Parameters: pDocument  - the document to add the components to. [INPUTS] Returns: TRUE if all the components were added successfully; FALSE if not. Errors: Out of memory, or other errors depending on implementations of each document component. See also: DocComponent; DocComponentClass Definition at line 1170 of file app.cpp. { // Go through the registered components and add their virtual function to add an // instance of the class to the Document object... DocComponentClass *pItem = (DocComponentClass *) DocComponentClasses->GetHead(); while (pItem != NULL) { if (!pItem->AddComponent(pDocument)) { // Component could not be added - probably out of memory. return FALSE; } // Try the next one pItem = (DocComponentClass *) DocComponentClasses->GetNext(pItem); } // All the components were successfully added return TRUE; }

BOOL Application::CallIdleProcessors (   )  [private]

To call registered operations OnIdle functions. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/94 Parameters: -  [INPUTS] Returns: TRUE if the registered operations require more idle events. FALSE if no operations need further idle events. Notes: It is assumed that if there are any processes registered, we still require idle events. When idle processsor methods are called, they return the following values: HIGH PRIORITY: TRUE = (claim) DO NOT call low-priority processors FALSE = (don't claim) DO call low-priority processors LOW PRIORITY: The return code is ignored. This allows us to drag in the DragManager, updating fequently on high-priority idles, but when the mouse is not moving, allow low-priority idles to be called (which allows scrolling in galleries to be highly responsive, but background redraws will kick into action very fast while the mouse stays still) Most high-priority handlers will just override all events while they're running, though there should never be very many high-priority handlers around. [TODO: Perhaps low priority handlers should always be called once in a while (e.g. always call them if they have not been called for a second or so), so that we can never get inot a complete-lock-out situation.] Returns: Errors: - See also: Application::RegisterIdleProcessor Definition at line 1393 of file app.cpp. { // If the system is disabled (due to an error box being up) we must not do anything, // as we definitely do not want to cause a re-entrant error situation! if( CCamApp::IsDisabled() ) return(TRUE); BOOL CallLowPriorityHandlers = TRUE; ListItemOpPtr *CurrentOp = (ListItemOpPtr*)IdleHighPriorityOps.GetHead(); ListItemOpPtr *NextOp; // If there are no registered processors, we'll return FALSE as idles aren't needed BOOL MoreIdlesNeeded = FALSE; while (CurrentOp != NULL) { // Remember the next item in the list now, in case this one deregisters itself NextOp = (ListItemOpPtr *) IdleHighPriorityOps.GetNext(CurrentOp); // Call the handler, and if it claims idles, disable calling of low-priority handlers if (CurrentOp->pOp->OnIdleEvent()) { MoreIdlesNeeded = TRUE; // we need more idles CallLowPriorityHandlers = FALSE; } CurrentOp = NextOp; } // If nobody objects to a low-priority pass, do one if (CallLowPriorityHandlers) { CurrentOp = (ListItemOpPtr*)IdleLowPriorityOps.GetHead(); while (CurrentOp != NULL) { // Remember the next item in the list now, in case this one deregisters itself NextOp = (ListItemOpPtr *) IdleLowPriorityOps.GetNext(CurrentOp); MoreIdlesNeeded = MoreIdlesNeeded || CurrentOp->pOp->OnIdleEvent(); CurrentOp = NextOp; } } return MoreIdlesNeeded; }

BOOL Application::CamelotIsDying (   )  [inline]

Definition at line 544 of file app.h. { return CamelotShuttingDown; }

Application::CC_DECLARE_MEMDUMP (  Application   )  [private]

BOOL Application::ChangeRealDownloadBrowserOtion (  HKEY  rootKey, HKEY  key, BOOL  changeVal )  [private]

Change the RealDownload "EnableBrowserWatch" key value. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/2000 Parameters: rootKey  - HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER (not checked) [INPUTS] key - already opened subpath key (to realdownload directory) changeVal - value to change the realdownload "EnableBrowserWatch" key to -  [OUTPUTS] Returns: TRUE if changed value, FALSE otherwise Errors: - See also: - Definition at line 1928 of file app.cpp. { LPCTSTR path = "software\\realnetworks\\realdownload\\"; const INT32 buf_size = 256; DWORD dwIndex = 0; // index of subkey to enumerate TCHAR Name[buf_size]; // buffer for subkey name DWORD cbName = buf_size; // size of subkey buffer TCHAR Class[buf_size]; // buffer for class string DWORD cbClass = buf_size; // size of class buffer FILETIME ftLastWriteTime; // time key last written to BOOL returnVal = FALSE; INT32 nResult = ERROR_SUCCESS; // String_256 KeyName; do { // reset the string sizes to their maximum for receiving data cbName = buf_size; cbClass = buf_size; // Does another sub-key exist? nResult = ::RegEnumKeyEx(key, dwIndex, Name, &cbName, NULL, Class, &cbClass, &ftLastWriteTime); if (nResult == ERROR_SUCCESS) { // weve hit a real download version number - scan it .... char subpath [100]; char newpath [200]; sprintf (subpath, "%s", Name); sprintf (newpath, "%s%s", path, subpath); HKEY subkey = OpenRegKey (rootKey, newpath); DWORD newval = (DWORD) changeVal; if (subkey) { DWORD type, dataVal, dataSize; if (RegQueryValueEx (subkey, "EnableBrowserWatch", NULL, &type, (unsigned char*) &dataVal, &dataSize) == ERROR_SUCCESS) { BOOL currentVal = (BOOL) dataVal; if (currentVal == TRUE) { if (RegSetValueEx (subkey, "EnableBrowserWatch", NULL, REG_DWORD, (unsigned char*) &newval, sizeof (newval)) == ERROR_SUCCESS) { RegCloseKey (subkey); return (TRUE); } else { RegCloseKey (subkey); return (FALSE); } } else if ((currentVal == FALSE) && (changeVal == TRUE)) // were resetting to TRUE { if (RegSetValueEx (subkey, "EnableBrowserWatch", NULL, REG_DWORD, (unsigned char*) &newval, sizeof (newval)) == ERROR_SUCCESS) { RegCloseKey (subkey); return (TRUE); } else { RegCloseKey (subkey); return (FALSE); } } } RegCloseKey (subkey); } // KeyName = Name; } // increment our indexing item and try again dwIndex ++; } while (nResult == ERROR_SUCCESS); if (DisabledRealDownload) { return (TRUE); } else { return (FALSE); } return false; }

void Application::CheckRealDownload (   )

Disables RealDownload browser integration if necessary - to prevent camelot from dying when downloading files that are registered with RealDownload. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 2044 of file app.cpp. { PORTNOTE("other","Application::CheckRealDownload - do nothing") #ifndef EXCLUDE_FROM_XARALX key = OpenRegKey (HKEY_CURRENT_USER, "software\\realnetworks\\realdownload\\"); if (key) { // disable it .... DisabledRealDownload = ChangeRealDownloadBrowserOtion (HKEY_CURRENT_USER, key, FALSE); if (DisabledRealDownload) { key2 = OpenRegKey (HKEY_LOCAL_MACHINE, "software\\realnetworks\\realdownload\\"); if (key2) { // disable it .... ChangeRealDownloadBrowserOtion (HKEY_LOCAL_MACHINE, key2, FALSE); } } } else { key2 = OpenRegKey (HKEY_LOCAL_MACHINE, "software\\realnetworks\\realdownload\\"); if (key2) { // disable it .... DisabledRealDownload = ChangeRealDownloadBrowserOtion (HKEY_LOCAL_MACHINE, key2, FALSE); } } #endif }

BOOL Application::CreateDragTargets (  DragInformation *  DragInfo  )

Definition at line 1498 of file app.cpp. { Document* pDocument = (Document*) Documents.GetHead(); while (pDocument != NULL) { pDocument->CreateDragTargets(DragInfo); pDocument = (Document*) Documents.GetNext(pDocument); } return TRUE; }

BOOL Application::DeclarePref (  LPTCHAR  Section, LPTCHAR  Pref, StringBase *  PrefVar )  [inline]

Definition at line 490 of file app.h. { return CamelotPrefs->DeclarePref(Section, Pref, PrefVar); };

BOOL Application::DeclarePref (  LPTCHAR  Section, LPTCHAR  Pref, double *  PrefVar, double  Min = DBL_MIN, double  Max = DBL_MAX )  [inline]

Definition at line 486 of file app.h. { return CamelotPrefs->DeclarePref(Section, Pref, PrefVar, Min, Max); };

BOOL Application::DeclarePref (  LPTCHAR  Section, LPTCHAR  Pref, UINT32 *  PrefVar, UINT32  Min = 0, UINT32  Max = UINT_MAX )  [inline]

Definition at line 482 of file app.h. { return CamelotPrefs->DeclarePref(Section, Pref, PrefVar, Min, Max); };

BOOL Application::DeclarePref (  LPTCHAR  Section, LPTCHAR  Pref, INT32 *  PrefVar, INT32  Min = INT_MIN, INT32  Max = INT_MAX )  [inline]

Definition at line 478 of file app.h. { return CamelotPrefs->DeclarePref(Section, Pref, PrefVar, Min, Max); };

BOOL Application::DeclareSection (  LPTCHAR  Section, UINT32  InitialSize )  [inline]

Definition at line 475 of file app.h. { return CamelotPrefs->DeclareSection(Section, InitialSize); };

void Application::Deinit (   )

Close down the kernel application object, including the user preferences system. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/8/93 Definition at line 617 of file app.cpp. { #ifdef PLUGINSUPPORT // Only add in if required - general plug-in removal at present // We need to ask the plug-in manager to save out its list of pathnames. // So before the prefs system is vaped. PlugInManager * pPlugMan = GetApplication()->GetPlugInManager(); if (pPlugMan) pPlugMan->WritePathNameList(); #endif // PLUGINSUPPORT #ifdef FREEHANDPLUGINS // clean up the memory used by MOA TRACEUSER( "claude", wxT("Free up frmo the handle manager\n") ); HandleManager* pHandleCleaning = GetApplication()->GetHandleManager(); if(pHandleCleaning) pHandleCleaning->FreeAll(); #endif // FREEHANDPLUGINS if (CamelotPrefs!=NULL) { CamelotPrefs->Deinit(); delete CamelotPrefs; CamelotPrefs = NULL; } if (Selection!=NULL) { delete Selection; Selection = NULL; } if (DocComponentClasses != NULL) { DocComponentClasses->DeleteAll(); delete DocComponentClasses; DocComponentClasses = NULL; } if (TheColourManager!=NULL) { ColourManager::Deinit(); delete TheColourManager; TheColourManager = NULL; } if (TheNoiseManager!=NULL) { TheNoiseManager->Destroy(); delete TheNoiseManager; TheNoiseManager=NULL; } #if !defined(EXCLUDE_FROM_RALPH) #if !defined(EXCLUDE_FROM_XARALX) PORTNOTE("colourmanager","Removed XaraCMS usage") if (CMSManager!=NULL) { CMSManager->Finalise(); delete CMSManager; CMSManager = NULL; } // VECTOR_STROKING - markn 25/4/97 // No pen stuff required in Webster // Taken out by vector stroking code Neville 2/10/97 #ifdef VECTOR_STROKING if (PressurePen != NULL) { delete PressurePen; PressurePen = NULL; } #endif // VECTOR_STROKING #endif // EXCLUDE_FROM_XARALX // Get rid of the blob manager if (BlobMgr!=NULL) { delete BlobMgr; BlobMgr = NULL; } #endif // EXCLUDE_FROM_RALPH PORTNOTE("other","Removed un-=impl. stuff") #ifndef EXCLUDE_FROM_XARALX // Get rid of the ATM Ini cache object if (pATMIniCache!=NULL) { delete pATMIniCache; pATMIniCache = NULL; } */ #endif // Get rid of the font manager if (FontMgr!=NULL) { delete FontMgr; FontMgr = NULL; } #if !defined(EXCLUDE_FROM_RALPH) #ifndef STANDALONE #ifndef WEBSTER // Do not do do on Webster as this conflicts with the CleanUpAfterExport code in BaseCamelotFilter // Toast the marks manager if (TheMarksManager!=NULL) { delete TheMarksManager; TheMarksManager = NULL; } #endif // WEBSTER #endif #endif #ifdef PLUGINSUPPORT // Only add in if required - general plug-in removal at present // Toast the plug-in manager if (ThePlugInManager != NULL) { delete ThePlugInManager; ThePlugInManager = NULL; } #endif // PLUGINSUPPORT #ifdef FREEHANDPLUGINS // Nuke the API interfaces (must be done after killing the plugin manager). Don't delete // it afterwards, it's all handled by the reference count... if(TheAPIObject != NULL) TheAPIObject->ShutDown(); // Delete the Moa handle manager if(TheHandleManager != NULL) { TRACEUSER( "claude", wxT("deleting the moa handle manager\n") ); delete TheHandleManager; TheHandleManager = NULL; } #endif // FREEHANDPLUGINS DeinitFilterManager(); if (m_pObjCache != NULL) { delete m_pObjCache; m_pObjCache = NULL; } if (TheBitmapCache) { TheBitmapCache->DeInitialise(); delete TheBitmapCache; TheBitmapCache = NULL; } DeinitWizOps(); #ifdef AUTOMATION DestroyCCC(); #endif // DialogManager was deinitialized a while ago, but this bit needs to be done after // the pref system has gone. It merely frees some memory DialogManager::FreePaneInfoHash(); ObjectRegistry::Delete(); }

BOOL Application::DeinitFilterManager (   )  [protected]

Support function to deinitialize & destruct this Application's FilterManager. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 26/12/96 Returns: TRUE if OK, FALSE if failed Definition at line 796 of file app.cpp. { BOOL Success = FALSE; FilterManager* pFilterManager = GetFilterManager(); if (pFilterManager != NULL) { Success = TheFilterManager->DeInit(); // ...ignore any errors if (!Success) { TRACE( wxT("Deinit of FilterManager not successful") ); } delete TheFilterManager; TheFilterManager = NULL; Success = TRUE; } else { TRACE( wxT("No Filter Manager") ); Success = FALSE; } return Success; }

BOOL Application::DeinitWizOps (   )  [protected]

Support function to deinitialize & destruct this Application's WizOps. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 26/12/96 Returns: TRUE if OK, FALSE if failed Definition at line 835 of file app.cpp. { BOOL Ok = TRUE; if (TheWizardOfOps != NULL) { delete TheWizardOfOps; TheWizardOfOps = NULL; } else { TRACE( wxT("No WizOps") ); Ok = FALSE; } return Ok; }

BOOL Application::DeleteRenderRegion (  RenderRegion *  Region  )

To remove a RenderRegion object from the RenderList. If the region in not in the list, no errors occur. The RenderRegion object will be destroyed (i.e. delete will be called on it). Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 27/5/93 Parameters: Region  - pointer to the RenderRegion to remove from the list. [INPUTS] Returns: TRUE if the region was in the list, FALSE otherwise. Errors: - See also: RenderRegion; List Definition at line 951 of file app.cpp. { #ifdef RALPH // Wait until it's safe to enter CCamApp::EnterGDrawCriticalSection(); #endif if (RenderList.FindPosition(Region) == NOT_IN_LIST) { #ifdef RALPH // Let another process have a go CCamApp::ExitGDrawCriticalSection(); #endif ENSURE( FALSE, "Couldn't find Region in List" ); return FALSE; } RenderList.Remove(Region); #ifdef RALPH // Let another process have a go CCamApp::ExitGDrawCriticalSection(); #endif return TRUE; }

void Application::DeleteRenderRegions (  View *  pView  )  [inline]

Definition at line 250 of file app.h. { RenderList.Remove(pView); };

void Application::DeleteRenderRegions (  Document *  pDoc  )  [inline]

Definition at line 248 of file app.h. { RenderList.Remove(pDoc); };

void Application::DumpAllOps (   )  [inline]

Definition at line 355 of file app.h. {DumpAllOps(NULL);} // The stupid QuickWatch window dosent allow default params!

void Application::DumpAllOps (  Document *  pDoc  )

To find the single 'global' ColourManager instance in Camelot Dumps information about all the operations in the history list to the debugger. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/95 Parameters: pDoc  points to the document containing the operation histor to dump, NULL for [INPUTS] selected doc. Displays  debug info [OUTPUTS] Returns: - See also: Application::DumpLastOp Definition at line 1690 of file app.cpp. { PORTNOTETRACE("other","Application::DumpAllOps - do nothing"); #ifndef EXCLUDE_FROM_XARALX #if DEBUG_TREE if (pDoc == NULL) pDoc = Document::GetSelected(); pDoc->GetOpHistory().DumpAll(); #endif #endif }

void Application::DumpLastOp (   )  [inline]

Definition at line 356 of file app.h. {DumpLastOp(NULL);}

void Application::DumpLastOp (  Document *  pDoc  )

Dumps information about the last operation in the history list to the debugger. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/95 Parameters: pDoc  points to the document containing the operation histor to dump, NULL for [INPUTS] selected doc. Displays  debug info [OUTPUTS] Returns: - See also: Application::DumpAllOps Definition at line 1719 of file app.cpp. { PORTNOTE("other","Application::DumpLastOp - do nothing") #ifndef EXCLUDE_FROM_XARALX #if DEBUG_TREE if (pDoc == NULL) pDoc = Document::GetSelected(); pDoc->GetOpHistory().DumpLast(); #endif #endif }

void Application::DumpTree (   )  [inline]

Definition at line 357 of file app.h. {DumpTree(NULL);}

void Application::DumpTree (  BaseDocument *  pDoc  )

Dumps information about the document tree to the debugger. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/8/95 Parameters: pDoc  points to the document containing the operation histor to dump, NULL for [INPUTS] selected doc. Displays  debug info [OUTPUTS] Returns: - See also: Application::DumpAllOps Definition at line 1748 of file app.cpp. { PORTNOTE("other","Removed DebugTreeDlg usage") #ifndef EXCLUDE_FROM_XARALX #if DEBUG_TREE DebugTreeDlg::TweeDump(pDoc); #endif #endif }

DocComponentClass * Application::EnumerateDocComponents (  DocComponentClass *  pContext  )

Allow the caller to examine/use all the registered document components. pContext should be NULL for the first call, which will return the first registered document component. After that, the returned pointer should be passed back in to this function, which will return the next one, and so on. For example: MonoOn DocComponentClass *pDocComp = NULL; do { pDocComp = Camelot.EnumerateDocComponents(pDocComp);. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/08/94 Parameters: pContext,:  NULL => Get the first document component [INPUTS] non-NULL => Get the next document component after the one pointed to by pContext. Returns: Pointer to the required document component. Do something groovy with pDocComp... } while (pDocComp != NULL); MonoOff See also: Application::RegisterDocComponent; DocComponent; DocComponentClass Definition at line 1137 of file app.cpp. { if (pContext == NULL) { // Return the first item in the list... return (DocComponentClass *) (DocComponentClasses->GetHead()); } else { // Return the next document component... return (DocComponentClass *) (DocComponentClasses->GetNext(pContext)); } }

SelRange* Application::FindSelection (   )  [inline]

Definition at line 270 of file app.h. { return(Selection); }; // SelRange object.

ColourManager* Application::FindTheColourManager (  void   )  [inline]

Definition at line 261 of file app.h. { return(TheColourManager); };

APIObject* Application::GetAPIObject (   )  const [inline]

Definition at line 303 of file app.h. { return TheAPIObject; }

ATMIniCache* Application::GetATMIniCache (   )  [inline]

Definition at line 285 of file app.h. { return pATMIniCache; }

CBitmapCache* Application::GetBitmapCache (   )  const [inline]

Definition at line 315 of file app.h. { return TheBitmapCache; }

BlobManager* Application::GetBlobManager (   )  [inline]

Definition at line 282 of file app.h. { return BlobMgr; }

XaraCMS* Application::GetCMSManager (   )  const [inline]

Definition at line 291 of file app.h. { return CMSManager; }

BOOL Application::GetConvertToEditableShapesDPI (  INT32 *  pValue  )

Wrapper function for gaining access to convert to editable shapes DPI (as requested by karim). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 13/11/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 2148 of file app.cpp. { return (Camelot.GetPrefValue(TEXT("Displays"),TEXT("CompCToEDPI"),pValue)); }

FilterManager* Application::GetFilterManager (   )  const [inline]

Definition at line 300 of file app.h. { return TheFilterManager; }

FontManager* Application::GetFontManager (   )  [inline]

Definition at line 288 of file app.h. { return FontMgr; }

GlobalBitmapList* Application::GetGlobalBitmapList (   )  [inline]

Definition at line 323 of file app.h. { return &GlobalBitmaps; }

GlobalFractalList* Application::GetGlobalFractalList (   )  [inline]

Definition at line 324 of file app.h. { return &GlobalFractals; }

HandleManager* Application::GetHandleManager (   )  const [inline]

Definition at line 309 of file app.h. {return TheHandleManager;}

PrintMarksMan* Application::GetMarksManager (   )  const [inline]

Definition at line 294 of file app.h. { return TheMarksManager; }

NoiseMan* Application::GetNoiseManager (   )  const [inline]

Definition at line 306 of file app.h. { return TheNoiseManager; }

ObjectCache * Application::GetObjectCache (   )

Dumps information about the document tree to the debugger return a pointer to the cache object so that external objects can add object in the cache. Author: Olivier_Gascoin (Xara Group Ltd) <camelotdev@xara.com> Date: 28/01/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: a pointer to the cache object See also: Application::Init(), Application::DeInit() Definition at line 1809 of file app.cpp. { return m_pObjCache; }

CCStatusBar * Application::GetpCCStatusBar (   )

return pointer to CMainFrame::CCStatusBar Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/94 Returns: pointer to CMainFrame::CCStatusBar else NULL if error (see Errors) Definition at line 1627 of file app.cpp. { PORTNOTETRACE("other","Application::GetpCCStatusBar - do nothing"); #ifndef EXCLUDE_FROM_XARALX CMainFrame* mfwindow = (CMainFrame*)(AfxGetApp()->m_pMainWnd); ERROR2IF(mfwindow==NULL,NULL,"Application::GetpCCStatusBar() - mfwindow==NULL"); return mfwindow->GetpCCStatusBar(); #else return NULL; #endif }

PlugInManager* Application::GetPlugInManager (   )  const [inline]

Definition at line 297 of file app.h. { return ThePlugInManager; }

BOOL Application::GetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, double *  pValue )  [inline]

Definition at line 525 of file app.h. { return CamelotPrefs->GetPrefDirect(Section, Pref, pValue); }

BOOL Application::GetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, UINT32 *  pValue )  [inline]

Definition at line 523 of file app.h. { return CamelotPrefs->GetPrefDirect(Section, Pref, pValue); }

BOOL Application::GetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, INT32 *  pValue )  [inline]

Definition at line 521 of file app.h. { return CamelotPrefs->GetPrefDirect(Section, Pref, pValue); }

BOOL Application::GetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, StringBase *  pValue )  [inline]

Definition at line 519 of file app.h. { return CamelotPrefs->GetPrefDirect(Section, Pref, pValue); }

BOOL Application::GetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, double *  PrefVar )  [inline]

Definition at line 498 of file app.h. { return CamelotPrefs->GetPrefValue(Section, Pref, PrefVar); };

BOOL Application::GetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, UINT32 *  PrefVar )  [inline]

Definition at line 496 of file app.h. { return CamelotPrefs->GetPrefValue(Section, Pref, PrefVar); };

BOOL Application::GetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, INT32 *  PrefVar )  [inline]

Definition at line 494 of file app.h. { return CamelotPrefs->GetPrefValue(Section, Pref, PrefVar); };

StatusLine * Application::GetpStatusLine (   )

Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/94 Returns: Pointer to CMainFrame::StatusLine else NULL if error (or not initialised) Notes: This has been bodged by Jason to return without an error if the mainframe has not yet been initialised as the progress system is tries to use it in this state! Definition at line 1651 of file app.cpp. { return StatusLine::Get(); }

RenderRegionList * Application::GetRegionList (   )

Gets a pointer to the Applications RenderRegion list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 9/6/95 Definition at line 897 of file app.cpp. { return &RenderList; }

CTemplateManager& Application::GetTemplateManager (   )  [inline]

Definition at line 455 of file app.h. { return *m_pTemplateManager.get(); }

WizOps* Application::GetWizOps (   )  const [inline]

Definition at line 312 of file app.h. { return TheWizardOfOps; }

BOOL Application::Init (  void   )

Initialise the application, including the user preferences system. This is the earliest kernel-level code to be called - do NOT ADD THINGS HERE. Almost everything that needs to be initialised should go in InitKernel, which gets called after this and some OIL initialisation. If you think you qualify to add something here, speak to Andy first. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the object initialised ok. Errors: None. Definition at line 299 of file app.cpp. { // Initialise the message handler class groups if(!( MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(MessageHandler)) && MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(Operation)) && MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(DialogOp)) && MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(OpDescriptor)) && MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(DialogBarOp)) && MessageHandler::RegisterClassGroup(CC_RUNTIME_CLASS(SelRangeMessageHandler)) )) { return FALSE; // Failed } #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) PORTNOTE("colourmanager","Removed XaraCMS usage") // Create the Xara CMS manager - we have to get this in there // before a colour manager initialise otherwise there'll be trouble. // Note that if this fails in any way, we continue happily, simply disabling // the advanced colour management functions. CMSManager = new XaraCMS; if (CMSManager != NULL) { // We got one. Let's initialise it if (!CMSManager->Initialise(1)) { delete CMSManager; CMSManager = NULL; } } CMSManager = NULL; #else CMSManager = NULL; #endif // startup the noise system TheNoiseManager = new NoiseMan; if (TheNoiseManager == NULL) return FALSE; if (!TheNoiseManager->Initialise()) return FALSE; // Initialise the colour system if (!ColourManager::Init()) return FALSE; // Create and initialise the Camelot Selection object // This must be done AFTER registering the SelRangeMessageHandler class above, // as the Selection tries to register a message handler when it is constructed. // Thus it is necessary to defer creation of the object until the msg system // has been appropriately set up. Selection = new SelRange; if (Selection == NULL) return(FALSE); // startup the noise system // Create and initialise the colour manager // THis is done here for the same reasons as described for the SelRange, above. TheColourManager = new ColourManager; if (TheColourManager == NULL) return(FALSE); // create and initialise a new Blob Manager BlobMgr = new BlobManager; if (BlobMgr == NULL) return FALSE; PORTNOTE("other","Removed init of stuff that is not supported") #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) // create the ATM ini cache. pATMIniCache = new ATMIniCache; if (pATMIniCache == NULL) return FALSE; #endif // Create the font mangler FontMgr = new FontManager; if (FontMgr == NULL) return FALSE; // And make sure its initialised; if (!FontMgr->Init()) return FALSE; #if !defined(EXCLUDE_FROM_RALPH) #ifndef STANDALONE #ifndef WEBSTER // Do not do do on Webster as this conflicts with the CleanUpAfterExport code in BaseCamelotFilter // Create a print marks manager please TheMarksManager = new PrintMarksMan; if (TheMarksManager == NULL) return FALSE; #endif // WEBSTER #endif #endif #if !defined(EXCLUDE_FROM_RALPH) && !defined(EXCLUDE_FROM_XARALX) #ifndef STANDALONE #ifdef FREEHANDPLUGINS // Only add in if required - general plug-in removal at present // Create the external (Freehand Xtra) API object TheAPIObject = new APIObject; if (TheAPIObject == NULL) return FALSE; // Actually we can probably run without this... #endif // FREEHANDPLUGINS #ifdef PLUGINSUPPORT // Create a plug-in manager please ThePlugInManager = new PlugInManager; if (ThePlugInManager == NULL) return FALSE; #endif // PLUGINSUPPORT #ifdef FREEHANDPLUGINS TRACEUSER( "claude", _T("new handlemanager\n")); TheHandleManager = new HandleManager; if (TheHandleManager == NULL) return FALSE; #endif // FREEHANDPLUGINS if (!InitFilterManager()) { return FALSE; } #endif // STANDALONE #endif // EXCLUDE_FROM_RALPH, EXCLUDE_FROM_XARALX #ifndef EXCLUDE_FROM_XARALX #ifdef AUTOMATION if (!InitCCC()) { return FALSE; } #endif #endif // Initialise the object registry. if (!ObjectRegistry::Init()) { // Error has been set return (FALSE); } if (!InitWizOps()) { return FALSE; } #if !defined(EXCLUDE_FROM_RALPH) // Create and initialise the CamelotPrefs object. // This object is dynamically created rather than being embedded in the Appliation object // because the Application destructor is called after the SimpleCCObject::MemoryDump() // function is called. Hence if the CamelotPrefs object were embedded, the MemoryDump // would list all the preference-related objects on application termination. CamelotPrefs = new Preferences; if (!((CamelotPrefs != NULL) && CamelotPrefs->Init())) return FALSE; #endif #ifdef VECTOR_STROKING // Neville 6/8/97 m_pObjCache = new ObjectCacheFIFO(50); // set a cache of 50 bytes if (m_pObjCache == NULL) return FALSE; // Set the cache size with an arbitrary value (in bytes) //m_ObjCache->SetMaxCacheSize(50); #endif // VECTOR_STROKING // Set up the Bitmap Cache... TheBitmapCache = new CBitmapCache(); TheBitmapCache->Initialise(); // Initialise with default settings // Get an empty list object to hold all the registered doc components DocComponentClasses = new List; if (DocComponentClasses == NULL) return FALSE; // Eveything worked (gasp!) return TRUE; }

BOOL Application::InitFilterManager (   )  [protected]

Support function to initialize this Application's FilterManager. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 26/12/96 Returns: TRUE if OK, FALSE if failed Definition at line 497 of file app.cpp. { BOOL Success = FALSE; TheFilterManager = new FilterManager; if (TheFilterManager != NULL) { Success = TheFilterManager->Init(); } else { Success = FALSE; } return Success; }

BOOL Application::InitWizOps (   )  [protected]

Support function to initialize this Application's WizardOfOps from the local registry. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 26/12/96 Returns: TRUE if OK, FALSE if failed Definition at line 528 of file app.cpp. { BOOL Ok = TRUE; TheWizardOfOps = new WizOps; if (TheWizardOfOps != NULL) { Ok = TheWizardOfOps->InitializeFromRegistry(); } else { Ok = FALSE; } return Ok; }

BOOL Application::IsBgRendering (   )

Find out if there is Background rendering in progress or not. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 10/5/95 Returns: TRUE if Background rendering is in progress. Definition at line 1059 of file app.cpp. { return BgRendering; }

BOOL Application::IsRenderingComplete (   )  [inline]

Definition at line 255 of file app.h. { return (RenderList.IsEmpty ()); }

BOOL Application::LateInit (   )

Initialise the application object bits that require the preferences system to be fully up & running. Currently that means the pen only. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 26/9/94 Returns: TRUE if OK, FALSE if failed->SetError. Errors: None. Definition at line 590 of file app.cpp. { #ifdef PLUGINSUPPORT // Only add in if required - general plug-in removal at present // We need the preferences system present so we must wait until here // before we ask the PlugInManager to initialise iteself; if (ThePlugInManager == NULL || !ThePlugInManager->Init()) return FALSE; #endif // PLUGINSUPPORT m_pTemplateManager->Init(); // Everything went ok return TRUE; }

BOOL Application::LockOutControlHelp (   )

Just interfaces to similar StatusLine funtion Notes: This is really a bodge to fix the annoying features of camelot that persist in infinitely updating the status bar with different text. At present, this occurs in two places (known to me): the transparency slider and when typing text within the text tool. This function locks the status bar to prevent these guys such annoying things. NOTE: if one calls this - then you MUST also have a matching Application::UnlockControlHelp () somewhere; cause otherwise camelots status bar will never again update itself .... Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/2000 Parameters: N/A  [INPUTS] Returns: Whatever our helper function feels like. NOTE: this function can also be used to prevent the status bar from updating at all (as in the solution to the text tool probs) .... See Also: Application::UnlockControlHelp () Definition at line 1582 of file app.cpp. { StatusLine* pStatusLine = GetpStatusLine (); if (pStatusLine==NULL) return FALSE; return (pStatusLine->LockOutControlHelp ()); }

void Application::NeedMoreIdles (   )

Tells the application we need more idles. Author: Alex Bligh <alex@alex.org.uk> Date: 17/5/2006 Parameters: -  [INPUTS] Returns: - Notes: This tells the application that we need further idle events, e.g. in the scenario of a newly added idle handler, or an idle handler that previously returned FALSE now returning true. This avoids waiting for the next event. Returns: Errors: - See also: Application::CallIdleProcessors Definition at line 1350 of file app.cpp. { CCamApp::NeedMoreIdles(); }

BOOL Application::OnIdle (  BOOL  IdleRedraw  )

This is where idle events are recived by the kernel. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/94 Parameters: IdleRedraw  - TRUE if background redrawing should be performed. [INPUTS] Returns: TRUE if more idle messages are needed. FALSE if no more idle processing is needed Errors: - See also: CCamApp::OnIdle Definition at line 1457 of file app.cpp. { // If the system is disabled (due to an error box being up) we must not do anything, // as we definitely do not want to cause a re-entrant error situation! if( CCamApp::IsDisabled() ) return(TRUE); Tool* CurTool=Tool::GetCurrent(); BOOL Idles =FALSE; if (IdleRedraw) if (ServiceRendering()) Idles=TRUE; if (CurTool!=NULL) if (CurTool->OnIdle()) Idles=TRUE; if (CallIdleProcessors()) Idles=TRUE; // ControlList::Idle(); // Idles=TRUE; return Idles; }

BOOL Application::OnKeyPress (  KeyPress *  pKeyPress  )

This is where key presses are handled in Camelot. It does the following in this order -. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> (simplified by JustinF) Date: 26/8/94 Parameters: pKeyPress  =Ptr to platform-indy key press object [INPUTS] Returns: TRUE if the key press was processed, so do not pass on. FALSE if not processed, so pass on to other interested parties 1) Lets the current tool have a go 2) See if a temporary tool switch has occurred 3) Check for a hot-key combination [ 4) Broadcast key press to all live ops - removed as it slows text typing by 20% ] If at any of the stages the key is processed, this function exits immediately with TRUE, i.e. it doesn't let the next stage try and deal with a key press that's been processed Returns: Errors: - See also: KeyPress::TranslateMessage Definition at line 1213 of file app.cpp. { #if !defined(EXCLUDE_FROM_RALPH) PORTNOTE("other","Removed XaraCMS usage") // First, pass the keypress to the Colour Editor. // This is used to stop keypresses while dragging in the editor, so must be done first if (ColourEditDlg::OnKeyPress(pKeyPress)) return(TRUE); #endif // Pass this keypress on to selected DocView, if we have one, otherwise // pass on to tools, hotkeys etc. DocView* pDocView = DocView::GetSelected(); return ( (pDocView != NULL && pDocView->HandleKeyPress(pKeyPress)) || Tool::SwitchTool(pKeyPress) || HotKey::OnKeyPress(pKeyPress) // removed by Ed 27/4/95 - no-one uses this and it slows text typing by 20%! // || (BROADCAST_TO_ALL(KeyMsg(KeyMsg::KEYPRESS, pKeyPress)) == EAT_MSG ) ); }

void Application::RegenerateNodesInList (   )

Calls all of the regeneration functions of the nodes in the list. Author: David_McClarnon (Xara Group Ltd) <camelotdev@xara.com> Date: 1/6/99 Parameters: The  node to add to the list [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1830 of file app.cpp. { if (RegenList.IsEmpty()) return; NodeListItem *pItem = (NodeListItem *)RegenList.GetHead(); while (pItem) { if (pItem->pNode) { if (pItem->pNode->GetHiddenCnt()==0) { if (pItem->pNode->IsBounded()) { ((NodeRenderableBounded *)pItem->pNode)->InvalidateBoundingRect(); } pItem->pNode->RegenerateNode(NULL, FALSE, FALSE); if (pItem->pNode->IsBounded()) { ((NodeRenderableBounded *)pItem->pNode)->InvalidateBoundingRect(); } } } pItem = (NodeListItem *)RegenList.GetNext(pItem); } RegenList.DeleteAll(); }

void Application::RegisterDocComponent (  DocComponentClass *  pClass  )

Register a new Document Component class with the application. This class will be asked to add an instance to a document every time a new document is created. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 02/08/94 Parameters: pClass  - pointer to the Document component class thatis to be added. [INPUTS] See also: DocComponentClass; DocComponent Definition at line 1080 of file app.cpp. { // Check for multiple registrations in debug build... #if _DEBUG DocComponentClass *pItem = (DocComponentClass *) DocComponentClasses->GetHead(); while (pItem != NULL) { // Already registered? if (pItem->GetRuntimeClass() == pClass->GetRuntimeClass()) { ENSURE(FALSE, "Document component registered more than once!"); return; } // Try the next one pItem = (DocComponentClass *) DocComponentClasses->GetNext(pItem); } #endif // Simple - just add it to the list DocComponentClasses->AddTail(pClass); }

void Application::RegisterIdleProcessor (  INT32  Priority, Operation *  pOp )

If an operation wants to do processing on idle events then it must register to receive them. It registers by calling this function with a pointer to itself. On idle events the operations OnIdle function is called. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/94 Parameters: Priority  - either IDLEPRIORITY_HIGH or IDLEPRIORITY_LOW. [INPUTS] pOp - Pointer to an operation. Returns: - Notes: If the operator is already registered for idles of the given priority, this call does nothing (i.e. registering twice will give you only one entry in the list) HIGH priority handlers are called on every Idle event. LOW priority handlers will only be called on idle events if there were no high priority handlers which returned TRUE from their OnIdle method. i.e. If any high priority handler is active, all low-priority idles cease to occur. Returns: Errors: - See also: Operation::OnIdleEvent, Application::CallIdleProcessors, Application::RemoveIdleProcessor Definition at line 1265 of file app.cpp. { List* Current = (Priority==IDLEPRIORITY_HIGH) ? &IdleHighPriorityOps : &IdleLowPriorityOps; // Ensure the given Op is only registered once on the list ListItemOpPtr* Entry = (ListItemOpPtr *)Current->GetHead(); while (Entry != NULL) { if (Entry->pOp == pOp) // Hey, you're already registered! return; Entry = (ListItemOpPtr *) Current->GetNext(Entry); } // Have not found an entry in this list for this Op, so add one Entry = new ListItemOpPtr; Entry->pOp = pOp; Current->AddTail(Entry); NeedMoreIdles(); // ensure it gets at least a first idle event }

void Application::RemoveIdleProcessor (  INT32  Priority, Operation *  pOp )

Stops an operation from receiving idle events. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/94 Parameters: Priority  - either IDLEPRIORITY_HIGH or IDLEPRIORITY_LOW. [INPUTS] pOp - Pointer to an operation. Returns: - Notes: If the Operation was not registered for idles, this call returns quietly. This allows you to ensure you are deregistered without having to remember if you did/didn't register for idles. It is safe to call this method when processing an idle event - the event processing code ensures that if you remove yourself from the list, it does not give a toss (or an access violation!). Returns: Errors: - See also: Application::CallIdleProcessors Definition at line 1313 of file app.cpp. { List* Current = (Priority==IDLEPRIORITY_HIGH) ? &IdleHighPriorityOps : &IdleLowPriorityOps; ListItemOpPtr* Entry = (ListItemOpPtr *)Current->GetHead(); while (Entry != NULL) { if (Entry->pOp == pOp) { Current->RemoveItem(Entry); delete Entry; return; } Entry = (ListItemOpPtr *) Current->GetNext(Entry); } }

void Application::ResetRealDownload (   )

Re-enables RealDownload browser integration if we disabled it. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 2095 of file app.cpp. { PORTNOTE("other","Application::ResetRealDownload - do nothing") #ifndef EXCLUDE_FROM_XARALX if (DisabledRealDownload) { if (key) { // both HKEY_CURRENT_USER and HKEY_LOCAL_MACHINE could have been used, reset both .... ChangeRealDownloadBrowserOtion (HKEY_CURRENT_USER, key, TRUE); RegCloseKey (key); if (key2) { ChangeRealDownloadBrowserOtion (HKEY_LOCAL_MACHINE, key2, TRUE); RegCloseKey (key2); } DisabledRealDownload = FALSE; } else if (key2) { // only HKEY_LOCAL_MACHINE will have been used, reset it .... ChangeRealDownloadBrowserOtion (HKEY_LOCAL_MACHINE, key2, TRUE); RegCloseKey (key2); DisabledRealDownload = FALSE; } } #endif }

BOOL Application::ServiceRendering (  BOOL  bImmediate = FALSE  )

Render some objects! This function will either render any outstanding 'immediate' render regions to completion, or render a background render regions for one time-slice. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 27/06/94 Returns: TRUE if more rendering needs to be done, FALSE if there are no more regions left to render. See also: RenderRegionList::ImmediateRender; RenderRegionList::BackgroundRender Definition at line 991 of file app.cpp. { #ifdef RALPH #ifdef _DEBUG if(::GetCurrentThreadId() == RalphDocument::GetImportingThreadID()) { // If we get in here, it's extremely BAD ! AfxDebugBreak(); } #endif // Fixes splodgy text problems... RalphCriticalSection RCS; #endif #ifdef RALPH // Wait until it's safe to enter CCamApp::EnterGDrawCriticalSection(); #endif // DMc - render the list of nodes to regenerate RegenerateNodesInList(); // TRACEUSER( "Gerry", _T("Service Rendering - Enter\n")); if (ImmediateRenderPending || bImmediate) { // Render all immediate render regions to completion, and then clear the // flag so we do some background rendering the next time around. RenderList.ImmediateRender(bImmediate); ImmediateRenderPending = FALSE; #ifdef RALPH // Let another process have a go CCamApp::ExitGDrawCriticalSection(); #endif // Try background rendering next // TRACEUSER( "Gerry", _T("Service Rendering - Exit - More\n")); return TRUE; } else { BOOL ok = RenderList.BackgroundRender(); #ifdef RALPH // Let another process have a go CCamApp::ExitGDrawCriticalSection(); #endif // TRACEUSER( "Gerry", _T("Service Rendering - Exit - %s\n"), ok ? _T("More") : _T("Finished")); return ok; } // TRACEUSER( "Gerry", _T("Service Rendering - Exit - More\n")); return TRUE; }

BOOL Application::SetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, double *  pValue )  [inline]

Definition at line 516 of file app.h. { return CamelotPrefs->SetPrefDirect(Section, Pref, pValue); }

BOOL Application::SetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, UINT32 *  pValue )  [inline]

Definition at line 514 of file app.h. { return CamelotPrefs->SetPrefDirect(Section, Pref, pValue); }

BOOL Application::SetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, INT32 *  pValue )  [inline]

Definition at line 512 of file app.h. { return CamelotPrefs->SetPrefDirect(Section, Pref, pValue); }

BOOL Application::SetPrefDirect (  LPTCHAR  Section, LPTCHAR  Pref, const TCHAR *  pValue, BOOL  Force = FALSE )  [inline]

Definition at line 510 of file app.h. { return CamelotPrefs->SetPrefDirect(Section, Pref, pValue, Force); }

BOOL Application::SetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, double *  PrefVar )  [inline]

Definition at line 505 of file app.h. { return CamelotPrefs->SetPrefValue(Section, Pref, PrefVar); };

BOOL Application::SetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, UINT32 *  PrefVar )  [inline]

Definition at line 503 of file app.h. { return CamelotPrefs->SetPrefValue(Section, Pref, PrefVar); };

BOOL Application::SetPrefValue (  LPTCHAR  Section, LPTCHAR  Pref, INT32 *  PrefVar )  [inline]

Definition at line 501 of file app.h. { return CamelotPrefs->SetPrefValue(Section, Pref, PrefVar); };

void Application::ShowViewScrollers (  BOOL  fIsVisible  )

Definition at line 1523 of file app.cpp. { Document* pDocument = (Document*) Documents.GetHead(); while (pDocument != NULL) { pDocument->ShowViewScrollers(fIsVisible); pDocument = (Document*) Documents.GetNext(pDocument); } }

void Application::ShuttingDown (  BOOL  fState = TRUE  )  [inline]

Definition at line 547 of file app.h. { CamelotShuttingDown = fState; }

BOOL Application::UnlockControlHelp (   )

Just interfaces to similar StatusLine funtion Notes: See Application::LockOutControlHelp () See Also: Application::LockOutControlHelp (). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/2000 Parameters: N/A  [INPUTS] Returns: Whatever our helper function feels like. Definition at line 1606 of file app.cpp. { StatusLine* pStatusLine = GetpStatusLine (); if (pStatusLine==NULL) return FALSE; return (pStatusLine->UnlockControlHelp ()); }

void Application::UpdateSelection (   )  [inline]

Definition at line 267 of file app.h. { Selection->Update(); }; // the selection may have changed.

BOOL Application::UpdateStatusBarText (  String_256 *  ptext, BOOL  PrefixSelDesc = TRUE )

Just interfaces to similar StatusLine funtion Notes: This has been bodged by Jason to return without an error if the status line has not yet been initialised as the progress system is tries to use it in this state! Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 16/11/94 Parameters: ptext  - text to go in the specified status bar pane [INPUTS] PrefixSelDesc - TRUE to prefix the displayed text with a selection description Returns: FALSE if falied Definition at line 1548 of file app.cpp. { StatusLine* pStatusLine = GetpStatusLine(); // ERROR2IF(pStatusLine==NULL,FALSE,"Application::UpdateStatusBarText() - pStatusLine==NULL"); if (pStatusLine==NULL) return FALSE; return pStatusLine->UpdateText(ptext,PrefixSelDesc); }

void Application::WipeDangerousPrefs (   )  [inline]

Definition at line 472 of file app.h. { CamelotPrefs->WipeDangerousPrefs (); };

void Application::WipePreferenceFile (   )  [inline]

Definition at line 470 of file app.h. { CamelotPrefs->WipePreferenceFile(); };

void Application::WritePreferences (   )  [inline]

Definition at line 467 of file app.h. { CamelotPrefs->Write(); };

---

Member Data Documentation

BOOL Application::BgRendering

Definition at line 259 of file app.h.

BlobManager* Application::BlobMgr [private]

Definition at line 391 of file app.h.

Preferences* Application::CamelotPrefs [private]

Definition at line 376 of file app.h.

BOOL Application::CamelotShuttingDown [private]

Definition at line 531 of file app.h.

XaraCMS* Application::CMSManager [private]

Definition at line 415 of file app.h.

BOOL Application::DisabledRealDownload [private]

Definition at line 534 of file app.h.

List* Application::DocComponentClasses [private]

Definition at line 394 of file app.h.

List Application::Documents

Definition at line 242 of file app.h.

FontManager* Application::FontMgr [private]

Definition at line 412 of file app.h.

GlobalBitmapList Application::GlobalBitmaps [private]

Definition at line 397 of file app.h.

GlobalFractalList Application::GlobalFractals [private]

Definition at line 400 of file app.h.

List Application::IdleHighPriorityOps [private]

Definition at line 403 of file app.h.

List Application::IdleLowPriorityOps [private]

Definition at line 404 of file app.h.

BOOL Application::ImmediateRenderPending [private]

Definition at line 374 of file app.h.

HKEY Application::key [private]

Definition at line 537 of file app.h.

HKEY Application::key2 [private]

Definition at line 538 of file app.h.

ObjectCache* Application::m_pObjCache [private]

Definition at line 436 of file app.h.

StatusLine* Application::m_pStatusLine [private]

Definition at line 449 of file app.h.

std::auto_ptr<CTemplateManager> Application::m_pTemplateManager [private]

Definition at line 451 of file app.h.

ATMIniCache* Application::pATMIniCache [private]

Definition at line 409 of file app.h.

List Application::RegenList [private]

Definition at line 566 of file app.h.

RenderRegionList Application::RenderList [private]

Definition at line 373 of file app.h.

SelRange* Application::Selection

Definition at line 262 of file app.h.

APIObject* Application::TheAPIObject [private]

Definition at line 427 of file app.h.

CBitmapCache* Application::TheBitmapCache [private]

Definition at line 439 of file app.h.

ColourManager* Application::TheColourManager [private]

Definition at line 379 of file app.h.

FilterManager* Application::TheFilterManager [private]

Definition at line 424 of file app.h.

HandleManager* Application::TheHandleManager [private]

Definition at line 430 of file app.h.

PrintMarksMan* Application::TheMarksManager [private]

Definition at line 418 of file app.h.

NoiseMan* Application::TheNoiseManager [private]

Definition at line 433 of file app.h.

PlugInManager* Application::ThePlugInManager [private]

Definition at line 421 of file app.h.

WizOps* Application::TheWizardOfOps [private]

Definition at line 442 of file app.h.

---

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

• Kernel/app.h (r1785/r1461)
• Kernel/app.cpp (r1785/r1531)

---