UnitsTab Class Reference

Allows the user to define the default units that are used for displaying size information, font size information and general display information. Also, alllows them to define their own units and edit the scaling factor applied to the spread, layer, or whatever. Based on the old UnitsDlg code. More...

#include <optsunit.h>

Inheritance diagram for UnitsTab:

List of all members.

Public Member Functions
	UnitsTab ()
	UnitsTab constructor. Creates a non-undoable operation.
	~UnitsTab ()
	UnitsTab destructor.
virtual BOOL	Init ()
	UnitsTab initialisation routine.
virtual BOOL	HandleMsg (DialogMsg *Msg)
	Handles all the units options tabs messages.
virtual BOOL	InitSection ()
	Sets initial values for the Units section of the options dialog box. This section includes the:-.
virtual BOOL	CommitSection ()
	Takes the values in the Units section tab of the options dialog box and sets the associated preference values accordingly Called when ok is pressed on the dialog box.
virtual BOOL	GreySection ()
	Called when the user has closed all documents.
virtual BOOL	UngreySection ()
	Called when the user has selected a new document.
BOOL	ChangeControlStatus (const BOOL Status)
	Called to grey/ungrey all controls on this tab.
virtual BOOL	UpdateSection (String_256 *DocumentName)
	Called when we have switched to a new document and need to update all the controls on this tab. Should only init the tab if the page is present. The document name allows the info field on the tab to be filled in correctly.
virtual CDlgResID	GetPageID ()
	Allows the options dialog code to determine the dialog ID of this section.
virtual BOOL	IsDocumentOption ()
	Allows the document options dialog code to determine if this tab belongs to the group of document options.
virtual BOOL	IsProgramOption ()
	Allows the program options dialog code to determine if this tab belongs to the group of program options.
Static Public Member Functions
static ScaleUnit *	GetColourUnitPreference ()
	Retrieves the user's Colour Unit preference to be used by the Colour Editor If no preference is found StandardUnit::UnitPercent is the default Scope: static.
Protected Member Functions
BOOL	CommitDialogValues ()
	Takes the values in the dialog. Called when the OK button is selected.
BOOL	SelectCurrentUserUnit ()
	Make sure that the current user unit, if any, is selected and hence shown as selected in the user units list.
BOOL	InitControls ()
	Inits all the controls in the dialog Called immediately after the bar is created to init drop lists, grey out gadgets, etc.
BOOL	InitUnitListControls ()
	Fills in all the drop lists and combo boxes of units with the ones in the document.
BOOL	EnableControls ()
	Enables or disables the controls depending on the current context, i.e. the controls are disabled if there is no selection, etc.
void	SetUnitToken (CGadgetID ID, UnitType ThisUnitType, INT32 Index=-1, BOOL EndOfList=FALSE)
	Readable function for putting unit token strings in controls.
void	ShowUnitDetails (CGadgetID ID, UnitType ThisUnitType, INT32 Index=-1, BOOL EndOfList=FALSE)
	Shows the summary of the details of the specified unit for putting user unit token strings in the scrollable details list.
BOOL	UpdateUnitListControls ()
	Updates the new name name of the currently selected user unit, if any in all of the lists.
BOOL	CreateNewUnit ()
	Creates a new user unit that the user has just requested.
BOOL	DeleteUnit ()
	Deletes the currently selected user unit.
BOOL	ShowUnitProperties ()
	Shows the current properties of the selected user unit.
Protected Attributes
ScaleUnit *	m_pOldColourUnit
RadioGroup	m_ColourUnitRadioGroup
Private Attributes
DocUnitList *	pDocUnitList
UnitType	CurrentUserUnitType
BOOL	GreyStatus
UnitType	OldPageUnits
UnitType	OldFontUnits

---

Detailed Description

Allows the user to define the default units that are used for displaying size information, font size information and general display information. Also, alllows them to define their own units and edit the scaling factor applied to the spread, layer, or whatever. Based on the old UnitsDlg code.

Author:

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

Date:

07/12/94

See also:

UnitsDlg;

OptionsTabs; AppPrefsDlg; DocPrefsDlg;

Definition at line 126 of file optsunit.h.

---

Constructor & Destructor Documentation

UnitsTab::UnitsTab (   )

UnitsTab constructor. Creates a non-undoable operation. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 168 of file optsunit.cpp. { // Do nothing at present }

UnitsTab::~UnitsTab (   )

UnitsTab destructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 189 of file optsunit.cpp. { }

---

Member Function Documentation

BOOL UnitsTab::ChangeControlStatus (  const BOOL  Status  )

Called to grey/ungrey all controls on this tab. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/2/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: UnitsTab::GreySection; UnitsTab::UngreySection; Definition at line 429 of file optsunit.cpp. { // Main units section pPrefsDlg->EnableGadget(_R(IDC_OPTS_INFO), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_UNITSGROUP), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_PAGEUNITSTXT), Status); // pPrefsDlg->EnableGadget(_R(IDC_OPTS_SCALEDUNITSTXT),Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_FONTUNITSTXT), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_PAGEUNITS), Status); // pPrefsDlg->EnableGadget(_R(IDC_OPTS_SCALEDUNITS), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_FONTUNITS), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_CLR_UNIT_USE_PERCENT), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_CLR_UNIT_USE_BYTE), Status); // Buttons in the user units section pPrefsDlg->EnableGadget(_R(IDC_OPTS_NEWUNIT), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_DELETEUNIT), Status); pPrefsDlg->EnableGadget(_R(IDC_OPTS_UNITPROPERTY), Status); return TRUE; }

BOOL UnitsTab::CommitDialogValues (   )  [protected]

Takes the values in the dialog. Called when the OK button is selected. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 5/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 575 of file optsunit.cpp. { ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::CommitDialogValues called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::HandleMsg called with no doc unit list"); // **** // All of the user units are handled as immediate edits and so no extra actions // are required. // **** // Now update the defaults units that may have been choosen by the user // Set up the units with useful defaults, just in case UnitType PageUnitType = MILLIMETRES; //UnitType ScaledUnitType = AUTOMATIC; UnitType FontUnitType = COMP_POINTS; WORD Index; // Work out which page units menu item is selected and then work out the unit type pPrefsDlg->GetValueIndex(_R(IDC_OPTS_PAGEUNITS), &Index); Unit *pPageUnit = pDocUnitList->FindUnit(Index); if (pPageUnit) PageUnitType = pPageUnit->GetUnitType(); pPrefsDlg->GetValueIndex(_R(IDC_OPTS_FONTUNITS), &Index); Unit *pFontUnit = pDocUnitList->FindUnit(Index); if (pFontUnit) FontUnitType = pFontUnit->GetUnitType(); // pPrefsDlg->GetValueIndex(_R(IDC_OPTS_SCALEDUNITS), &Index); // if (Index <= 0) // ScaledUnitType = AUTOMATIC; // else // { // // Remove the automatic units from the calculation // Unit *pScaleUnit = pDocUnitList->FindUnit(Index - 1); // if (pScaleUnit) // ScaledUnitType = pScaleUnit->GetUnitType(); // } if (pDocUnitList != NULL) { pDocUnitList->SetPageUnits(PageUnitType); //pDocUnitList->SetScaleUnits(ScaledUnitType); pDocUnitList->SetFontUnits(FontUnitType); } ScaleUnit* pColourUnit = (ScaleUnit*)m_ColourUnitRadioGroup.GetSelected(); ERROR3IF(pColourUnit == NULL, "UnitsTab::CommitDialogValues - Gibberish from GetSelected()"); // If we have changed the units from the entry ones then tell other users about the change // Do a blantant update if the current user units are the current page or font units if ( (PageUnitType != OldPageUnits) || //(ScaledUnitType != OldScaledUnits) || (FontUnitType != OldFontUnits) || (pColourUnit != NULL && m_pOldColourUnit != pColourUnit) || (CurrentUserUnitType == PageUnitType) || (CurrentUserUnitType == FontUnitType) ) { // Colour units have changed so store the default as a preference then send a message in case // the Colour Editor is listening if (m_pOldColourUnit != pColourUnit) { ERROR3IF(!(pColourUnit->IS_KIND_OF(ScaleUnit)), "UnitsTab::CommitDialogValues - Not ScaleUnit"); Camelot.SetPrefDirect(ColourUnitSection, ColourUnitPreference, pColourUnit->GetQualifier()->GetToken(), TRUE); m_pOldColourUnit = pColourUnit; } // Now tell other users of units that there is a possibly new default units in operation // and so update any currently displayed units. BROADCAST_TO_ALL(OptionsChangingMsg(pDocument, OptionsChangingMsg::NEWUNITS)); // Mark the document as modified as we have changed something that is saved with the // document but only if the page or font units have changed. if (pDocument && ( (PageUnitType != OldPageUnits) || (FontUnitType != OldFontUnits) ) ) { pDocument->SetModified(TRUE); } // Note the new entry state of the controls //OldScaledUnits = ScaledUnitType; OldPageUnits = PageUnitType; OldFontUnits = FontUnitType; } // If there is a currently seleted user unit then make sure its name in all the lists is // correct. Only really true on Apply Now clicks as Oks will of course remove the dialog // box. if (CurrentUserUnitType != NOTYPE) { // Need to do this as otherwise for some strange reason the DialogManager errors // denying knowledge of the control. Really saying WindowHandler is 0! BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The edit page identifier if (!ok) return TRUE; // page not present //InitControls(); UpdateUnitListControls(); } return TRUE; }

BOOL UnitsTab::CommitSection (   )  [virtual]

Takes the values in the Units section tab of the options dialog box and sets the associated preference values accordingly Called when ok is pressed on the dialog box. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: True if values in dialog box ok, False otherwise. Errors: - See also: - Implements OptionsTabs. Definition at line 301 of file optsunit.cpp. { TRACEUSER( "Neville", _T("commit units section\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::CommitSection called with no dialog pointer"); BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The units page identifier if (!ok) return TRUE; // Talk to page failed to return now // Section = Units // All units work off the selected document and so we must do nothing if there is no // selected document. Check our clas variable to see if this is true or not. // Units should have been set up by the caller. if (pDocument == NULL || pSpread == NULL) { // If this fails then there is no document and so we must ensure // things which need a selected document are greyed. GreySection(); return TRUE; } ok = CommitDialogValues(); return ok; }

BOOL UnitsTab::CreateNewUnit (   )  [protected]

Creates a new user unit that the user has just requested. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 700 of file optsunit.cpp. { ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::CreateNewUnit called with no doc unit list"); Unit* pUnit = NULL; BOOL ok; ok = pDocUnitList->MakeNewUnit(&pUnit); if (ok) { CurrentUserUnitType = pUnit->GetUnitType(); // Fire up the user units name dialog box, but only if we have // a current user unit to edit. BOOL Ok = TRUE; if (CurrentUserUnitType != NOTYPE) { // This is ok as we are using a modal dialog box Ok = UnitPropertiesDlg::InvokeDialog(CurrentUserUnitType); if (!Ok) DeleteUnit(); } // Only do the rest of this if the user named the unit ok if (Ok) { EnableControls(); SetUnitToken(_R(IDC_OPTS_PAGEUNITS), CurrentUserUnitType, 0,TRUE); //SetUnitToken(_R(IDC_OPTS_SCALEDUNITS),CurrentUserUnitType,NULL,TRUE); SetUnitToken(_R(IDC_OPTS_FONTUNITS), CurrentUserUnitType, 0,TRUE); InitControls(); // Now make sure the current user unit is selected in the list SelectCurrentUserUnit(); // Mark the document as modified as we have changed something // that is saved with the document. if (pDocument) pDocument->SetModified(TRUE); } } else { // Failed to create the new unit, usually due to no memory. // So report this to the user. Error set by new on failure. InformError(); } return TRUE; }

BOOL UnitsTab::DeleteUnit (   )  [protected]

Deletes the currently selected user unit. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 765 of file optsunit.cpp. { ERROR2IF(pDocument == NULL,FALSE,"UnitsTab::DeleteUnit called with no document"); ERROR2IF(pSpread == NULL,FALSE,"UnitsTab::DeleteUnit called with no document"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::DeleteUnit called with no doc unit list"); Unit* pNextUserUnit = NULL; Unit* pCurUserUnit = NULL; pCurUserUnit = pDocUnitList->FindUnit(CurrentUserUnitType); pNextUserUnit = pDocUnitList->FindNextUserUnit(pCurUserUnit); if (pNextUserUnit == NULL) { pNextUserUnit = pDocUnitList->FindFirstUserUnit(); if (pNextUserUnit->GetUnitType() == CurrentUserUnitType) pNextUserUnit = NULL; } UnitReason DeleteReason = UNITREASON_OK; // Before we try and delete the unit we must check if it is being used // by the default grid or by the scaling strings. If so then we should not // allow the operation to continue. // First check the grid NodeGrid* pDefaultGrid = pSpread->FindFirstDefaultGridInSpread(); if (pDefaultGrid) { // Default grid present so ensure not using these units // Specify True so that we get the scaled units. Otherwise, // if scaling is set then the user is warned but cannot see the // units in the grid tab! UnitType GridUnits = pDefaultGrid->GetUnits(TRUE); if (CurrentUserUnitType == GridUnits) DeleteReason = UNITREASON_BEINGUSED; } // Now the document scaling, returns page units if not active // If present in inactive strings then user will be warned when they // try and activate this scale. DimScale* pDimScale = pSpread->GetPtrDimScale(); if (pDimScale) { UnitType ScaleUnits = pDimScale->GetScaleUnits(); if (CurrentUserUnitType == ScaleUnits) DeleteReason = UNITREASON_BEINGUSED; else { // If scale string ok then check the drawing string, if the scale is // active BOOL Active = pDimScale->IsActive(); if (Active) { String_32 Str; BOOL ok = TRUE; double dummy = 0.0; Str = pDimScale->GetDrawingScaleStr(); ok = Convert::StringToComponents(Str, &dummy, &ScaleUnits); if (ok && CurrentUserUnitType == ScaleUnits) DeleteReason = UNITREASON_BEINGUSED; } } } // Try and delete the unit from the doc unit list, will complain if the // unit has decendents i.e. units based on it or it is being used for // the default page, font or scaling units. // Only do it if we haven't found above reason not to delete it if (DeleteReason == UNITREASON_OK) DeleteReason = pDocUnitList->DeleteUnit(CurrentUserUnitType); switch (DeleteReason) { case UNITREASON_OK : if (pNextUserUnit == NULL) CurrentUserUnitType = NOTYPE; else CurrentUserUnitType = pNextUserUnit->GetUnitType(); EnableControls(); InitControls(); // Now make sure the current user unit is selected in the list SelectCurrentUserUnit(); // Mark the document as modified as we have changed something // that is saved with the document. if (pDocument) pDocument->SetModified(TRUE); break; case UNITREASON_HASDESCENDENTS: Error::SetError(_R(IDS_UNITERROR_HASDESCENDENTS),0); InformError(); break; case UNITREASON_BEINGUSED: Error::SetError(_R(IDS_UNITERROR_BEINGUSED),0); InformError(); break; default : ENSURE(FALSE,"Unexpected DeleteUnit reason"); break; } return TRUE; }

BOOL UnitsTab::EnableControls (   )  [protected]

Enables or disables the controls depending on the current context, i.e. the controls are disabled if there is no selection, etc. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 1273 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UnitsTab::EnableControls\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::EnableControls called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::EnableControls called with no doc unit list pointer"); BOOL enable = (pDocUnitList->FindFirstUserUnit() != NULL); pPrefsDlg->EnableGadget(_R(IDC_OPTS_DELETEUNIT), enable); pPrefsDlg->EnableGadget(_R(IDC_OPTS_UNITPROPERTY), enable); return TRUE; }

ScaleUnit * UnitsTab::GetColourUnitPreference (   )  [static]

Retrieves the user's Colour Unit preference to be used by the Colour Editor If no preference is found StandardUnit::UnitPercent is the default Scope: static. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 26/06/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the preferred colour unit NULL if an error occurred Definition at line 1187 of file optsunit.cpp. { String_32 DefaultUnitString; Camelot.GetPrefDirect(ColourUnitSection, ColourUnitPreference, &DefaultUnitString); ScaleUnit* pColourUnit = StandardUnit::PercentGroup.FindUnitFromQualifier(DefaultUnitString); if (pColourUnit == NULL) // no default has been set pColourUnit = &StandardUnit::UnitPercent; if (!pColourUnit->IS_KIND_OF(ScaleUnit)) { ERROR3("m_pOldColourUnit is not"); return NULL; } return pColourUnit; }

CDlgResID UnitsTab::GetPageID (   )  [virtual]

Allows the options dialog code to determine the dialog ID of this section. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The dialog ID of this tab section. Errors: - See also: - Implements OptionsTabs. Definition at line 236 of file optsunit.cpp. { return _R(IDD_OPTSTAB_UNITS); }

BOOL UnitsTab::GreySection (   )  [virtual]

Called when the user has closed all documents. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/2/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: UnitsTab::UngreySection; Reimplemented from OptionsTabs. Definition at line 343 of file optsunit.cpp. { TRACEUSER( "Neville", _T("GreySection in UnitsTab section\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::GreySection called with no dialog pointer"); BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The UnitsTab identifier if (!ok) return TRUE; // Talk to page failed to return now // Make sure the information field displaying the name of the current document // is correct. String_256 DocumentName(_R(IDT_OPTS_UNITS_INFO)); DocumentName += *GetDocumentName(); pPrefsDlg->SetStringGadgetValue(_R(IDC_OPTS_INFO), DocumentName); // Only update if we are not already grey if (GreyStatus == TRUE) return TRUE; m_ColourUnitRadioGroup.Disable(); // Call our central greying/ungreying function ok = ChangeControlStatus(FALSE); GreyStatus = TRUE; return ok; }

BOOL UnitsTab::HandleMsg (  DialogMsg *  Msg  )  [virtual]

Handles all the units options tabs messages. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Implements OptionsTabs. Definition at line 498 of file optsunit.cpp. { TRACEUSER( "Neville", _T("HandleUnitsMsg\n")); ERROR2IF(Msg == NULL,FALSE,"UnitsTab::Message null message received"); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::HandleMsg called with no dialog pointer"); BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The edit page identifier if (!ok) return TRUE; // page not present switch(Msg->DlgMsg) { case DIM_CREATE: // Initialise controls GreyStatus = FALSE; // we are ungreyed by default ok = InitSection(); if (!ok) InformError(); break; case DIM_LFT_BN_CLICKED: OptionsTabs::SetApplyNowState(TRUE); if (Msg->GadgetID == _R(IDC_OPTS_UNITPROPERTY)) // Show the user the properties of the selected user unit ShowUnitProperties(); else if (Msg->GadgetID == _R(IDC_OPTS_NEWUNIT)) // Create the user a new unit CreateNewUnit(); else if (Msg->GadgetID == _R(IDC_OPTS_DELETEUNIT)) // Delete the currently selected user unit DeleteUnit(); break; case DIM_SELECTION_CHANGED: { OptionsTabs::SetApplyNowState(TRUE); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::HandleMsg called with no doc unit list"); WORD Index = 0; Unit* pUnit = NULL; // Unit* pCurUserUnit = NULL; if (Msg->GadgetID == _R(IDC_OPTS_UNITSLIST)) { // Clicked on the list of user unit types // Now, switch to the new item pPrefsDlg->GetValueIndex(_R(IDC_OPTS_UNITSLIST), &Index); pUnit = pDocUnitList->FindUserUnit(Index); if (pUnit != NULL) { CurrentUserUnitType = pUnit->GetUnitType(); } } } default: break; } return TRUE; }

BOOL UnitsTab::Init (  void   )  [virtual]

UnitsTab initialisation routine. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: True if initialised ok, False if failed. Errors: - See also: - Reimplemented from OptionsTabs. Definition at line 209 of file optsunit.cpp. { CurrentUserUnitType = NOTYPE; pDocUnitList = NULL; // Initialise the dialog box that we require to create new and edit user units BOOL ok = UnitPropertiesDlg::Init(); return ok; }

BOOL UnitsTab::InitControls (  void   )  [protected]

Inits all the controls in the dialog Called immediately after the bar is created to init drop lists, grey out gadgets, etc. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 1126 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UnitsTab::InitControls\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::InitControls called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::InitControls called with no doc unit list pointer"); InitUnitListControls(); // Get the current default settings UnitType PageUnits = pDocUnitList->GetPageUnits(); // The units used to display page measurements //UnitType ScaledUnits = pDocUnitList->GetScaleUnits(); // The units to display scaled measurements UnitType FontUnits = pDocUnitList->GetFontUnits(); // The units to display font measurements // Work out the indicies which these units correspond to on a list of units INT32 PageUnitsIndex = pDocUnitList->FindUnitIndex(PageUnits); INT32 FontUnitsIndex = pDocUnitList->FindUnitIndex(FontUnits); // And now select the correct item on the list of units pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_PAGEUNITS), PageUnitsIndex); pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_FONTUNITS), FontUnitsIndex); // // Remember to add in the automatic units to the index calculation // if (ScaledUnits != AUTOMATIC) // { // // Not Automatic so work out the index which this item corresponds to on the unit list // INT32 ScaleUnitsIndex = pDocUnitList->FindUnitIndex(ScaledUnits); // pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_SCALEDUNITS), ScaleUnitsIndex + 1); // } // else // pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_SCALEDUNITS), 0); // Note entry state of controls //OldScaledUnits = ScaledUnits; OldPageUnits = PageUnits; OldFontUnits = FontUnits; m_pOldColourUnit = GetColourUnitPreference(); if (m_pOldColourUnit == NULL) return FALSE; m_ColourUnitRadioGroup.SetDefault(m_pOldColourUnit); EnableControls(); return TRUE; }

BOOL UnitsTab::InitSection (   )  [virtual]

Sets initial values for the Units section of the options dialog box. This section includes the:-. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 6/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, else FALSE Errors: - See also: - Implements OptionsTabs. Definition at line 1305 of file optsunit.cpp. { TRACEUSER( "Neville", _T("InitUnitsSection\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::InitSection called with no dialog pointer"); // Make sure the information field displaying the name of the current document // is correct. String_256 DocumentName(_R(IDT_OPTS_UNITS_INFO)); DocumentName += *GetDocumentName(); pPrefsDlg->SetStringGadgetValue(_R(IDC_OPTS_INFO), DocumentName); m_ColourUnitRadioGroup.SetAssociations((DialogOp*)pPrefsDlg, ColourUnitAssociations, NUM_CLR_DEFAULTS); // If no current document then do nothing as this may be valid // Use the document specified in the base class (OptionsTabs) if (pDocument != NULL) { // This uses current doc instead of selected doc //pDocUnitList = DocUnitList::GetCurrentDocUnitList(); pDocUnitList = pDocument->GetDocUnitList(); ERROR3IF(pDocUnitList == NULL,"Where's the current doc unit list eh?"); if (pDocUnitList != NULL) { // Find out if we have any user defined units in this document Unit* pUserUnit = pDocUnitList->FindFirstUserUnit(); if (pUserUnit != NULL) CurrentUserUnitType = pUserUnit->GetUnitType(); else CurrentUserUnitType = NOTYPE; } else { // Could not create and hence find any units pDocUnitList = NULL; // reset the unit list to null just in case // Ensure our section is greyed. GreySection(); return FALSE; // Could not initialise ok so fail } // Section = Units InitControls(); SelectCurrentUserUnit(); //ShowUnitDetails(); } else { // Ensure our section is greyed. GreySection(); } return TRUE; }

BOOL UnitsTab::InitUnitListControls (   )  [protected]

Fills in all the drop lists and combo boxes of units with the ones in the document. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 1218 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UnitsTab::InitControls()\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::InitUnitListControls called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::InitUnitListControls called with no doc unit list pointer"); INT32 i; Unit* pUnit = NULL; // Make sure all the lists are blank pPrefsDlg->DeleteAllValues(_R(IDC_OPTS_PAGEUNITS)); //pPrefsDlg->DeleteAllValues(_R(IDC_OPTS_SCALEDUNITS)); pPrefsDlg->DeleteAllValues(_R(IDC_OPTS_FONTUNITS)); pPrefsDlg->DeleteAllValues(_R(IDC_OPTS_UNITSLIST)); //SetUnitToken(_R(IDC_OPTS_SCALEDUNITS),AUTOMATIC,0); UnitType ThisUnitType = NOTYPE; for (i = 0; i < pDocUnitList->GetNumUnits(); i++) { pUnit = pDocUnitList->FindUnit(i); ThisUnitType = pUnit->GetUnitType(); SetUnitToken(_R(IDC_OPTS_PAGEUNITS), ThisUnitType , i); //SetUnitToken(_R(IDC_OPTS_SCALEDUNITS), ThisUnitType, i+1); SetUnitToken(_R(IDC_OPTS_FONTUNITS), ThisUnitType, i); } // Update the list of user unit details pUnit = pDocUnitList->FindFirstUserUnit(); for (i = 0; pUnit != NULL; i++) { ShowUnitDetails(_R(IDC_OPTS_UNITSLIST),pUnit->GetUnitType(), i); pUnit = pDocUnitList->FindNextUserUnit(pUnit); } return TRUE; }

BOOL UnitsTab::IsDocumentOption (   )  [virtual]

Allows the document options dialog code to determine if this tab belongs to the group of document options. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Returns True if this tab is a document option. Errors: - See also: IsProgramOption(); Implements OptionsTabs. Definition at line 257 of file optsunit.cpp. { return TRUE; // This tab is a document option }

BOOL UnitsTab::IsProgramOption (   )  [virtual]

Allows the program options dialog code to determine if this tab belongs to the group of program options. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Returns True if this tab is a program option. Errors: - See also: IsProgramOption(); Implements OptionsTabs. Definition at line 278 of file optsunit.cpp. { return TRUE; // This tab is a program option }

BOOL UnitsTab::SelectCurrentUserUnit (   )  [protected]

Make sure that the current user unit, if any, is selected and hence shown as selected in the user units list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 941 of file optsunit.cpp. { ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::CommitUserDialogValues called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::CommitUserDialogValues called with no doc unit list pointer"); // Check if the user has selected a valid user unit to edit // If not do nothing if (CurrentUserUnitType != NOTYPE) { INT32 UnitIndex = pDocUnitList->FindUnitIndex(CurrentUserUnitType); Unit * pUnit = pDocUnitList->FindFirstUserUnit(); if (pUnit) { UnitType FirstUserUnitType = pUnit->GetUnitType(); INT32 UserUnitIndex = pDocUnitList->FindUnitIndex(FirstUserUnitType); INT32 Index = UnitIndex - UserUnitIndex; pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_UNITSLIST), Index); } } return TRUE; }

void UnitsTab::SetUnitToken (  CGadgetID  ID, UnitType  ThisUnitType, INT32  Index = -1, BOOL  EndOfList = FALSE )  [protected]

Readable function for putting unit token strings in controls. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/94 Parameters: ID  = the ID of the control to put the unit token in [INPUTS] ThisUnitType = the type of the unit whose token you want putting in the control Index = index into a drop list (-1 = main field) EndOfList - if TRUE, item is stuck on end of list, regardless of Index -  [OUTPUTS] Returns: - See also: - Definition at line 1042 of file optsunit.cpp. { String_32 Str = pDocUnitList->GetToken(ThisUnitType); String_256 Str256 = Str; pPrefsDlg->SetStringGadgetValue(ID, Str256, EndOfList, Index); }

void UnitsTab::ShowUnitDetails (  CGadgetID  ID, UnitType  ThisUnitType, INT32  Index = -1, BOOL  EndOfList = FALSE )  [protected]

Shows the summary of the details of the specified unit for putting user unit token strings in the scrollable details list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/95 Parameters: ID  = the ID of the control to put the unit token in [INPUTS] ThisUnitType = the type of the unit whose token you want putting in the control Index = index into a drop list (-1 = main field) EndOfList - if TRUE, item is stuck on end of list, regardless of Index -  [OUTPUTS] Returns: - See also: - Definition at line 1068 of file optsunit.cpp. { String_256 Details; String_32 Name = pDocUnitList->GetToken(ThisUnitType); // Add the abbreviation String_32 Abbrev = pDocUnitList->GetSpecifier(ThisUnitType); Unit* pCurUserUnit = NULL; pCurUserUnit = pDocUnitList->FindUnit(ThisUnitType); String_32 PrefixStr; double BaseNumerator = 0.0; double BaseDenominator = 0.0; String_32 Numerator; String_32 Denominator; String_32 BasedOn; if (pCurUserUnit) { // Set up the prefix/suffix state for this user's unit. if (pCurUserUnit->IsPrefix()) PrefixStr.MakeMsg(_R(IDS_UNITS_PREFIX)); else PrefixStr.MakeMsg(_R(IDS_UNITS_SUFFIX)); BaseNumerator = pCurUserUnit->GetBaseNumerator(); BaseDenominator = pCurUserUnit->GetBaseDenominator(); Convert::DoubleToString(BaseNumerator, &Numerator); Convert::DoubleToString(BaseDenominator, &Denominator); UnitType BaseUnit = pCurUserUnit->GetBaseUnitType(); BasedOn = pDocUnitList->GetSpecifier(BaseUnit); } Details.MakeMsg(_R(IDS_UNITSDESCRIPTION), (TCHAR*)Name, (TCHAR*)Abbrev, (TCHAR*)PrefixStr, (TCHAR*)Denominator, (TCHAR*)Numerator, (TCHAR*)BasedOn); pPrefsDlg->SetStringGadgetValue(ID, Details, EndOfList, Index); }

BOOL UnitsTab::ShowUnitProperties (   )  [protected]

Shows the current properties of the selected user unit. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 886 of file optsunit.cpp. { ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::ShowUnitProperties called with no doc unit list"); // Fire up the user units property dialog box, but only if we have // a current user unit to edit. BOOL Ok = TRUE; if (CurrentUserUnitType != NOTYPE) { // This is ok as we are using a modal dialog box Ok = UnitPropertiesDlg::InvokeDialog(CurrentUserUnitType); // If Oked then make sure everything is updated to reflect this potential new info if (Ok) { // Make sure that the selected user units list item is updated with the new info. if (CurrentUserUnitType != NOTYPE) { INT32 UnitIndex = pDocUnitList->FindUnitIndex(CurrentUserUnitType); Unit * pUnit = pDocUnitList->FindFirstUserUnit(); if (pUnit) { UnitType FirstUserUnitType = pUnit->GetUnitType(); INT32 UserUnitIndex = pDocUnitList->FindUnitIndex(FirstUserUnitType); INT32 Index = UnitIndex - UserUnitIndex; pPrefsDlg->DeleteValue(_R(IDC_OPTS_UNITSLIST), FALSE, Index); ShowUnitDetails(_R(IDC_OPTS_UNITSLIST), CurrentUserUnitType, Index, FALSE); pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_UNITSLIST), Index); } } // Make sure the controls displaying user units are updated with this change. UpdateUnitListControls(); } } return TRUE; }

BOOL UnitsTab::UngreySection (   )  [virtual]

Called when the user has selected a new document. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/2/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: UnitsTab::UngreySection; Reimplemented from OptionsTabs. Definition at line 386 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UngreySection in UnitsTab section\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::UngreySection called with no dialog pointer"); BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The UnitsTab identifier if (!ok) return TRUE; // Talk to page failed to return now // Make sure the information field displaying the name of the current document // is correct. String_256 DocumentName(_R(IDT_OPTS_UNITS_INFO)); DocumentName += *GetDocumentName(); pPrefsDlg->SetStringGadgetValue(_R(IDC_OPTS_INFO), DocumentName); // Only update if we are not already ungrey if (GreyStatus == FALSE) return TRUE; m_ColourUnitRadioGroup.Enable(); // Call our central greying/ungreying function ok = ChangeControlStatus(TRUE); GreyStatus = FALSE; return ok; }

BOOL UnitsTab::UpdateSection (  String_256 *  DocumentName  )  [virtual]

Called when we have switched to a new document and need to update all the controls on this tab. Should only init the tab if the page is present. The document name allows the info field on the tab to be filled in correctly. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/2/95 Parameters: Name  of document [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: UnitsTab::GreySection; UnitsTab::UngreySection; UnitsTab::InitSection; Reimplemented from OptionsTabs. Definition at line 470 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UnitsTab::UpdateSection\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::UpdateSection called with no dialog pointer"); BOOL ok = pPrefsDlg->TalkToPage(_R(IDD_OPTSTAB_UNITS)); // The UnitsTab identifier if (!ok) return TRUE; // page not present // Call the normal init section code return InitSection(); }

BOOL UnitsTab::UpdateUnitListControls (   )  [protected]

Updates the new name name of the currently selected user unit, if any in all of the lists. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 8/9/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: UnitPropertiesDlg::DisplayUserUnitDetails; UnitsTab::ShowUnitDetails; Definition at line 979 of file optsunit.cpp. { TRACEUSER( "Neville", _T("UnitsTab::UpdateUnitListControls()\n")); ERROR2IF(pPrefsDlg == NULL,FALSE,"UnitsTab::UpdateUnitListControls called with no dialog pointer"); ERROR2IF(pDocUnitList == NULL,FALSE,"UnitsTab::UpdateUnitListControls called with no doc unit list pointer"); // Make sure that we have the text for the current unit up to date String_256 TokenStr = _T(""); String_32 TokenStr_32 = _T(""); Unit* pCurUserUnit = NULL; pCurUserUnit = pDocUnitList->FindUnit(CurrentUserUnitType); if (pCurUserUnit != NULL) { // Get the current name for this unit TokenStr = pCurUserUnit->GetToken(); //TokenStr = TokenStr_32; // Now update the name in the lists INT32 UnitIndex = pDocUnitList->FindUnitIndex(CurrentUserUnitType); // Have to delete them and then reinsert them back into the list // These lists have all units on pPrefsDlg->DeleteValue(_R(IDC_OPTS_PAGEUNITS), FALSE, UnitIndex); pPrefsDlg->DeleteValue(_R(IDC_OPTS_FONTUNITS), FALSE, UnitIndex); pPrefsDlg->SetStringGadgetValue(_R(IDC_OPTS_PAGEUNITS), TokenStr, FALSE, UnitIndex); pPrefsDlg->SetStringGadgetValue(_R(IDC_OPTS_FONTUNITS), TokenStr, FALSE, UnitIndex); // Must set the selected item as otherwise it will blank the main list item. // Work out the indicies which these units correspond to on a list of units // Get the current default settings UnitType PageUnits = pDocUnitList->GetPageUnits(); UnitType FontUnits = pDocUnitList->GetFontUnits(); INT32 PageUnitsIndex = pDocUnitList->FindUnitIndex(PageUnits); INT32 FontUnitsIndex = pDocUnitList->FindUnitIndex(FontUnits); // And now select the correct item on the list of units pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_PAGEUNITS), PageUnitsIndex); pPrefsDlg->SetSelectedValueIndex(_R(IDC_OPTS_FONTUNITS), FontUnitsIndex); } return TRUE; }

---

Member Data Documentation

UnitType UnitsTab::CurrentUserUnitType [private]

Definition at line 189 of file optsunit.h.

BOOL UnitsTab::GreyStatus [private]

Definition at line 191 of file optsunit.h.

RadioGroup UnitsTab::m_ColourUnitRadioGroup [protected]

Definition at line 185 of file optsunit.h.

ScaleUnit* UnitsTab::m_pOldColourUnit [protected]

Definition at line 183 of file optsunit.h.

UnitType UnitsTab::OldFontUnits [private]

Definition at line 196 of file optsunit.h.

UnitType UnitsTab::OldPageUnits [private]

Definition at line 194 of file optsunit.h.

DocUnitList* UnitsTab::pDocUnitList [private]

Definition at line 188 of file optsunit.h.

---

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

• Kernel/optsunit.h (r1785/r1282)
• Kernel/optsunit.cpp (r1785/r1282)

---