DialogOp Class Reference

The abstract DialogOp class is used as the base class for all Dialog box classes in Camelot. It provides methods required to create dialogs and to communicate with gadgets. More...

#include <dialogop.h>

Inheritance diagram for DialogOp:

List of all members.

Public Member Functions
	DialogOp (CDlgResID DialogResID, CDlgMode Mode, CDlgResID SubDialogID=0, CCRuntimeClass *Class=CC_RUNTIME_CLASS(DialogOp), INT32 OpeningPage=-1, CWindowID ParentWnd=NULL)
	The Constructor of the DialogOp class simply sets the resource ID of the dialog and its modality.
virtual BOOL	IsABar ()
virtual BOOL	IsAGallery ()
virtual BOOL	IsVertical ()
virtual BOOL	Create ()
	The create method reserves everything needed to guarantee that the dialog will appear. It returns FALSE if it fails. If any dialog merging was specified (by providing a non-zero value for SubDialogID in the call to the DialogOp constructor) then it will be carried out when this function is called.
void	Open ()
	The open dialog method displays the dialog box. If Create was successful then this function cannot fail.
void	Close ()
	The close method removes the dialog from the display but keeps all system resources associated with it. It hides the dialog.
BOOL	IsOpen ()
	Don't use this function any more. It's ambiguous and marked for destruction. Call IsWindowVisible or HasWindow instead. This has been a public service announcement !!!! (Simon).
BOOL	IsWindowVisible ()
	Find out if a dialog is shown or hidden.
BOOL	IsCustomComboDropdownVisible (CGadgetID Gadget)
	Used to determin whether the custom controls dropdown is visible.
BOOL	CloseDropdown (CGadgetID Gadget, BOOL CloseVal)
	Used to close the controls dropdown. This routine was written because of the amount of trouble that I was experiencing with my custom controls down to escape key processing (which is viewed as a hotkey within camelot).
BOOL	HasWindow ()
	To find out if DialogOp has a window associated with it.
BOOL	BringToTop ()
	This function brings an open dialog to the top of the z-order.
BOOL	IsGadgetTickable (CGadgetID Gadget)
	To determine if Gadget is of a particular type that can be ticked. eg. if the gadget is a button.
BOOL	ColourPickerAbort (CGadgetID Gadget, WPARAM wParam=0)
	Used to abort the dragging of the custom colour picker control from within the colour editor.
	~DialogOp ()
	The DialogOp destructor destroys the instance of the DialogOp and all associated resources. If the dialog was open then it is closed.
RenderRegion *	CreateGRenderRegion (DocRect *pRequiredSize, ReDrawInfoType *ExtraInfo, BOOL UseSelViewColContext=FALSE)
	Simplifies the creation of a render region as used in a dialog box. It will create a render region, scaled to the correct size etc and deal with all the Creation, initialisation etc of the region. StartRender is also called, so if this function does not return NULL you are able to start drawing into it. You MUST call DestroyGRenderRegion when you have draw everything that you need to as this calls StopRender (which does the blit to the screen) as well as deleting the render region for you.
BOOL	DestroyGRenderRegion (RenderRegion *pRender)
	Deinitialises the render region and deletes it.
RenderRegion *	CreateOSRenderRegion (DocRect *pRequiredSize, ReDrawInfoType *ExtraInfo, BOOL UseSelViewColContext=FALSE)
	Simplifies the creation of a render region as used in a dialog box. It will create a render region, scaled to the correct size etc and deal with all the Creation, initialisation etc of the region. StartRender is also called, so if this function does not return NULL you are able to start drawing into it. You MUST call DestroyOSRenderRegion when you have draw everything that you need to as this calls StopRender (which does the blit to the screen) as well as deleting the render region for you.
BOOL	DestroyOSRenderRegion (RenderRegion *pRender)
	Deinitialises the render region and deletes it.
void	SetComboListLength (CGadgetID Gadget)
	See DialogManager for a description of this function.
BOOL	SetUnitGadgetValue (CGadgetID Gadget, UnitType Unit, MILLIPOINT value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetDimensionUnitGadgetValue (CGadgetID Gadget, UnitType units, double value, Node *pNode, BOOL IncludeUnitSpecifier=TRUE, BOOL EndOfList=FALSE, INT32 ListPos=-1)
	See DialogManager for a description of this function.
BOOL	SetLongGadgetValue (CGadgetID Gadget, INT32 value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetDoubleGadgetValue (CGadgetID Gadget, double value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetBoolGadgetSelected (CGadgetID Gadget, BOOL IsSelected, INT32 ListPos=0)
	An interface for turning option/radio buttons and list item selection states on or off. See DialogManager::SetBoolGadgetValue for details.
BOOL	SetRadioGroupSelected (CGadgetID *GroupGadgets, CGadgetID SelectedGadget)
	Allows you to select one of a group of gadgets, while ensuring that all other gadgets are disabled. Each item in the NULL_terminated list will be deselected, except the item 'SelectedGadget', which will be selected.
BOOL	SetStringGadgetValue (CGadgetID Gadget, UINT32 IDStr, BOOL EndOfList=TRUE, INT32 ListPos=0)
BOOL	SetStringGadgetValue (CGadgetID Gadget, const StringBase &StrVal, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetCustomComboGadgetValue (CGadgetID Gadget, CustomComboBoxControlDataItem *TheItem, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SelectCustomComboGadgetValueOnString (CGadgetID Gadget, StringBase *StrVal)
	See DialogManager for a description of this function.
void	BuildResDropList (const CGadgetID DropListID, const BOOL bIncludeAuto=TRUE, const BOOL bVerbose=FALSE, const INT32 Default=0)
	Builds a drop down list for a combo box.
void	SetResDropListValue (const CGadgetID DropListID, const BOOL bIncludeAuto=TRUE, const INT32 iValue=0)
	Builds a drop down list for a combo box.
INT32	GetResDropListValue (const CGadgetID DropListID, const BOOL bIncludeAuto=TRUE, BOOL *bValid=NULL)
	Gets value from Resolution dropdown list.
BOOL	SetGadgetRange (CGadgetID Gadget, INT32 Min, INT32 Max, INT32 PageInc=1)
	See DialogManager for a description of this function.
BOOL	SetSelectedValueIndex (CGadgetID Gadget, INT32 Index)
	See DialogManager for a description of this function.
BOOL	SetSelectedValueRange (CGadgetID Gadget, WORD StartIndex, WORD EndIndex, BOOL Select=TRUE)
	See DialogManager for a description of this function.
BOOL	SetDimensionGadgetValue (CGadgetID Gadget, MILLIPOINT value, Node *pNode, BOOL IncludeUnitSpecifier=TRUE, BOOL EndOfList=FALSE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetMemoryGadgetValue (CGadgetID Gadget, UINT32 value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	SetGadgetHelp (CGadgetID Gadget, UINT32 BubbleID, UINT32 StatusID, UINT32 ModuleID=0)
	See DialogManager for a description of this function.
MILLIPOINT	GetUnitGadgetValue (CGadgetID Gadget, UnitType DefaultType, MILLIPOINT StartRange, MILLIPOINT EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL)
	See DialogManager for a description of this function.
INT32	GetLongGadgetValue (CGadgetID GadgetID, INT32 StartRange, INT32 EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, Convert::PFNSTRINGTOINT32 pfnParser=Convert::StringToLong)
	See DialogManager for a description of this function.
double	GetDoubleGadgetValue (CGadgetID GadgetID, double StartRange, double EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, Convert::PFNSTRINGTODOUBLE pfnParser=Convert::StringToDouble)
	See DialogManager for a description of this function.
BOOL	GetDoubleAndUnitGadgetValue (double *pMPValue, double *pUnitValue, UnitType *pUnitType, CGadgetID GadgetID, Node *pNode)
	Read the value from a gadget as a double millipont values accounting for unit scaling ALSO read the type of unit specified and the gadget value in terms of these units ie 0.5m would return 36000.0, 0.5 and METERS (assuming scaling 1m->1in).
BOOL	GetBoolGadgetSelected (CGadgetID GadgetID, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, INT32 ListPos=-1)
	See DialogManager for a description of this function.
INT32	GetSelectedValueIndex (CGadgetID GadgetID)
	A *SENSIBLE* interface to read which item of a combo/list box type of gadget is selected.
CGadgetID	GetRadioGroupSelected (CGadgetID *GroupGadgets)
	To determine which control in a group is selected. Returns the first control found to be selected, or if no controls were found to be selected, returns NULL.
String_256	GetStringGadgetValue (CGadgetID GadgetID, BOOL *Valid=NULL, INT32 ListPos=-1)
	See DialogManager for a description of this function.
BOOL	GetGadgetRange (CGadgetID GadgetID, INT32 *Min, INT32 *Max)
	See DialogManager for a description of this function.
MILLIPOINT	GetDimensionGadgetValue (CGadgetID Gadget, Node *pNode, BOOL *Valid=NULL, INT32 ListPos=-1)
	See DialogManager for a description of this function.
UINT32	GetMemoryGadgetValue (CGadgetID Gadget, UINT32 StartRange, UINT32 EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL)
	See DialogManager for a description of this function.
BOOL	DeleteAllValues (CGadgetID GadgetID)
	Deletes ALL values in list-gadgets See DialogManager for a description of this function.
BOOL	DeleteValue (CGadgetID GadgetID, BOOL EndOfList=TRUE, INT32 ListPos=0)
	See DialogManager for a description of this function.
BOOL	GetValueCount (CGadgetID GadgetID, INT32 *Count)
	See DialogManager for a description of this function.
BOOL	GetValueIndex (CGadgetID GadgetID, WORD *Index)
	See DialogManager for a description of this function.
BOOL	GetValueIndex (CGadgetID GadgetID, INT32 *Index)
	See DialogManager for a description of this function.
INT32	GetSelectedCount (CGadgetID GadgetID)
	Returns the number of selected items in a list-type gadget.
INT32	GetFirstSelectedItem (CGadgetID GadgetID)
	Returns the index of the first selected item in a list-type gadget.
INT32 *	GetSelectedItems (CGadgetID GadgetID)
	Returns a ptr to an INT32 array that holds the list of selected indexes. The last array entry contains -1.
BOOL	EnableGadget (CGadgetID GadgetID, BOOL Enabled)
	See DialogManager for a description of this function.
BOOL	IsGadgetEnabled (CGadgetID Gadget)
	For checking if a gadget is enabled/disabled.
BOOL	HideGadget (CGadgetID GadgetID, BOOL Hide)
	See DialogManager for a description of this function.
BOOL	SetGadgetWritable (CGadgetID Gadget, BOOL enable)
	Sets the state of the 'Read Only' flag of an edit field or combo box.
BOOL	GadgetRedraw (CGadgetID GadgetID, BOOL Redraw)
	See DialogManager for a description of this function.
void	Layout (BOOL CanYield=FALSE)
	Relayout dialog - for sizer changes.
BOOL	SetKeyboardFocus (CGadgetID gadID)
	Sets the keyboard input focus to the given control.
BOOL	HighlightText (CGadgetID gadID, INT32 nStart=0, INT32 nEnd=-1)
	Highlights the given range of text (by default all of it) within a control that holds editable text, eg. an edit field.
BOOL	CaptureMouse (CGadgetID gadID)
	Allows the given control to Capture the mouse.
BOOL	ReleaseMouse (CGadgetID gadID)
	Releases the mouse captured by the given control.
void	PaintGadgetNow (CGadgetID gid)
	Immediately paints any invalid areas the control may have (like the "UpdateWindow" function in Windows, really).
void	InvalidateGadget (CGadgetID Gadget, BOOL EraseBackground=TRUE)
	Causes the Dialog Manager to tell the host os to get the gadget to be redrawn. Calling this on a cc_DialogDraw gadget will cause you to receive a DIM_REDRAW message in the not too distant future.
void	InvalidateGadget (CGadgetID Gadget, ReDrawInfoType *ExtraInfo, DocRect *InvalidRect)
	Causes the Dialog Manager to tell the host os to get the cc_DialogDraw gadget to be redrawn, over the specfied rectangle. You should recieve a DIM_REDRAW message in the not too distant future.
void	ScrollKernelRenderedGadget (CGadgetID Gadget, DocRect *RectToScroll, DocCoord *ScrollBy)
	Causes the Dialog Manager to tell the host os to get the cc_DialogDraw gadget to be scrolled, over the specfied rectangle. You should recieve a DIM_REDRAW message in the not too distant future, to update any portions that 'scroll into view'.
BOOL	GetKernelRenderedGadgetInfo (CGadgetID Gadget, ReDrawInfoType *Result)
	Allows the user access to the same information which is passed in to DIM_REDRAW and the kernel-rendered-dialogue mouse-handling messages. This is just for convenience so they can calculate stuff at a time other than handling those two types of dialogue event (e.g. if a document message causes you to have to redraw a small portion of your gadget, you need this information to calculate the invalidation rectangle from).
void	SetEditGadgetType (CGadgetID Gadget, EditGadgetType Type)
	See DialogManager for a description of this function.
void	SetEditGadgetType (CGadgetID Gadget, UINT32 IDSValidChar)
	See DialogManager for a description of this function.
CTreeItemID	SetTreeGadgetItem (CGadgetID Gadget, CTreeItemID hParent, const StringBase &str, CTreeItemID hInsAfter, INT32 iImage, CCObject *pObj=NULL)
CCObject *	GetTreeGadgetItemData (CGadgetID Gadget, CTreeItemID hItem)
BOOL	SelectTreeGadgetItem (CGadgetID Gadget, CTreeItemID hItem, BOOL bNewState=TRUE)
CTreeItemID	GetTreeGadgetRootItem (CGadgetID Gadget)
CTreeItemID	GetTreeGadgetFirstSelectedItem (CGadgetID Gadget)
BOOL	TreeGadgetExpandItem (CGadgetID Gadget, CTreeItemID hItem)
CTreeItemID	GetTreeGadgetNextVisItem (CGadgetID Gadget, CTreeItemID hItem)
CTreeItemID	GetTreeGadgetFirstChildItem (CGadgetID Gadget, CTreeItemID hItem)
size_t	GetTreeGadgetChildrenCount (CGadgetID Gadget, CTreeItemID hItem, BOOL bRecursive=FALSE)
void	DualFunctionButton (CGadgetID ButtonGadget)
	See DialogManager for a description of this function.
void	SetGadgetBitmaps (CGadgetID GadgetID, UINT32 Bitmap1, UINT32 Bitmap2)
	Calls the dialog manager to set the bitmaps of the gadget (only for cc_Slider controls at the moment).
void	SetGadgetBitmaps (CGadgetID GadgetID, const CGadgetImageList &imagelist)
	Calls the dialog manager to set the bitmaps of the gadget.
void	SetGadgetBitmap (CGadgetID Gadget, ResourceID Bitmap)
	Calls the dialog manager to set the bitmaps of the gadget.
ResourceID	GetGadgetBitmap (CGadgetID Gadget)
	Calls the dialog manager to set the bitmaps of the gadget.
UINT32	GetGadgetImageCount (CGadgetID)
	Calls the dialog manager to set the bitmaps of the gadget.
void	SetBitmapButtonIndexes (CGadgetID GadgetID, UINT32 UnselectedIndex, UINT32 SelectedIndex)
	Calls the dialog manager to set the bitmaps of the cc_bitmapbutton control.
BOOL	MakeListBoxDragable (CGadgetID ListGadget)
	See DialogManager for a description of this function.
virtual MsgResult	Message (Msg *Message)
BOOL	SetTitlebarName (String_256 *Name)
	Sets the titlebar text.
	DialogOp ()
BOOL	UpdateStringGadgetValue (CGadgetID Gadget, StringBase *NewString)
	Similar to SetStringGadgetValue but compares the contents of the gadget in the dialogue before the update and dosen't bother if the new value is the same as the current one. This reduces dialogue flicker. See also: DialogOp::SetStringGadgetValue.
OpDescriptor *	GetGadgetOpDescriptor (CGadgetID Gadget)
	Finds the OpDescriptor associated with a gadget.
BOOL	SendMessageToControl (OpDescriptor *OpDesc, DialogMsg *Msg, BOOL Processed=FALSE)
	Conditionally sends a message to a particular control pointed to by an opdescriptor,.
virtual void	DisallowInteractiveProfiles ()
CWindowID	GetReadWriteWindowID ()
	For a non tabbed dialog this function simply returns the DialogOp's WindowID. For a tabbed dialog the WindowID of the dialog page specified by the last call to TalkToPage is returned.
BOOL	IsModal ()
CDlgResID	GetCurrentPageID ()
	For a non tabbed dialog this function simply returns NULL. For a tabbed dialog it returns the PageID of the dialog page specified by the last call to TalkToPage.
UINT32	SetTimer (UINT32 nIDEvent, UINT32 nElapse, void(*lpfnTimer)(void *)=NULL, void *param=NULL, BOOL OneShot=FALSE)
	Allows the user access to setting a timer caller back or event for a dialog box. The caller can either specify a call back procedure to be called when the timer goes off or if null is specified, a DIM_TIMER message will be sent. The return value is effectively the handle onto the timer system. It must be passed to the KillTimer member function to kill the timer. A Nonzero value indicates successful allocation of the timer; non-zero implies a problem.
BOOL	KillTimer (INT32 nIDEvent)
	Allows the user access to killing a timer caller back or event that has been set up for a dialog box. Kills the timer event identified by nIDEvent from the earlier call to SetTimer. Any pending WM_TIMER messages associated with the timer are removed from the message queue.
BOOL	GetWindowPosition (wxRect *pRect)
	Allows the user to get the current window position.
BOOL	GetWindowPosition (RECT *pRect)
BOOL	GetGadgetPosition (CGadgetID Gadget, wxRect *pRect)
	Allows the user to get the current position of the specified icon or control.
BOOL	GetGadgetPosition (CGadgetID Gadget, RECT *pRect)
BOOL	SetWindowPosition (const wxRect &Rect)
	Allows the user to set the current window position.
BOOL	SetWindowPosition (const RECT &Rect)
BOOL	SetGadgetPosition (CGadgetID Gadget, const wxRect &Rect)
	Allows the user to set the current position of the specified icon or control.
BOOL	SetGadgetPosition (CGadgetID Gadget, const RECT &Rect)
INT32	GetScreenDpi ()
	Allows the user to find out the screen dpi.
BOOL	GetScreenSize (INT32 *pWidth, INT32 *pHeight)
	Allows the user to find out the screen size.
BOOL	IsVisible ()
	Used by the tool bar customize system to find out if a tool bar is visible or not.
virtual void	SetVisibility (BOOL Visible)
	Used by the tool bar customize system to open and close a tool bar.
Static Public Member Functions
static BOOL	IsADialogWindow (CWindowID WndID)
	To find out if WndID is the window ID of a dialog.
static DialogOp *	FindDialogOp (CDlgResID ResID)
	Looks for a given DialogOp by using its ResourceID.
Public Attributes
CWindowID	WindowID
Protected Member Functions
void	ProfileSelectionChange (DialogMsg *Message, CGadgetID GadgetID)
	Responds to CGadgetID's corresponding profile dialog messages. Profile changes are applied (internally) through ChangeProfile ().
virtual void	ChangeProfile (CProfileBiasGain *Profile, CGadgetID GadgetID)
	Actually applies the profile to the selection. This base class function does nothing. It MUST be overidden within InformationBarOp derived classes.
virtual void	ChangeProfileOnIdle (CProfileBiasGain *Profile, CGadgetID GadgetID)
	This is a special version of the ChangeProfile () function. It is only called when the user has stopped moving the mouse whilst dragging a profile slider. In this way, camelot now possess TRUE idle slider processing.
virtual BOOL	AddControlsToHelper ()
	If you want to subclass some or all of the controls on your dialog then override this function.
virtual void	RemoveControlsFromHelper ()
	If you added some controls in AddControlsToHelper then you must remove them here.
BOOL	AddDialogControlToHelper (CGadgetID GadgetID)
	Calls the dialog manager add this control to the dialog control helper.
BOOL	AddDialogControlToHelper (CGadgetID GadgetID, CDlgResID PageID)
	Overridden version of above for use with tabbed dialogs, allows you to add controls that are not on the currently active page.
BOOL	RemoveDialogControlFromHelper (CGadgetID GadgetID)
	Calls the dialog manager remove this control from the dialog control helper.
BOOL	RemoveDialogControlFromHelper (CGadgetID GadgetID, CDlgResID PageID)
	Calls the dialog manager remove this control from the dialog control helper Overridden version.
Protected Attributes
CDlgResID	DlgResID
CDlgResID	SubDlgID
CDlgMode	DlgMode
CWindowID	ParentDlgWnd
DialogEventHandler *	pEvtHandler
DialogManager *	DlgMgr
CDlgResID	ReadWritePage
INT32	PageToOpen
Private Attributes
UINT32	MagicWord
BOOL	m_bInteractiveProfiles
Friends
class	DialogEventHandler
class	DialogManager

---

Detailed Description

The abstract DialogOp class is used as the base class for all Dialog box classes in Camelot. It provides methods required to create dialogs and to communicate with gadgets.

Author:

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

Date:

15/9/93

See also:

DialogManager

Definition at line 145 of file dialogop.h.

---

Constructor & Destructor Documentation

DialogOp::DialogOp (  CDlgResID  DialogResID, CDlgMode  Mode, CDlgResID  SubDialogID = 0, CCRuntimeClass *  Class = CC_RUNTIME_CLASS(DialogOp), INT32  OpeningPage = -1, CWindowID  ParentWnd = NULL )

The Constructor of the DialogOp class simply sets the resource ID of the dialog and its modality. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: DialogResID,:  The resource ID of the dialog [INPUTS] Mode: The dialog's mode (modal, medeless) SubDialogID: The resource ID of another dialog - this allows you to merge two dialogs to create a new one (if this parameter is omitted no merging occurs and you get a normal dialog). MainInst, SubInst - instance handles of the modules containing the dialog templates (if 0 the main application instance is used). OpeningPage: For tabbed dialogs allows opening tab to be chosen Definition at line 199 of file dialogop.cpp. : Operation(Class) { MagicWord = MAGIC_CREATE; // Save this for later DlgResID = DialogResID; // Dialog's resource ID DlgMode = Mode; // Dialog's mode SubDlgID = SubDialogID; // Dialog to merge with (0 => no merging) WindowID = NULL; // We don't know this until we create the dialog DlgMgr = CCamApp::GetDlgManager(); // Store a pointer to the Dialog Manager so that // it's easy to get at ReadWritePage = 0; // The page within the dialog that we are currently // reading or writing to. This is NULL for all // non tabbed dialogs. PageToOpen = OpeningPage; // for tabbed dialogs allows opening tab to be chosen pEvtHandler = NULL; m_bInteractiveProfiles = TRUE; PORTNOTE("dialog","Removed Windows resource'ism") #ifndef EXCLUDE_FROM_XARALX // Make the main resource instance the uk.dll one, or whatever, if it exists if(MainInst == 0) MainInst = ExtraDLLs[Resources_DLL]; // Set up instance handle for the main dialog if (MainInst == 0) MainDlgInst = AfxGetInstanceHandle(); else MainDlgInst = MainInst; // Make the sub resource instance the uk.dll one, or whatever, if it exists if(SubDlgInst == 0) SubDlgInst = ExtraDLLs[Resources_DLL]; // Set up instance handle for the main dialog if (SubInst == 0) SubDlgInst = AfxGetInstanceHandle(); else SubDlgInst = SubInst; #endif // User is interacting, so shouldn't be waiting! OpFlags.HasOwnTimeIndicator = TRUE; ParentDlgWnd = ParentWnd; }

DialogOp::~DialogOp (   )

The DialogOp destructor destroys the instance of the DialogOp and all associated resources. If the dialog was open then it is closed. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Note that a dialog box can be destroyed even if it was never created. In this case no message is sent to the dialog manager. Returns: Errors: - See also: - Definition at line 598 of file dialogop.cpp. { CheckMagic("DialogOp destructor"); if (WindowID != NULL) DlgMgr->Delete(WindowID, this); WindowID = NULL; // ensure we get a NULL pointer if this is used again DlgMgr = NULL; // Again, ensure this is a NULL pointer pEvtHandler=NULL; MagicWord = MAGIC_DESTROY; }

DialogOp::DialogOp (   )

Definition at line 257 of file dialogop.cpp. { ENSURE(FALSE, "Invalid constructor called for DialogOp"); }

---

Member Function Documentation

BOOL DialogOp::AddControlsToHelper (   )  [protected, virtual]

If you want to subclass some or all of the controls on your dialog then override this function. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 14/7/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: always TRUE Errors: - See also: First implementation in BrushDlg.h/cpp, DialogControlHelper class (DlgCtHlp.h/.cpp) Reimplemented in CBrushEditDlg. Definition at line 440 of file dialogop.cpp. { return TRUE; }

BOOL DialogOp::AddDialogControlToHelper (  CGadgetID  GadgetID, CDlgResID  PageID )  [protected]

Overridden version of above for use with tabbed dialogs, allows you to add controls that are not on the currently active page. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 23/9/99 Parameters: GadgetID  [INPUTS] PageID - the ID of the tabbed dialog page that this control belongs to Definition at line 2291 of file dialogop.cpp. { // get the handle of the page first CWindowID PageWindow = DialogManager::GetPageWindow(WindowID, PageID); if (PageWindow == NULL) return FALSE; return DialogManager::AddDialogControlToHelper(PageWindow, GadgetID); }

BOOL DialogOp::AddDialogControlToHelper (  CGadgetID  GadgetID  )  [protected]

Calls the dialog manager add this control to the dialog control helper. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 23/9/99 Parameters: GadgetID  [INPUTS] Definition at line 2272 of file dialogop.cpp. { return DialogManager::AddDialogControlToHelper(GetReadWriteWindowID(), GadgetID); }

BOOL DialogOp::BringToTop (   )

This function brings an open dialog to the top of the z-order. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 27/6/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if the function failed. Errors: - See also: - Definition at line 416 of file dialogop.cpp. { ERROR2IF(!WindowID, FALSE, "BringToTop called on a dialog without a window"); return (DlgMgr->BringToTop(WindowID, this)); }

void DialogOp::BuildResDropList (  const CGadgetID  DropListID, const BOOL  bIncludeAuto = TRUE, const BOOL  bVerbose = FALSE, const INT32  Default = 0 )

Builds a drop down list for a combo box. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 10-06-2005 Definition at line 942 of file dialogop.cpp. { DeleteAllValues(DropListID); SetComboListLength(DropListID); // TODO: // Get XML document from alongside exe // For each resolution // Add item to dropdown // Next if (bVerbose) { if (bIncludeAuto) SetStringGadgetValue(DropListID, _R(IDS_RES_AUTOVARIABLE), TRUE); // SetStringGadgetValue(DropListID, _R(IDS_RES_72), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_SCREEN), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_INTERMEDIATE), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_PRINT), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_PRINT300), TRUE); } else { if (bIncludeAuto) SetStringGadgetValue(DropListID, _R(IDS_RES_AUTO), TRUE); // SetStringGadgetValue(DropListID, _R(IDS_RES_72), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_96), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_150), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_200), TRUE); SetStringGadgetValue(DropListID, _R(IDS_RES_300), TRUE); } SetComboListLength(DropListID); SetSelectedValueIndex(DropListID, Default); }

BOOL DialogOp::CaptureMouse (  CGadgetID  gadID  )

Allows the given control to Capture the mouse. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 28/04/97 Parameters: gadID  ID of the "gadget" (control) which is to receive the [INPUTS] input focus -  [OUTPUTS] Returns: TRUE if successful. Errors: - See also: DialogManager::CaptureMouse; DialogManager::ReleaseMouse Definition at line 1940 of file dialogop.cpp. { return DialogManager::CaptureMouse(GetReadWriteWindowID(), gadID); }

void DialogOp::ChangeProfile (  CProfileBiasGain *  Profile, CGadgetID  GadgetID )  [protected, virtual]

Actually applies the profile to the selection. This base class function does nothing. It MUST be overidden within InformationBarOp derived classes. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 19/1/2000 Parameters: CBiasGainGadget&  and its GadgetID (for added safety) [INPUTS] -  [OUTPUTS] Returns: - Take a look at tools.cpp for an example of this. Returns: Errors: - See also: InformationBarOp::ProfileSelectionChange () Reimplemented in BlendInfoBarOp, ContourInfoBarOp, GradInfoBarOp, and TranspInfoBarOp. Definition at line 3787 of file dialogop.cpp. { return; }

void DialogOp::ChangeProfileOnIdle (  CProfileBiasGain *  Profile, CGadgetID  GadgetID )  [protected, virtual]

This is a special version of the ChangeProfile () function. It is only called when the user has stopped moving the mouse whilst dragging a profile slider. In this way, camelot now possess TRUE idle slider processing. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 9/8/2000 Parameters: CBiasGainGadget&  and its GadgetID (for added safety) [INPUTS] -  [OUTPUTS] Returns: - Actually applies the profile to the selection (which should be non-undoable). This base class function does nothing. It MUST be overidden within InformationBarOp derived classes. Take a look at tools.cpp for an example of this. Returns: Errors: - See also: InformationBarOp::ProfileSelectionChange (), InformationBarOp::ChangeProfile () Reimplemented in BlendInfoBarOp, and ContourInfoBarOp. Definition at line 3815 of file dialogop.cpp. { return; }

void DialogOp::Close (  void   )

The close method removes the dialog from the display but keeps all system resources associated with it. It hides the dialog. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 344 of file dialogop.cpp. { CheckMagic("DialogOp:Close()"); ENSURE(WindowID != NULL, "Trying to close a window with a NULL window ID !"); DlgMgr->Close(WindowID, this); // remove any subclassed controls from the control helper RemoveControlsFromHelper(); // we have changed the appearance of the screen so broadcast a message if (Document::GetCurrent() != NULL) // only if we have a current document BROADCAST_TO_ALL(ScreenChangeMsg()); }

BOOL DialogOp::CloseDropdown (  CGadgetID  Gadget, BOOL  CloseVal )

Used to close the controls dropdown. This routine was written because of the amount of trouble that I was experiencing with my custom controls down to escape key processing (which is viewed as a hotkey within camelot). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 21/2/2000 Parameters: Gadget,:  The Gadget to call this routine on [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 573 of file dialogop.cpp. { return (DlgMgr->CloseDropdown(GetReadWriteWindowID(), Gadget, CloseVal)); }

BOOL DialogOp::ColourPickerAbort (  CGadgetID  Gadget, WPARAM  wParam = 0 )

Used to abort the dragging of the custom colour picker control from within the colour editor. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/2000 Parameters: Gadget,:  The Gadget to call this routine on [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 506 of file dialogop.cpp. { return (DlgMgr->ColourPickerAbort(GetReadWriteWindowID(), Gadget, wParam)); }

BOOL DialogOp::Create (  void   )  [virtual]

The create method reserves everything needed to guarantee that the dialog will appear. It returns FALSE if it fails. If any dialog merging was specified (by providing a non-zero value for SubDialogID in the call to the DialogOp constructor) then it will be carried out when this function is called. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if all resources to create the dialog can be successfully allocated. FALSE otherwise Errors: If the resources cannot be allocated then ERRORIF is called with a Dialog creation failed error message. See also: - Reimplemented in BarCreationDlg, BarStatesDlg, BarRedefineStateDlg, InformationBarOp, BlobbyDlg, BlobbyBar, BmpPrefsDlg, PhotoCDDlg, BmpDlg, CMXTreeDlg, ColourEditDlg, CXFTreeDlg, DebugTreeDlg, ExtendSetsDlg, WebAddressDlg, InfoBarOp, LayerDlg, LayerNameDlg, NewColourDlg, SepsDlg, UnitPropertiesDlg, SelMediaDlg, SuperGallery, SGalleryOptionsDlg, SGallerySortDlg, SGallerySearchDlg, ColourNameDlg, TipsDlg, ToolbarDlg, ToolnameDlg, CustomizeBarDlg, WebPrefsDlg, NativePrefsDlg, PasteSpecialDlg, and SGalleryLinePropertiesDlg. Definition at line 287 of file dialogop.cpp. { // Create an instance of the dialog by calling the dialog managers Create method. The // The WindowID will be set by this call BOOL Created = DlgMgr->Create(this, /*MainDlgInst,*/ DlgResID, /*SubDlgInst,*/ SubDlgID, DlgMode, PageToOpen, ParentDlgWnd); ERRORIF(!Created, _R(IDT_DIALOG_CREATEFAIL), FALSE); // It all worked return TRUE; }

RenderRegion * DialogOp::CreateGRenderRegion (  DocRect *  pRequiredSize, ReDrawInfoType *  ExtraInfo, BOOL  UseSelViewColContext = FALSE )

Simplifies the creation of a render region as used in a dialog box. It will create a render region, scaled to the correct size etc and deal with all the Creation, initialisation etc of the region. StartRender is also called, so if this function does not return NULL you are able to start drawing into it. You MUST call DestroyGRenderRegion when you have draw everything that you need to as this calls StopRender (which does the blit to the screen) as well as deleting the render region for you. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: pRequiredSize  - The size that you want the effective area of the window to [INPUTS] be. Measured in Millipoints. eg. If you want your control to appear to be 1 inch square (whatever the actual size of it is), pass in a DocRect that looks a bit like this ... DocRect(0,0,72000,72000) ExtraInfo - The info about the region, as supplied by the dialog manager Returns: Render Region. This returns a pointer to a render region, or NULL if it failed to create one. Notes: Use GRenderRegions when you want fast redraw, grad fills, and transparency. If only simple rendering is required, think about perhaps using an OSRenderRegion instead. See also: DialogOp::DestroyGRenderRegion DialogOp::CreateOSRenderRegion Definition at line 2676 of file dialogop.cpp. { // Make a new dialog view DialogView *pDialogView = new DialogView; if (pDialogView == NULL) // Error - return failure. return NULL; // Initialise the DialogView if (!pDialogView->Init()) { // Error - return failure. delete pDialogView; return NULL; } // Pixelise the rectangle pRequiredSize->lo.Pixelise(pDialogView); pRequiredSize->hi.Pixelise(pDialogView); DocRect ClipRect = *pRequiredSize; // Get some default params for the render region FIXED16 Scale(1); // Ok, go and scale things INT32 ReqDx = ClipRect.Width(); INT32 ReqDy = ClipRect.Height(); // Work out the scale factors FIXED16 XScale = FIXED16(double(ExtraInfo->dx) / double(ReqDx)); FIXED16 YScale = FIXED16(double(ExtraInfo->dy) / double(ReqDy)); // Build the matricies // One to shift everything to the correct side of the X axis Matrix Translate(0, -ExtraInfo->dy); // One to scale everything into the window Matrix ScaleIt(XScale, YScale); // One to translate everything to the origin Matrix ToOrigin(-ClipRect.lo.x, -ClipRect.lo.y); // Combine them all ToOrigin *= ScaleIt; ToOrigin *= Translate; // If the caller wants to use the same colour separation options (ColourPlate) as the // currently selected view, then copy the ColourPlate across to the new DialogView if (UseSelViewColContext && DocView::GetSelected() != NULL) pDialogView->SetColourPlate(DocView::GetSelected()->GetColourPlate()); // make a render region GRenderRegion* pRender = new GRenderDIB(ClipRect, ToOrigin, Scale, 32, (double)ExtraInfo->Dpi); if (pRender!=NULL) { // Try and create the bitmap etc if (pRender->AttachDevice(pDialogView, ExtraInfo->pDC->GetDC(), NULL)) { // Try and start the render region if (pRender->StartRender()) { return pRender; } } // Failed to attach and start the render region so free up the region delete pRender; } // Something went wrong, fail delete pDialogView; return NULL; }

RenderRegion * DialogOp::CreateOSRenderRegion (  DocRect *  pRequiredSize, ReDrawInfoType *  ExtraInfo, BOOL  UseSelViewColContext = FALSE )

Simplifies the creation of a render region as used in a dialog box. It will create a render region, scaled to the correct size etc and deal with all the Creation, initialisation etc of the region. StartRender is also called, so if this function does not return NULL you are able to start drawing into it. You MUST call DestroyOSRenderRegion when you have draw everything that you need to as this calls StopRender (which does the blit to the screen) as well as deleting the render region for you. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> (Jason copied CreateGRenderRegion) Date: 17/10/94 (11/1/95) Parameters: pRequiredSize  - The size that you want the effective area of the window to [INPUTS] be. Measured in Millipoints. eg. If you want your control to appear to be 1 inch square (whatever the actual size of it is), pass in a DocRect that looks a bit like this ... DocRect(0,0,72000,72000) ExtraInfo - The info about the region, as supplied by the dialog manager Returns: Render Region. This returns a pointer to a render region, or NULL if it failed to create one. Notes: Use GRenderRegions when you want fast redraw, grad fills, and transparency. If only simple rendering is required, think about perhaps using an OSRenderRegion instead. See also: DialogOp::DestroyOSRenderRegion DialogOp::CreateGRenderRegion Definition at line 2822 of file dialogop.cpp. { // Make a new dialog view DialogView *pDialogView = new DialogView; if (pDialogView == NULL) // Error - return failure. return NULL; // Initialise the DialogView if (!pDialogView->Init()) { // Error - return failure. delete pDialogView; return NULL; } // Pixelise the rectangle pRequiredSize->lo.Pixelise(pDialogView); pRequiredSize->hi.Pixelise(pDialogView); DocRect ClipRect = *pRequiredSize; // Get some default params for the render region FIXED16 Scale(1); // Ok, go and scale things INT32 ReqDx = ClipRect.Width(); INT32 ReqDy = ClipRect.Height(); // Work out the scale factors FIXED16 XScale = FIXED16(double(ExtraInfo->dx) / double(ReqDx)); FIXED16 YScale = FIXED16(double(ExtraInfo->dy) / double(ReqDy)); // Build the matricies // One to shift everything to the correct side of the X axis Matrix Translate(0, -ExtraInfo->dy); // One to scale everything into the window Matrix ScaleIt(XScale, YScale); // One to translate everything to the origin Matrix ToOrigin(-ClipRect.lo.x, -ClipRect.lo.y); // Combine them all ToOrigin *= ScaleIt; ToOrigin *= Translate; // If the caller wants to use the same colour separation options (ColourPlate) as the // currently selected view, then copy the ColourPlate across to the new DialogView if (UseSelViewColContext && DocView::GetSelected() != NULL) pDialogView->SetColourPlate(DocView::GetSelected()->GetColourPlate()); // Make a render region for the screen, asking specifically for an OSRenderRegion, // and none of this sneaky & cunning diverting it back into being a GRenderRegion! RenderRegion* pRender = OSRenderRegion::Create(ClipRect, ToOrigin, Scale, RENDERTYPE_SCREEN, NULL, TRUE); if (pRender!=NULL) { // Try and create the bitmap etc if (pRender->AttachDevice(pDialogView, ExtraInfo->pDC, NULL)) { // Try and start the render region if (pRender->StartRender()) { return pRender; } } // Failed to attach and start the render region so free up the region delete pRender; } // Something went wrong, fail delete pDialogView; return NULL; }

BOOL DialogOp::DeleteAllValues (  CGadgetID  GadgetID  )

Deletes ALL values in list-gadgets See DialogManager for a description of this function. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/5/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::DeleteAllValues Definition at line 1596 of file dialogop.cpp. { return(DlgMgr->DeleteAllValues(GetReadWriteWindowID(), GadgetID)); }

BOOL DialogOp::DeleteValue (  CGadgetID  GadgetID, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::DeleteValue Definition at line 1620 of file dialogop.cpp. { return (DlgMgr->DeleteValue(GetReadWriteWindowID(), GadgetID, EndOfList, ListPos)); }

BOOL DialogOp::DestroyGRenderRegion (  RenderRegion *  pRender  )

Deinitialises the render region and deletes it. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: A  pointer to a render region return by CreateGRenderRegion [INPUTS] Returns: TRUE if it worked, FALSE if the render region passed in was bad Errors: ERROR2 error if pRender is NULL See also: DialogOp::CreateGRenderRegion Definition at line 2768 of file dialogop.cpp. { // Test for preconditions ERROR2IF(pRender==NULL, FALSE, "DestroyGRenderRegion was passed a NULL render region"); // Blit to the screen pRender->StopRender(); // and delete the render region and its (dialog) view // these are deleted in this order because the RenderRegion destructor may // call functions on its RenderView View* pView = pRender->GetRenderView(); delete pRender; delete pView; // It worked return TRUE; }

BOOL DialogOp::DestroyOSRenderRegion (  RenderRegion *  pRender  )

Deinitialises the render region and deletes it. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> (Jason copied CreateGRenderRegion) Date: 17/10/94 (11/1/95) Parameters: A  pointer to a render region return by CreateOSRenderRegion [INPUTS] Returns: TRUE if it worked, FALSE if the render region passed in was bad Errors: ERROR2 error if pRender is NULL See also: DialogOp::CreateGRenderRegion DialogOp::CreateOSRenderRegion Definition at line 2922 of file dialogop.cpp. { // Test for preconditions ERROR2IF(pRender==NULL, FALSE, "DestroyOSRenderRegion was passed a NULL render region"); // Blit to the screen pRender->StopRender(); // and delete the render region and its (dialog) view // these are deleted in this order because the RenderRegion destructor may // call functions on its RenderView View* pView = pRender->GetRenderView(); delete pRender; delete pView; // It worked return TRUE; }

virtual void DialogOp::DisallowInteractiveProfiles (   )  [inline, virtual]

Definition at line 478 of file dialogop.h. { m_bInteractiveProfiles = FALSE; }

void DialogOp::DualFunctionButton (  CGadgetID  ButtonGadget  )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 7/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::DualFunctionButton Definition at line 2398 of file dialogop.cpp. { DlgMgr->DualFunctionButton(GetReadWriteWindowID(), ButtonGadget); }

BOOL DialogOp::EnableGadget (  CGadgetID  Gadget, BOOL  Enabled )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::EnableGadget Definition at line 1798 of file dialogop.cpp. { return (DlgMgr->EnableGadget(GetReadWriteWindowID(), Gadget, Enabled)); }

DialogOp * DialogOp::FindDialogOp (  CDlgResID  ResID  )  [static]

Looks for a given DialogOp by using its ResourceID. Author: Alex Bligh <alex@alex.org.uk> Date: 17/4/2006 Parameters: ResID  - The resource ID of the dialog to find [INPUTS] -  [OUTPUTS] Returns: ptr to DialogOp NULL is returned if not found Errors: - See also: - Definition at line 3012 of file dialogop.cpp. { List* pList = MessageHandler::GetClassList(CC_RUNTIME_CLASS(DialogOp)); DialogOp* pDialogOp = (DialogOp*)pList->GetHead(); while (pDialogOp != NULL) { if (pDialogOp->DlgResID == ResID) return (pDialogOp); pDialogOp = (DialogOp*)pList->GetNext(pDialogOp); } return NULL; }

BOOL DialogOp::GadgetRedraw (  CGadgetID  GadgetID, BOOL  Redraw )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GadgetRedraw Definition at line 1899 of file dialogop.cpp. { return (DlgMgr->GadgetRedraw(GetReadWriteWindowID(), GadgetID, Redraw)); }

BOOL DialogOp::GetBoolGadgetSelected (  CGadgetID  Gadget, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, INT32  ListPos = -1 )

See DialogManager for a description of this function. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 10/4/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetLongGadgetValue; DialogOp::GetRadioGroupSelected Definition at line 1431 of file dialogop.cpp. { return (DlgMgr->GetBoolGadgetSelected(GetReadWriteWindowID(), Gadget, IDSInvalidMsg, Valid, ListPos)); }

CDlgResID DialogOp::GetCurrentPageID (   )

For a non tabbed dialog this function simply returns NULL. For a tabbed dialog it returns the PageID of the dialog page specified by the last call to TalkToPage. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: the PageID of the tab currently being used. NULL if its the main page. Errors: - Scope: public See also: DialogTabOp::TalkToPage; DialogOp::GetReadWriteWindowID(); Definition at line 2990 of file dialogop.cpp. { // Just return the current id of the tab page in use. return ReadWritePage; }

MILLIPOINT DialogOp::GetDimensionGadgetValue (  CGadgetID  Gadget, Node *  pNode, BOOL *  Valid = NULL, INT32  ListPos = -1 )

See DialogManager for a description of this function. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 15/6/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetDimensionGadgetValue Definition at line 1544 of file dialogop.cpp. { return (DlgMgr->GetDimensionGadgetValue(GetReadWriteWindowID(), Gadget, pNode, Valid, ListPos)); }

BOOL DialogOp::GetDoubleAndUnitGadgetValue (  double *  pMPValue, double *  pUnitValue, UnitType *  pUnitType, CGadgetID  GadgetID, Node *  pNode )

Read the value from a gadget as a double millipont values accounting for unit scaling ALSO read the type of unit specified and the gadget value in terms of these units ie 0.5m would return 36000.0, 0.5 and METERS (assuming scaling 1m->1in). BOOL DialogOp::GetDoubleAndUnitGadgetValue( double* pMPValue, double* pUnitValue, UnitType* pUnitType, CGadgetID GadgetID, Node* pNode) Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/95 Parameters: GadgetID  - [INPUTS] pNode - node from which to determine default units (ie page units) pMPValue  - value of gadget converted to millipoints (accounting for scaling) [OUTPUTS] pUnitValue - value of gadget in terms of units output in pUnitType pUnitType - type of unit the value was specified in (or page units if none) Returns: FALSE if fails Definition at line 1401 of file dialogop.cpp. { return DlgMgr->GetDoubleAndUnitGadgetValue( pMPValue, pUnitValue, pUnitType, GetReadWriteWindowID(), GadgetID, pNode); }

double DialogOp::GetDoubleGadgetValue (  CGadgetID  Gadget, double  StartRange, double  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, Convert::PFNSTRINGTODOUBLE  pfnParser = Convert::StringToDouble )

See DialogManager for a description of this function. Author: Alex_Bligh (Xara Group Ltd) <camelotdev@xara.com> Date: 16/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetDoubleGadgetValue Definition at line 1365 of file dialogop.cpp. { return DlgMgr->GetDoubleGadgetValue(GetReadWriteWindowID(), Gadget, StartRange, EndRange, IDSInvalidMsg, Valid, pfnParser); }

INT32 DialogOp::GetFirstSelectedItem (  CGadgetID  GadgetID  )

Returns the index of the first selected item in a list-type gadget. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: GadgetID  = ID of list-type gadget [INPUTS] Returns: The index of the firsted selected items in the list-type gadget, or -1 if it fails See also: - Definition at line 1709 of file dialogop.cpp. { return (DlgMgr->GetFirstSelectedItem(GetReadWriteWindowID(),GadgetID)); }

ResourceID DialogOp::GetGadgetBitmap (  CGadgetID  Gadget  )

Calls the dialog manager to set the bitmaps of the gadget. Author: Alex Bligh <alex@alex.org.uk> Date: 07/05/2006 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] Bitmap - The ID of the bitmap Definition at line 2216 of file dialogop.cpp. { // Call the dialog Manager return DialogManager::GetGadgetBitmap(GetReadWriteWindowID(), Gadget); }

UINT32 DialogOp::GetGadgetImageCount (  CGadgetID  GadgetID  )

Calls the dialog manager to set the bitmaps of the gadget. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] imagelist - list of images for this gadget Definition at line 2235 of file dialogop.cpp. { // Call the dialog Manager return DialogManager::GetGadgetImageCount(GetReadWriteWindowID(), GadgetID); }

OpDescriptor * DialogOp::GetGadgetOpDescriptor (  CGadgetID  Gadget  )

Finds the OpDescriptor associated with a gadget. Author: Alex Bligh Date: 03-Mar-2005 Parameters: Gadget  - the Gadget to get the OpDescriptor for [INPUTS] -  [OUTPUTS] Returns: Pointer the gadget's associated OpDescriptor Errors: - See also: - Definition at line 3675 of file dialogop.cpp. { return (DlgMgr->GetGadgetOpDescriptor(GetReadWriteWindowID(), Gadget)); }

BOOL DialogOp::GetGadgetPosition (  CGadgetID  Gadget, RECT *  pRect )

Definition at line 3462 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::GetGadgetPosition(GetReadWriteWindowID(), Gadget, pRect); }

BOOL DialogOp::GetGadgetPosition (  CGadgetID  Gadget, wxRect *  pRect )

Allows the user to get the current position of the specified icon or control. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: Rect  pointer to the rectangle to fill in [OUTPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::SetGadgetPosition; DialogManager::GetGadgetPosition; Definition at line 3456 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::GetGadgetPosition(GetReadWriteWindowID(), Gadget, pRect); }

BOOL DialogOp::GetGadgetRange (  CGadgetID  GadgetID, INT32 *  Min, INT32 *  Max )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetGadgetRange Definition at line 1522 of file dialogop.cpp. { return (DlgMgr->GetGadgetRange(GetReadWriteWindowID(), GadgetID, Min, Max)); }

BOOL DialogOp::GetKernelRenderedGadgetInfo (  CGadgetID  Gadget, ReDrawInfoType *  Result )

Allows the user access to the same information which is passed in to DIM_REDRAW and the kernel-rendered-dialogue mouse-handling messages. This is just for convenience so they can calculate stuff at a time other than handling those two types of dialogue event (e.g. if a document message causes you to have to redraw a small portion of your gadget, you need this information to calculate the invalidation rectangle from). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 19/1/95 Parameters: Gadget  - The ID of the gadget that you want info for [INPUTS] Returns: FALSE if there was a catastrophic error (it will report an ERROR2), in which case the returned data is invalid (well, it defaults to 96 Dpi and an area of 72000x72000 millipoints, so is 'safe' to use, but probably wrong) TRUE under normal conditions Parameters: Result  - will be returned filled in with appropriate kernel-rendered- [OUTPUTS] dialogue information (dx, dy, and Dpi will be filled in with the appropriate values; pMousePOs, pDC, and pClipRect will all be NULL) See also: DialogManager::GetKernelRenderedGadgetInfo Definition at line 2139 of file dialogop.cpp. { // Call the Dialog Manager return(DialogManager::GetKernelRenderedGadgetInfo(GetReadWriteWindowID(), Gadget, Result)); }

INT32 DialogOp::GetLongGadgetValue (  CGadgetID  Gadget, INT32  StartRange, INT32  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, Convert::PFNSTRINGTOINT32  pfnParser = Convert::StringToLong )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetLongGadgetValue Definition at line 1329 of file dialogop.cpp. { return DlgMgr->GetLongGadgetValue(GetReadWriteWindowID(), Gadget, StartRange, EndRange, IDSInvalidMsg, Valid, pfnParser); }

UINT32 DialogOp::GetMemoryGadgetValue (  CGadgetID  Gadget, UINT32  StartRange, UINT32  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL )

See DialogManager for a description of this function. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 30/1/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetMemoryGadgetValue; DialogManager::SetMemoryGadgetValue; Definition at line 1568 of file dialogop.cpp. { return(DlgMgr->GetMemoryGadgetValue(GetReadWriteWindowID(), Gadget, StartRange, EndRange, IDSInvalidMsg, Valid)); }

CGadgetID DialogOp::GetRadioGroupSelected (  CGadgetID *  GroupGadgets  )

To determine which control in a group is selected. Returns the first control found to be selected, or if no controls were found to be selected, returns NULL. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: GroupGadgets  - Points to a NULL-terminated list of Gadget IDs [INPUTS] -  [OUTPUTS] Returns: The gadget ID of the gadget in the input list which was selected or NULL if the list was empty or no items in it were selected Errors: ERROR3 occurs in debug builds if the list was empty SeelAlso: DialogOp::SetRadioGroupSelected; DialogOp::SetBoolGadgetSelected Definition at line 1467 of file dialogop.cpp. { INT32 i = 0; ERROR3IF(GroupGadgets[0] == 0, "DialogOp::GetRadioGroupSelected called with blank ID list"); while (GroupGadgets[i] != 0) { if (GetBoolGadgetSelected(GroupGadgets[i])) return(GroupGadgets[i]); i++; } return( 0 ); }

CWindowID DialogOp::GetReadWriteWindowID (   )

For a non tabbed dialog this function simply returns the DialogOp's WindowID. For a tabbed dialog the WindowID of the dialog page specified by the last call to TalkToPage is returned. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 29/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: the WindowID of the window that we are currently reading or writing to. NULL if the window does not exist. Errors: - Scope: protected See also: DialogTabOp::TalkToPage Definition at line 2964 of file dialogop.cpp. { CheckMagic("DialogOp::GetReadWriteWindowID"); return (DlgMgr->GetPageWindow(WindowID, ReadWritePage)); }

INT32 DialogOp::GetResDropListValue (  const CGadgetID  DropListID, const BOOL  bIncludeAuto = TRUE, BOOL *  pbValid = NULL )

Gets value from Resolution dropdown list. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 10-06-2005 Definition at line 1060 of file dialogop.cpp. { BOOL Valid; INT32 iValue = 0; if (pbValid) *pbValid = FALSE; // First check whether it's "none" or not String_256 str; str = GetStringGadgetValue(DropListID, &Valid, -1); // if (str.IsIdentical(String_32(_R(IDS_LE_NONE))) || // str.IsIdentical(String_32(_R(IDS_LE_MANY))) || // !Valid) // { // return; // } // if (bIncludeAuto && str.IsIdentical(String_32(_R(IDS_RES_AUTO)))) { iValue = 0; Valid = TRUE; } else if (str.IsIdentical(String_32(_R(IDS_RES_AUTOVARIABLE)))) { iValue = 0; Valid = TRUE; } else if (str.IsIdentical(String_32(_R(IDS_RES_SCREEN)))) { iValue = 96; Valid = TRUE; } else if (str.IsIdentical(String_32(_R(IDS_RES_INTERMEDIATE)))) { iValue = 150; Valid = TRUE; } else if (str.IsIdentical(String_32(_R(IDS_RES_PRINT)))) { iValue = 200; Valid = TRUE; } else if (str.IsIdentical(String_32(_R(IDS_RES_PRINT300)))) { iValue = 300; Valid = TRUE; } else iValue = GetLongGadgetValue(DropListID, 1, 1000, 0, &Valid); if (pbValid) *pbValid = Valid; return iValue; }

INT32 DialogOp::GetScreenDpi (   )

Allows the user to find out the screen dpi. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Returns: 0 or the dpi of the screen. See also: DialogManager::GetScreenDpi; Definition at line 3530 of file dialogop.cpp. { return DialogManager::GetScreenDpi(); }

BOOL DialogOp::GetScreenSize (  INT32 *  pWidth, INT32 *  pHeight )

Allows the user to find out the screen size. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: pWidth  the screen width in pixels [OUTPUTS] pHeight the screen height in pixels Returns: True if worked ok, False otherwise. See also: DialogManager::GetScreenSize; Definition at line 3549 of file dialogop.cpp. { ERROR2IF(pWidth == NULL || pHeight == NULL,FALSE,"GetScreenSize Bad params!"); return DialogManager::GetScreenSize(pWidth, pHeight); }

INT32 DialogOp::GetSelectedCount (  CGadgetID  GadgetID  )

Returns the number of selected items in a list-type gadget. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: GadgetID  = ID of list-type gadget [INPUTS] Returns: The number of selected items in the list-type gadget, or -1 if it fails See also: - Definition at line 1691 of file dialogop.cpp. { return (DlgMgr->GetSelectedCount(GetReadWriteWindowID(), GadgetID)); }

INT32 * DialogOp::GetSelectedItems (  CGadgetID  GadgetID  )

Returns a ptr to an INT32 array that holds the list of selected indexes. The last array entry contains -1. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: GadgetID  = ID of list-type gadget [INPUTS] Returns: ptr to the INT32 array, or NULL if it fails The caller is responsible for deleting the array that's returned. e.g INT32* pArray = GetSelectedItems(WindowID,GadgetID); if (pArray != NULL) { ..... // Use the array delete [] pArray; } See also: - Definition at line 1737 of file dialogop.cpp. { return (DlgMgr->GetSelectedItems(GetReadWriteWindowID(),GadgetID)); }

INT32 DialogOp::GetSelectedValueIndex (  CGadgetID  GadgetID  )

A *SENSIBLE* interface to read which item of a combo/list box type of gadget is selected. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/94 Parameters: GadgetID  - the 'listy' gadget you wish to interrogate [INPUTS] Returns: -1 if no items are selected in the gadget Otherwise, the index of the selected item [0 .. numitems-1] See also: DialogOp::GetValueIndex; DialogOp::SetSelectedValueIndex Definition at line 1665 of file dialogop.cpp. { INT32 Index; BOOL Valid = DlgMgr->GetValueIndex(GetReadWriteWindowID(), GadgetID, &Index); if (Valid) return(Index); return(-1); // No selection, or some error }

String_256 DialogOp::GetStringGadgetValue (  CGadgetID  Gadget, BOOL *  Valid = NULL, INT32  ListPos = -1 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetStringGadgetValue Definition at line 1502 of file dialogop.cpp. { return (DlgMgr->GetStringGadgetValue(GetReadWriteWindowID(), Gadget, Valid, ListPos)); }

size_t DialogOp::GetTreeGadgetChildrenCount (  CGadgetID  Gadget, CTreeItemID  hItem, BOOL  bRecursive = FALSE )

Definition at line 3655 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetChildrenCount(GetReadWriteWindowID(), Gadget, hItem)); }

CTreeItemID DialogOp::GetTreeGadgetFirstChildItem (  CGadgetID  Gadget, CTreeItemID  hItem )

Definition at line 3650 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetFirstChildItem(GetReadWriteWindowID(), Gadget, hItem)); }

CTreeItemID DialogOp::GetTreeGadgetFirstSelectedItem (  CGadgetID  Gadget  )

Definition at line 3635 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetFirstSelectedItem(GetReadWriteWindowID(), Gadget)); }

CCObject * DialogOp::GetTreeGadgetItemData (  CGadgetID  Gadget, CTreeItemID  hItem )

Definition at line 3620 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetItemData(GetReadWriteWindowID(), Gadget, hItem)); }

CTreeItemID DialogOp::GetTreeGadgetNextVisItem (  CGadgetID  Gadget, CTreeItemID  hItem )

Definition at line 3645 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetNextVisItem(GetReadWriteWindowID(), Gadget, hItem)); }

CTreeItemID DialogOp::GetTreeGadgetRootItem (  CGadgetID  Gadget  )

Definition at line 3630 of file dialogop.cpp. { return (DlgMgr->GetTreeGadgetRootItem(GetReadWriteWindowID(), Gadget)); }

MILLIPOINT DialogOp::GetUnitGadgetValue (  CGadgetID  Gadget, UnitType  DefaultType, MILLIPOINT  StartRange, MILLIPOINT  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetUnitGadgetValue Definition at line 1298 of file dialogop.cpp. { return(DlgMgr->GetUnitGadgetValue(GetReadWriteWindowID(), Gadget, DefaultType, StartRange, EndRange, IDSInvalidMsg, Valid)); }

BOOL DialogOp::GetValueCount (  CGadgetID  GadgetID, INT32 *  Count )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetValueCount Definition at line 1642 of file dialogop.cpp. { return (DlgMgr->GetValueCount(GetReadWriteWindowID(), GadgetID, Count)); }

BOOL DialogOp::GetValueIndex (  CGadgetID  GadgetID, INT32 *  Index )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetValueIndex Definition at line 1778 of file dialogop.cpp. { return (DlgMgr->GetValueIndex(GetReadWriteWindowID(), GadgetID, Index)); }

BOOL DialogOp::GetValueIndex (  CGadgetID  GadgetID, WORD *  Index )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::GetValueIndex Definition at line 1758 of file dialogop.cpp. { return (DlgMgr->GetValueIndex(GetReadWriteWindowID(), GadgetID, Index)); }

BOOL DialogOp::GetWindowPosition (  RECT *  pRect  )

Definition at line 3437 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::GetWindowPosition(GetReadWriteWindowID(), pRect); }

BOOL DialogOp::GetWindowPosition (  wxRect *  pRect  )

Allows the user to get the current window position. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: Rect  pointer to the rectangle to fill in [OUTPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::SetWindowPosition; DialogManager::GetWindowPosition; Definition at line 3431 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::GetWindowPosition(GetReadWriteWindowID(), pRect); }

BOOL DialogOp::HasWindow (   )

To find out if DialogOp has a window associated with it. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 30/11/93 Returns: TRUE if this DialogOp has an associated window. SeeAlso DialogOp::IsWindowVisible Definition at line 396 of file dialogop.cpp. { return (WindowID != NULL); }

BOOL DialogOp::HideGadget (  CGadgetID  GadgetID, BOOL  Hide )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::HideGadget Definition at line 1841 of file dialogop.cpp. { return (DlgMgr->HideGadget(GetReadWriteWindowID(), GadgetID, Hide)); }

BOOL DialogOp::HighlightText (  CGadgetID  gadID, INT32  nStart = 0, INT32  nEnd = -1 )

Highlights the given range of text (by default all of it) within a control that holds editable text, eg. an edit field. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 10/11/94 Parameters: gadID  control ID within the window/dialogue box [INPUTS] nStart first letter to highlight (by default the very first) nEnd last letter to highlight (by default the very last) -  [OUTPUTS] Returns: TRUE if successful Errors: ERROR3 if you try to highlight text in a control without any, eg. a button or a scroller. See also: DialogManager::HighlightText Definition at line 1985 of file dialogop.cpp. { return DialogManager::HighlightText(GetReadWriteWindowID(), gadID, nStart, nEnd); }

void DialogOp::InvalidateGadget (  CGadgetID  Gadget, ReDrawInfoType *  ExtraInfo, DocRect *  InvalidRect )

Causes the Dialog Manager to tell the host os to get the cc_DialogDraw gadget to be redrawn, over the specfied rectangle. You should recieve a DIM_REDRAW message in the not too distant future. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 28/11/94 Parameters: Gadget  - The ID of the gadget that you want to be redrawn [INPUTS] ExtraInfo - The information passed to your DIM_ mouse event handler InvalidRect - The MILLIPOINT rectangle to invalidate, in the (0,0)->(dx,dy) coordinate space used in ReDrawInfoType. See also: DialogManager::InvalidateGadget Definition at line 2058 of file dialogop.cpp. { // Call the Dialog Manager DialogManager::InvalidateGadget(GetReadWriteWindowID(), Gadget, ExtraInfo, InvalidRect); }

void DialogOp::InvalidateGadget (  CGadgetID  Gadget, BOOL  EraseBackground = TRUE )

Causes the Dialog Manager to tell the host os to get the gadget to be redrawn. Calling this on a cc_DialogDraw gadget will cause you to receive a DIM_REDRAW message in the not too distant future. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 Parameters: Gadget  - The ID of the gadget that you want to be redrawn [INPUTS] EraseBackground TRUE if the background should be erased See also: DialogManager::InvalidateGadget Definition at line 2029 of file dialogop.cpp. { // Call the Dialog Manager DialogManager::InvalidateGadget(GetReadWriteWindowID(), Gadget, EraseBackground); }

virtual BOOL DialogOp::IsABar (   )  [inline, virtual]

Reimplemented in DialogBarOp, BlobbyBar, SuperGallery, and StandardBar. Definition at line 159 of file dialogop.h. { return FALSE; }

BOOL DialogOp::IsADialogWindow (  CWindowID  WndID  )  [static]

To find out if WndID is the window ID of a dialog. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/3/94 Parameters: WndID,:  The CWindowID to try and find [INPUTS] -  [OUTPUTS] Returns: TRUE if WndID is the window id of a dialog Errors: - See also: - Definition at line 2602 of file dialogop.cpp. { // Traverse the dialog list to see if WndID is a dialog window // Obtain the first live dialogOp List* DlgList = GetClassList(CC_RUNTIME_CLASS(DialogOp)); ListItem* CurrentOp = DlgList->GetHead(); while (CurrentOp != NULL) { if (((DialogOp*)CurrentOp)->WindowID == WndID) { return TRUE; } CurrentOp = DlgList->GetNext(CurrentOp); // Get next operation in the live list } return FALSE; }

virtual BOOL DialogOp::IsAGallery (   )  [inline, virtual]

Reimplemented in SuperGallery. Definition at line 160 of file dialogop.h. {return FALSE; }

BOOL DialogOp::IsCustomComboDropdownVisible (  CGadgetID  Gadget  )

Used to determin whether the custom controls dropdown is visible. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 21/2/2000 Parameters: Gadget,:  The Gadget to call this routine on [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 549 of file dialogop.cpp. { return (DlgMgr->IsCustomComboDropdownVisible(GetReadWriteWindowID(), Gadget)); }

BOOL DialogOp::IsGadgetEnabled (  CGadgetID  Gadget  )

For checking if a gadget is enabled/disabled. Author: Luke_Hart (Xara Group Ltd) <lukeh@xara.com> Date: 07/09/06 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier [OUTPUTS]  Returns: TRUE if enabled, else FALSE Errors: - See also: DialogOp::IsGadgetEnabled Definition at line 1821 of file dialogop.cpp. { return DlgMgr->IsGadgetEnabled( GetReadWriteWindowID(), Gadget ); }

BOOL DialogOp::IsGadgetTickable (  CGadgetID  Gadget  )

To determine if Gadget is of a particular type that can be ticked. eg. if the gadget is a button. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/6/95 Parameters: Gadget,:  The Gadget to test [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 484 of file dialogop.cpp. { return (DlgMgr->IsGadgetTickable(GetReadWriteWindowID(), Gadget)); }

BOOL DialogOp::IsModal (   )  [inline]

Definition at line 508 of file dialogop.h. { return (DlgMode == MODAL); };

BOOL DialogOp::IsOpen (   )

Don't use this function any more. It's ambiguous and marked for destruction. Call IsWindowVisible or HasWindow instead. This has been a public service announcement !!!! (Simon). Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/93 Returns: !!!!!!!!!!!!!!!!!!!! Bodge Definition at line 373 of file dialogop.cpp. { if( WindowID != NULL ) { return ( (wxWindow *)WindowID )->IsShown(); // <<< -------------- BODGE, BODGE, BODGE } else return FALSE; }

virtual BOOL DialogOp::IsVertical (   )  [inline, virtual]

Reimplemented in StandardBar. Definition at line 161 of file dialogop.h. { return FALSE; }

BOOL DialogOp::IsVisible (   )

Used by the tool bar customize system to find out if a tool bar is visible or not. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 29/4/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if this DialogOp is on screen Errors: - See also: - This function is a hangover from old bar days. You probably don't want to use it. Use Show() etc. which are orthogonal to this. This merely tells you whether there is a window ID there... FOR COMPATIBILITY ONLY Reimplemented in InformationBarOp. Definition at line 3048 of file dialogop.cpp. { return (WindowID != NULL); }

BOOL DialogOp::IsWindowVisible (   )

Find out if a dialog is shown or hidden. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>, function name changed by Simon Date: 9/11/93 Returns: TRUE if the window associated with this Op is visible. FALSE if not. Note the Window must exist to do this check. A call to HasWindow will verify this SeeAlso DialogOp::HasWindow Definition at line 526 of file dialogop.cpp. { ERROR2IF (WindowID != NULL, FALSE, "The window does not exist, Should have called HasWindow"); return (DlgMgr->IsWindowVisible(WindowID)); }

BOOL DialogOp::KillTimer (  INT32  nIDEvent  )

Allows the user access to killing a timer caller back or event that has been set up for a dialog box. Kills the timer event identified by nIDEvent from the earlier call to SetTimer. Any pending WM_TIMER messages associated with the timer are removed from the message queue. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Parameters: nIDEvent  Specifies a nonzero timer identifier. [INPUTS] Returns: True if the event was killed, FALSE if the specified timer event could not be found. See also: DialogOp::SetTimer; DialogManager::SetTimer; Definition at line 3407 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::KillTimer( this, GetReadWriteWindowID(), nIDEvent ); }

void DialogOp::Layout (  BOOL  CanYield = FALSE  )

Relayout dialog - for sizer changes. Author: Alex Bligh <alex@alex.org.uk> Date: 10/05/2006 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1879 of file dialogop.cpp. { DlgMgr->Layout(GetReadWriteWindowID(), CanYield); }

BOOL DialogOp::MakeListBoxDragable (  CGadgetID  ListGadget  )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 16/12/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::MakeListBoxDragable Definition at line 2419 of file dialogop.cpp. { return (DlgMgr->MakeListBoxDragable(GetReadWriteWindowID(), ListGadget)); }

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

if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; Handle Msg here } Pass message on to base class for rest of handling. return <BaseClass>Message(Message); This Pure virtual function will ENSURE Returns: Errors: - See also: MessageHandler IS_OUR_DIALOG_MSG Reimplemented from MessageHandler. Reimplemented in ArrangeAlignment, AppPrefsDlg, GIFAnimationPropertyTabsDlg, AnimExOptns, BarCreationDlg, BarStatesDlg, BarRedefineStateDlg, DialogBarOp, SystemBarOp, InformationBarOp, BfxDlg, BfxPlugInDlg, CBiasGainDlg, BlobbyDlg, BlobbyBar, BlobbyTabDlg, BmapPrevDlg, BitmapExportPreviewDialog, BmpPrefsDlg, JPEGExportPrefsDialog, PhotoCDDlg, BmpDlg, CBaseBrushNameDlg, CBrushEditDlg, CMXTreeDlg, ColourEditDlg, CXFTreeDlg, DaveDlg, DebugTreeDlg, DialogTabOp, ExtendSetsDlg, ImagemapDlg, FileInfo, GuidelinePropDlg, WebAddressDlg, InfoBarOp, LayerDlg, LayerNameDlg, LayerPropertyTabsDlg, NameDialog, NewColourDlg, NameGallery, BaseNameObjectsDlg, SepsDlg, UnitPropertiesDlg, PreviewDialog, PrintPrefsDlg, RenderDemoDlg, SelMediaDlg, SuperGallery, SGalleryOptionsDlg, SGallerySortDlg, SGallerySearchDlg, TEMPLATESGallery, BitmapSGallery, ColourSGallery, ColourNameDlg, FrameSGallery, LayerSGallery, LibraryGallery, LibClipartSGallery, LibFillsSGallery, LineGallery, NameGallery, NameObjectsDlg, StatusLine, StandardBar, TipsDlg, TemplateDialog, ToolbarDlg, ToolnameDlg, CustomizeBarDlg, TraceDlg, URLImportDlg, WebPrefsDlg, NativePrefsDlg, XSEPSExportOptions, BevelInfoBarOp, BezToolInfoBarOp, BlendInfoBarOp, BlankInfoBarOp, ContourInfoBarOp, GradInfoBarOp, TranspInfoBarOp, FreeHandInfoBarOp, GridInfoBarOp, LiveEffectsInfoBarOp, MouldInfoBarOp, PenToolInfoBarOp, QuickShapeBaseInfoBarOp, SelectorInfoBarOp, SliceInfoBarOp, TextInfoBarOp, ZoomInfoBarOp, PasteSpecialDlg, PrintProgressDlg, FontsSGallery, and SGalleryLinePropertiesDlg. Definition at line 2454 of file dialogop.cpp. { CheckMagic("DialogOp::Message");; if (MESSAGE_IS_A(Message, DocChangingMsg)) { // Get a pointer the correct type of message. DocChangingMsg *pDocMsg = (DocChangingMsg *) Message; if ( static_cast<OpMsg*> ( Message )->MsgType == (OpMsg::OpMsgType)DocViewMsg::SELCHANGED ) { // Selected document has changed: // Make sure we were actually up to date before.. if (pDocMsg->pOldDoc) { ERROR3IF(pOurDoc != pDocMsg->pOldDoc, "pOurDoc ptr is out of date in DialogOp::Message()"); } // Update our document pointer (might be NULL). pOurDoc = pDocMsg->pNewDoc; } } else if (MESSAGE_IS_A(Message, DocViewMsg)) { // Get a pointer the correct type of message. DocViewMsg *pDocViewMsg = (DocViewMsg *) Message; if ( static_cast<OpMsg*> ( Message )->MsgType == (OpMsg::OpMsgType)DocViewMsg::SELCHANGED ) { // Selected document has changed: // Make sure we were actually up to date before.. ERROR3IF(pOurView != (View *) pDocViewMsg->pOldDocView, "pOurView ptr is out of date in DialogOp::Message()"); // Update our view pointer. pOurView = (View *) pDocViewMsg->pNewDocView; } } else if (IS_OUR_DIALOG_MSG(Message)) { // We have an unhandled dialog message. If it is for a button with the appropriate // "help" resource/gadget ID then run some help for this dialog. DialogMsg* pDlgMsg = (DialogMsg*) Message; // Messages for individial controls with OpDescriptors need to be sent to that control if (pDlgMsg->GadgetID) { OpDescriptor *OpDesc = GetGadgetOpDescriptor(pDlgMsg->GadgetID); if (OpDesc) { // These tend to change bar state ControlList::Get()->Changed(); // Its a message for the current OpDescriptor // Convert the dialog message into a OpDescriptor control message BROADCAST_TO_CLASS( OpDescControlMsg(OpDesc, pDlgMsg->DlgMsg, OpDesc->GetBarControlInfo()->ControlID, OpDesc->GetBarControlInfo()->ResourceID, this), OpDescriptor); } } switch (pDlgMsg->DlgMsg) { case DIM_LFT_BN_CLICKED: case DIM_RGT_BN_CLICKED: // If they clicked on a "help" button then invoke the help system for this dialog. if (pDlgMsg->GadgetID == _R(ID_CC_HELP_BUTTON)) { // Invoke the help system and mark this message as completely processed. If we // don't and instead fall through to the base-class handler, the base class might // conceivably fail the message (as it doesn't know anything about it). HelpUser(*this); return DLG_EAT_IF_HUNGRY(pDlgMsg); } break; case DIM_TITLEFOCUSWARN: { // this indicates that the dialog has been moved, we need to send a message saying that the // screen has changed BROADCAST_TO_ALL(ScreenChangeMsg()); } break; case DIM_DLG_MOVED: { BROADCAST_TO_ALL(ScreenChangeMsg()); } break; case DIM_COMMIT: case DIM_CANCEL: case DIM_CREATE: case DIM_BAR_DEATH: { // These messages need to be propagated to all controls BOOL Destroy = ControlList::Get()->SendMessageToAllControls(this, pDlgMsg); // These messages need to be broadcast to all controls within the dialog // temporarily ALWAYS destroy if we get as far as here on a DIM_CANCEL if ((pDlgMsg->DlgMsg==DIM_CANCEL) || (pDlgMsg->DlgMsg==DIM_COMMIT) ||Destroy ) { Close(); End(); // the Op has now been deleted. Exit fast! return OK; //DlgMgr->Delete(WindowID, this); //WindowID = NULL; } break; } default: break; } // Pass to the base class for possibly more handling. If there isn't any then we // eat the message, as we know it's for this dialogue. MsgResult msgrslt = Operation::Message(Message); return (msgrslt == OK) ? DLG_EAT_IF_HUNGRY(pDlgMsg) : msgrslt; } // Not interested or possibly more to do - pass to base class. return Operation::Message(Message); }

void DialogOp::Open (   )

The open dialog method displays the dialog box. If Create was successful then this function cannot fail. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 13/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 317 of file dialogop.cpp. { ENSURE(WindowID != NULL, "Trying to open a dialog box which has not been created !"); // we may wish to subclass some of our controls, do so here AddControlsToHelper(); // open the dialog DlgMgr->Open(WindowID,this); }

void DialogOp::PaintGadgetNow (  CGadgetID  gid  )

Immediately paints any invalid areas the control may have (like the "UpdateWindow" function in Windows, really). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/94 Parameters: gid  the gadget ID of a control [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 2006 of file dialogop.cpp. { DialogManager::PaintGadgetNow(GetReadWriteWindowID(), gid); }

void DialogOp::ProfileSelectionChange (  DialogMsg *  Message, CGadgetID  GadgetID )  [protected]

Responds to CGadgetID's corresponding profile dialog messages. Profile changes are applied (internally) through ChangeProfile (). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 19/1/2000 Parameters: CBiasGainGadget&  and its GadgetID (for added safety) [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: InformationBarOp::ChangeProfile () Definition at line 3740 of file dialogop.cpp. { CProfileBiasGain* pBiasGainValue = NULL; switch (Message->DlgMsg) { case DIM_PROFILE_CHANGED: pBiasGainValue = reinterpret_cast<CProfileBiasGain* /*const**/>( Message->DlgMsgParam ); ChangeProfile( pBiasGainValue, GadgetID ); break; case DIM_PROFILE_CHANGING: if (m_bInteractiveProfiles == TRUE) { pBiasGainValue = reinterpret_cast<CProfileBiasGain* /*const**/>( Message->DlgMsgParam ); ChangeProfile( pBiasGainValue, GadgetID ); } break; case DIM_PROFILE_CHANGEIDLE: pBiasGainValue = reinterpret_cast<CProfileBiasGain* /*const**/>( Message->DlgMsgParam ); ChangeProfileOnIdle( pBiasGainValue, GadgetID ); break; default: break; } // end switch (message) }

BOOL DialogOp::ReleaseMouse (  CGadgetID  gadID  )

Releases the mouse captured by the given control. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 28/04/97 Parameters: gadID  ID of the "gadget" (control) which is to receive the [INPUTS] input focus -  [OUTPUTS] Returns: TRUE if successful. Errors: - See also: DialogManager::CaptureMouse; DialogManager::ReleaseMouse Definition at line 1961 of file dialogop.cpp. { return DialogManager::ReleaseMouse(GetReadWriteWindowID(), gadID); }

void DialogOp::RemoveControlsFromHelper (   )  [protected, virtual]

If you added some controls in AddControlsToHelper then you must remove them here. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 14/7/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: First implementation in BrushDlg.h/cpp, DialogControlHelper class (DlgCtHlp.h/.cpp) Reimplemented in CBrushEditDlg. Definition at line 462 of file dialogop.cpp. { return; }

BOOL DialogOp::RemoveDialogControlFromHelper (  CGadgetID  GadgetID, CDlgResID  PageID )  [protected]

Calls the dialog manager remove this control from the dialog control helper Overridden version. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 23/9/99 Parameters: GadgetID  [INPUTS] PageID - ID of the tabbed dialog page this control is on Definition at line 2331 of file dialogop.cpp. { // get the handle of the page first CWindowID PageWindow = DialogManager::GetPageWindow(WindowID, PageID); if (PageWindow == NULL) return FALSE; return DialogManager::RemoveDialogControlFromHelper(PageWindow, GadgetID); }

BOOL DialogOp::RemoveDialogControlFromHelper (  CGadgetID  GadgetID  )  [protected]

Calls the dialog manager remove this control from the dialog control helper. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 23/9/99 Parameters: GadgetID  [INPUTS] Definition at line 2313 of file dialogop.cpp. { return DialogManager::RemoveDialogControlFromHelper(GetReadWriteWindowID(), GadgetID); }

void DialogOp::ScrollKernelRenderedGadget (  CGadgetID  Gadget, DocRect *  RectToScroll, DocCoord *  ScrollBy )

Causes the Dialog Manager to tell the host os to get the cc_DialogDraw gadget to be scrolled, over the specfied rectangle. You should recieve a DIM_REDRAW message in the not too distant future, to update any portions that 'scroll into view'. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/1/95 Parameters: wid  - The Window identifier [INPUTS] Gadget - The ID of the gadget that you want to be redrawn RectToScroll - The MILLIPOINT rectangle to scroll, in the (0,0)->(dx,dy) coordinate space used in ReDrawInfoType structures. Think of this rectangle as the visible portion of the window which will be copied (some of which will be scrolled out of view), and let this method worry about invalidating the 'hole' left behind to finish off the display. This parameter may be NULL, in which case the entire gadget will be scrolled ScrollBy - Gives the X and Y amounts in millipoints to scroll the given rectangle. I don't know what will happen if neither of these values is zero! Notes: If you are using a Virtual coordinate space which differs from the (0,0)->(dx,dy) space that this requires, then you'll need to call some conversion methods which do not yet exist! See the dlgmgr version for fuller details See also: DialogManager::ScrollKernelRenderedGadget Definition at line 2101 of file dialogop.cpp. { // Call the Dialog Manager DialogManager::ScrollKernelRenderedGadget(GetReadWriteWindowID(), Gadget, RectToScroll, ScrollBy); }

BOOL DialogOp::SelectCustomComboGadgetValueOnString (  CGadgetID  Gadget, StringBase *  StrVal )

See DialogManager for a description of this function. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> S Date: 9/9/99 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SelectCustomComboGadgetValueOnString Definition at line 922 of file dialogop.cpp. { return (DlgMgr->SelectCustomComboGadgetValueOnString (GetReadWriteWindowID(), Gadget, StrVal)); }

BOOL DialogOp::SelectTreeGadgetItem (  CGadgetID  Gadget, CTreeItemID  hItem, BOOL  bNewState = TRUE )

Definition at line 3625 of file dialogop.cpp. { return (DlgMgr->SelectTreeGadgetItem(GetReadWriteWindowID(), Gadget, hItem, bNewState)); }

BOOL DialogOp::SendMessageToControl (  OpDescriptor *  OpDesc, DialogMsg *  DlgMsg, BOOL  Processed = FALSE )

Conditionally sends a message to a particular control pointed to by an opdescriptor,. Author: Alex Bligh Date: 03-Mar-2005 Parameters: Msg,:  The message to handle [INPUTS] -  [OUTPUTS] Returns: TRUE to destroy the window, else FALSE Errors: - See also: - The message is only sent if it is destined for that OpDescriptor - that's a broadcast, or if the dialog message has a gadget ID equal to that of the opdescriptor Definition at line 3699 of file dialogop.cpp. { BOOL DestroyWindow = FALSE; if (OpDesc) { // If the message is DIM_CANCEL then we must inform all OpDescriptors on the // bar that their controls are about to be destroyed. if (DlgMsg->DlgMsg == DIM_CANCEL||DlgMsg->DlgMsg == DIM_BAR_DEATH) { // Tell the OpDescriptor its controls are about to be destroyed OpDescControlDestroyMsg op(OpDesc, OpDesc->GetBarControlInfo()->ControlID, OpDesc->GetBarControlInfo()->ResourceID, this); OpDesc->Message(&op); DestroyWindow = TRUE; // Cos we are cancelling } else if (DlgMsg->DlgMsg == DIM_CREATE) { // Tell the OpDescriptor its controls have been created OpDescControlCreateMsg op(OpDesc, OpDesc->GetBarControlInfo()->ControlID, OpDesc->GetBarControlInfo()->ResourceID, this); OpDesc->Message(&op); } } return DestroyWindow; }

void DialogOp::SetBitmapButtonIndexes (  CGadgetID  GadgetID, UINT32  UnselectedIndex, UINT32  SelectedIndex )

Calls the dialog manager to set the bitmaps of the cc_bitmapbutton control. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 23/9/99 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] SelectedIndex - index for the selected state glyph UnselectedIndex - index for the unselected state glyph Definition at line 2254 of file dialogop.cpp. { // call the dialog manager function DialogManager::SetBitmapButtonIndexes(GetReadWriteWindowID(), GadgetID, SelectedIndex, UnselectedIndex); }

BOOL DialogOp::SetBoolGadgetSelected (  CGadgetID  Gadget, BOOL  IsSelected, INT32  ListPos = 0 )

An interface for turning option/radio buttons and list item selection states on or off. See DialogManager::SetBoolGadgetValue for details. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/7/94 Parameters: Gadget  - The Gadget to be set [INPUTS] IsSelected - TRUE to select, FALSE to deselect the gadget ListPos - The item (in list fields) to be affected -  [OUTPUTS] Returns: TRUE if it succeeded Errors: - See also: DialogManager::SetBoolGadgetValue Definition at line 765 of file dialogop.cpp. { return(DlgMgr->SetBoolGadgetSelected(GetReadWriteWindowID(), Gadget, IsSelected, ListPos)); // return(DlgMgr->SetLongGadgetValue(WindowID, Gadget, // (IsSelected) ? TRUE : FALSE, EndOfList, ListPos)); }

void DialogOp::SetComboListLength (  CGadgetID  Gadget  )

See DialogManager for a description of this function. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetUnitGadgetValue Definition at line 629 of file dialogop.cpp. { DlgMgr->SetComboListLength(GetReadWriteWindowID(),Gadget); }

BOOL DialogOp::SetCustomComboGadgetValue (  CGadgetID  Gadget, CustomComboBoxControlDataItem *  TheItem, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> S Date: 12/8/99 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetCustomComboGadgetValue Definition at line 895 of file dialogop.cpp. { #ifndef EXCLUDE_FROM_XARALX return( DlgMgr->SetCustomComboGadgetValue( GetReadWriteWindowID(), Gadget, TheItem, EndOfList, ListPos ) ); #else return FALSE; #endif }

BOOL DialogOp::SetDimensionGadgetValue (  CGadgetID  Gadget, MILLIPOINT  Value, Node *  pNode, BOOL  IncludeUnitSpecifier = TRUE, BOOL  EndOfList = FALSE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 15/6/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetDimensionGadgetValue Definition at line 1209 of file dialogop.cpp. { return(DlgMgr->SetDimensionGadgetValue(GetReadWriteWindowID(), Gadget, Value, pNode, IncludeUnitSpecifier, EndOfList, ListPos)); }

BOOL DialogOp::SetDimensionUnitGadgetValue (  CGadgetID  Gadget, UnitType  units, double  Value, Node *  pNode, BOOL  IncludeUnitSpecifier = TRUE, BOOL  EndOfList = FALSE, INT32  ListPos = -1 )

See DialogManager for a description of this function. Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/95 Definition at line 679 of file dialogop.cpp. { return DlgMgr->SetDimensionUnitGadgetValue(GetReadWriteWindowID(), Gadget, units, Value, pNode, IncludeUnitSpecifier, EndOfList, ListPos); }

BOOL DialogOp::SetDoubleGadgetValue (  CGadgetID  Gadget, double  value, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetLongGadgetValue Definition at line 737 of file dialogop.cpp. { return(DlgMgr->SetDoubleGadgetValue(GetReadWriteWindowID(), Gadget, value, EndOfList, ListPos)); }

void DialogOp::SetEditGadgetType (  CGadgetID  Gadget, UINT32  IDSValidChar )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetEditGadgetType Definition at line 2378 of file dialogop.cpp. { DlgMgr->SetEditGadgetType(GetReadWriteWindowID(), Gadget, IDSValidChar); }

void DialogOp::SetEditGadgetType (  CGadgetID  Gadget, EditGadgetType  Type )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetEditGadgetType Definition at line 2358 of file dialogop.cpp. { DlgMgr->SetEditGadgetType(GetReadWriteWindowID(), Gadget, Type); }

void DialogOp::SetGadgetBitmap (  CGadgetID  Gadget, ResourceID  Bitmap )

Calls the dialog manager to set the bitmaps of the gadget. Author: Alex Bligh <alex@alex.org.uk> Date: 07/05/2006 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] Bitmap - The ID of the bitmap Definition at line 2198 of file dialogop.cpp. { // Call the dialog Manager DialogManager::SetGadgetBitmap(GetReadWriteWindowID(), Gadget, Bitmap); }

void DialogOp::SetGadgetBitmaps (  CGadgetID  GadgetID, const CGadgetImageList &  imagelist )

Calls the dialog manager to set the bitmaps of the gadget. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] imagelist - list of images for this gadget Definition at line 2180 of file dialogop.cpp. { // Call the dialog Manager DialogManager::SetGadgetBitmaps(GetReadWriteWindowID(), GadgetID, imagelist); }

void DialogOp::SetGadgetBitmaps (  CGadgetID  GadgetID, UINT32  Bitmap1, UINT32  Bitmap2 )

Calls the dialog manager to set the bitmaps of the gadget (only for cc_Slider controls at the moment). Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: GadgetID  - The gadget to set the bitmaps of [INPUTS] Bitmap1 - The first Bitmaps ID Bitmap2 - The Second bitmaps ID Definition at line 2161 of file dialogop.cpp. { // Call the dialog Manager DialogManager::SetGadgetBitmaps(GetReadWriteWindowID(), GadgetID, Bitmap1, Bitmap2); }

BOOL DialogOp::SetGadgetHelp (  CGadgetID  Gadget, UINT32  BubbleID, UINT32  StatusID, UINT32  ModuleID = 0 )

See DialogManager for a description of this function. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 21/4/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetGadgetHelp Definition at line 1266 of file dialogop.cpp. { return(DlgMgr->SetGadgetHelp(GetReadWriteWindowID(), Gadget, BubbleID, StatusID, ModuleID)); }

BOOL DialogOp::SetGadgetPosition (  CGadgetID  Gadget, const RECT &  Rect )

Definition at line 3512 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::SetGadgetPosition(GetReadWriteWindowID(), Gadget, Rect); }

BOOL DialogOp::SetGadgetPosition (  CGadgetID  Gadget, const wxRect &  Rect )

Allows the user to set the current position of the specified icon or control. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: Rect  pointer to the rectangle to fill in [INPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::SetGadgetPosition; DialogManager::GetGadgetPosition; Definition at line 3506 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::SetGadgetPosition(GetReadWriteWindowID(), Gadget, Rect); }

BOOL DialogOp::SetGadgetRange (  CGadgetID  GadgetID, INT32  Min, INT32  Max, INT32  PageInc = 1 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetGadgetValue Definition at line 1135 of file dialogop.cpp. { return (DlgMgr->SetGadgetRange(GetReadWriteWindowID(), GadgetID, Min, Max, PageInc)); }

BOOL DialogOp::SetGadgetWritable (  CGadgetID  GadgetID, BOOL  enable )

Sets the state of the 'Read Only' flag of an edit field or combo box. Author: DMC Date: 15/11/94 Parameters: id,the  'IDC_?' of the control. [INPUTS] enable, TRUE to allow the control to be typed into. FALSE to make it read only. Definition at line 1859 of file dialogop.cpp. { return( DlgMgr->SetGadgetWritable( GetReadWriteWindowID(), GadgetID, enable ) ); }

BOOL DialogOp::SetKeyboardFocus (  CGadgetID  gadID  )

Sets the keyboard input focus to the given control. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 10/11/94 Parameters: gadID  ID of the "gadget" (control) which is to receive the [INPUTS] input focus -  [OUTPUTS] Returns: TRUE if successful. Errors: - See also: DialogManager::SetKeyboardFocus; DialogManager::DefaultKeyboardFocus Definition at line 1920 of file dialogop.cpp. { return DialogManager::SetKeyboardFocus(GetReadWriteWindowID(), gadID); }

BOOL DialogOp::SetLongGadgetValue (  CGadgetID  Gadget, INT32  value, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetLongGadgetValue Definition at line 711 of file dialogop.cpp. { return(DlgMgr->SetLongGadgetValue(GetReadWriteWindowID(), Gadget, value, EndOfList, ListPos)); }

BOOL DialogOp::SetMemoryGadgetValue (  CGadgetID  Gadget, UINT32  Value, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 30/1/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetMemoryGadgetValue; DialogManager::SetMemoryGadgetValue; Definition at line 1239 of file dialogop.cpp. { return(DlgMgr->SetMemoryGadgetValue(GetReadWriteWindowID(), Gadget, Value, EndOfList, ListPos)); }

BOOL DialogOp::SetRadioGroupSelected (  CGadgetID *  GroupGadgets, CGadgetID  SelectedGadget )

Allows you to select one of a group of gadgets, while ensuring that all other gadgets are disabled. Each item in the NULL_terminated list will be deselected, except the item 'SelectedGadget', which will be selected. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Parameters: GroupGadgets  - A NULL-terminated list of gadgets in the radio group [INPUTS] SelectedGadget - The gadget from this list which you wish to be selected -  [OUTPUTS] Returns: TRUE if it succeeded Errors: ERROR3 will occur if the list is empty, or if the SelectedGadget does not appear in the list. See also: DialogManager::SetBoolGadgetValue; DialogOp::GetRadioGroupSelected Definition at line 797 of file dialogop.cpp. { INT32 i = 0; INT32 returnval = 0; // Accumulator for BOOL return values #ifdef _DEBUG BOOL WasInList = FALSE; #endif while (GroupGadgets[i] != 0) { #ifdef _DEBUG if (GroupGadgets[i] == SelectedGadget) WasInList = TRUE; #endif returnval |= (INT32) SetBoolGadgetSelected(GroupGadgets[i], (GroupGadgets[i] == SelectedGadget)); i++; } #ifdef _DEBUG if (!WasInList) ERROR3("DialogOp::SetRadioGroupSelected - SelectedGadget is not in the list of radio gadgets"); #endif return(returnval != 0); }

void DialogOp::SetResDropListValue (  const CGadgetID  DropListID, const BOOL  bIncludeAuto = TRUE, const INT32  iValue = 0 )

Builds a drop down list for a combo box. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 10-06-2005 Definition at line 997 of file dialogop.cpp. { // TODO: // Get XML document from alongside exe // Discover index by comparing value against values in XML INT32 iAutoAdjust = bIncludeAuto ? 1 : 0; switch (iValue) { case 0: if (bIncludeAuto) { SetSelectedValueIndex(DropListID, 0); } break; // case 72: // SetSelectedValueIndex(DropListID, iAutoAdjust + 0); // break; case 96: SetSelectedValueIndex(DropListID, iAutoAdjust + 0); break; case 150: SetSelectedValueIndex(DropListID, iAutoAdjust + 1); break; case 200: SetSelectedValueIndex(DropListID, iAutoAdjust + 2); break; case 300: SetSelectedValueIndex(DropListID, iAutoAdjust + 3); break; default: { // Remove selected item from list first // otherwise is screws up the value we are about to put into the field SetSelectedValueIndex(DropListID, -1); TCHAR str[32]; String_32 strTemp(_R(IDS_RES_PPI_FORMAT)); camSnprintf( str, 32, strTemp, iValue ); String_32 strPPI(str); SetStringGadgetValue(DropListID, strPPI, FALSE, -1); } break; } }

BOOL DialogOp::SetSelectedValueIndex (  CGadgetID  Gadget, INT32  Index )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 20/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetSelectedValueIndex Definition at line 1156 of file dialogop.cpp. { return (DlgMgr->SetSelectedValueIndex(GetReadWriteWindowID(), Gadget, Index)); }

BOOL DialogOp::SetSelectedValueRange (  CGadgetID  Gadget, WORD  StartIndex, WORD  EndIndex, BOOL  Select = TRUE )

See DialogManager for a description of this function. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 29/04/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetSelectedValueIndex Definition at line 1180 of file dialogop.cpp. { return (DlgMgr->SetSelectedValueRange(GetReadWriteWindowID(), Gadget, StartIndex, EndIndex, Select)); }

BOOL DialogOp::SetStringGadgetValue (  CGadgetID  Gadget, const StringBase &  StrValue, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetStringGadgetValue Definition at line 869 of file dialogop.cpp. { return (DlgMgr->SetStringGadgetValue(GetReadWriteWindowID(), Gadget, StrValue, EndOfList, ListPos)); }

BOOL DialogOp::SetStringGadgetValue (  CGadgetID  Gadget, UINT32  IDStr, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

Definition at line 842 of file dialogop.cpp. { return(DlgMgr->SetStringGadgetValue(GetReadWriteWindowID(), Gadget, IDStr, EndOfList, ListPos)); }

UINT32 DialogOp::SetTimer (  UINT32  nIDEvent, UINT32  nElapse, void(*)(void *)  lpfnTimer = NULL, void *  param = NULL, BOOL  OneShot = FALSE )

Allows the user access to setting a timer caller back or event for a dialog box. The caller can either specify a call back procedure to be called when the timer goes off or if null is specified, a DIM_TIMER message will be sent. The return value is effectively the handle onto the timer system. It must be passed to the KillTimer member function to kill the timer. A Nonzero value indicates successful allocation of the timer; non-zero implies a problem. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 15/4/97 Parameters: nIDEvent  Specifies a nonzero timer identifier. [INPUTS] nElapse Specifies the time-out value, in milliseconds. param An opaque parameter sent to the timer function (along with nIDEvent) Returns: The timer identifier of the new timer if Nonzero, Zero means a problem. See also: DialogOp::KillTimer; DialogManager::SetTimer; Definition at line 3384 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::SetTimer( this, GetReadWriteWindowID(), nIDEvent, nElapse, lpfnTimer, param, OneShot ); }

BOOL DialogOp::SetTitlebarName (  String_256 *  Name  )

Sets the titlebar text. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 1/12/94 Parameters: The  title bar name [INPUTS] -  [OUTPUTS] Returns: FALSE if the function fails, otherwise TRUE Errors: - See also: - Definition at line 2639 of file dialogop.cpp. { return(DlgMgr->SetTitlebarName(GetReadWriteWindowID(), Name)); }

CTreeItemID DialogOp::SetTreeGadgetItem (  CGadgetID  Gadget, CTreeItemID  hParent, const StringBase &  str, CTreeItemID  hInsAfter, INT32  iImage, CCObject *  pObj = NULL )

Definition at line 3615 of file dialogop.cpp. { return (DlgMgr->SetTreeGadgetItem(GetReadWriteWindowID(), Gadget, hParent, str, hInsAfter, iImage, pObj)); }

BOOL DialogOp::SetUnitGadgetValue (  CGadgetID  Gadget, UnitType  Unit, MILLIPOINT  Value, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )

See DialogManager for a description of this function. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::SetUnitGadgetValue Definition at line 654 of file dialogop.cpp. { return(DlgMgr->SetUnitGadgetValue(GetReadWriteWindowID(), Gadget, Unit, Value, EndOfList, ListPos)); }

void DialogOp::SetVisibility (  BOOL  Visible  )  [virtual]

Used by the tool bar customize system to open and close a tool bar. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 29/4/94 Parameters: Open  - if TRUE then open DialogOp in its last pos if it is [INPUTS] currently closed. if FALSE, it is closed -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented in NameGallery, and SuperGallery. Definition at line 3070 of file dialogop.cpp. { if (Visible) { if (!WindowID) { Create(); } Open(); } else { Close(); } }

BOOL DialogOp::SetWindowPosition (  const RECT &  Rect  )

Definition at line 3487 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::SetWindowPosition(GetReadWriteWindowID(), Rect); }

BOOL DialogOp::SetWindowPosition (  const wxRect &  Rect  )

Allows the user to set the current window position. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: Rect  pointer to the rectangle to fill in [INPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::SetWindowPosition; DialogManager::GetWindowPosition; Definition at line 3481 of file dialogop.cpp. { // Call the Dialog Manager return DialogManager::SetWindowPosition(GetReadWriteWindowID(), Rect); }

BOOL DialogOp::TreeGadgetExpandItem (  CGadgetID  Gadget, CTreeItemID  hItem )

Definition at line 3640 of file dialogop.cpp. { return (DlgMgr->TreeGadgetExpandItem(GetReadWriteWindowID(), Gadget, hItem)); }

BOOL DialogOp::UpdateStringGadgetValue (  CGadgetID  Gadget, StringBase *  NewString )

Similar to SetStringGadgetValue but compares the contents of the gadget in the dialogue before the update and dosen't bother if the new value is the same as the current one. This reduces dialogue flicker. See also: DialogOp::SetStringGadgetValue. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 14/09/94 Parameters: Dialog  - pointer to the DialogOp containing the gadget. [INPUTS] Gadget - the gadget ID to update. NewString - the new contents of the gadget. Returns: TRUE if the dialogue was updated. FALSE if it wasn't. Definition at line 3572 of file dialogop.cpp. { String_256 OldString = GetStringGadgetValue(Gadget, NULL, -1); if (OldString != *NewString) { SetStringGadgetValue(Gadget, *NewString); return TRUE; } else { return FALSE; } }

---

Friends And Related Function Documentation

friend class DialogEventHandler [friend]

Definition at line 147 of file dialogop.h.

friend class DialogManager [friend]

Definition at line 148 of file dialogop.h.

---

Member Data Documentation

DialogManager* DialogOp::DlgMgr [protected]

Definition at line 497 of file dialogop.h.

CDlgMode DialogOp::DlgMode [protected]

Definition at line 490 of file dialogop.h.

CDlgResID DialogOp::DlgResID [protected]

Definition at line 488 of file dialogop.h.

BOOL DialogOp::m_bInteractiveProfiles [private]

Definition at line 547 of file dialogop.h.

UINT32 DialogOp::MagicWord [private]

Definition at line 546 of file dialogop.h.

INT32 DialogOp::PageToOpen [protected]

Definition at line 502 of file dialogop.h.

CWindowID DialogOp::ParentDlgWnd [protected]

Definition at line 493 of file dialogop.h.

DialogEventHandler* DialogOp::pEvtHandler [protected]

Definition at line 495 of file dialogop.h.

CDlgResID DialogOp::ReadWritePage [protected]

Definition at line 499 of file dialogop.h.

CDlgResID DialogOp::SubDlgID [protected]

Definition at line 489 of file dialogop.h.

CWindowID DialogOp::WindowID

Definition at line 469 of file dialogop.h.

---

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

• Kernel/dialogop.h (r1785/r1751)
• Kernel/dialogop.cpp (r1785/r1751)

---