AppPrefsDlg Class Reference

#include <appprefs.h>

Inheritance diagram for AppPrefsDlg:

List of all members.

Public Member Functions
	AppPrefsDlg ()
	AppPrefsDlg constructor. Creates a non-undoable operation.
	AppPrefsDlg (INT32 StartingPage)
	AppPrefsDlg constructor which allows a starting page to be specified. Creates a non-undoable operation.
	~AppPrefsDlg ()
	AppPrefsDlg destructor.
void	Do (OpDescriptor *)
	Creates then opens the dialog in response to a request from the user.
virtual MsgResult	Message (Msg *Message)
	Handles all the application preferences dialog's messages.
virtual BOOL	RegisterYourPagesInOrderPlease ()
	This virtual function will get called to give you a chance to add pages to your DialogTabOp. This function will usually make multiple calls to AddAPage to register the initial set of pages to be contained in the tab dialog. The pages should all be the same size and be registered in the left to right order in which you wish them to appear.
BOOL	CommitDialogValues ()
	Takes the values in the dialog box and sets the return values accordingly Called when ok is pressed on the dialog box.
BOOL	HasImages ()
TabType	GetTabType ()
Static Public Member Functions
static BOOL	Init ()
	AppPrefsDlg Init method. Called when the kernel initialises.
static void	Deinit ()
	AppPrefsDlg Deinit method. Called when the kernel deinitialises.
static OpState	GetState (String_256 *, OpDescriptor *)
	AppPrefsDlg GetState method.
static BOOL	IsSaveOnExitSet ()
	If TRUE, then the preference file Camelot.INI will be saved when the program exits. If FALSE, then no save will take place. Allows the state of the save preferences on exit flag to be read.
static BOOL	SetSaveOnExit (BOOL NewState)
	This allows the state of the Save on exit flag to be set to either TRUE or FALSE.
Static Public Attributes
static const CDlgResID	IDD = _R(IDD_APPLICATIONOPTIONS)
static const CDlgMode	Mode = MODELESS
static PageSizesList *	pPageSizesList = NULL
Private Attributes
String_256	TitleString

---

Detailed Description

Definition at line 139 of file appprefs.h.

---

Constructor & Destructor Documentation

AppPrefsDlg::AppPrefsDlg (   )

AppPrefsDlg constructor. Creates a non-undoable operation. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 303 of file appprefs.cpp. : DialogTabOp(AppPrefsDlg::IDD, AppPrefsDlg::Mode) { // At present, just:- OptionsTabs::SetApplyNowState(FALSE); // grey the apply now button OptionsTabs::SetInitMessageState(FALSE); // not sending an init message OptionsTabs::pScopeDocument = NULL; // Document in use when sending messages // Set default units OptionsTabs::SetDefaultUnits(); // set up our default display units // Document and spread we are supposed to be working on. Of course none at present. OptionsTabs::SetCurrentDocAndSpread(NULL); }

AppPrefsDlg::AppPrefsDlg (  INT32  StartingPage  )

AppPrefsDlg constructor which allows a starting page to be specified. Creates a non-undoable operation. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 334 of file appprefs.cpp. : DialogTabOp(AppPrefsDlg::IDD, AppPrefsDlg::Mode, CC_RUNTIME_CLASS(DialogOp), StartingPage) { // At present, just:- OptionsTabs::SetApplyNowState(FALSE); // grey the apply now button OptionsTabs::SetInitMessageState(FALSE); // not sending an init message OptionsTabs::pScopeDocument = NULL; // Document in use when sending messages // Set default units OptionsTabs::SetDefaultUnits(); // set up our default display units // Document and spread we are supposed to be working on. Of course none at present. OptionsTabs::SetCurrentDocAndSpread(NULL); }

AppPrefsDlg::~AppPrefsDlg (   )

AppPrefsDlg destructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 365 of file appprefs.cpp. { // Make sure that we remove our options tabs link to the dialog box class // as the dialog will now be destroyed OptionsTabs::pPrefsDlg = NULL; }

---

Member Function Documentation

BOOL AppPrefsDlg::CommitDialogValues (   )

Takes the values in the dialog box and sets the return values accordingly Called when ok is pressed on the dialog box. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: True if values in dialog box ok, False otherwise. Errors: - See also: - Definition at line 388 of file appprefs.cpp. { // Ok has been pressed so take the values from the dialog box BOOL ok = TRUE; BOOL ValuesOk = TRUE; // Make sure that we have set up our class variables so that the tabs know what // is the current document and spread to work on. Document *pDocument = Document::GetSelected(); OptionsTabs::SetCurrentDocAndSpread(pDocument); // Plus the current document units are correct OptionsTabs::SetUpDocUnits(); // Go through all the tabs declared to the system in turn // and tell them to commit the values for their tab OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only get the tab to commit if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { // Get the found page to commit its values. // Should return False if reported error and we should just fail. // 2 if set an error which we should report and then fail. ok = pOptionsTabs->CommitSection(); if ( ok != TRUE) { if (ok == 2) InformError(); // If error required show it. // Carry on with other pages so that report all errors and have a chance // to correct mistakes in other pages but make note of error state. ValuesOk = FALSE; } } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } // Return whether we found bad values or not. return ValuesOk; }

void AppPrefsDlg::Deinit (   )  [static]

AppPrefsDlg Deinit method. Called when the kernel deinitialises. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1272 of file appprefs.cpp. { BOOL ok; // Remove any options tabs that have been declared to the system. ok = OptionsTabs::DeinitOptionsTabs(); // Remove the page sizes list that is currently attached to the applications options // dialog box for the present moment. if (pPageSizesList != NULL) { ok = pPageSizesList->DeinitPageSizes(); // delete all list items delete pPageSizesList; // delete list item object pPageSizesList = NULL; // set item pointer to null } }

void AppPrefsDlg::Do (  OpDescriptor *   )  [virtual]

Creates then opens the dialog in response to a request from the user. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from Operation. Definition at line 1306 of file appprefs.cpp. { BOOL ok; //if (OptionsTabs::pPrefsDlg != NULL) //{ // ERROR3("AppPrefsDlg::Do an options tabbed dialog box is already present"); // return; //} // Set up the name that the main dialog page is going to use String_256 Temp(_R(IDN_APPLICATIONOPTS)); TitleString = Temp; SetName(&TitleString); // Make sure that our options tabs have a link to the dialog box class OptionsTabs::pPrefsDlg = this; OptionsTabs::SetApplyNowState(FALSE); // Make sure that we have set up our class variables so that the tabs know what // is the current document and spread to work on. Document *pDocument = Document::GetSelected(); OptionsTabs::SetCurrentDocAndSpread(pDocument); // Work out the document name so that it is ready for options tabs to display. OptionsTabs::SetDocumentName(pDocument); // Force the dialog box to be created, as it is non-modal it must be opened if the create // works ok. ok = Create(); // create the dialog box if ( ok ) { // MarkH 29/6/99 - We need to physically walk through the tabs and initialize them as // the new MFC in VC6 dosn't do it for you!!! GIT!!!! // Now go through all the tabs declared to the system OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only Initialize the Section tab if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { // Make sure we`re talking to the page! TalkToPage(pOptionsTabs->GetPageID()); pOptionsTabs->InitSection(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } // Modal at present so remove the Open() Open(); // created ok so open the dialog box up // grey out the apply now button as this should only become enabled when we have // made a change to the dialog box. OptionsTabs::SetInitMessageState(FALSE); OptionsTabs::SetApplyNowState(FALSE); OptionsTabs::GreyApplyNow(); } else { // Could not create the dialog box so call inform error InformError(); // Show user the error End(); // End the operation } }

OpState AppPrefsDlg::GetState (  String_256 *  , OpDescriptor *  )  [static]

AppPrefsDlg GetState method. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1073 of file appprefs.cpp. { OpState OpSt; // If the pointer is non-null then it implies that another dialog box is up which // uses our tab set and so we must force greying of the menu option if (OptionsTabs::pPrefsDlg != NULL) OpSt.Greyed=TRUE; return(OpSt); }

TabType AppPrefsDlg::GetTabType (   )  [inline, virtual]

Reimplemented from DialogTabOp. Definition at line 175 of file appprefs.h. {return TABTYPE_TREE/*TABTYPE_LIST*/;}

BOOL AppPrefsDlg::HasImages (   )  [inline, virtual]

Reimplemented from DialogTabOp. Definition at line 174 of file appprefs.h. {return TRUE;}

BOOL AppPrefsDlg::Init (  void   )  [static]

AppPrefsDlg Init method. Called when the kernel initialises. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from SimpleCCObject. Definition at line 1103 of file appprefs.cpp. { BOOL InitOK = TRUE; // Declare any preferences that we require. if ( Camelot.DeclareSection(TEXT("Preferences"), 3) ) { // section declared ok so now define the preference option Camelot.DeclarePref(TEXT("Preferences"), TEXT("SaveOnExit"), &SaveOnExit, 0, 1); } // Now register ourselves with the dialog system InitOK = RegisterOpDescriptor( 0, // Tool ID _R(IDS_UTILOPTIONS), // String resource ID CC_RUNTIME_CLASS(AppPrefsDlg), // Runtime class OPTOKEN_UTILOPTIONS, // Token string GetState, // GetState function 0, // help ID _R(IDBBL_OPTIONSDLG), // bubble help _R(IDD_BARCONTROLSTORE), // resource ID _R(IDC_BTN_OPTIONSDLG), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation 0, // No vertical counterpart _R(IDS_APPPREFSDLG_ONE), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); // Now register ourselves with the dialog system for the units button on the windows // button bar as well InitOK = InitOK && RegisterOpDescriptor( 0, // Tool ID _R(IDS_UNITDLG), // String resource ID CC_RUNTIME_CLASS(UnitsTabAppPrefsDlg), // Runtime class OPTOKEN_UNITDLG, // Token string GetState, // GetState function 0, // help ID _R(IDBBL_UNITDLG), // bubble help _R(IDD_BARCONTROLSTORE), // resource ID _R(IDC_BTN_UNITSETUPDLG), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Receive messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart _R(IDS_UNIT_DLG_OPEN), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); ); // Now register ourselves with the dialog system for the units button on the windows // button bar as well InitOK = InitOK && RegisterOpDescriptor( 0, // Tool ID _R(IDS_SCALEDLG), // String resource ID CC_RUNTIME_CLASS(ScaleTabAppPrefsDlg), // Runtime class OPTOKEN_SCALEDLG, // Token string GetState, // GetState function 0, // help ID _R(IDBBL_SCALEDLG), // bubble help _R(IDD_BARCONTROLSTORE), // resource ID _R(IDC_BTN_SCALEFACTORDLG), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Receive messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart _R(IDS_SCALE_DLG_OPEN), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); ); // Now register ourselves with the dialog system for somebody who wants to get to the page options tab InitOK = InitOK && RegisterOpDescriptor( 0, // Tool ID _R(IDS_PAGESIZEDLG), // String resource ID CC_RUNTIME_CLASS(PageTabAppPrefsDlg), // Runtime class OPTOKEN_PAGESIZEDLG, // Token string GetState, // GetState function 0, // help ID _R(IDBBL_PAGESIZEDLG), // bubble help _R(IDD_BARCONTROLSTORE), // resource ID _R(IDC_BTN_PAGESIZEDLG), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart _R(IDS_APPPREFSDLG_ONE), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); // Now register ourselves with the dialog system for somebody who wants to get to the page options tab InitOK = InitOK && RegisterOpDescriptor( 0, // Tool ID _R(IDS_GRIDANDRULERSDLG), // String resource ID CC_RUNTIME_CLASS(GridTabAppPrefsDlg), // Runtime class OPTOKEN_GRIDANDRULERSDLG, // Token string GetState, // GetState function 0, // help ID _R(IDBBL_GRIDANDRULERSDLG), // bubble help 0, //_R(IDD_BARCONTROLSTORE), // resource ID 0, //_R(IDC_BTN_PAGESIZEDLG), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart _R(IDS_APPPREFSDLG_ONE), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); // Now register ourselves with the dialog system for somebody who wants to get to the plug-ins tab InitOK = InitOK && RegisterOpDescriptor( 0, // Tool ID _R(IDS_PLUGINS_PLUGINSMNGR), // String resource ID CC_RUNTIME_CLASS(PlugsTabAppPrefsDlg), // Runtime class OPTOKEN_PLUGSDLG, // Token string GetState, // GetState function 0, // help ID 0, // bubble help 0, // resource ID _R(IDS_PLUGINS_PLUGINSMNGR), // control ID SYSTEMBAR_WINDOW, // Bar ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart _R(IDS_APPPREFSDLG_ONE), // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ); // Set up any options tabs that are required InitOK = InitOK && OptionsTabs::InitOptionsTabs(); // Set up any page sizes that are required // Make the doc unit list pPageSizesList = new PageSizesList; InitOK = InitOK && (pPageSizesList != NULL && pPageSizesList->InitPageSizes()); // Set up our special print options dialog box as well as this is effectively the // same dialog box. // WEBSTER-ranbirr-13/11/96 #ifndef WEBSTER InitOK = InitOK && PrintPrefsDlg::Init(); #endif //webster return (InitOK); }

BOOL AppPrefsDlg::IsSaveOnExitSet (   )  [static]

If TRUE, then the preference file Camelot.INI will be saved when the program exits. If FALSE, then no save will take place. Allows the state of the save preferences on exit flag to be read. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The state of the Save on exit flag as either TRUE or FALSE. Errors: - See also: - Definition at line 250 of file appprefs.cpp. { if ( SaveOnExit == 0 ) return FALSE; else return TRUE; }

MsgResult AppPrefsDlg::Message (  Msg *  Message  )  [virtual]

Handles all the application preferences dialog's messages. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: OK Message handled ok (return this even if you don't need to respond to the message). FAIL Something terrible happened whilst processing the message eg. we ran out of memory. You must set ERROR if you are returning this value. EAT_MSG The Message was handled ok but don't send it to any more MessageHandlers. Returns: Errors: - See also: - Reimplemented from DialogTabOp. Definition at line 455 of file appprefs.cpp. { #ifndef STANDALONE #ifndef REMOVE_PRINT_TABS // Jason - This is a message-loop lock which is used in the DIM_CREATE code to // allow the print marks manager cache print marks - this causes a lot of diocument // message broadcats and suchlike, which cause re-entrant messages to come in // here and trigger 3 billion ERROR3s. While caching the print marks, we lock this // message handler so that it just ignores all resultant broadcasts. static BOOL IgnoreAllMessages = FALSE; if (IgnoreAllMessages) return DialogTabOp::Message(Message); #endif ERROR3IF(Message == NULL,"AppPrefsDlg::Message null message received"); // Cope with document changing messages so that if all documents are closed then // we take some remedial action such as greying all controls. if (MESSAGE_IS_A(Message, DocChangingMsg)) { DocChangingMsg *TheMsg = (DocChangingMsg *) Message; switch ( TheMsg->State ) { case DocChangingMsg::TITLECHANGED: case DocChangingMsg::SELCHANGED: { // In the different cases there are different document pointers that // we must use. Document *pDocument = NULL; if (TheMsg->State == DocChangingMsg::TITLECHANGED) { // Document title has changed message. pDocument = TheMsg->pChangingDoc; } else { // Document selection changed. pDocument = TheMsg->pNewDoc; } // Make sure that we have set up our class variables so that the // tabs know what is the current document and spread to work on. OptionsTabs::SetCurrentDocAndSpread(pDocument); // Plus the current document units are correct OptionsTabs::SetUpDocUnits(); // Set the document name up to be either:- // - the default if we have a null document pointer // - the current name of the document OptionsTabs::SetDocumentName(pDocument); // Is the new one null ==> no new document if (pDocument == NULL) { // Now go through all the tabs declared to the system // And call a function to get them to update themselves. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only get the tab to update if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { // Get that tab to update itself. pOptionsTabs->GreySection(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } else { // Now go through all the tabs declared to the system // And call a function to get them to update themselves. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only get the tab to update if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { // Get that tab to update itself. pOptionsTabs->UngreySection(); //pOptionsTabs->UpdateSection(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } } break; // This message is sent when a new or just opened document is stable. // Selection messages no good as the template document is loaded into // the same document and hence the selected document/spread/view does // not change and so we do not get the last update. // Could cache all messages from BORN to this and only update on this. case DocChangingMsg::BORNANDSTABLE: { // In the different cases there are different document pointers that // we must use, in this case the changing doc is relevent. Document *pDocument = NULL; pDocument = TheMsg->pChangingDoc; if (pDocument != NULL) { // Now go through all the tabs declared to the system // And call a function to get them to update themselves. // Work out the document name and pass this to the tab so that it has // chance to fill in its info field ok. OptionsTabs::SetCurrentDocAndSpread(pDocument); OptionsTabs::SetDocumentName(pDocument); OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); String_256 DocumentName = *OptionsTabs::GetDocumentName(); while (pOptionsTabs != NULL) { // Only get the tab to update if it is a document based option if ( pOptionsTabs->IsProgramOption() ) { // Get that tab to update itself. //pOptionsTabs->UngreySection(); pOptionsTabs->UpdateSection(&DocumentName); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } } break; default: break; } } #ifndef REMOVE_PRINT_TABS // WEBSTER-ranbirr-13/11/96 #ifndef WEBSTER else if (MESSAGE_IS_A(Message,PrintMsg)) // Check for print messages { PrintMsg* pPrintMsg = (PrintMsg*)Message; if (pPrintMsg->Reason == PrintMsg::SETTINGSCHANGED) { // Tell the print layout tab about the print settings change OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { if (pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_PRINTLAYOUT) || pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_PRINTGENERAL)) { PrintBaseTab* pBaseTab = (PrintBaseTab *) pOptionsTabs; pBaseTab->PrintSettingsChanged(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } } #endif #endif //webster else if (MESSAGE_IS_A(Message, DocViewMsg)) { // Cope with document view changing messages so that we allow all the tabs to update // themselves when switching to a new view. // Unfortunately, at present if we sit on the DocView changing message and wait for // a selection then at this point there is NO SELECTED spread and so things will fail. // Therefore, wait for a selected spread message DocViewMsg *TheMsg = (DocViewMsg *) Message; switch ( TheMsg->State ) { case DocViewMsg::SELCHANGED: { if (TheMsg->pNewDocView != NULL) { // Now go through all the tabs declared to the system // And call a function to get them to update themselves. // Work out the document name and pass this to the tab so that it has // chance to fill in its info field ok. Document *pDocument = TheMsg->pNewDocView->GetDoc(); OptionsTabs::SetCurrentDocAndSpread(pDocument); OptionsTabs::SetDocumentName(pDocument); OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); String_256 DocumentName = *OptionsTabs::GetDocumentName(); while (pOptionsTabs != NULL) { // Only get the tab to update if it is a application based option if ( pOptionsTabs->IsProgramOption() ) { // Get that tab to update itself. //pOptionsTabs->UngreySection(); pOptionsTabs->UpdateSection(&DocumentName); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } } break; default: break; } } else if (MESSAGE_IS_A(Message, OptionsChangingMsg)) { // Cope with a new units messages so that we give the options tabs a chance to // update themselves to display using the newly specified defaults. OptionsChangingMsg *TheMsg = (OptionsChangingMsg *) Message; // Make sure that we have set up our class variables so that the tabs know what // is the current document and spread to work on. Document *pDocument = Document::GetSelected(); OptionsTabs::SetCurrentDocAndSpread(pDocument); // Plus the current document units are correct OptionsTabs::SetUpDocUnits(); switch ( TheMsg->State ) { case OptionsChangingMsg::NEWUNITS: { // Current display units may have changed changed so may need to update // any display fields on other tabs which are using units. // Now go through all the tabs declared to the system // And call a function to get them to update themselves. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only get the tab to update if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { // Get that tab to update itself. pOptionsTabs->NewUnitsInSection(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } break; } // WEBSTER-ranbirr-13/11/96 #ifndef WEBSTER case OptionsChangingMsg::ASKBEFORESETTINGATTR: { // Tell the Misc tab about the change in state of ask before setting // the attribute OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { if (pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_MISC)) { MiscTab *pMiscTab = (MiscTab *) pOptionsTabs; pMiscTab->UpdateAskBefore(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } break; } case OptionsChangingMsg::IMPORTWITHLAYERS: { // Tell the Misc tab about the change in state of Import with layers OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { if (pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_MISC)) { MiscTab *pMiscTab = (MiscTab *) pOptionsTabs; pMiscTab->UpdateImportWithLayers(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } break; } #endif //webster case OptionsChangingMsg::NEWPAGESIZE: case OptionsChangingMsg::PAGESIZEHASCHANGED: { // Current page size may have changed changed so may need to update // any display fields on other tabs which are showing pages. // Now go through all the tabs declared to the system // And call a function to get them to update themselves. // PAGESIZEHASCHANGED is sent by the page tab so do not get it to update. // NEWPAGESIZE sent by the undo/redo actions so do get it to update OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // If we are the page tab then call its special function but only if it // did not send the message. if (pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_PAGE) && TheMsg->State == OptionsChangingMsg::NEWPAGESIZE ) { PageTab *pPageTab = (PageTab *) pOptionsTabs; pPageTab->UpdatePageSection(); } // Only sned the message to a tab if its an application based option if ( pOptionsTabs->IsProgramOption() ) { // Call a function to allow other tabs to update themselves pOptionsTabs->PageSizeHasChanged(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } break; } case OptionsChangingMsg::NEWDEFAULTGRID: { // Current default grid may have changed changed // so may need to update any display fields on other tabs which // are showing pages. // Now go through all the tabs declared to the system // And call a function to get them to update themselves. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { if (pOptionsTabs->GetPageID() == _R(IDD_OPTSTAB_GRID)) { GridTab *pGridTab = (GridTab *) pOptionsTabs; pGridTab->UpdateGridSection(); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } break; } default: { // If nobody above has processed the message, then pass it around all the tabs in // case it's of use to them. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only sned the message to a tab if its an application based option if ( pOptionsTabs->IsProgramOption() ) pOptionsTabs->Message(Message); pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } break; } } else if (IS_OUR_DIALOG_MSG(Message)) { // Cope with messages for the dialog box DialogMsg* Msg = (DialogMsg*)Message; MsgResult Result; // Main handler for dialog type messages BOOL EndDialog = FALSE; // TRUE if we should quit the dialog BOOL CommitValues = FALSE; // TRUE if we should commit the dialog values BOOL OldApplyNow = OptionsTabs::GetApplyNowState(); // Old ApplyNow button state // Make sure that we have set up our class variables so that the tabs know what // is the current document and spread to work on. Document *pDocument = Document::GetSelected(); OptionsTabs::SetCurrentDocAndSpread(pDocument); // Plus the current document units are correct OptionsTabs::SetUpDocUnits(); // Check if sending init/create message and if so set flag True. // If True then do not ungrey the ApplyNow button on changing messages if (Msg->DlgMsg == DIM_CREATE) OptionsTabs::SetInitMessageState(TRUE); // If the message is not for the main options window then try the tab pages BOOL FoundPage = FALSE; if (Msg->PageID != 0) { // Now go through all the tabs declared to the system // And see if the message is for that page or not. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL && !FoundPage) { CDlgResID PageId = pOptionsTabs->GetPageID(); if (PageId == Msg->PageID) { // Found the correct page so stop the search and send the message // to that page pOptionsTabs->HandleMsg(Msg); FoundPage = TRUE; } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } else { // Main page window switch (Msg->DlgMsg) { case DIM_CREATE: // Creating the main dialog box #ifndef REMOVE_PRINT_TABS IgnoreAllMessages = TRUE; // BLOCK { // Make sure the print marks are cached by the PMManager. This must be done now // because we want to demand-load the marks, but if we leave it any later we get // an awful lot of rather nasty problems with document messages flying around. PrintMarksMan* pMarksMan = GetApplication()->GetMarksManager(); if (pMarksMan) { pMarksMan->ConstructCache(); if (Document::GetSelected() != NULL) pMarksMan->AddDefaultMarksToDoc(Document::GetSelected()); } } IgnoreAllMessages = FALSE; #endif break; // grey out the apply now button as this should only become enabled when // we have made a change to the dialog box. // OptionsTabs::SetInitMessageState(FALSE); // OptionsTabs::SetApplyNowState(FALSE); // OptionsTabs::GreyApplyNow(); // break; case DIM_COMMIT: // Want to commit and quit { OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only give the tab the message if it is a application based option if ( pOptionsTabs->IsProgramOption() ) pOptionsTabs->HandleMsg(Msg); pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } EndDialog = TRUE; CommitValues = TRUE; } break; case DIM_SOFT_COMMIT: // Want to commit { OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only give the tab the message if it is a application based option if ( pOptionsTabs->IsProgramOption() ) pOptionsTabs->HandleMsg(Msg); pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } CommitValues = TRUE; } break; case DIM_CANCEL: // Want to quit { // We pass the message to all the tabs so that they clean up and discard all changes made, if any OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only give the tab the message if it is a application based option if ( pOptionsTabs->IsProgramOption() ) pOptionsTabs->HandleMsg(Msg); pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } EndDialog = TRUE; } break; default: break; } } // Commit values here if (CommitValues) { // // To stop dangerous things happening such as being told to cancel the dialog box // // when we are in the middle of a apply now/ok, we will grey all the dodgy buttons // // whilst we are in danger of this happening. // // Example: if change show transparency state and apply this, then a dialog may // // pop up to question whether this is required or not. At this point the dialog // // box is still accessable. If click cancel then access violations happen. // CDlgResID PageID = GetCurrentPageID(); // Get currently selected Tab id // TalkToPage(NULL); // Select the main tab // EnableGadget(_R(ID_APPLY_NOW), FALSE); // grey button on main tab // EnableGadget(IDOK, FALSE); // grey button on main tab // EnableGadget(IDCANCEL, FALSE); // grey button on main tab // TalkToPage(PageID); // Select the originally selected tab // BOOL ApplyNow = OptionsTabs::SetApplyNowState(FALSE); BOOL ok = CommitDialogValues(); // Only unset EndDialog as in SOFT_COMMIT case we do not want to end the // Operation and hence close the dialog box if (!ok) { EndDialog = FALSE; // Values not correct so do not allow exit Msg->DlgMsg = DIM_SOFT_COMMIT; // turn the message into a soft-commit so the base class does not destroy the dialog } #ifndef REMOVE_PRINT_TABS // Now, a nasty bodge. The print tabs need to re-cache their local print control data // from the committed values in the document print control, or else all hell will break // loose. // WEBSTER-ranbirr-13/11/96 #ifndef WEBSTER PrintBaseTab::DocumentSettingsUpdated(); #endif // // Committing and not closing the dialog so re-enable the ok, cancel and apply // // now buttons. // PageID = GetCurrentPageID(); // Get currently selected Tab id // TalkToPage(NULL); // Select the main tab // EnableGadget(_R(ID_APPLY_NOW), TRUE); // ungrey button on main tab // EnableGadget(IDOK, TRUE); // ungrey button on main tab // EnableGadget(IDCANCEL, TRUE); // ungrey button on main tab // TalkToPage(PageID); // Select the originally selected tab // OptionsTabs::SetApplyNowState(ApplyNow); #endif //webster } if ( !OldApplyNow && OptionsTabs::GetApplyNowState() && !EndDialog && !OptionsTabs::GetInitMessageState() ) { // Check for a change from apply now being False to it becoming // True as an item has been changed. OptionsTabs::UngreyApplyNow(); } if ( OptionsTabs::GetApplyNowState() && (Msg->DlgMsg == DIM_SOFT_COMMIT) && !EndDialog && !OptionsTabs::GetInitMessageState() ) { // Check for an apply now (DIM_SOFT_COMMIT) being used and the // apply being True, should always be the case, so that we can reset // the grey state to False as we are in an unchanged state. OptionsTabs::SetApplyNowState(FALSE); OptionsTabs::GreyApplyNow(); } // Allow the base class access to the message, it will do the // DLG_EAT_IF_HUNGRY(Msg) for us // Note that this call can DELETE "this" Result = DialogTabOp::Message(Message); // End dialog here if (EndDialog) { // Make sure that we remove our options tabs link to the dialog box class // as the dialog will now be destroyed OptionsTabs::pPrefsDlg = NULL; } // Check if have been sending an init/create message and if so then set flag False. // Only do this in the init/create case as we might be sent one of these and then // be sent other messages whilst in the middle of the init/create message such as // text changing messages. if (Msg->DlgMsg == DIM_CREATE) OptionsTabs::SetInitMessageState(FALSE); // The message was for our dialog box so return that we have handled it, if necessary //return (DLG_EAT_IF_HUNGRY(Msg)); return Result; } else { // If nobody above has processed the message, then pass it around all the tabs in // case it's of use to them. OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only give the tab the message if it is a application based option if ( pOptionsTabs->IsProgramOption() ) pOptionsTabs->Message(Message); pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } } #endif // return OK; return DialogTabOp::Message(Message); }

BOOL AppPrefsDlg::RegisterYourPagesInOrderPlease (   )  [virtual]

This virtual function will get called to give you a chance to add pages to your DialogTabOp. This function will usually make multiple calls to AddAPage to register the initial set of pages to be contained in the tab dialog. The pages should all be the same size and be registered in the left to right order in which you wish them to appear. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 05/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: return TRUE if all calls to AddAPage returned TRUE, else FALSE This function get's called directly from the Create method, Don't call it explicitly yourself. If you return FALSE from this method then the Create method will fail. Returns: Errors: - See also: DialogTabOp::AddAPage; DialogOp::Create Reimplemented from DialogTabOp. Definition at line 1398 of file appprefs.cpp. { BOOL ok = TRUE; // Now go through all the tabs declared to the system OptionsTabs *pOptionsTabs = OptionsTabs::GetFirst(); while (pOptionsTabs != NULL) { // Only add the tab if it is a program based option if ( pOptionsTabs->IsProgramOption() ) { CDlgResID PageId = pOptionsTabs->GetPageID(); ok = ok && AddAPage(PageId); } // Get the next option's tab. pOptionsTabs = OptionsTabs::GetNext(pOptionsTabs); } return (ok); }

BOOL AppPrefsDlg::SetSaveOnExit (  BOOL  NewState  )  [static]

This allows the state of the Save on exit flag to be set to either TRUE or FALSE. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 08/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The old state of the save preferences on exit flag. Errors: - See also: - Definition at line 273 of file appprefs.cpp. { // First, remember old state BOOL OldSaveOnExit = SaveOnExit; if ( NewState != 0 ) SaveOnExit = TRUE; else SaveOnExit = FALSE; return OldSaveOnExit; }

---

Member Data Documentation

const CDlgResID AppPrefsDlg::IDD = _R(IDD_APPLICATIONOPTIONS) [static]

Definition at line 161 of file appprefs.h.

const CDlgMode AppPrefsDlg::Mode = MODELESS [static]

Definition at line 162 of file appprefs.h.

PageSizesList * AppPrefsDlg::pPageSizesList = NULL [static]

Definition at line 169 of file appprefs.h.

String_256 AppPrefsDlg::TitleString [private]

Definition at line 178 of file appprefs.h.

---

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

• Kernel/appprefs.h (r1785/r1282)
• Kernel/appprefs.cpp (r1785/r1361)

---