TemplateDialog Class Reference

Allows intelligent users to make attributes changeable via templates. More...

#include <tmpltdlg.h>

Inheritance diagram for TemplateDialog:

List of all members.

Public Member Functions
	TemplateDialog ()
	Required constructor for DialogManager, gives Modeless dialog and resource ID.
virtual	~TemplateDialog ()
	Destructor deletes those member variables.
virtual void	Do (OpDescriptor *)
	Waste some space.
TextControl &	GetKeyControl () const
TextControl &	GetValueControl () const
StaticTextControl &	GetParamHintControl () const
void	SetUserCanModifyQuestion (BOOL TheyAre)
Static Public Member Functions
static BOOL	Init ()
	Creates an OpDescriptor for a TemplateDialog so you can make a template dialog pop up using pOpDescriptor->Invoke(). Call this before even thinking of invoking it 'cos otherwise it won't work. Somewhere in main3.cpp would be nice.
static OpState	GetState (String_256 *, OpDescriptor *)
	Silliness with statics (derived classes anyone?).
Static Public Attributes
static const CDlgResID	s_IDD = _R(IDD_TEMPLATE_DIALOG)
static const CDlgMode	s_Mode = MODELESS
Protected Member Functions
virtual MsgResult	Message (Msg *Message)
	Bog standard dispatch the message type switch statement.
virtual void	OnCreate ()
	Handles a message that the dialog has just been created.
virtual void	OnTextChange ()
	Responds to the user's request to add the selected template argument to the list of used properties.
virtual void	OnParamChange ()
	Responds to the user's request to add the selected template argument to the list of used properties.
virtual void	OnAddButtonClicked ()
	Responds to the user's request to add the selected template argument to the list of used properties.
virtual void	OnRemoveButtonClicked ()
	Handles the message when the user clicks on the Remove button.
virtual void	OnRemoveAllButtonClicked ()
virtual void	OnUsedListHighlightChanged ()
	Handles the message that the Used Properties list box has had its highlight changed. Updates the question edit box as appropriate.
virtual void	OnAvailableListHighlightChanged ()
	Handles the message that the Available Properties list box has had its highlight changed. If there wasn't a highlight before you can now press the add button.
virtual void	OnAvailableListDoubleClicked ()
	Responds to the user's request to add the selected template argument to the list of used properties.
virtual void	OnSelectionChange ()
	Handles a message that there's been a selection change.
virtual void	OnMakeStyleClicked ()
	Responds to a request to make a style from a WizOp.
virtual void	OnApplyClicked ()
	Responds to the user's request to apply the Name and Template Property attributes to the selection.
void	OnAvailableSelectionChange ()
	Responds to a change to the selected item in the Available List.
void	OnUsedSelectionChange ()
	Updates the state of the buttons which are determined solely by the Available properties list.
void	SetDialogInitialState (BaseDocument *const pSelectedDocument)
	Handles a message that there's been a selection change.
void	InitializeControls ()
	Sets up the dialog according to what attributes are applied to the selection. The cases are:.
void	ReflectControlAvailability ()
void	ShowInitialControlAvailablity ()
RenderableNodeEnumerator *	CreateEnumerator () const
	Provides a suitable Node enumerator depending on the selection.
Style *	AddNewStyle (const Style &NewStyle) const
	Support function that attempts to add the given style to the styles associated with the selected document.
BOOL	BuildUsedPropertiesList ()
BOOL	BuildAvailablePropertiesList (BaseDocument *const pSelectedDocument)
	Updates the state of the buttons which are determined solely by the Available properties list.
void	MakePropertyUsed ()
void	RemoveUsedProperty ()
void	RemoveAllUsedProperties ()
BOOL	CreateGadgets ()
	Support function to create the controls in the dialog. The DialogManager should do this but I haven't time.
void	ApplyUsedAttributes ()
	Applies all the properties marked as used to the current selection.
AvailablePropertiesList &	GetAvailableProperties ()
	Data Member access.
UsedPropertiesList &	GetUsedProperties ()
BOOL	UserCanModifyQuestion () const
WizOps &	GetWizOps () const
WizOpStyles *	GetStyles () const
Static Protected Member Functions
static BOOL	ShowCustomProperty ()
	Tells us if we should add a custom property to the Available Properties list according to preference.
Private Member Functions
	CC_DECLARE_DYNCREATE (TemplateDialog)
Private Attributes
ListControl *	m_pUsedListGadget
ListControl *	m_pAvailableListGadget
TextControl *	m_pQuestionGadget
StaticTextControl *	m_pParamHintGadget
TextControl *	m_pParamGadget
Button *	m_pAddButton
Button *	m_pRemoveButton
Button *	m_pRemoveAllButton
Button *	m_pApplyButton
Button *	m_pMakeStyleButton
AvailablePropertiesList *	m_pAvailableProperties
UsedPropertiesList *	m_pUsedProperties
BOOL	m_UserCanModifyQuestion
Static Private Attributes
static String_32	s_PreferenceSection = TEXT("Wizard Properties")
static const UINT32	s_NumberOfPreferences = 1
static String_16	s_ShowCustom = TEXT("Show Custom")
	If TRUE, the Wizard Properties dialog will show an Available Property "Custom" through which the user can add.
static BOOL	s_ShowCustomProperty = FALSE

---

Detailed Description

Allows intelligent users to make attributes changeable via templates.

Author:

Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes)

Date:

09/06/97

Definition at line 132 of file tmpltdlg.h.

---

Constructor & Destructor Documentation

TemplateDialog::TemplateDialog (   )

Required constructor for DialogManager, gives Modeless dialog and resource ID. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 1951 of file tmpltdlg.cpp. : DialogOp(TemplateDialog::s_IDD, TemplateDialog::s_Mode) { m_pAvailableProperties = NULL; m_pUsedProperties = NULL; m_pUsedListGadget = NULL; m_pAvailableListGadget = NULL; m_pQuestionGadget = NULL; m_pParamHintGadget = NULL; m_pParamGadget = NULL; m_pAddButton = NULL; m_pRemoveButton = NULL; m_pRemoveAllButton = NULL; m_pApplyButton = NULL; m_pMakeStyleButton = NULL; m_UserCanModifyQuestion = FALSE; }

TemplateDialog::~TemplateDialog (   )  [virtual]

Destructor deletes those member variables. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 1982 of file tmpltdlg.cpp. { delete m_pAvailableProperties; m_pAvailableProperties = NULL; delete m_pUsedProperties; m_pUsedProperties = NULL; delete m_pUsedListGadget; m_pUsedListGadget = NULL; delete m_pAvailableListGadget; m_pAvailableListGadget = NULL; delete m_pQuestionGadget; m_pQuestionGadget = NULL; delete m_pParamHintGadget; m_pParamHintGadget = NULL; delete m_pParamGadget; m_pParamGadget = NULL; delete m_pAddButton; m_pAddButton = NULL; delete m_pRemoveButton; m_pRemoveButton = NULL; delete m_pRemoveAllButton; m_pRemoveAllButton = NULL; delete m_pApplyButton; m_pApplyButton = NULL; delete m_pMakeStyleButton; m_pMakeStyleButton = NULL; }

---

Member Function Documentation

Style * TemplateDialog::AddNewStyle (  const Style &  NewStyle  )  const [protected]

Support function that attempts to add the given style to the styles associated with the selected document. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Returns: A pointer to the style to use (the one that was added) NULL if the addition failed or the Style Name already exists in the selected document's style component. Definition at line 2980 of file tmpltdlg.cpp. { Style* pStyleToUse = NULL; WizOpStyles* const pStyles = GetStyles(); if (pStyles != NULL) { // don't give them a style to use if one with the same name already exists pStyleToUse = pStyles->FindStyleFromName(NewStyle.GetName()); if (pStyleToUse == NULL) { pStyleToUse = pStyles->AddStyle(NewStyle); } else { pStyleToUse = NULL; } } return pStyleToUse; }

void TemplateDialog::ApplyUsedAttributes (   )  [protected]

Applies all the properties marked as used to the current selection. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 3059 of file tmpltdlg.cpp. { GetUsedProperties().Commit(*this); m_pApplyButton->Disable(); }

BOOL TemplateDialog::BuildAvailablePropertiesList (  BaseDocument *const   pSelectedDocument  )  [protected]

Updates the state of the buttons which are determined solely by the Available properties list. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2772 of file tmpltdlg.cpp. { BOOL Ok = TRUE; // Delete the last load of available properties we got when the selected document changed delete m_pAvailableProperties; m_pAvailableProperties = NULL; if (pSelectedDocument != NULL) { // Fill 'er up with template handlers aka WizOps m_pAvailableProperties = new AvailablePropertiesList(); } Ok = (m_pAvailableProperties != NULL && m_pAvailableListGadget != NULL); if (Ok) { Ok = m_pAvailableProperties->Interact(*m_pAvailableListGadget); } if (Ok) { Ok = m_pAvailableProperties->AddTemplateHandlers(GetWizOps()); } // ...and any styles that are hanging about if (Ok) { WizOpStyles* const pStyles = GetStyles(); Ok = (pStyles != NULL); if (Ok) { #if FALSE WizOpStyle NewStyle(String_8("Style"), String_64("The shading in the trees"), *GetWizOps().GetFirstWizOp(), String_8("P1")); pStyles->AddStyle(NewStyle); #endif Ok = m_pAvailableProperties->AddStyles(*pStyles); } } // ...and add a Custom Property entry if (Ok && ShowCustomProperty()) { CustomProperty* pCustomProperty = new CustomProperty(); if (pCustomProperty != NULL) { Ok = m_pAvailableProperties->InsertEntry(*pCustomProperty); } } if (!Ok) { delete m_pAvailableProperties; m_pAvailableProperties = NULL; } return Ok; }

BOOL TemplateDialog::BuildUsedPropertiesList (   )  [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2843 of file tmpltdlg.cpp. { BOOL Ok = TRUE; // when the selection changes, bin the old used properties list, and start afresh delete m_pUsedProperties; m_pUsedProperties = NULL; m_pUsedProperties = new UsedPropertiesList(); Ok = (m_pUsedProperties != NULL && m_pUsedListGadget != NULL); if (Ok) { Ok = m_pUsedProperties->Interact(*m_pUsedListGadget); } RenderableNodeEnumerator* pEnumerator = NULL; if (Ok) { pEnumerator = CreateEnumerator(); if (pEnumerator != NULL) { Ok = m_pUsedProperties->BuildFromEnumerator(*pEnumerator); } } delete pEnumerator; pEnumerator = NULL; return Ok; }

TemplateDialog::CC_DECLARE_DYNCREATE (  TemplateDialog   )  [private]

RenderableNodeEnumerator * TemplateDialog::CreateEnumerator (   )  const [protected]

Provides a suitable Node enumerator depending on the selection. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 3028 of file tmpltdlg.cpp. { RenderableNodeEnumerator* pEnumerator = NULL; SelRange* const pSelRange = GetApplication()->FindSelection(); if (pSelRange != NULL && !pSelRange->IsEmpty()) { pEnumerator = new RangeEnumerator(pSelRange); } else if (pSelRange != NULL && pSelRange->IsEmpty()) { // If there's no selection the AttrUser's need to be applied to the Document (maybe) // pEnumerator = new DocPseudoEnumerator(Document::GetSelected()); } return pEnumerator; }

BOOL TemplateDialog::CreateGadgets (   )  [protected]

Support function to create the controls in the dialog. The DialogManager should do this but I haven't time. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 3165 of file tmpltdlg.cpp. { m_pUsedListGadget = new ListControl(this, _R(IDC_TMLPTDLG_USED)); m_pAvailableListGadget = new ListControl(this, _R(IDC_TMLPTDLG_AVAILABLE)); m_pQuestionGadget = new TextControl(this, _R(IDC_TMLPTDLG_QUESTION)); m_pParamHintGadget = new StaticTextControl(this, _R(IDC_TMPLTDLG_PARAM_TEXT)); m_pParamGadget = new TextControl(this, _R(IDC_TMPLTDLG_PARAM)); m_pAddButton = new Button(this, _R(IDC_TMPLTDLG_ADD)); m_pRemoveButton = new Button(this, _R(IDC_TMPLTDLG_REMOVE)); m_pRemoveAllButton = new Button(this, _R(IDC_TMPLTDLG_REMOVE_ALL)); m_pApplyButton = new Button(this, IDOK); m_pMakeStyleButton = new Button(this, _R(IDC_TMPLTDLG_MAKE_STYLE)); return (m_pUsedListGadget != NULL && m_pAvailableListGadget != NULL && m_pQuestionGadget != NULL && m_pParamHintGadget != NULL && m_pParamGadget != NULL && m_pAddButton != NULL && m_pRemoveButton != NULL && m_pRemoveAllButton != NULL && m_pApplyButton != NULL && m_pMakeStyleButton != NULL ); }

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

Waste some space. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Reimplemented from Operation. Definition at line 2034 of file tmpltdlg.cpp. { // We're called when the menu item / button is clicked: once to open the dialog, once // to close it. This is pseudo model isn't it and rather silly. if (g_TheOneTemplateDialogInTheEntireUniverse == NULL) { // First time so stick the dialog on the screen if (Create()) { g_TheOneTemplateDialogInTheEntireUniverse = this; Open(); } else { End(); } } else { // Clicked button / menu to close the dialog g_TheOneTemplateDialogInTheEntireUniverse->Close(); g_TheOneTemplateDialogInTheEntireUniverse->End(); End(); // throw away the TemplateDialog that was created for this Do() g_TheOneTemplateDialogInTheEntireUniverse = NULL; } }

AvailablePropertiesList & TemplateDialog::GetAvailableProperties (   )  [protected]

Data Member access. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 3082 of file tmpltdlg.cpp. { // This static dummy object is used for returning in the ERROR2 case // The original used to return a ptr to a local variable, which is a tad dangerous. // This solution is not ideal, because there's a permanent instance of an object // that will probably never be used. static AvailablePropertiesList DummyList; ERROR2IF(m_pAvailableProperties == NULL, DummyList, "NULL Member"); return *m_pAvailableProperties; }

TextControl & TemplateDialog::GetKeyControl (   )  const

Definition at line 3108 of file tmpltdlg.cpp. { ASSERT(m_pParamGadget != NULL); return *m_pParamGadget; }

StaticTextControl & TemplateDialog::GetParamHintControl (   )  const

Definition at line 3123 of file tmpltdlg.cpp. { ASSERT(m_pParamHintGadget != NULL); return *m_pParamHintGadget; }

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

Silliness with statics (derived classes anyone?). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 1910 of file tmpltdlg.cpp. { OpState OpSt; if (g_TheOneTemplateDialogInTheEntireUniverse != NULL) { OpSt.Ticked = TRUE; } return OpSt; }

WizOpStyles * TemplateDialog::GetStyles (   )  const [protected]

Definition at line 3130 of file tmpltdlg.cpp. { WizOpStyles* pStyles = NULL; BaseDocument* pDoc = Document::GetSelected(); if (pDoc != NULL) { pStyles = (WizOpStyles*)pDoc->GetDocComponent(CC_RUNTIME_CLASS(WizOpStyles)); } return pStyles; }

UsedPropertiesList & TemplateDialog::GetUsedProperties (   )  [protected]

Definition at line 3095 of file tmpltdlg.cpp. { // This static dummy object is used for returning in the ERROR2 case // The original used to return a ptr to a local variable, which is a tad dangerous. // This solution is not ideal, because there's a permanent instance of an object // that will probably never be used. static UsedPropertiesList DummyList; ERROR2IF(m_pUsedProperties == NULL, DummyList, "NULL Member"); return *m_pUsedProperties; }

TextControl & TemplateDialog::GetValueControl (   )  const

Definition at line 3116 of file tmpltdlg.cpp. { ASSERT(m_pQuestionGadget != NULL); return *m_pQuestionGadget; }

WizOps & TemplateDialog::GetWizOps (   )  const [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 3012 of file tmpltdlg.cpp. { return ::GetWizOps(); }

BOOL TemplateDialog::Init (  void   )  [static]

Creates an OpDescriptor for a TemplateDialog so you can make a template dialog pop up using pOpDescriptor->Invoke(). Call this before even thinking of invoking it 'cos otherwise it won't work. Somewhere in main3.cpp would be nice. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Returns: FALSE if it fails Reimplemented from SimpleCCObject. Definition at line 1862 of file tmpltdlg.cpp. { BOOL Ok = TRUE; Ok = OpRemoveAttributeFromSelection::Declare(); Ok |= RegisterOpDescriptor( 0, // Tool ID _R(IDS_TEMPLATE_DIALOG), // String resouirce ID CC_RUNTIME_CLASS(TemplateDialog), // Runtime class OPTOKEN_TEMPLATEDLG, // Token string TemplateDialog::GetState, // GetState function 0, // is now helpless _R(IDH_Command_Wizard_Properties), // Help ID _R(IDBBL_TEMPLATE_DIALOG), // Bubble ID _R(IDD_BARCONTROLSTORE), // Resource ID _R(IDC_TMPLTDLG), // Control ID SYSTEMBAR_UTILITIES, // Bar ID TRUE, // Recieve system messages (and button msgs) FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // No vertical counterpart NULL, // String to say only one instance allowed ( DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) ); Ok |= NameDialog::Init(); Ok |= Camelot.DeclareSection(s_PreferenceSection, s_NumberOfPreferences); Ok |= Camelot.DeclarePref(s_PreferenceSection, s_ShowCustom, &s_ShowCustomProperty ); return Ok; }

void TemplateDialog::InitializeControls (   )  [protected]

Sets up the dialog according to what attributes are applied to the selection. The cases are:. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2539 of file tmpltdlg.cpp. { // Fill the right-hand one with applied user attributes BuildUsedPropertiesList(); ShowInitialControlAvailablity(); }

void TemplateDialog::MakePropertyUsed (   )  [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2886 of file tmpltdlg.cpp. { ENSURE_THIS(); const UINT32 OrignalEntries = GetUsedProperties().GetNumberOfEntries(); // should be Notified really // Get the selected template handler in the available properties list VisibleListIterator Iterator = GetAvailableProperties().SelectionBegin(); while (Iterator != GetAvailableProperties().End()) { // and add a new entry in the used list AvailableProperty& PropertyToUse = (AvailableProperty&)*Iterator; ENSURE_KIND((&PropertyToUse), AvailableProperty); GetUsedProperties().AddAvailableProperty(PropertyToUse); ++Iterator; } // if we actually added something then enable the Apply button if (GetUsedProperties().GetNumberOfEntries() > OrignalEntries) { m_pApplyButton->Enable(); // should be Notified really m_pRemoveAllButton->Enable(); // should be Notified really } // disable the Make Style button 'cos we don't have a working attribute now m_pMakeStyleButton->Disable(); m_pAddButton->Disable(); }

MsgResult TemplateDialog::Message (  Msg *  pMessage  )  [protected, virtual]

Bog standard dispatch the message type switch statement. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Parameters: pMessage,:  The message that DialogManager may or may not send us [INPUTS] Returns: DialogOp::MsgResult Reimplemented from DialogOp. Definition at line 2079 of file tmpltdlg.cpp. { if (IS_OUR_DIALOG_MSG(pMessage)) { DialogMsg* const pDialogMsg = ((DialogMsg*) pMessage); switch (pDialogMsg->DlgMsg) { case DIM_TEXT_CHANGED: // just respond to changes to the question // should use Notify really switch (pDialogMsg->GadgetID) { case _R(IDC_TMLPTDLG_QUESTION): // Make sure we don't respond to the changes we make internally OnTextChange(); break; case _R(IDC_TMPLTDLG_PARAM): OnParamChange(); break; } break; case DIM_SELECTION_CHANGED_COMMIT: // who named this??? if (pDialogMsg->GadgetID == _R(IDC_TMLPTDLG_AVAILABLE)) { OnAvailableListDoubleClicked(); } break; case DIM_LFT_BN_CLICKED: switch(pDialogMsg->GadgetID) { case _R(IDC_TMPLTDLG_ADD): OnAddButtonClicked(); break; case _R(IDC_TMPLTDLG_REMOVE): OnRemoveButtonClicked(); break; case _R(IDC_TMPLTDLG_REMOVE_ALL): OnRemoveAllButtonClicked(); break; case _R(IDC_TMPLTDLG_MAKE_STYLE): OnMakeStyleClicked(); break; } break; case DIM_SELECTION_CHANGED: // NB: This means Messrs Mouse & Keyboard have manipulated one of the list boxes. // It doesn't mean the selection has changed! if (pDialogMsg->GadgetID == _R(IDC_TMLPTDLG_AVAILABLE)) { OnAvailableListHighlightChanged(); } else if (pDialogMsg->GadgetID == _R(IDC_TMLPTDLG_USED)) { OnUsedListHighlightChanged(); } break; case DIM_CREATE: OnCreate(); break; case DIM_COMMIT: OnApplyClicked(); break; case DIM_CANCEL: Close(); End(); g_TheOneTemplateDialogInTheEntireUniverse = NULL; break; } } else if (MESSAGE_IS_A(pMessage, SelChangingMsg)) { if ( ((SelChangingMsg*)pMessage)->State == SelChangingMsg::SELECTIONCHANGED ) OnSelectionChange(); } else if (MESSAGE_IS_A(pMessage, DocChangingMsg)) { // Look out for the selected document changing DocChangingMsg::DocState State = ((DocChangingMsg*)pMessage)->State; if (State == DocChangingMsg::SELCHANGED) { SetDialogInitialState(((DocChangingMsg*)pMessage)->pNewDoc); } } else if (MESSAGE_IS_A(pMessage, StylesMessage)) { // We're sent one of these when the styles are added to (not by us) // Make sure they're the styles we've got displayed that are changing if (&(((StylesMessage*)pMessage)->GetStylesChanging()) == GetStyles()) { SetDialogInitialState(Document::GetSelected()); } } return DialogOp::Message(pMessage); }

void TemplateDialog::OnAddButtonClicked (   )  [protected, virtual]

Responds to the user's request to add the selected template argument to the list of used properties. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2330 of file tmpltdlg.cpp. { // For each selected item in the Available list add the appropriate attribute MakePropertyUsed(); // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnApplyClicked (   )  [protected, virtual]

Responds to the user's request to apply the Name and Template Property attributes to the selection. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2478 of file tmpltdlg.cpp. { GetUsedProperties().RemoveSelection(); // this ensures the shown question is updated ApplyUsedAttributes(); //And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnAvailableListDoubleClicked (   )  [protected, virtual]

Responds to the user's request to add the selected template argument to the list of used properties. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2310 of file tmpltdlg.cpp. { MakePropertyUsed(); //And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnAvailableListHighlightChanged (   )  [protected, virtual]

Handles the message that the Available Properties list box has had its highlight changed. If there wasn't a highlight before you can now press the add button. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes, mostly Graham's Web/Hot/URL/Link Dialog) Date: 09/06/97 Definition at line 2438 of file tmpltdlg.cpp. { OnAvailableSelectionChange(); // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnAvailableSelectionChange (   )  [protected]

Responds to a change to the selected item in the Available List. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 2594 of file tmpltdlg.cpp. { VOID_ENSURE_NOT_NULL(m_pAddButton); if (m_pAddButton != NULL) { // Remove the selection from the selected list. This will remove any question / param // so they can be used to add new entries if (GetUsedProperties().GetNumberOfSelectedEntries() > 0) { GetUsedProperties().RemoveSelection(); } GetAvailableProperties().OnSelectionChange(*this); // should use a Notify for this... if (GetAvailableProperties().GetNumberOfSelectedEntries() > 0) { m_pAddButton->Enable(); } else { m_pAddButton->Disable(); } } VOID_ENSURE_NOT_NULL(m_pMakeStyleButton); if (m_pMakeStyleButton != NULL) { // ensure the style button is disabled m_pMakeStyleButton->Disable(); } }

void TemplateDialog::OnCreate (   )  [protected, virtual]

Handles a message that the dialog has just been created. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2199 of file tmpltdlg.cpp. { CreateGadgets(); // Set up the dialog in its initial state SetDialogInitialState(Document::GetSelected()); // And put the keyboard focus in the available properties list SetKeyboardFocus(_R(IDC_TMLPTDLG_AVAILABLE)); }

void TemplateDialog::OnMakeStyleClicked (   )  [protected, virtual]

Responds to a request to make a style from a WizOp. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2388 of file tmpltdlg.cpp. { // (should probably do this somewhere else - GOD this is ugly) AvailableProperty* const pSelectedProperty = (AvailableProperty*)GetAvailableProperties().GetFirstSelectedEntry(); if (pSelectedProperty != NULL) { // Invoke a dialog for the name NameDialogParam StyleNameParam; if (NameDialog::Invoke(StyleNameParam)) // returns TRUE if they didn't cancel { // if so create a new style Style* pNewStyle = pSelectedProperty->MakeStyle(StyleNameParam.GetNameEntered()); if (pNewStyle != NULL) { WizOpStyle* pStyleToUse = (WizOpStyle*)AddNewStyle(*pNewStyle); if (pStyleToUse != NULL) { GetAvailableProperties().AddStyle(*pStyleToUse); pSelectedProperty->Hide(); } // AddNewStyle creates a copy, so we can bin this delete pNewStyle; pNewStyle = NULL; } // disable the Make Style button 'cos we don't have a working attribute now m_pMakeStyleButton->Disable(); m_pAddButton->Disable(); } } // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnParamChange (   )  [protected, virtual]

Responds to the user's request to add the selected template argument to the list of used properties. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Notes: The order of events should go: m_pParamGadget->OnChange() Notify(this) this->OnParamChange() but we'll bodge it a bit & go directly here 'cos DialogOp's a bit of a mess at the moment. Definition at line 2286 of file tmpltdlg.cpp. { /* if (UserCanModifyQuestion()) { // bit bodgy this... m_pApplyButton->Enable(); SetUserCanModifyQuestion(FALSE); // well they can but who cares now? } */ }

void TemplateDialog::OnRemoveAllButtonClicked (   )  [protected, virtual]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2369 of file tmpltdlg.cpp. { RemoveAllUsedProperties(); // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnRemoveButtonClicked (   )  [protected, virtual]

Handles the message when the user clicks on the Remove button. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2350 of file tmpltdlg.cpp. { RemoveUsedProperty(); // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnSelectionChange (   )  [protected, virtual]

Handles a message that there's been a selection change. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes, mostly Graham's Web/Hot/URL/Link Dialog) Date: 09/06/97 Definition at line 2499 of file tmpltdlg.cpp. { //Put the dialog into its initial state InitializeControls(); }

void TemplateDialog::OnTextChange (   )  [protected, virtual]

Responds to the user's request to add the selected template argument to the list of used properties. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2222 of file tmpltdlg.cpp. { // if we're modifying a question, that means it's a Used Property, so // allow them to Apply the change if (UserCanModifyQuestion()) { // bit bodgy this... m_pApplyButton->Enable(); SetUserCanModifyQuestion(FALSE); // well they can but who cares now? } else { // If we've got one Available Property selected we might want to // allow them to make a style of it BOOL ShouldEnableMakeStyle = FALSE; if (GetAvailableProperties().GetNumberOfSelectedEntries() == 1) { String_256 Question; VOID_ENSURE_NOT_NULL(m_pQuestionGadget); if (m_pQuestionGadget != NULL) { m_pQuestionGadget->RetrieveText(&Question); } AvailableProperty* pSelectedEntry = (AvailableProperty*)GetAvailableProperties().GetFirstSelectedEntry(); if (pSelectedEntry != NULL) { ShouldEnableMakeStyle = pSelectedEntry->CanBecomeStyle() && !Question.IsEmpty(); } } if (ShouldEnableMakeStyle) { m_pMakeStyleButton->Enable(); } else { m_pMakeStyleButton->Disable(); } } }

void TemplateDialog::OnUsedListHighlightChanged (   )  [protected, virtual]

Handles the message that the Used Properties list box has had its highlight changed. Updates the question edit box as appropriate. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes, mostly Graham's Web/Hot/URL/Link Dialog) Date: 09/06/97 Definition at line 2458 of file tmpltdlg.cpp. { OnUsedSelectionChange(); // And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void TemplateDialog::OnUsedSelectionChange (   )  [protected]

Updates the state of the buttons which are determined solely by the Available properties list. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 2684 of file tmpltdlg.cpp. { VOID_ENSURE_NOT_NULL(m_pRemoveButton); VOID_ENSURE_NOT_NULL(m_pRemoveAllButton); VOID_ENSURE_NOT_NULL(m_pMakeStyleButton); VOID_ENSURE_NOT_NULL(m_pAddButton); if (m_pRemoveButton != NULL && m_pRemoveAllButton != NULL && m_pMakeStyleButton != NULL && m_pAddButton != NULL) { // Remove the selection from the available list if (GetAvailableProperties().GetNumberOfSelectedEntries() > 0) { GetAvailableProperties().RemoveSelection(); m_pMakeStyleButton->Disable(); m_pAddButton->Disable(); } GetUsedProperties().OnSelectionChange(*this); // Can only remove selected items if (GetUsedProperties().GetNumberOfSelectedEntries() > 0) { m_pRemoveButton->Enable(); } else { m_pRemoveButton->Disable(); } // Whenever there's anything in the used list, enable the Remove All Button if (GetUsedProperties().GetNumberOfEntries() > 0) { m_pRemoveAllButton->Enable(); } else { m_pRemoveAllButton->Disable(); } } }

void TemplateDialog::ReflectControlAvailability (   )  [protected]

void TemplateDialog::RemoveAllUsedProperties (   )  [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 2951 of file tmpltdlg.cpp. { ENSURE_THIS(); GetUsedProperties().DeleteAllEntries(); m_pApplyButton->Enable(); // should be Notified really m_pRemoveButton->Disable(); // should be Notified really m_pRemoveAllButton->Disable(); // should be Notified really }

void TemplateDialog::RemoveUsedProperty (   )  [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 2926 of file tmpltdlg.cpp. { ENSURE_THIS(); GetUsedProperties().DeleteSelectedEntries(); m_pApplyButton->Enable(); // should be Notified really m_pRemoveButton->Disable(); // should be Notified really if (GetUsedProperties().GetNumberOfEntries() == 0) { m_pRemoveAllButton->Disable(); // should be Notified really } }

void TemplateDialog::SetDialogInitialState (  BaseDocument *const   pSelectedDocument  )  [protected]

Handles a message that there's been a selection change. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes, mostly Graham's Web/Hot/URL/Link Dialog) Date: 09/06/97 Definition at line 2516 of file tmpltdlg.cpp. { m_UserCanModifyQuestion = FALSE; // Fill the left-hand list box with the available WizOps / Styles & a Custom property BuildAvailablePropertiesList(pSelectedDocument); // Set the controls up in their correct initial state InitializeControls(); }

void TemplateDialog::SetUserCanModifyQuestion (  BOOL  TheyAre  )

Definition at line 3149 of file tmpltdlg.cpp. { m_UserCanModifyQuestion = TheyCan; }

BOOL TemplateDialog::ShowCustomProperty (   )  [static, protected]

Tells us if we should add a custom property to the Available Properties list according to preference. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> (from assorted dialog classes) Date: 09/06/97 Definition at line 1934 of file tmpltdlg.cpp. { return s_ShowCustomProperty; }

void TemplateDialog::ShowInitialControlAvailablity (   )  [protected]

Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 09/06/97 Definition at line 2556 of file tmpltdlg.cpp. { m_pQuestionGadget->Disable(); m_pParamGadget->Disable(); m_pAddButton->Disable(); m_pRemoveButton->Disable(); m_pRemoveAllButton->Disable(); m_pMakeStyleButton->Disable(); m_pApplyButton->Disable(); // if nothing's selected don't let them click on it SelRange* const pSelRange = GetApplication()->FindSelection(); if (pSelRange != NULL && pSelRange->IsEmpty()) { m_pAvailableListGadget->Disable(); m_pUsedListGadget->Disable(); } else { m_pAvailableListGadget->Enable(); m_pUsedListGadget->Enable(); } }

BOOL TemplateDialog::UserCanModifyQuestion (   )  const [protected]

Definition at line 3144 of file tmpltdlg.cpp. { return m_UserCanModifyQuestion; }

---

Member Data Documentation

Button* TemplateDialog::m_pAddButton [private]

Definition at line 219 of file tmpltdlg.h.

Button* TemplateDialog::m_pApplyButton [private]

Definition at line 222 of file tmpltdlg.h.

ListControl* TemplateDialog::m_pAvailableListGadget [private]

Definition at line 215 of file tmpltdlg.h.

AvailablePropertiesList* TemplateDialog::m_pAvailableProperties [private]

Definition at line 225 of file tmpltdlg.h.

Button* TemplateDialog::m_pMakeStyleButton [private]

Definition at line 223 of file tmpltdlg.h.

TextControl* TemplateDialog::m_pParamGadget [private]

Definition at line 218 of file tmpltdlg.h.

StaticTextControl* TemplateDialog::m_pParamHintGadget [private]

Definition at line 217 of file tmpltdlg.h.

TextControl* TemplateDialog::m_pQuestionGadget [private]

Definition at line 216 of file tmpltdlg.h.

Button* TemplateDialog::m_pRemoveAllButton [private]

Definition at line 221 of file tmpltdlg.h.

Button* TemplateDialog::m_pRemoveButton [private]

Definition at line 220 of file tmpltdlg.h.

ListControl* TemplateDialog::m_pUsedListGadget [private]

Definition at line 214 of file tmpltdlg.h.

UsedPropertiesList* TemplateDialog::m_pUsedProperties [private]

Definition at line 226 of file tmpltdlg.h.

BOOL TemplateDialog::m_UserCanModifyQuestion [private]

Definition at line 229 of file tmpltdlg.h.

const CDlgResID TemplateDialog::s_IDD = _R(IDD_TEMPLATE_DIALOG) [static]

Definition at line 209 of file tmpltdlg.h.

const CDlgMode TemplateDialog::s_Mode = MODELESS [static]

Definition at line 210 of file tmpltdlg.h.

const UINT32 TemplateDialog::s_NumberOfPreferences = 1 [static, private]

Definition at line 233 of file tmpltdlg.h.

String_32 TemplateDialog::s_PreferenceSection = TEXT("Wizard Properties") [static, private]

Definition at line 232 of file tmpltdlg.h.

String_16 TemplateDialog::s_ShowCustom = TEXT("Show Custom") [static, private]

If TRUE, the Wizard Properties dialog will show an Available Property "Custom" through which the user can add. Preference: Show Custom Section: Wizard Properties Range: TRUE or FALSE Definition at line 235 of file tmpltdlg.h.

BOOL TemplateDialog::s_ShowCustomProperty = FALSE [static, private]

Definition at line 236 of file tmpltdlg.h.

---

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

• Kernel/tmpltdlg.h (r1785/r751)
• Kernel/tmpltdlg.cpp (r1785/r1282)

---