LayerDlg Class Reference

The Layer dialog allows a user to. More...

#include <layerdlg.h>

Inheritance diagram for LayerDlg:

List of all members.

Public Member Functions
	LayerDlg ()
	LayerDlg constructor. Creates a non-undoable operation.
void	Do (OpDescriptor *)
	Creates then opens the dialog.
BOOL	Create ()
	LayerDlg create method.
virtual MsgResult	Message (Msg *Message)
	Handles all the Layer dialog's messages.
Static Public Member Functions
static BOOL	Init ()
	LayerDlg Init method.
static OpState	GetState (String_256 *, OpDescriptor *)
	LayerDlg GetState method.
Static Public Attributes
static const INT32	IDD = _R(IDD_LAYERDLG)
static const CDlgMode	Mode = MODELESS
Private Member Functions
BOOL	InitDialog ()
	Sets initial dialog values.
void	ShowLayerDetails ()
	Shows Layer info for the selected Layer.
void	ChangeAttribute (CGadgetID Gadget)
	Handles a request to change an attribute of the layer Scope: private.
void	DeleteSelectedLayer ()
	Deletes the selected Layer.
BOOL	CreateNewLayer ()
	Creates a new layer, adding it to the end of the layer details list. If a new layer could not be allocated then InformError is called then FALSE returned.
void	UpdateLayerID ()
	Updates the identifier Scope: private.
void	SetSelectedLayer (WORD Index)
	Sets the Indexth layer in the list to be the selected layer.
void	SetSelectedLayerActive ()
	Sets the selected layer to be the active layer.
BOOL	ValidValues ()
	To validate the values that the user has input. If the values are not valid then InformError is called to inform the user of the error.
Private Attributes
LyrDetails *	SelectedLyr
WORD	SelectedLyrIndex
WORD	NumLayers

---

Detailed Description

The Layer dialog allows a user to.

Author:

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

Date:

13/12/93

View all layers for a spread Change the relative z-order of the layers Create a new layer Delete a layer Set various layer attributes

See also:

LayerManager

Definition at line 129 of file layerdlg.h.

---

Constructor & Destructor Documentation

LayerDlg::LayerDlg (   )

LayerDlg constructor. Creates a non-undoable operation. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 140 of file layerdlg.cpp. : DialogOp(LayerDlg::IDD, LayerDlg::Mode) { }

---

Member Function Documentation

void LayerDlg::ChangeAttribute (  CGadgetID  Gadget  )  [private]

Handles a request to change an attribute of the layer Scope: private. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 11/1/94 Parameters: Gadget,:  Gadget ID for the attribute [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 480 of file layerdlg.cpp. { switch (Gadget) { case _R(IDC_VISIBLE): //SelectedLyr->Status.Flags.Visible = !(SelectedLyr->Status.Flags.Visible); break; case _R(IDC_LOCKED): //SelectedLyr->Status.Flags.Locked = !(SelectedLyr->Status.Flags.Locked); break; case _R(IDC_ACTIVE): SetSelectedLayerActive(); break; case _R(IDC_GLOBAL): // Don't know if we are to implement global or not //SelectedLyr->Status.Flags.Global = !(SelectedLyr->Status.Flags.Global); break; case _R(IDC_PRINTABLE): //SelectedLyr->Status.Flags.Printable = !(SelectedLyr->Status.Flags.Printable); break; case _R(IDC_BACKGROUND): //SelectedLyr->Status.Flags.Background = !(SelectedLyr->Status.Flags.Background); break; } }

BOOL LayerDlg::Create (  void   )  [virtual]

LayerDlg create method. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, else FALSE Errors: - See also: - Reimplemented from DialogOp. Definition at line 674 of file layerdlg.cpp. { ENSURE(FALSE,"The old layer dlg is now defunct!"); return (FALSE); if (DialogOp::Create()) { // Set the initial control values InitDialog(); return TRUE; } else { return FALSE; } }

BOOL LayerDlg::CreateNewLayer (   )  [private]

Creates a new layer, adding it to the end of the layer details list. If a new layer could not be allocated then InformError is called then FALSE returned. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, else FALSE Errors: - Scope: private See also: - Definition at line 375 of file layerdlg.cpp. { LyrDetails* LayerDet; LayerDet = new LyrDetails(); if (LayerDet == NULL) { // Inform the error to the user. The error message is set by new InformError(); return FALSE; } // Initialise default layer values LayerDet->Layer = NULL; // Because the layer node has not yet been created ! LayerDet->New = TRUE; // A new layer LayerDet->Deleted = FALSE; // Default attribute values //LayerDet->Status.Flags.Visible = TRUE; //LayerDet->Status.Flags.Locked = FALSE; //LayerDet->Status.Flags.Active = FALSE; //LayerDet->Status.Flags.Printable = TRUE; //LayerDet->Status.Flags.Background = FALSE; //LayerDet->Status.StringLayerID = Document::GetCurrent()->GetLayerMgr().CreateUniqueLayerID(); //LayerDet->Status.LayerQualityLevel = 11; // Add the new layer details record to the tail of the layer details list //(Document::GetCurrent()->GetLayerMgr()).LyrDetList.AddTail(LayerDet); NumLayers++; SelectedLyr = LayerDet; // Make the new layer the selected layer SelectedLyrIndex = NumLayers-1; // Update the layer list gadget // Add layerID to end of list box SetStringGadgetValue(_R(IDC_LAYER_LIST),&(SelectedLyr->Status.StringLayerID)); SetSelectedValueIndex(_R(IDC_LAYER_LIST), SelectedLyrIndex); // Select the new layer ShowLayerDetails(); return TRUE; }

void LayerDlg::DeleteSelectedLayer (   )  [private]

Deletes the selected Layer. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 12/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 281 of file layerdlg.cpp. { ENSURE(NumLayers > 1, "It is illegal delete the final Layer on a spread"); // Delete the selected Layer from the Layer list DeleteValue(_R(IDC_LAYER_LIST), FALSE, SelectedLyrIndex); // Flag the Layer as having been deleted SelectedLyr->Deleted = TRUE; // If there is a Layer with a z-order one greater than this Layer, then this becomes the // selected Layer. Else the Layer with a z-order one less becomes the selected Layer. if ( (SelectedLyrIndex+1) != NumLayers ) { // There is a Layer with a z-order one greater so select this do { ENSURE(SelectedLyr != NULL, "Selected Layer is NULL"); //SelectedLyr = (LyrDetails*)((Document::GetCurrent()->GetLayerMgr()).LyrDetList.GetNext(SelectedLyr)); } while ( ((LyrDetails*)SelectedLyr)->Deleted ); // Note there is no need to change the SelectedLyrIndex } else { // Select the Layer which has a z-order one less do { ENSURE(SelectedLyr != NULL, "Selected Layer is NULL"); //SelectedLyr = (LyrDetails*)((Document::GetCurrent()->GetLayerMgr()).LyrDetList.GetPrev(SelectedLyr)); } while ( ((LyrDetails*)SelectedLyr)->Deleted ); SelectedLyrIndex--; } ENSURE(SelectedLyr != NULL, "Selected Layer does not exist"); SetSelectedValueIndex(_R(IDC_LAYER_LIST), SelectedLyrIndex); // Select the active Layer NumLayers--; ShowLayerDetails(); }

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

Creates then opens the dialog. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from Operation. Definition at line 708 of file layerdlg.cpp. { ENSURE(FALSE,"The old layer dlg is now defunct!"); return; if (Create()) { Open(); } else // Could not create { InformError(); End(); // End the operation } }

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

LayerDlg GetState method. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 618 of file layerdlg.cpp. { OpState OpSt; return(OpSt); }

BOOL LayerDlg::Init (  void   )  [static]

LayerDlg Init method. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from SimpleCCObject. Definition at line 641 of file layerdlg.cpp. { return (TRUE); /* return (RegisterOpDescriptor( 0, _R(IDS_LAYERDLG), CC_RUNTIME_CLASS(LayerDlg), OPTOKEN_LAYERDLG, LayerDlg::GetState, 0, // help ID _R(IDBBL_LAYERDLG), 0 // bitmap ID )); */ }

BOOL LayerDlg::InitDialog (   )  [private]

Sets initial dialog values. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 740 of file layerdlg.cpp. { /* // Make the OK button dual function // DualFunctionButton(IDOK); // Common controls have currently been disabled //SetGadgetRange(_R(IDC_QUALITY), 1, 11); // Make the Layer list box dragable so that users can change the Z order of the Layers //MakeListBoxDragable(_R(IDC_Lyr_LIST)); GadgetRedraw(_R(IDC_LAYER_LIST),FALSE); // Turn off drawing until we have finished making changes // to the gadget. // Traverse the Layer Manager's LyrDetList and add all Layer identifiers to the list gadget List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLyrDet = LyrList->GetHead(); ENSURE(CurLyrDet != NULL, "The LyrDetList is empty"); WORD i =0; NumLayers = 0; while (CurLyrDet != NULL) { // Add string to end of list box SetStringGadgetValue(_R(IDC_LAYER_LIST),&(((LyrDetails*)CurLyrDet)->Status.StringLayerID)); // If the current Layer is active then make it the selected item if (((LyrDetails*)CurLyrDet)->Status.Flags.Active) { SelectedLyr = (LyrDetails*)CurLyrDet; // Set the selected Layer SelectedLyrIndex = i; } CurLyrDet = LyrList->GetNext(CurLyrDet); i++; NumLayers++; } GadgetRedraw(_R(IDC_LAYER_LIST),TRUE); // Turn drawing back on SetSelectedValueIndex(_R(IDC_LAYER_LIST), SelectedLyrIndex); // Select the active Layer ShowLayerDetails(); return TRUE; */ return (FALSE); }

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

Handles all the Layer dialog's messages. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from DialogOp. Definition at line 160 of file layerdlg.cpp. { if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; BOOL EndDialog = FALSE; switch (Msg->DlgMsg) { case DIM_COMMIT: { EndDialog = ValidValues(); if (EndDialog) { // commit all changes made //(Document::GetCurrent()->GetLayerMgr()).CommitLayerChanges(); // Reflect changes in rest of interface //(Document::GetCurrent()->GetLayerMgr()).UpdateInterface(); } break; } case DIM_SOFT_COMMIT: { TRACE( _T("Rgt OK handling here\n")); break; } case DIM_CANCEL: { // Cancel all changes made to the Layers //if((Document::GetCurrent()->GetLayerMgr()).CancelLayerChanges()) //{ // EndDialog = TRUE; //} // else InformError will have been called break; } case DIM_LFT_BN_CLICKED: { switch (Msg->GadgetID) { case _R(IDC_NEW): CreateNewLayer(); break; case _R(IDC_DELETE): DeleteSelectedLayer(); break; default: ChangeAttribute(Msg->GadgetID); } break; } case DIM_SELECTION_CHANGED_COMMIT: { if (Msg->GadgetID == _R(IDC_LAYER_LIST)) { // A double click, make the Layer active // Obtain the index of the selected item GetValueIndex(_R(IDC_LAYER_LIST), &SelectedLyrIndex); SetSelectedLayer(SelectedLyrIndex); // Sets the selected Layer SetSelectedLayerActive(); // Update the dialog to show the new Layers details ShowLayerDetails(); } break; } case DIM_SELECTION_CHANGED: { if (Msg->GadgetID == _R(IDC_LAYER_LIST)) { // User clicked on new Layer // Obtain the index of the selected item GetValueIndex(_R(IDC_LAYER_LIST), &SelectedLyrIndex); SetSelectedLayer(SelectedLyrIndex); // Sets the selected Layer // Update the dialog to show the new Layers details ShowLayerDetails(); } break; } case DIM_TEXT_CHANGED: { if (Msg->GadgetID == _R(IDC_LAYER_ID)) { // User is editing the Layer identifier UpdateLayerID(); break; } } } if (EndDialog) // Dialog communication over { Close(); // Close the dialog End(); // Destroy dialog // CMainFrame::pInfoBar->EnableLayerControl(); // Enable the infobar's Layer control } // return (DLG_EAT_IF_HUNGRY(Msg)); } // return OK; // Pass everything on to the base class . . . return DialogOp::Message(Message); }

void LayerDlg::SetSelectedLayer (  WORD  Index  )  [private]

Sets the Indexth layer in the list to be the selected layer. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 12/1/94 Parameters: Index,:  List index of new selected layer [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 434 of file layerdlg.cpp. { /* // Find the Indexth layer // Traverse the Layer Manager's LyrDetList and add all layer identifiers to the list gadget List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLayerDet = LyrList->GetHead(); ENSURE(CurLayerDet != NULL, "The LyrDetList is empty"); WORD i =0; while (CurLayerDet != NULL) { if (! (((LyrDetails*)CurLayerDet)->Deleted) ) // The layer has not been deleted { if (i == Index) { // Found SelectedLyr = (LyrDetails*)CurLayerDet; return; } i++; } CurLayerDet = LyrList->GetNext(CurLayerDet); } ENSURE(FALSE, "Could not find layer to select"); */ }

void LayerDlg::SetSelectedLayerActive (   )  [private]

Sets the selected layer to be the active layer. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 24/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 524 of file layerdlg.cpp. { /* // Traverse the Layer Manager's LyrDetList and set all Active flags to FALSE List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLayerDet = LyrList->GetHead(); ENSURE(CurLayerDet != NULL, "The LyrDetList is empty"); while (CurLayerDet != NULL) { ((LyrDetails*)CurLayerDet)->Status.Flags.Active = FALSE; CurLayerDet = LyrList->GetNext(CurLayerDet); // Get next layer detail record } SelectedLyr->Status.Flags.Active = TRUE; // Disable the Active control EnableGadget(_R(IDC_ACTIVE), FALSE); // Disable the Delete button EnableGadget(_R(IDC_DELETE), FALSE); // The visible and locked controls are set to their defaults and disabled SetLongGadgetValue(_R(IDC_VISIBLE), 1); SetLongGadgetValue(_R(IDC_LOCKED), 0); EnableGadget(_R(IDC_VISIBLE), FALSE); EnableGadget(_R(IDC_LOCKED), FALSE); SelectedLyr->Status.Flags.Visible = TRUE; SelectedLyr->Status.Flags.Locked = FALSE; */ }

void LayerDlg::ShowLayerDetails (   )  [private]

Shows Layer info for the selected Layer. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 11/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 807 of file layerdlg.cpp. { ENSURE(SelectedLyr != NULL, "The Selected Layer is NULL"); //SetLongGadgetValue(_R(IDC_VISIBLE), (INT32)SelectedLyr->Status.Flags.Visible ? 1: 0); //SetLongGadgetValue(_R(IDC_LOCKED), (INT32)SelectedLyr->Status.Flags.Locked ? 1: 0); //SetLongGadgetValue(_R(IDC_ACTIVE), (INT32)SelectedLyr->Status.Flags.Active ? 1: 0); SetLongGadgetValue(_R(IDC_GLOBAL), (INT32) FALSE); // Bodge //SetLongGadgetValue(_R(IDC_PRINTABLE), (INT32)SelectedLyr->Status.Flags.Printable ? 1: 0); //SetLongGadgetValue(_R(IDC_BACKGROUND), (INT32)SelectedLyr->Status.Flags.Background ? 1: 0); // Disable the quality gadget if global quality is set SetStringGadgetValue(_R(IDC_LAYER_ID), &(SelectedLyr->Status.StringLayerID)); // Disable the active, visible, and locked gadgets if the Layer is active //EnableGadget(_R(IDC_ACTIVE), !(SelectedLyr->Status.Flags.Active)); //EnableGadget(_R(IDC_VISIBLE), !(SelectedLyr->Status.Flags.Active)); //EnableGadget(_R(IDC_LOCKED), !(SelectedLyr->Status.Flags.Active)); // Disable the delete gadget if the Layer is active or if there is only one Layer //EnableGadget(_R(IDC_DELETE), !(SelectedLyr->Status.Flags.Active || NumLayers == 1)); return; }

void LayerDlg::UpdateLayerID (   )  [private]

Updates the identifier Scope: private. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/1/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 337 of file layerdlg.cpp. { BOOL Valid; String_256 TempStr; TempStr = GetStringGadgetValue(_R(IDC_LAYER_ID), &Valid); // Only update if the string has really changed if (TempStr != SelectedLyr->Status.StringLayerID) { // Update the selected layer's details SelectedLyr->Status.StringLayerID = TempStr; ENSURE(Valid, "Error when trying to read a string value"); // Replace the list box string with the updated string GadgetRedraw(_R(IDC_LAYER_LIST),FALSE); // Turn off drawing until we have finished making changes DeleteValue(_R(IDC_LAYER_LIST), FALSE, SelectedLyrIndex); // Delete old value SetStringGadgetValue(_R(IDC_LAYER_LIST),&(SelectedLyr->Status.StringLayerID), FALSE, SelectedLyrIndex); // Reset the selection SetSelectedValueIndex(_R(IDC_LAYER_LIST), SelectedLyrIndex); // Select the active layer GadgetRedraw(_R(IDC_LAYER_LIST),TRUE); } }

BOOL LayerDlg::ValidValues (   )  [private]

To validate the values that the user has input. If the values are not valid then InformError is called to inform the user of the error. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the values entered in the dialog are valid. Scope: private Returns: Errors: - See also: - Definition at line 571 of file layerdlg.cpp. { /* // Check that the names given to the layers are unique List* LyrList = &((Document::GetCurrent()->GetLayerMgr()).LyrDetList); ListItem* CurLyrDet = LyrList->GetHead(); ListItem* CmpLyrDet; while (CurLyrDet != NULL) { CmpLyrDet = LyrList->GetHead(); while (CmpLyrDet != NULL) { if (CmpLyrDet != CurLyrDet) // We are not looking at the same details structure { if (((LyrDetails*)CurLyrDet)->Status.StringLayerID == ((LyrDetails*)CmpLyrDet)->Status.StringLayerID) { // duplicate layer names found, inform the user InformError(_R(IDS_LAYERIDS_NOT_UNIQUE)); return (FALSE); } } CmpLyrDet = LyrList->GetNext(CmpLyrDet); } CurLyrDet = LyrList->GetNext(CurLyrDet); // Get next Layer detail record } return(TRUE); */ return (TRUE); }

---

Member Data Documentation

const INT32 LayerDlg::IDD = _R(IDD_LAYERDLG) [static]

Definition at line 140 of file layerdlg.h.

const CDlgMode LayerDlg::Mode = MODELESS [static]

Definition at line 141 of file layerdlg.h.

WORD LayerDlg::NumLayers [private]

Definition at line 159 of file layerdlg.h.

LyrDetails* LayerDlg::SelectedLyr [private]

Definition at line 157 of file layerdlg.h.

WORD LayerDlg::SelectedLyrIndex [private]

Definition at line 158 of file layerdlg.h.

---

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

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

---