ColourNameDlg Class Reference

#include <sgcolour.h>

Inheritance diagram for ColourNameDlg:

List of all members.

Public Member Functions
	ColourNameDlg ()
	ColourNameDlg constructor.
void	DoWithParam (OpDescriptor *, OpParam *)
	Creates then opens the dialog.
BOOL	Create ()
	ColourNameDlg create method.
virtual MsgResult	Message (Msg *Message)
	Handles all the scale dialog's messages.
Static Public Member Functions
static BOOL	InvokeDialog (ColourList *Parentlist, IndexedColour *ColourToName)
	Opens the gallery name dialogue on screen, elicits a response, and returns having set the new name. This is a MODAL dlg.
static BOOL	InvokeDialog (String_64 *NameToFill, IndexedColour *DisplayColour=NULL)
	Opens the gallery name dialogue on screen, elicits a response, and returns having set the new name. This is a MODAL Dlg.
static OpState	GetState (String_256 *, OpDescriptor *)
	ColourNameDlg GetState method.
static BOOL	Init ()
	ColourNameDlg Init method. Called by sginit.cpp.
Static Public Attributes
static const INT32	IDD = _R(IDD_COLOURNAMEDLG)
static const CDlgMode	Mode = MODAL
Protected Member Functions
void	CommitName (void)
	Commits to the current setting for the new name Reads the name into the supplied destination, sets the return value to TRUE and closes and ends the Dlg Op.
Protected Attributes
ColourNameParam *	Info

---

Detailed Description

Definition at line 682 of file sgcolour.h.

---

Constructor & Destructor Documentation

ColourNameDlg::ColourNameDlg (   )

ColourNameDlg constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Definition at line 4911 of file sgcolour.cpp. : DialogOp(ColourNameDlg::IDD, ColourNameDlg::Mode) { }

---

Member Function Documentation

void ColourNameDlg::CommitName (  void   )  [protected]

Commits to the current setting for the new name Reads the name into the supplied destination, sets the return value to TRUE and closes and ends the Dlg Op. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 2/4/95 Notes: If the result is placed into TheColour, then a ColourChangingMsg broadcast will be sent. Thus, if a caller wants only to rename a colour, they need only call up the dialogue upon that colour - set and forget. Definition at line 5029 of file sgcolour.cpp. { Info->Result = TRUE; String_256 NewName = GetStringGadgetValue(_R(IDC_COLNAME_TEXT)); if (NewName.Length() < 1) // User gave NULL name. Use 'Unnamed' instead. NewName.MakeMsg(_R(IDS_UNNAMEDCOLOUR)); if (Info->TheList != NULL && Info->TheColour != NULL) { // We must set the new name for the colour - first make sure it's unique String_64 UniqueName; Info->TheList->GenerateUniqueColourName((const StringBase *) &NewName, &UniqueName); IndexedColour *NewCol = new IndexedColour(*Info->TheColour); if (NewCol == NULL) InformError(); else { NewCol->SetName(UniqueName); ColourManager::ChangeColour(Info->TheList, NewCol, Info->TheColour, TRUE); } } else if (Info->TheName != NULL) { // We just copy the string into the result string, truncating at 63 chars NewName.Left(Info->TheName, 63); } Close(); End(); }

BOOL ColourNameDlg::Create (  void   )  [virtual]

ColourNameDlg create method. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Returns: TRUE if successful, else FALSE Reimplemented from DialogOp. Definition at line 5121 of file sgcolour.cpp. { return(DialogOp::Create()); }

void ColourNameDlg::DoWithParam (  OpDescriptor *  , OpParam *  pOpParam )  [virtual]

Creates then opens the dialog. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Parameters: pOpParam  = ptr to a ColourNameParam struct [INPUTS] Reimplemented from Operation. Definition at line 5141 of file sgcolour.cpp. { ERROR3IF(pOpParam == NULL, "Come on, play by the rules"); Info = (ColourNameParam *) pOpParam; if (Info->TheColour == NULL && Info->TheName == NULL) { ERROR3("ColourNameDlg parameters are unhelpful to say the least"); End(); } if (!Create()) { InformError(); End(); } }

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

ColourNameDlg GetState method. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Definition at line 5075 of file sgcolour.cpp. { OpState OpSt; return(OpSt); }

BOOL ColourNameDlg::Init (  void   )  [static]

ColourNameDlg Init method. Called by sginit.cpp. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Reimplemented from SimpleCCObject. Definition at line 5094 of file sgcolour.cpp. { return (RegisterOpDescriptor( 0, _R(IDS_COLOURNAMEDLG), CC_RUNTIME_CLASS(ColourNameDlg), OPTOKEN_COLOURNAMEDLG, ColourNameDlg::GetState, 0, // help ID 0 // bubble ID ) ); }

BOOL ColourNameDlg::InvokeDialog (  String_64 *  NameToFill, IndexedColour *  DisplayColour = NULL )  [static]

Opens the gallery name dialogue on screen, elicits a response, and returns having set the new name. This is a MODAL Dlg. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Returns: TRUE if the OK button was clicked, FALSE if cancel was clicked Parameters: NameToFill  - A String_64 containing the default name. This will be [INPUTS] changed to the new nbame to use. DisplayColour - A colour to be displayed in the dialogue. This is just for the user to look at and say "oooh, pretty!" This variant gets the name of a new colour. The window indicates that a new colour is being created, and has 'Create' and 'Cancel' buttons. Only if it returns TRUE should you create the colour. Note that this variant is not 'set and forget'. You have to do something with the returned name. Notes: DO NOT use this method with the result of a call to the IndexedColour::GetName() function! See the other variant to do this. If you SetName() a colour already in a colour list, (in which case you should be using the other variant of this method) then you MUST ensure that the name you set is guaranteed to be unique within the list (or export/import will fail). Definition at line 5242 of file sgcolour.cpp. { ERROR3IF(NameToFill == NULL, "Come on, play by the rules"); ColourNameParam Info(NameToFill, DisplayColour); OpDescriptor *NameDlg = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(ColourNameDlg)); ERROR3IF(NameDlg == NULL, "ColourNameDlg::InvokeDialog is unable to find the Dlg OpDescriptor"); if (NameDlg != NULL) NameDlg->Invoke(&Info); return(Info.Result); }

BOOL ColourNameDlg::InvokeDialog (  ColourList *  ParentList, IndexedColour *  ColourToName )  [static]

Opens the gallery name dialogue on screen, elicits a response, and returns having set the new name. This is a MODAL dlg. vAuthor: Jason Date: 1/4/95 Returns: TRUE if the OK button was clicked, FALSE if cancel was clicked Parameters: ParentList  - the list in which the colour resides (not NULL) [INPUTS] ColourToName - the colour whose name should be changed (not NULL) This variant renames an existing colour. The window indicates that renaming is going to occur, and has 'Apply' and 'Cancel' buttons. If the name is changed, the colour name will be set (to a name guaranteed to be unique within the colour list), and an appropriate ColourChangingMsg willbe broadcast (i.e. it's a set-and-forget mode) Definition at line 5188 of file sgcolour.cpp. { ERROR3IF(ParentList == NULL || ColourToName == NULL, "Come on, play by the rules"); ColourNameParam Info(ParentList, ColourToName); OpDescriptor *NameDlg = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(ColourNameDlg)); ERROR3IF(NameDlg == NULL, "ColourNameDlg::InvokeDialog is unable to find the Dlg OpDescriptor"); if (NameDlg != NULL) NameDlg->Invoke(&Info); return(Info.Result); }

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

Handles all the scale dialog's messages. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from DialogOp. Definition at line 4932 of file sgcolour.cpp. { if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; // BOOL EndDialog = FALSE; switch (Msg->DlgMsg) { case DIM_CREATE: { String_256 Name; if (Info->TheName != NULL) // Must be creating new colour { Name.MakeMsg(_R(IDS_COLNAME_CREATE)); SetStringGadgetValue(_R(IDOK), _R(IDS_COLNAME_YCREATE)); SetStringGadgetValue(_R(IDC_COLNAME_TEXT), *Info->TheName); } else if (Info->TheColour != NULL) // Are renaming existing colour { Name.MakeMsg(_R(IDS_COLNAME_ALTER)); SetStringGadgetValue(_R(IDOK), _R(IDS_COLNAME_YALTER)); SetStringGadgetValue(_R(IDC_COLNAME_TEXT), *Info->TheColour->GetName()); } SetTitlebarName(&Name); SetKeyboardFocus (_R(IDC_COLNAME_TEXT)); HighlightText (_R(IDC_COLNAME_TEXT)); } break; case DIM_COMMIT: case DIM_SOFT_COMMIT: CommitName(); break; case DIM_CANCEL: Close(); End(); break; case DIM_REDRAW: if (Msg->GadgetID == _R(IDC_COLNAME_PATCH)) { ReDrawInfoType *RedrawInfo = (ReDrawInfoType*) Msg->DlgMsgParam; DocRect VirtualSize(0, 0, RedrawInfo->dx, RedrawInfo->dy); RenderRegion *pRender = CreateOSRenderRegion(&VirtualSize, RedrawInfo); if (pRender) { pRender->SaveContext(); DocColour PatchCol(128L, 128L, 128L); if (Info->TheColour != NULL) PatchCol.MakeRefToIndexedColour(Info->TheColour); pRender->SetLineWidth(0); pRender->SetLineColour(PatchCol); pRender->SetFillColour(PatchCol); pRender->DrawRect(&VirtualSize); pRender->RestoreContext(); DestroyOSRenderRegion(pRender); } } break; default: break; } return (DLG_EAT_IF_HUNGRY(Msg)); } return OK; }

---

Member Data Documentation

const INT32 ColourNameDlg::IDD = _R(IDD_COLOURNAMEDLG) [static]

Definition at line 697 of file sgcolour.h.

ColourNameParam* ColourNameDlg::Info [protected]

Definition at line 709 of file sgcolour.h.

const CDlgMode ColourNameDlg::Mode = MODAL [static]

Definition at line 698 of file sgcolour.h.

---

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

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

---