DialogManager Class Reference

#include <dlgmgr.h>

Inheritance diagram for DialogManager:

List of all members.

Public Member Functions
	DialogManager ()
	DialogManager constructor. It allocates our special Property atom.
CWindowID	Create (DialogOp *DialogOp)
	~DialogManager ()
	DialogManager destructor.
void	SetPropertyPageModified (BOOL Value)
	Sets the modified property of the currently active property page of the current tabbed dialog (if it exists).
Static Public Member Functions
static BOOL	Create (DialogOp *DlgOp, CDlgResID MainDlgID, CDlgResID SubDlgID, CDlgMode Mode=MODELESS, INT32 OpeningPage=-1, CWindowID ParentWnd=NULL)
static void	Open (CWindowID WindowID, DialogOp *DlgOp)
static void	Close (CWindowID WindowID, DialogOp *DlgOp)
	The close method removes a modeless dialog from the display but keeps all system resources associated with it. It hides the dialog. It can be called on a modal dialog but it does nothing.
static BOOL	MergeDialogs (CWindowID Dialog, CWindowID Mergee, bool fAbove)
	This function places the contents of a dialog above or below the contents of an existing dialog.
static BOOL	BringToTop (CWindowID WindowID, DialogOp *pDlgOp)
	This function brings an open dialog to the top of the z-order.
static wxBookCtrlBase *	GetBookControl (CWindowID WindowID, CGadgetID Gadget=0)
	This function will return a pointer to the book control in a window. If the window is of type wxPropertySheetDialog then it Gadget is not required.
static BOOL	IsGadgetTickable (CWindowID WindowID, CGadgetID Gadget)
	Determines if the gadget is of a type that can be ticked.
static BOOL	ColourPickerAbort (CWindowID WindowID, CGadgetID Gadget, WPARAM wParam=0)
	Instructs camelots custom colour control (which I also wrote) to 'shutdown' and (indirectly) return control to the colour editor dialog.
static void	Delete (CWindowID WindowID, DialogOp *DlgOp)
	The delete method will delete all system resources and other information which is kept about the dialog. It also records the dialogs current position so that it can be restored the next time the dialog is created.
static void	ProcessMouseEvent (CDlgMessage DialogMessageType, wxWindow *pDlg, UINT32 wParam, INT32 lParam)
static wxWindow *	GetGadget (CWindowID WindowID, CGadgetID Gadget)
static OpDescriptor *	GetGadgetOpDescriptor (CWindowID WindowID, CGadgetID Gadget)
static BOOL	SetUnitGadgetValue (CWindowID WindowID, CGadgetID Gadget, UnitType Unit, MILLIPOINT value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	Send custom WM_SETBITMAPEX message to custom controls This method is used to set a gadget which should hold a number to a certain value. The actual type of the gadget does not matter.
static BOOL	SetDimensionUnitGadgetValue (CWindowID WindowID, CGadgetID Gadget, UnitType units, double value, Node *pNode, BOOL IncludeUnitSpecifier=TRUE, BOOL EndOfList=FALSE, INT32 ListPos=0)
	as SetDimensionGadgetValue() but you can specify the units in which it is displayed
static BOOL	SetLongGadgetValue (CWindowID WindowID, CGadgetID Gadget, INT32 value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This function is used to set a numeric gadget value. It performs different functions depending on the type of the gadget.
static BOOL	SetDoubleGadgetValue (CWindowID WindowID, CGadgetID Gadget, double value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This function is used to set a numeric gadget value. It performs different functions depending on the type of the gadget.
static BOOL	SetStringGadgetValue (CWindowID WindowID, CGadgetID Gadget, UINT32 IDStrID, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This function is used to set a gadgets value to a resource string. It can only be used on gadgets with a string value type.
static BOOL	SetStringGadgetValue (CWindowID WindowID, CGadgetID Gadget, const StringBase &StrVal, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This function is used to set a gadgets string value. It can only be used on gadgets with a string value type.
static BOOL	SetCustomComboGadgetValue (CWindowID WindowID, CGadgetID Gadget, CustomComboBoxControlDataItem *TheItem, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This function is used to set a CustomComboBoxes item (i.e. basically insert another item).
static BOOL	SelectCustomComboGadgetValueOnString (CWindowID WindowID, CGadgetID Gadget, StringBase *StrVal)
	This function is used to select an item (StrVal) within cc_2dBitmapComboBoxEdit custom comboboxes.
static BOOL	SetGadgetRange (CWindowID WindowID, CGadgetID Gadget, INT32 Min, INT32 Max, INT32 PageInc=1)
	For setting the range of a gadget.
static BOOL	SetListBoxSelection (CWindowID WindowID, CGadgetID Gadget, INT32 Index, BOOL SelectIt, BOOL SingleSelection)
	For selecting the Value specified by Index in a list Gadget. A subroutine used by the selection-setting DialogManager calls.
static BOOL	SetBoolGadgetSelected (CWindowID WindowID, CGadgetID Gadget, BOOL IsSelected, INT32 ListPos=0)
	For setting the selection state of a gadget, or an item within a list gadget.
static BOOL	SetSelectedValueIndex (CWindowID WindowID, CGadgetID Gadget, INT32 Index)
	For selecting the Value specified by Index in a list Gadget.
static BOOL	SetSelectedValueRange (CWindowID WindowID, CGadgetID Gadget, WORD StartIndex, WORD EndIndex, BOOL Selected=TRUE)
	For selecting the Value specified by Index in a list Gadget.
static BOOL	SetDimensionGadgetValue (CWindowID WindowID, CGadgetID Gadget, MILLIPOINT value, Node *pNode, BOOL IncludeUnitSpecifier=TRUE, BOOL EndOfList=FALSE, INT32 ListPos=-1)
	This is the routine to call for displaying a node's dimension in a control. It creates a string that represents 'Value' in the units the user wants, possibly scaled up/down if the user has specified a dimension scaling factor (e.g. 1 mile = 2 cm) Once the string is created, SetStringGadgetValue is called on the control, so you should be aware of this routine's features/limitations before calling SetDimensionGadgetValue.
static BOOL	SetMemoryGadgetValue (CWindowID WindowID, CGadgetID Gadget, UINT32 value, BOOL EndOfList=TRUE, INT32 ListPos=0)
	This method is used to set a gadget which should display an amount of memory being used or allocated. The value will be rounded to the nearest K or M or G byte value. The actual type of the gadget does not matter.
static BOOL	SetGadgetHelp (CWindowID WindowID, CGadgetID Gadget, UINT32 BubbleID, UINT32 StatusID, UINT32 ModuleID=0)
	Allows the Bubble and Status ID's of a control to be changed at runtime.
static MILLIPOINT	GetUnitGadgetValue (CWindowID WindowID, CGadgetID Gadget, UnitType DefaultType, MILLIPOINT StartRange, MILLIPOINT EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL)
	This function will obtain the gadget value and validate it. Validation will check that data has been entered in a correct unit type, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value.
static INT32	GetLongGadgetValue (CWindowID WindowID, CGadgetID Gadget, INT32 StartRange, INT32 EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, Convert::PFNSTRINGTOINT32 pfnParser=Convert::StringToLong)
	This function will obtain the gadget value and validate it. Validation will check that a correct INT32 value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value.
static double	GetDoubleGadgetValue (CWindowID WindowID, CGadgetID Gadget, double StartRange, double EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, Convert::PFNSTRINGTODOUBLE pfnParser=Convert::StringToDouble)
	This function will obtain the gadget value and validate it. Validation will check that a correct double value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value.
static BOOL	GetBoolGadgetSelected (CWindowID WindowID, CGadgetID Gadget, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL, INT32 ListPos=0)
	This function will obtain the gadget value and validate it. Validation will check that a correct INT32 value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. [This does not seem correct - AMB].
static String_256	GetStringGadgetValue (CWindowID WindowID, CGadgetID Gadget, BOOL *Valid=NULL, INT32 ListPos=-1)
	For finding a gadgets string value. This function can only be used for gadgets with a text value.
static BOOL	GetGadgetRange (CWindowID WindowID, CGadgetID Gadget, INT32 *Min, INT32 *Max)
	For obtaining the range of a gadget.
static MILLIPOINT	GetDimensionGadgetValue (CWindowID WindowID, CGadgetID Gadget, Node *pNode, BOOL *Valid=NULL, INT32 ListPos=-1)
	This is the routine to call for getting user-entered dimensions from a control. The value is scaled from user dimensions to an internal millipoint value. The routine uses DialogManager::GetStringGadgetValue to extract the string from the control. The caller should be aware of the features/limitations of this routine before calling GetDimensionGadgetValue.
static BOOL	GetDoubleAndUnitGadgetValue (double *pMPValue, double *pUnitValue, UnitType *pUnitType, CWindowID WindowID, CGadgetID Gadget, 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).
static UINT32	GetMemoryGadgetValue (CWindowID WindowID, CGadgetID Gadget, UINT32 StartRange, UINT32 EndRange, UINT32 IDSInvalidMsg=0, BOOL *Valid=NULL)
	This function allows a memory value to be read back from a control. It will cope with the memory being specified in bytes, K, M or G bytes and will also validate it. Validation will check that data has been entered in a correct unit type, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value.
static BOOL	DeleteAllValues (CWindowID WindowID, CGadgetID Gadget)
	For deleting all values in a list-gadget.
static BOOL	DeleteValue (CWindowID WindowID, CGadgetID Gadget, BOOL EndOfList=TRUE, INT32 ListPos=0)
	For deleting a gadget value.
static BOOL	GetValueCount (CWindowID WindowID, CGadgetID Gadget, INT32 *Count)
	For finding the number of values stored in a gadget.
static BOOL	GetValueIndex (CWindowID WindowID, CGadgetID Gadget, INT32 *Index)
	For finding the index of the currently selected item in a gadget.
static BOOL	GetValueIndex (CWindowID WindowID, CGadgetID Gadget, WORD *Index)
	For finding the index of the currently selected item in a gadget.
static INT32	GetSelectedCount (CWindowID WindowID, CGadgetID Gadget)
	Returns the number of selected items in a list-type gadget.
static INT32	GetFirstSelectedItem (CWindowID WindowID, CGadgetID Gadget)
	Returns the index of the first selected item in a list-type gadget.
static INT32 *	GetSelectedItems (CWindowID WindowID, CGadgetID Gadget)
	Returns a ptr to an INT32 array that holds the list of selected indexes. The last array entry contains -1.
static BOOL	EnableGadget (CWindowID WindowID, CGadgetID Gadget, BOOL Enabled)
	For enabling/disabling a gadget.
static BOOL	IsGadgetEnabled (CWindowID WindowID, CGadgetID Gadget)
	For checking if a gadget is enabled/disabled.
static BOOL	SetGadgetWritable (CWindowID id, CGadgetID Gadget, BOOL enable)
	Sets the state of the 'Read Only' flag of an edit field or combo box.
static BOOL	HideGadget (CWindowID WindowID, CGadgetID Gadget, BOOL Hide)
	For hiding/showing gadgets.
static BOOL	GadgetRedraw (CWindowID WindowID, CGadgetID Gadget, BOOL Redraw)
	This function sets a gadgets redraw state. If Redraw = FALSE then the gadget will not be redrawn when changes are made to it. Conversely if Redraw = TRUE then the Gadget will redraw itself after any changes are made.
static void	Layout (CWindowID WindowID, BOOL CanYield=FALSE)
	Relayout dialog - for sizer changes.
static void	RelayoutDialog (DialogTabOp *DlgOp)
	Force the dialog to relayout after control hide Scope: public.
static BOOL	SetKeyboardFocus (CWindowID WindowID, CGadgetID Gadget)
	Sets the keyboard focus to the given control.
static BOOL	DefaultKeyboardFocus ()
	Sets the keyboard focus to the "default" window, which currently is the main frame window (which in turn sets it to the active view window).
static BOOL	HighlightText (CWindowID WindowID, CGadgetID Gadget, 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.
static BOOL	CaptureMouse (CWindowID WindowID, CGadgetID Gadget)
	Allows the given control to Capture the mouse.
static BOOL	ReleaseMouse (CWindowID WindowID, CGadgetID Gadget)
	Release the mouse captured by the given control.
static void	PaintGadgetNow (CWindowID WindowID, CGadgetID gid)
	Immediate paints any invalid areas of the given control (like the Windows "UpdateWindow" function).
static void	InvalidateGadget (CWindowID WindowID, CGadgetID Gadget, BOOL EraseBackround=TRUE)
	Invalidates the control so that it will be repainted soon.
static void	InvalidateGadget (CWindowID WindowID, 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.
static void	ScrollKernelRenderedGadget (CWindowID WindowID, 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'.
static BOOL	GetKernelRenderedGadgetInfo (CWindowID WindowID, 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).
static void	SetEditGadgetType (CWindowID WindowID, CGadgetID Gadget, EditGadgetType Type)
	Subclasses the edit gadget so that it only accepts characters specified by the Type parameter.
static void	SetEditGadgetType (CWindowID WindowID, CGadgetID, UINT32 IDSValidChar)
	To subclass the edit gadget so that it only accepts characters in the string specified by IDSValidChar.
static void	DualFunctionButton (CWindowID DialogWnd, CGadgetID ButtonGadget)
	To subclass the button gadget so that it accepts right mouse button clicks.
static BOOL	MakeListBoxDragable (CWindowID WindowID, CGadgetID Gadget)
static void	SetComboListLength (CWindowID WindowID, CGadgetID Gadget)
static void	SetGadgetBitmaps (CWindowID DialogWnd, CGadgetID Gadget, UINT32 Bitmap1, UINT32 Bitmap2)
	This function will set the bitmaps associated with a gadget.
static void	SetGadgetBitmaps (CWindowID DialogWnd, CGadgetID Gadget, const CGadgetImageList &images)
	This function will set the bitmaps associated with a gadget.
static void	SetGadgetBitmap (CWindowID WindowID, CGadgetID Gadget, ResourceID Bitmap)
	This function will set the bitmaps associated with a gadget.
static ResourceID	GetGadgetBitmap (CWindowID WindowID, CGadgetID Gadget)
	This function will get the bitmaps associated with a gadget.
static void	SetBitmapButtonIndexes (CWindowID WindowID, CGadgetID Gadget, UINT32 UnselectedIndex, UINT32 SelectedIndex)
	This function allows you to specify bitmaps for both the selected and unselected states of a bitmap button. Most likely you have already selected your bitmap for the selected state in your resource file, however this allows you to specify the unselected state also.
static UINT32	GetGadgetImageCount (CWindowID wnd, CGadgetID Gadget)
	To get the number of images set in the trree control.
static void	DeInit ()
	Deinitialise the DialogManager.
static BOOL	IsADialogWindow (wxWindow *pWnd)
	To determine if hwnd is the handle of a dialog.
static CTreeItemID	SetTreeGadgetItem (CWindowID wnd, CGadgetID Gadget, CTreeItemID hParent, const StringBase &str, CTreeItemID hInsAfter, INT32 iImage, CCObject *pObj=NULL)
	To insert an item into a tree control.
static CCObject *	GetTreeGadgetItemData (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem)
	To insert an item into a tree control.
static BOOL	SelectTreeGadgetItem (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem, BOOL bNewState=TRUE)
	To select an item in a tree control.
static CTreeItemID	GetTreeGadgetRootItem (CWindowID wnd, CGadgetID Gadget)
	To get the ID of the root item in the tree control.
static CTreeItemID	GetTreeGadgetFirstSelectedItem (CWindowID wnd, CGadgetID Gadget)
	To get the ID of the first selected item in the tree control.
static BOOL	TreeGadgetExpandItem (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem)
	To expand an item in the tree control.
static CTreeItemID	GetTreeGadgetNextVisItem (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem)
	To get the ID of the next visible item in the tree control after a specified item.
static CTreeItemID	GetTreeGadgetFirstChildItem (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem)
	To get the ID of the first child item of the specified in the tree control.
static UINT32	GetTreeGadgetChildrenCount (CWindowID wnd, CGadgetID Gadget, CTreeItemID hItem, BOOL bRecursive=FALSE)
	To get the number of children of an item in a tree control.
static BOOL	AddAPage (DialogTabOp *pDialogTabOp, CDlgResID DialogResID, CGadgetID Gadget=0)
	Adds a page to the tabbed dialog with resource ID DialogResID.
static CWindowID	GetPageWindow (CWindowID Win, CDlgResID PageID, INT32 *PageIndex=NULL)
	Returns the Window ID of a page within a property sheet. If the page is NULL then Win is simply returned, It can be called on a non property sheet dialog. Just pretend that they are property sheets without any pages.
static BOOL	SetTitlebarName (CWindowID Win, String_256 *Name)
	Sets the titlebar text of the dialog.
static BOOL	ModalDialogOpen (DialogOp **pModal=NULL)
	To determine if there is currently an open modal dialog.
static BOOL	IsWindowVisible (CWindowID Win)
	To test the visibility of Win.
static BOOL	IsCustomComboDropdownVisible (CWindowID WindowID, CGadgetID Gadget)
	To test the visibility of WinID's dropdown.
static BOOL	CloseDropdown (CWindowID WindowID, 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).
static void	EnableAllDialogs (BOOL Enable, wxWindow *pExceptMe=NULL)
	Enables or Disables all Dialogs on the DialogOp message handler list. This is useful when opening/closing modal dialogs.
static BOOL	RecordActiveDialogState ()
	This function will get called before a MODAL dialog is opened. It records which window is currently active, and if the window is a MODAL dialog. After a MODAL dialog is closed RestoreActiveDialogState is called to restore the active window.
static void	RestoreActiveDialogState ()
	This function is called after a MODAL dialog is closed. it restores the Active window.
static CDlgResID	GetActivePage (CWindowID WindowID, CGadgetID Gadget=0)
	To find out the currently active page in a tabbed dialog.
static BOOL	AddDialogControlToHelper (CWindowID WindowID, CGadgetID Gadget)
	To add this control to the static dialog control helper, which will subclass it.
static BOOL	RemoveDialogControlFromHelper (CWindowID, CGadgetID)
	To add this control to the static dialog control helper, which will subclass it.
static BOOL	GetStatusLineText (String_256 *ptext, CWindowID window)
	Fills in the status line text from the help text if over a control Scope: Public.
static CWindowID	GetWindowUnderPointer (WinCoord *wc=NULL)
	Fills in the status line text from the help text if over a control Scope: Public.
static UINT32	SetTimer (DialogOp *pDialogOp, CWindowID WindowID, 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. This maps onto the Windows API/CWnd call. 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.
static BOOL	KillTimer (DialogOp *pDialogOp, CWindowID WindowID, 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.
static BOOL	GetWindowPosition (CWindowID WindowID, wxRect *pRect)
	Allows the user to get the current window position.
static BOOL	GetWindowPosition (CWindowID WindowID, RECT *pRect)
static BOOL	GetGadgetPosition (CWindowID WindowID, CGadgetID Gadget, wxRect *pRect)
	Allows the user to get the current position of the specified gadget or icon.
static BOOL	GetGadgetPosition (CWindowID WindowID, CGadgetID Gadget, RECT *pRect)
static BOOL	SetWindowPosition (CWindowID WindowID, const wxRect &Rect)
	Allows the user to set the current window position.
static BOOL	SetWindowPosition (CWindowID WindowID, const RECT &Rect)
static BOOL	SetGadgetPosition (CWindowID WindowID, CGadgetID Gadget, const wxRect &Rect)
	Allows the user to set the current position of the specified gadget or icon.
static BOOL	SetGadgetPosition (CWindowID WindowID, CGadgetID Gadget, const RECT &Rect)
static INT32	GetScreenDpi ()
	Allows the user to find out the screen dpi.
static BOOL	GetScreenSize (INT32 *pWidth, INT32 *pHeight)
	Allows the user to find out the screen size.
static void	FreePaneInfoHash ()
	Free the pane info hash if it exists Scope: protected.
Static Public Attributes
static wxWindow *	pDlgCurrent = NULL
Static Protected Member Functions
static void	Event (DialogEventHandler *pEvtHandler, wxEvent &event)
	OnCommand message handler. Translates a windows Command message into a DIM.
static void	EnsurePanePreferenceDeclared (wxString key)
	Ensures the relevant preference has been declared Scope: protected.
static void	InitPaneInfoHash ()
	Initializes the pane info hash if it has not been previously initialized Scope: protected.
static void	LoadPaneInfo (wxString key, wxAuiPaneInfo &paneinfo)
	Loads the pane info structure from the hash Scope: protected.
static void	SavePaneInfo (wxString key, wxAuiPaneInfo &paneinfo)
	Saves the pane info structure to the hash Scope: protected.
Static Protected Attributes
static IdToSerializedPaneInfo *	s_pPaneInfoHash = NULL
Static Private Member Functions
static void	CreateRecursor (wxWindow *pwxWindow)
	Initialize platform dependent resources.
static BOOL	CreateBar (DialogBarOp *DlgOp)
	Handles the creation of a bar Scope: private.
static BOOL	CreateTabbedDialog (DialogTabOp *pTabDlgOp, CDlgMode Mode, INT32 OpeningPage, CDlgResID MainDlgID)
	Handles the creation of a tabbed dialog Opening page allows a page to be specified that is not the initial page, which will be the default if this is the first time the dialog has been opened or if it has been opened before then the initial page will be the last one opened. Scope: private.
static BOOL	PostCreate (DialogOp *pDialogOp, INT32 OpeningPage)
	This function will get called after a dialog has been created. If a modeless dialog has been created then it gets called directly from the Create method. For a modal dialog however it gets called after receiving a WM_INIT_DIALOG message. It completes the creation process.
static void	DeletePropShtDetails (DialogTabOp *pOp)
static DLGTEMPLATE *	MergeDialog (CDlgResID Main, CDlgResID Other)
	Merge two dialogs together into one dialog template. The return value points to the new merged dialog, which the caller should pass to CreateDialogIndirect(). Once the dialog has been created using this block, CCFree() should be called on the block to return it to the system pool. The significance of the 'Main' and 'Other' names is that the dialog style (border, menuname, classname, title and font) is taken from 'Main' - the header of 'Other' is discarded.
static void	SetGadgetIDToFocus (wxWindow *pDialogWnd)
	If a child control of the dialog window has the focus then the function sets the Gadget to the ID of this control.
static List *	GetControlList (CWindowID)
	Hide the mechanism we use to attach our lists to various windows. In fact we use window properties.
static void	DeleteControlList (CWindowID)
	Deletes the Properties that are used to store the ControlList. Should be called as the very last thing before the Window is vaped e.g. in response to a WM_DESTROY message. Destroying it earlier will cause GetControlList to return NULL which proves fatal within the various message handlers. Scope: Private, static.
static LPWSTR	MovePastWideStr (LPWSTR pWideStr)
	Given a ptr to the first byte in a wide string (or char string if win16) return a ptr to the byte past the null.
static size_t	SizeDlgHeader (DLGTEMPLATE *pHeader)
	Given a ptr to DIALOGBOXHEADER, return its size.
static size_t	SizeCtrlData (DLGITEMTEMPLATE *pData)
	Given a ptr to a controldata struct, return its length. Under Win32, all strings are UniCode (as they are in the res file).
static wxPropertySheetDialog *	GetPropertySheetFromOp (DialogTabOp *pDialogTabOp)
static BOOL	HandleScrollBarMsg (wxWindow *pScrollWnd, UINT32 wParam, INT32 lParam, WORD CurrentThumbPos)
static DialogPosition *	FindDialogPositionRecord (CDlgResID DialogID)
	Searches the DialogPositionList to see if this dialog has been created before if it has then a pointer to its DialogPosition record is returned, else NULL is retuned. Scope: private.
static INT32 FAR PASCAL EXPORT	ValidateEditGadgetProc (wxWindow *pwnd, UINT32 message, UINT32 wParam, INT32 lParam)
	subclassed edit control proc
static INT32 FAR PASCAL EXPORT	RgtMouseButtonProc (wxWindow *pwnd, UINT32 message, UINT32 wParam, INT32 lParam)
	subclassed button control proc
static BOOL	CustomControlMsg (wxWindow *pwnd, UINT32 wParam, INT32 lParam)
	Handles custom control messages.
Static Private Attributes
static List	DiscardStrList
static List	DialogPositionList
static List	ScrollPageIncList
static UINT32	MsgDragList
static UINT32	MsgSlaveDrawItem
static ActiveDlgStateStack	ActiveDlgStack
Friends
class	DialogEventHandler
class	wxPropertySheetDialog

---

Detailed Description

Definition at line 330 of file dlgmgr.h.

---

Constructor & Destructor Documentation

DialogManager::DialogManager (   )

DialogManager constructor. It allocates our special Property atom. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/12/93 Definition at line 192 of file dlgmgr.cpp. { // we must use a unique string so we don't clash with anyone else }

DialogManager::~DialogManager (   )

DialogManager destructor. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 8/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::DeInit Definition at line 6428 of file dlgmgr.cpp. { }

---

Member Function Documentation

BOOL DialogManager::AddAPage (  DialogTabOp *  pDialogTabOp, CDlgResID  DialogResID, CGadgetID  Gadget = 0 )  [static]

Adds a page to the tabbed dialog with resource ID DialogResID. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/94 Parameters: pDialogTabOp,:  The operation we wish to add a page too [INPUTS] DialogResID: The resource ID of the dialog page we wish to add to the DialogTabOp Gadget The gadget of the book control to add the page to (or zero to take a good guess) -  [OUTPUTS] Returns: TRUE if the page was added successfully. Errors: - See also: - Definition at line 7003 of file dlgmgr.cpp. { // Try to add the page to the property sheet associated with the DialogTabOp // let's try and find it wxBookCtrlBase* pNoteBook = GetBookControl(pDialogTabOp->WindowID, Gadget); // We need to create a page object // Because wxNotebookPage is derived from an MFC object we have to cope with exceptions wxWindow* pNewPage; wxString ObjectName; try { const TCHAR* pDialogName=CamResource::GetObjectNameFail( DialogResID ); ERROR1IF(pDialogName == NULL, FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); TRACEUSER( "jlh92", _T("Cre tab %s\n"), pDialogName ); ObjectName = pDialogName; pNewPage = wxXmlResource::Get()->LoadPanel( pNoteBook, pDialogName ); ERROR1IF(pNewPage == NULL, FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); pNewPage->SetId( DialogResID ); CamArtProvider::Get()->EnsureChildBitmapsLoaded( pNewPage ); } catch( CMemoryException ) { ERROR1(FALSE, _R(IDS_OUT_OF_MEMORY)); } // Just to be safe ERROR1IF(pNewPage == NULL, FALSE, _R(IDS_OUT_OF_MEMORY)); wxString Title = wxEmptyString; if (pNewPage->IsKindOf(CLASSINFO(wxDialog))) Title=((wxDialog *)pNewPage)->GetTitle(); if (Title.IsEmpty()) Title = pNewPage->GetLabel(); // because wxPanel doesn't seem to support a title if( Title.IsEmpty() ) { ResourceID NameResID = CamResource::GetResourceID( PCTSTR(ObjectName) ); PCTSTR pszStringLookup = CamResource::GetTextFail( NameResID ); if( NULL != pszStringLookup ) { Title = pszStringLookup; TRACEUSER( "jlh92", _T("Page (FST) = \"%s\"\n"), pszStringLookup ); } } if( Title.IsEmpty() ) { // Finally, in desperation, we (mis-)use the tooltip string because now the wx folks have removed // the label, even though it's needed for accessibility. Aarrghh wxToolTip* pTip = pNewPage->GetToolTip(); if (pTip) Title=pTip->GetTip(); } wxImageList * pImageList = NULL; wxBitmap b; // Add images if present if (pDialogTabOp->HasImages()) { // Get the image list pImageList = pNoteBook->GetImageList(); wxBitmap * pBitmap = CamArtProvider::Get()->FindBitmap(DialogResID); if (!pBitmap || (pBitmap==CamArtProvider::Get()->GetMissingBitmap()) || !pBitmap->Ok()) { TRACEUSER("Phil", _T("Unable to use options tab icon %d\n"), DialogResID); int /*TYPENOTE: Correct */ w=32; int /*TYPENOTE: Correct */ h=32; if (pImageList) pImageList->GetSize(0, w, h); b = wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_OTHER, wxSize(w, h)); } else b= *pBitmap; // If there is no image list, create one if (!pImageList) { pImageList = new wxImageList(b.GetWidth(), b.GetHeight()); if (pImageList) pNoteBook->AssignImageList(pImageList); } } if (pImageList) pImageList->Add(b); pNoteBook->AddPage( pNewPage, Title ); if (pImageList) pNoteBook->SetPageImage(pNoteBook->GetPageCount()-1, pImageList->GetImageCount()-1); return true; }

BOOL DialogManager::AddDialogControlToHelper (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

To add this control to the static dialog control helper, which will subclass it. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 14/7/2000 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier [OUTPUTS]  Returns: TRUE if successful, else FALSE Definition at line 5103 of file dlgmgr.cpp. { // For the time being, we do this by Hide/Unhide wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; pGadget->Show(TRUE); return TRUE; }

BOOL DialogManager::BringToTop (  CWindowID  WindowID, DialogOp *  pDlgOp )  [static]

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] Returns: FALSE if the function failed. Definition at line 1087 of file dlgmgr.cpp. { ERROR2IF(!WindowID, FALSE, "BringToTop called on a dialog without a window"); ( (wxWindow *)WindowID )->Raise(); if (pDlgOp->pEvtHandler->wxAUImanaged) CCamFrame::GetMainFrame()->UpdateFrameManager(); return TRUE; }

BOOL DialogManager::CaptureMouse (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

Allows the given control to Capture the mouse. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 28/04/97 Parameters: WindowID  ID of the window / dialogue box containing . . . [INPUTS] Gadget ID of the "gadget" (control) to receive the focus -  [OUTPUTS] Returns: TRUE if successful. Errors: - See also: DialogManager::DefaultKeyboardFocus; DialogOp::SetKeyboardFocus Definition at line 5384 of file dlgmgr.cpp. { // Set the focus to the control within the given window/dialogue box. // For the time being, we do this by Hide/Unhide wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; pGadget->CaptureMouse(); return TRUE; }

void DialogManager::Close (  CWindowID  WindowID, DialogOp *  pDlgOp )  [static]

The close method removes a modeless dialog from the display but keeps all system resources associated with it. It hides the dialog. It can be called on a modal dialog but it does nothing. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: WindowID,:  Dialog's window identifier [INPUTS] pDlgOp: The DialogOp See also: DialogOp::Close Definition at line 1017 of file dlgmgr.cpp. { // Hide the dialog // Determine if we are hiding a bar PORTNOTE("dialog","Removed DialogBarOp usage") #ifndef EXCLUDE_FROM_XARALX if (pDlgOp->IsKindOf(CC_RUNTIME_CLASS(DialogBarOp))) { // Find the BaseBar object wxWindow* pCWnd = CWnd::FromHandlePermanent(WindowID); ENSURE(pCWnd != NULL, "Could not find bar object"); // Show the bar window if (pCWnd != NULL) { ((BaseBar*)pCWnd)->Hide((DialogBarOp*)pDlgOp); } } else #endif if (!(pDlgOp->IsModal())) // The delete method closes a modal dialog { ENSURE(WindowID != NULL,"NULL WindowID"); ( (wxWindow *)WindowID )->Show( false ); } if (pDlgOp->pEvtHandler->wxAUImanaged) CCamFrame::GetMainFrame()->UpdateFrameManager(); }

BOOL DialogManager::CloseDropdown (  CWindowID  WindowID, CGadgetID  Gadget, BOOL  CloseVal )  [static]

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: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if things went ok Errors: - See also: - Definition at line 6956 of file dlgmgr.cpp. { PORTNOTE("dialog","Programatic CB drop not supported by wx") return (TRUE); }

BOOL DialogManager::ColourPickerAbort (  CWindowID  WindowID, CGadgetID  Gadget, WPARAM  wParam = 0 )  [static]

Instructs camelots custom colour control (which I also wrote) to 'shutdown' and (indirectly) return control to the colour editor dialog. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/2000 Parameters: WindowID,:  Dialog's window identifier [INPUTS] Gadget: The colourpicker that this request is made upon (which is checked to ensure that it is a custom colour picker). Definition at line 1769 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::ColourPickerAbort - do nothing"); #ifndef EXCLUDE_FROM_XARALX // Currently the gadget is only tickable if it is a button HWND hGadget = GetDlgItem((HWND)WindowID, (INT32)Gadget); String_256 ClassNameStr; // The control type // Find out the class type of the gadget GetClassName(hGadget, (TCHAR*)ClassNameStr, 255); if (ClassNameStr == String_8(TEXT("cc_colPicker"))) { BOOL RetVal = FALSE; RetVal = SendMessage(hGadget, WM_COLOURPICKERABORT, wParam, 0); return (RetVal); } return (TRUE); ENSURE(FALSE, "Calling ColourPickerAbort for an invalid control"); #endif return FALSE; }

CWindowID DialogManager::Create (  DialogOp *  DialogOp  )

BOOL DialogManager::Create (  DialogOp *  DlgOp, CDlgResID  MainDlgID, CDlgResID  SubDlgID, CDlgMode  Mode = MODELESS, INT32  OpeningPage = -1, CWindowID  ParentWnd = NULL )  [static]

Definition at line 320 of file dlgmgr.cpp. { ERROR2IF(!DlgOp, FALSE, _T("Create Passed Null DialogOp")); ERROR2IF(DlgOp->pEvtHandler, FALSE, _T("Window has already been created. Having two is greedy")); DlgOp->pEvtHandler = new DialogEventHandler(DlgOp); ERRORIF(!DlgOp->pEvtHandler || !DlgOp->pEvtHandler->pDialogOp, FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); BOOL wxAUImanaged = FALSE; if ( DlgOp->IsABar() || DlgOp->IsAGallery() ) { BOOL modal = DlgOp->IsModal(); ERROR2IF(modal, FALSE, "Attempting to create a wxAUImanaged Dialog that is modal"); // They wanted a bar. Well, the main difference to us is we let wxAUI manage it. wxAUImanaged = TRUE; } // ERROR2IF( DlgOp->IS_KIND_OF(DialogBarOp), FALSE, _T("Bar creation not yet supported")); // ERROR2IF( DlgOp->IS_KIND_OF(DialogTabOp), FALSE, _T("Tabbed dialogs not yet supported")); ERROR2IF( SubDlgID !=0, FALSE, _T("Merging of dialogs not yet supported")); // if no parent dialog window specified use the main frame window if ((ParentWnd == NULL) || wxAUImanaged) ParentWnd = GetMainFrame(); const TCHAR* pDialogName = NULL; wxWindow* pDialogWnd = NULL; if( DlgOp->IS_KIND_OF(DialogTabOp) && !(((DialogTabOp*)DlgOp)->LoadFrameFromResources())) { // ok first try and create the property sheet wxDynamicPropertySheetDialog* pPropertySheet; // error handling done later pPropertySheet = new wxDynamicPropertySheetDialog(); if (pPropertySheet) { pPropertySheet->SetTabType(((DialogTabOp*)DlgOp)->GetTabType()); if (!pPropertySheet->Create((wxWindow *)ParentWnd, wxID_ANY, (TCHAR*) (*((DialogTabOp*)DlgOp)->GetName()) )) { delete pPropertySheet; pPropertySheet=NULL; // error handling done below } else { wxStdDialogButtonSizer *sizer = new wxStdDialogButtonSizer(); wxButton * ok=new wxButton(pPropertySheet, wxID_OK); sizer->AddButton(ok); // Add an OK button sizer->AddButton(new wxButton(pPropertySheet, wxID_CANCEL)); // Add a Cancel button sizer->AddButton(new wxButton(pPropertySheet, wxID_APPLY)); // Add an Apply button sizer->AddButton(new wxButton(pPropertySheet, wxID_HELP)); // Add a Help button ok->SetDefault(); ok->SetFocus(); pPropertySheet->SetAffirmativeId(wxID_OK); sizer->Realize(); pPropertySheet->GetInnerSizer()->Add( sizer, 0, wxGROW|wxALIGN_CENTER_VERTICAL|wxTOP|wxBOTTOM|wxLEFT|wxRIGHT, 2); pPropertySheet->GetInnerSizer()->AddSpacer(2); } } pDialogWnd=pPropertySheet; } else { pDialogName=CamResource::GetObjectNameFail(MainDlgID); ERROR1IF(pDialogName == NULL, FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); PORTNOTE("dialog","A more general scheme is needed to allow creation of a panel for non-toolbar type dialog") if (wxAUImanaged || _R(IDD_BITMAPPREVIEWDIALOG) == MainDlgID ) pDialogWnd = wxXmlResource::Get()->LoadPanel((wxWindow *)ParentWnd, pDialogName); else pDialogWnd = wxXmlResource::Get()->LoadDialog((wxWindow *)ParentWnd, pDialogName); } ERROR1IF(pDialogWnd == NULL, FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); pDialogWnd->Hide(); CamArtProvider::Get()->EnsureChildBitmapsLoaded(pDialogWnd); // On the Mac, panels etc. are by default transparent; fix them up #ifdef __WXMAC__ pDialogWnd->SetBackgroundStyle(wxBG_STYLE_COLOUR); pDialogWnd->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); #endif // Note that we might one day want to create (say) wxPanels, or wxToolbars instead above // It deosn't matter to us, we just want a wxWindow DlgOp->pEvtHandler->pwxWindow = pDialogWnd; DlgOp->pEvtHandler->wxAUImanaged = wxAUImanaged; DlgOp->pEvtHandler->ID =MainDlgID; // Set the DialogOp's WindowID DlgOp->WindowID = (CWindowID)pDialogWnd; pDialogWnd->PushEventHandler(DlgOp->pEvtHandler); if (DlgOp->IS_KIND_OF(DialogTabOp)) { // on balance we might be best ignoring errors here - we are really now past // the point of no return, and the dialog can be closed cleanly by the user // but let's try anyway if (!CreateTabbedDialog( (DialogTabOp*)DlgOp, Mode, OpeningPage, MainDlgID )) { // try using our own tolerant delete mechanism Delete(pDialogWnd, DlgOp); ERROR1(FALSE, _R(IDE_CANNOT_CREATE_DIALOG)); } } CreateRecursor(pDialogWnd); // Register all the child controls ControlList::Get()->RegisterWindowAndChildren(pDialogWnd, DlgOp); ControlList::Get()->ReflectAllStates(); // might as well do the processing before the bar / dialog appears // we call this directly now BOOL ok = PostCreate(DlgOp, OpeningPage); if( ok && Mode == MODAL && pDialogWnd->IsKindOf( CLASSINFO(wxDialog) ) ) { ((wxDialog *) pDialogWnd)->ShowModal(); } #ifdef USE_WXAUI if (wxAUImanaged) { wxString Title = wxEmptyString; if (pDialogWnd->IsKindOf(CLASSINFO(wxDialog))) Title=((wxDialog *)pDialogWnd)->GetTitle(); if (Title.IsEmpty()) Title = pDialogWnd->GetLabel(); // because wxPanel doesn't seem to support a title if (Title.IsEmpty()) { const TCHAR * ResString=CamResource::GetTextFail(pDialogWnd->GetId()); if (ResString) Title=wxString(ResString); } if (Title.IsEmpty()) { // Finally, in desperation, we (mis-)use the tooltip string because now the wx folks have removed // the label, even though it's needed for accessibility. Aarrghh wxToolTip* pTip = pDialogWnd->GetToolTip(); if (pTip) Title=pTip->GetTip(); } if (Title.IsEmpty()) Title = wxString(CamResource::GetText(_R(IDS_ANONYMOUSBARTITLE))); // We really should take a wxPaneInfo() as an additional parameter to this function to allow this sort // of stuff to be specified. Or try and retrieve it from the DialogBarOp or similar. Anyway, for now // give it some default parameters wxAuiPaneInfo paneinfo; if (!DlgOp->IsABar()) { // default galleries to 300 deep. Specifying -1 as a width doesn't seem to work paneinfo.FloatingSize(100,300); } LoadPaneInfo(wxString(CamResource::GetObjectName(pDialogWnd->GetId())), paneinfo); paneinfo.DestroyOnClose(FALSE); if (DlgOp->IsABar()) { if (DlgOp->IsKindOf(CC_RUNTIME_CLASS(StatusLine))) paneinfo.Bottom().Layer(1).Row(2).LeftDockable(FALSE).RightDockable(FALSE).Floatable(FALSE).Movable(FALSE).Gripper(FALSE).CaptionVisible(FALSE).PaneBorder(FALSE); else { paneinfo.ToolbarPane().Fixed(); if (DlgOp->IsVertical()) { paneinfo.Left().Layer(0).GripperTop().TopDockable(FALSE).BottomDockable(FALSE); } else { paneinfo.Top().Layer(1).Row(2).LeftDockable(FALSE).RightDockable(FALSE); } } } else { // Gallery paneinfo.Layer(3).GripperTop().TopDockable(FALSE).BottomDockable(FALSE).Float().Dockable(FALSE); // temporarilly stop galleries from docking } if (DlgOp->IsKindOf(CC_RUNTIME_CLASS(InformationBarOp))) { paneinfo.Floatable(FALSE); // temporarilly do not allow Info Bars to float as they can be closed // which means they can't be reopened (no UI), and wxAUI rightly objects to the // tool switch that deletes them deleting the window. } paneinfo.Name(pDialogName).Caption(Title).PinButton(TRUE); wxSizer * pSizer = pDialogWnd->GetSizer(); if (pSizer) { pSizer->SetSizeHints(pDialogWnd); pDialogWnd->SetSizerAndFit(pSizer); } // Ensure the main frame is shown if the pane is floating, or it can get "behind" // the main frame on wxGTK if (paneinfo.IsFloating() && !CCamFrame::GetFrameManager()->GetManagedWindow()->IsShown()) CCamFrame::GetFrameManager()->GetManagedWindow()->Show(); CCamFrame::GetFrameManager()->AddPane(pDialogWnd, paneinfo); CCamFrame::GetMainFrame()->UpdateFrameManager(); // Make sure newly created floating panes are at the top in an attempt to fix // Bugzilla bug 1393 (can't duplicate here...) wxWindow * pTLW = pDialogWnd; while (pTLW->GetParent()) pTLW=pTLW->GetParent(); if (pTLW->IsKindOf(CLASSINFO(wxAuiFloatingFrame))) pTLW->Raise(); } #endif return ok; }

BOOL DialogManager::CreateBar (  DialogBarOp *  DlgOp  )  [static, private]

Handles the creation of a bar Scope: private. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 5/12/94 Parameters: DlgOp,:  The DialogBarOp to create [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::Create Definition at line 7642 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::CreateBar - do nothing"); #ifndef EXCLUDE_FROM_XARALX BaseBar* DBWnd = NULL; // We need to create a DialogBar object if ( DlgOp->IsKindOf(CC_RUNTIME_CLASS(SuperGallery)) ) { #ifdef EXCLUDE_GALS return FALSE; #else DBWnd = new GalleryBar(); #endif } else { DBWnd = new DialogBar(); } if (DBWnd != NULL) { // Attempt to create the window if(!(DBWnd->Create((DialogBarOp*)DlgOp))) // Should set the error code { delete DBWnd; } } else { ERROR1(FALSE, _R(IDS_OUT_OF_MEMORY)); // Failed to create the DialogBar } #endif return TRUE; }

void DialogManager::CreateRecursor (  wxWindow *  pwxWindow  )  [static, private]

Initialize platform dependent resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pWindow  - pointer to window to process [INPUTS] None  [OUTPUTS] Returns: None Errors: - See also: - Definition at line 560 of file dlgmgr.cpp. { // Process this one wxPlatformDependent::Get()->InitWindow(pwxWindow); // bodge OD combo boxes not to have scroll bars so often if (pwxWindow->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { ((wxOwnerDrawnComboBox*)pwxWindow)->SetPopupMaxHeight(600); ((wxOwnerDrawnComboBox*)pwxWindow)->SetPopupAnchor(wxLEFT); } // Now process children if any wxWindowList::Node * pNode = pwxWindow->GetChildren().GetFirst(); while (pNode) { CreateRecursor(pNode->GetData()); pNode = pNode->GetNext(); } return; }

BOOL DialogManager::CreateTabbedDialog (  DialogTabOp *  pTabDlgOp, CDlgMode  Mode, INT32  OpeningPage, CDlgResID  mainDlgID )  [static, private]

Handles the creation of a tabbed dialog Opening page allows a page to be specified that is not the initial page, which will be the default if this is the first time the dialog has been opened or if it has been opened before then the initial page will be the last one opened. Scope: private. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 5/12/94 Parameters: DlgOp,:  The DialogTabOp to create [INPUTS] CDlgMode: MODAL/MODELESS OpeningPage: Override the page which is active (defaults to -1) -  [OUTPUTS] Returns: - Errors: - See also: DialogManager::Create Definition at line 7727 of file dlgmgr.cpp. { wxBookCtrlBase * pBook = GetBookControl(pTabDlgOp->WindowID); if (!pBook) return TRUE; // nothing to do // Before we can create the property sheet we must add pages to it. // Let's ask the op do do this for us if (!(pTabDlgOp->RegisterYourPagesInOrderPlease())) { // We failed to add pages to the dialog so we must tidy-up and fail return FALSE; } #if 0 // Something very odd happens with the image list so we copy and reset it if (pBook->GetImageList()) { wxImageList temp=*pBook->GetImageList(); pBook->SetImageList(&temp); } #endif // Get the dialog sized to fit RelayoutDialog(pTabDlgOp); // Scroll to start and end after yeild ::wxYield(); pBook->SetSelection(pBook->GetPageCount()-1); pBook->SetSelection(0); // First check if the OpeningPage parameter is not equal to -1, in which case this // specifies the active page to be opened. // Has to be an index as otherwise we have not specified the pages yet and so cannot // convert the PageID into an index which is what the PropertySheets require. UINT32 ActivePageIndex = 0; if (OpeningPage != -1) { // Set the index of the page that is to be the active one to the one that has // been specified. ActivePageIndex = OpeningPage; } else { // Determine if this dialog has been created before DialogPosition* pPosDetails = FindDialogPositionRecord( mainDlgID ); if (pPosDetails != NULL) { // The dialog has been created before so find out the index of the active page ActivePageIndex = pPosDetails->ActivePageIndex; } } // Now that the pages have been registered, check if the dialog has been opened // before. If so force the new ActivePage to be specified rather than the old. if (OpeningPage != -1) { // Determine if this dialog has been created before DialogPosition* pPosDetails = FindDialogPositionRecord( mainDlgID ); if (pPosDetails != NULL) { // The dialog has been created before so check if the specified page was the // last active one. If it was then everything should be ok. // if (OpeningPage != pPosDetails->ActivePageIndex) // { ERROR3IF(pBook == NULL, "There is no current PropertySheet"); wxNotebookPage* pPage = (wxNotebookPage*)(pBook->GetPage(OpeningPage)); ERROR3IF(pPage == NULL, "There is no active page"); pPosDetails->ActivePage = pPage->GetId(); TRACEUSER( "MarkH", _T("CreateTabbedDialog ActivePage = %d\n"),pPosDetails->ActivePage); // pPosDetails->ActivePage = 27666; pPosDetails->ActivePageIndex = OpeningPage; // } } } return TRUE; }

BOOL DialogManager::CustomControlMsg (  wxWindow *  pDlg, UINT32  wParam, INT32  lParam )  [static, private]

Handles custom control messages. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Parameters: hdlg,:  Dialog HWND [INPUTS] -  [OUTPUTS] Returns: TRUE if message handled Errors: - See also: - Definition at line 5884 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::CustomControlMsg - do nothing"); #ifndef EXCLUDE_FROM_XARALX String_256 ClassNameStr; GetClassName( HWND(lParam), (TCHAR*)ClassNameStr, 255); if ((ClassNameStr == String_16(TEXT("cc_BitmapButton")))|| ClassNameStr == String_16(TEXT("cc_SmallButton"))) { Gadget = HIWORD(wParam); switch (LOWORD(wParam)) { case BN_CLICKED: DialogManager::DIM = DIM_LFT_BN_CLICKED; DialogManager::HandleMessage = TRUE; return TRUE; case BN_BUTTONUP: DialogManager::DIM = DIM_LFT_BN_UP; DialogManager::HandleMessage = TRUE; return TRUE; case WM_MOUSEMOVE: DialogManager::DIM = DIM_MOUSE_MOVE; DialogManager::HandleMessage = TRUE; return TRUE; default: TRACEUSER( "JustinF", _T("Unknown message ID in DialogManager::CustomControlMsg\n")); break; } } #endif return FALSE; // Not a custom control message }

BOOL DialogManager::DefaultKeyboardFocus (   )  [static]

Sets the keyboard focus to the "default" window, which currently is the main frame window (which in turn sets it to the active view window). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 10/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if successful. Errors: - See also: DialogManager::SetKeyboardFocus; DialogOp::SetKeyboardFocus Definition at line 5444 of file dlgmgr.cpp. { // Set the focus to the main window, which will in turn set it to the active view. GetMainFrame()->SetFocus(); return TRUE; }

void DialogManager::DeInit (  void   )  [static]

Deinitialise the DialogManager. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 8/9/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 6361 of file dlgmgr.cpp. { // Because this function is called from CCamApp::SaveAllModified, of all places, // it gets called twice on system shutdown (once on receipt of WM_QUERYENDSESSION, // which itself calls CCamApp::SaveAllModified, and once on receipt of WM_ENDSESSION, // which performs a SC_CLOSE system command which ultimately also calls SaveAllModified. // This flags is a bodge for v1.1 to stop this happening, a better solution would be // to rewrite the dialog manager to be more rational. // It's not currently broken this way changed TRACE to ERROR3- Alex static BOOL fCalledOnceBodge = FALSE; if (!fCalledOnceBodge) fCalledOnceBodge = TRUE; else { ERROR3( wxT("DialogManager::DeInit called twice - please fix me properly sometime\n") ); return; } // save current bar state - this should check whether save prefs on exit is set!!!! PORTNOTE("dialog","Removed IsFullScreenMode usage") #ifndef EXCLUDE_FROM_XARALX if( GetMainFrame()->IsFullScreenMode() ) DialogBarOp::WriteNamedBars("clean"); else DialogBarOp::WriteNamedBars("normal"); #endif // Send a CANCEL message to all open dialogs BROADCAST_TO_CLASS(DialogMsg(NULL, DIM_CANCEL, 0), DialogOp); // BODGE Special nasty stuff for v1 release. // InformationBarOp is completely deaf to the message broadcast above so we must // make sure their windows are destroyed (manually) InformationBarOp::SetVisibility(FALSE, TRUE); // Delete all Dialog position info ListItem* DlgPos = DialogPositionList.GetHead(); ListItem* NextPos; while (DlgPos != NULL) { // Make sure that all dialogs have been deleted. ENSURE( ((DialogPosition*)DlgPos)->DlgWinList.IsEmpty(), "Live Dialog box found whilst destoying dialog manager"); NextPos = DialogPositionList.GetNext(DlgPos); delete DialogPositionList.RemoveItem(DlgPos); DlgPos = NextPos; } // We do not delete s_pPaneInfoHash here because the preferences have not been written out }

void DialogManager::Delete (  CWindowID  WindowID, DialogOp *  pDlgOp )  [static]

The delete method will delete all system resources and other information which is kept about the dialog. It also records the dialogs current position so that it can be restored the next time the dialog is created. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: WindowID,:  Dialog's window identifier [INPUTS] pDlgOp: The DialogOp See also: DialogOp::Delete Definition at line 1811 of file dlgmgr.cpp. { ERROR2IF (!pDlgOp, (void)0, "No dialog op to DialogManager::Delete()"); ERROR2IF (!WindowID, (void)0, "No window to DialogManager::Delete()"); if (!pDlgOp->pEvtHandler) { ERROR3("DialogManager::Delete() No dialog op event handler - has this window been deleted twice?"); return; } // If we've already been destroyed (by something else) - a situation which should never happen - then // return without doing anything if (pDlgOp->pEvtHandler && pDlgOp->pEvtHandler->m_GrimReaperSent) { TRACEALL(_T("DialogManager::Delete() Window has been deleted by something else, then Delete() called")); return; } if (((wxWindow *)WindowID)->IsBeingDeleted()) { ERROR3("Trying to delete a window that is already being deleted, has an event handler, but has not sent grim reaper"); return; } wxBookCtrlBase * pBook=NULL; // Only do special processing for DialogTabOp if (pDlgOp->IS_KIND_OF(DialogTabOp)) pBook=GetBookControl(WindowID); // ResourceID BookGadget=pBook?pBook->GetId():0; // See if the dialogs has a position record (If it's a DialogBarOp it won't have one) DialogPosition* DlgPos = (DialogPosition*)DialogPositionList.GetHead(); CWindowIDItem* WinID; while(DlgPos != NULL) { // Search the DlgWinList for the DlgPos for WindowID WinID = (CWindowIDItem*)DlgPos->DlgWinList.GetHead(); while (WinID != NULL) { if ((WinID->DlgWin) == WindowID) // Found the dialogs position record { // The Dialogs window is about to be destroyed so delete the WinID from the // DlgWinList of DlgPos. delete(DlgPos->DlgWinList.RemoveItem((ListItem*)WinID)); goto FoundPos; // What a rebel } WinID = (CWindowIDItem*)DlgPos->DlgWinList.GetNext((ListItem*)WinID); } // Get the next position record DlgPos = ((DialogPosition*)DialogPositionList.GetNext((ListItem*)DlgPos)); } // No DialogPosition record was found so must be a DialogBarOp FoundPos: wxWindow *pCWnd = (wxWindow *)WindowID; if (DlgPos != NULL) { // Record the dialog's position so that it can be restored if the dialog is created again wxRect DialogRect( pCWnd->GetRect() ); DlgPos->LastX = DialogRect.x; DlgPos->LastY = DialogRect.y; DlgPos->ActivePage = 0; DlgPos->ActivePageIndex = 0; // If the dialog is tabbed then we need to record the active page as well // We can't find the runtime class of the DialogOp at this point because Delete can be called // from its destructor if (pBook) { wxNotebookPage* pPage = pBook->GetCurrentPage(); if (pPage) { DlgPos->ActivePage = pPage->GetId(); // Store the pages index as well GetPageWindow(WindowID, DlgPos->ActivePage, &(DlgPos->ActivePageIndex)); } else ERROR3("There is no active page"); } } if (pDlgOp->pEvtHandler->wxAUImanaged) { wxAuiPaneInfo paneinfo = CCamFrame::GetMainFrame()->GetFrameManager()->GetPane(pCWnd); if (paneinfo.IsOk()) SavePaneInfo(wxString(CamResource::GetObjectName(pCWnd->GetId())), paneinfo); // Remove the bar from wxAUI CCamFrame::GetMainFrame()->GetFrameManager()->DetachPane(pCWnd); CCamFrame::GetMainFrame()->UpdateFrameManager(); } // Delete all discardable strings associated with the dialog DlgDiscardString* DiscardStr = (DlgDiscardString*)(DiscardStrList.GetHead()); while (DiscardStr != NULL) // While there are still strings to delete { DlgDiscardString* Next = (DlgDiscardString*)(DiscardStrList.GetNext(DiscardStr)); if (DiscardStr->DlgWindow == WindowID) // The string belongs to the dialog being // deleted { delete (DiscardStr->pStr); // Delete the string delete(DiscardStrList.RemoveItem(DiscardStr)); // Delete the DiscardStr record } DiscardStr = Next; // Get next string record } // Delete all scrollPageInc information associated with the dialog ScrollPageInc* PgInc = (ScrollPageInc*)(ScrollPageIncList.GetHead()); while (PgInc != NULL) { ScrollPageInc* Next = (ScrollPageInc*)(ScrollPageIncList.GetNext((ListItem*)PgInc)); if( PgInc->pDlgWindow == WindowID ) // The ScrollPageInc record belongs to the dialog // being deleted. delete (ScrollPageIncList.RemoveItem( (ListItem*)PgInc) ); // Delete the // ScrollPageInc record PgInc = Next; // Get next record } // Delete all ControlInfo records List* ControlInfoList = GetControlList( (wxWindow *)WindowID ); // Kill of Dropdowns DropDown::KillDropDownsByWindow(WindowID); CGridDropDown::KillDropDownsByWindow(WindowID); // Remove new-form control list ControlList::Get()->RemoveWindowAndChildren((wxWindow *)WindowID); // We are about to destroy the window. Disconnecting our event handler sounds like a good // idea at this point, as Destroy() does not destroy the window immediately, so there // is a possibility of receiving further events ((wxWindow *)WindowID)->PopEventHandler(FALSE); // leave the DialogOp's destructor to delete it pDlgOp->pEvtHandler->Destroy(); if (pDlgOp->IsModal() && WindowID->IsKindOf(CLASSINFO(wxDialog))) // A normal Modal { ( (wxDialog *)WindowID )->EndModal( TRUE ); ( (wxWindow *)WindowID )->Destroy(); } else { ( (wxWindow *)WindowID )->Destroy(); } if (ControlInfoList) { // Its one of our special windows with an attached list while (!ControlInfoList->IsEmpty()) delete(ControlInfoList->RemoveHead()); // Delete the ControlInfo list delete (ControlInfoList); ControlInfoList = NULL; } // Restore the active/disabled window state if (pDlgOp->IsModal()) { // DialogManager::RestoreActiveDialogState(); } DefaultKeyboardFocus(); // All spick and span }

BOOL DialogManager::DeleteAllValues (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

For deleting all values in a list-gadget. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/5/94 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Returns: TRUE if the values could be deleted, else FALSE. For Windows ----------- This function can be used to delete list items from ComboBox, ListBox, or cc_ListBox controls. ALL items in the given Gadget will be deleted (i.e. it resets the list to containing no items at all. This is equivalent to calling DeleteValue for each list item in turn) Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::DeleteAllValues; DialogManager::DeleteValue Definition at line 4683 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; //if ( pGadget->IsKindOf(CLASSINFO(wxControlWithItems)) ) // Includes wxListBox - this seems to have false positives if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { ((wxControlWithItems *)pGadget)->Clear(); return TRUE; } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { ((wxOwnerDrawnComboBox *)pGadget)->Clear(); return TRUE; } else if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { ((wxTreeCtrl*)pGadget)->DeleteAllItems(); return TRUE; } ERROR3("Invalid control"); return FALSE; }

void DialogManager::DeleteControlList (  CWindowID  hWnd  )  [static, private]

Deletes the Properties that are used to store the ControlList. Should be called as the very last thing before the Window is vaped e.g. in response to a WM_DESTROY message. Destroying it earlier will cause GetControlList to return NULL which proves fatal within the various message handlers. Scope: Private, static. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 14/11/94 Parameters: A  Window handle [INPUTS] Definition at line 6484 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::DeleteControlList - do nothing"); #ifndef EXCLUDE_FROM_XARALX RemoveProp( hWnd, MAKEINTATOM(GetListAtom) ); #ifndef WIN32 RemoveProp( hWnd, MAKEINTATOM(GetListAtomSegment) ); #endif #endif }

static void DialogManager::DeletePropShtDetails (  DialogTabOp *  pOp  )  [static, private]

BOOL DialogManager::DeleteValue (  CWindowID  WindowID, CGadgetID  Gadget, BOOL  EndOfList = TRUE, INT32  ListPos = 0 )  [static]

For deleting a gadget value. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 9/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier The following inputs only need to be provided if the gadget has multiple values, for example a ListBox. EndOfList: TRUE if the value is to be deleted from the end of the gadgets value list. (Default = TRUE) ListPos: If EndOfList = FALSE then this input specifies the position in the list (Default = 0, so if you want to delete the value at the top of the list simply specify EndOfList = FALSE) Returns: TRUE if the value could be deleted, else FALSE. For Windows ----------- This function can be used to delete list items from ListBox or ComboBox controls. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::DeleteValue Definition at line 4753 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; //if ( pGadget->IsKindOf(CLASSINFO(wxControlWithItems)) ) // Includes wxListBox - this seems to have false positives if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { if (EndOfList) ((wxControlWithItems *)pGadget)->Delete(((wxControlWithItems *)pGadget)->GetCount()-1); else ((wxControlWithItems *)pGadget)->Delete(ListPos); return TRUE; } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { if (EndOfList) ((wxOwnerDrawnComboBox *)pGadget)->Delete(((wxOwnerDrawnComboBox *)pGadget)->GetCount()-1); else ((wxOwnerDrawnComboBox *)pGadget)->Delete(ListPos); return TRUE; } ERROR3("Invalid control"); return FALSE; }

void DialogManager::DualFunctionButton (  CWindowID  DialogWnd, CGadgetID  ButtonGadget )  [static]

To subclass the button gadget so that it accepts right mouse button clicks. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 7/9/93 Parameters: DialogWnd,:  Dialog box window identifier [INPUTS] ButtonGadget: Button gadget identifier -  [OUTPUTS] Returns: - Errors: - See also: DialogOp::DualFunctionButton Definition at line 6126 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::DualFunctionButton - do nothing"); #ifndef EXCLUDE_FROM_XARALX // This function should only be called for a button control HWND hGadget = GetDlgItem((HWND)DialogWnd, (INT32)ButtonGadget); #if _DEBUG String_256 ClassNameStr; GetClassName(hGadget, (TCHAR*)ClassNameStr, 255); ENSURE((ClassNameStr == String_8(TEXT("Button"))), "DualFunctionButton function called\n" "on a gadget which is not a button"); #endif ControlInfo* ControlInfoPtr; // This structure will be passed to the // RgtMOuseButtonProc. ControlInfoPtr = new ControlInfo; ControlInfoPtr->pControlWnd = hGadget; ControlInfoPtr->lpfnOldProc = (FARPROC) GetWindowLong(hGadget, GWL_WNDPROC); // Store the button control info in the dialog's Edit control info list GetControlList( DialogWnd )->AddHead(ControlInfoPtr); FARPROC lpfnDualFn = MakeProcInstance((FARPROC) DialogManager::RgtMouseButtonProc, AfxGetApp()->m_hInstance); // Subclass the control so that it calls the new button proc SetWindowLong(hGadget, GWL_WNDPROC, (INT32) lpfnDualFn ); #endif }

void DialogManager::EnableAllDialogs (  BOOL  Enable, wxWindow *  pExceptMe = NULL )  [static]

Enables or Disables all Dialogs on the DialogOp message handler list. This is useful when opening/closing modal dialogs. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 Parameters: Enable,:  When TRUE all dialogs are enabled [INPUTS] ExceptMe: An optional dialog to exclude. If a modal dialog X has just been created then all dialogs except X will need disabling Parameters: -  [OUTPUTS] Returns: - Definition at line 5939 of file dlgmgr.cpp. { // Obtain a list of all live dialogs List *pDlgList = MessageHandler::GetClassList( CC_RUNTIME_CLASS(DialogOp) ); ERROR3IF( pDlgList == NULL, "Could not find the DialogOp Class List" ); if( NULL != pDlgList ) { ListItem *CurrentOp = pDlgList->GetHead(); DialogOp *pDlgOp; while( CurrentOp != NULL ) { if (CurrentOp->IS_KIND_OF(DialogOp)) // They all should be { pDlgOp = (DialogOp*)CurrentOp; // Determine if the dialog has an associated window if (pDlgOp->HasWindow()) { if (pDlgOp->WindowID != pExceptMe) { ( (wxWindow *)pDlgOp->WindowID )->Enable( FALSE != Enable ); } } } CurrentOp = pDlgList->GetNext(CurrentOp); // Get next operation in the live list } } // For some reason, the green bit of code below did not disable common dialogs. Therefore // the semi-bodge below was added to disable the active window. wxWindow *pActiveWindow = wxWindow::FindFocus(); if( NULL != pActiveWindow ) { if( pActiveWindow != pExceptMe ) { pActiveWindow->Enable( FALSE != Enable ); } } }

BOOL DialogManager::EnableGadget (  CWindowID  WindowID, CGadgetID  Gadget, BOOL  Enabled )  [static]

For enabling/disabling a gadget. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Enabled: TRUE if the gadget is to be enabled. FALSE if the gadget is to be disabled. [OUTPUTS]  Returns: TRUE if successful, else FALSE For Windows ----------- This function can be called for all controls Returns: Errors: - See also: DialogOp::EnableGadget Definition at line 5160 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; pGadget->Enable( FALSE != Enabled ); return (TRUE); }

void DialogManager::EnsurePanePreferenceDeclared (  wxString  key  )  [static, protected]

Ensures the relevant preference has been declared Scope: protected. Author: Alex Bligh <alex@alex.org.uk> Date: 25/07/06 Parameters: key  - the key the pane info will be stored under [INPUTS] None  [OUTPUTS] Returns: None Definition at line 821 of file dlgmgr.cpp. { if (!s_pPaneInfoHash) InitPaneInfoHash(); if (!s_pPaneInfoHash) return; IdToSerializedPaneInfo::iterator i=s_pPaneInfoHash->find(key); if (i==s_pPaneInfoHash->end()) { // ok, it's not in the hash, so it can't have been declared as a preference // yet. So we will declare it as a preference now (*s_pPaneInfoHash)[key]=_T(""); i=s_pPaneInfoHash->find(key); if (i==s_pPaneInfoHash->end()) { ERROR3("This hash leaks like a seive"); return; } // -------------------------------------------------------------------------- // Detect first-time run and make Open File dialog default to Examples folder if (Camelot.DeclareSection(_T("BarPositions"), 10)) { Camelot.DeclarePref( NULL, (TCHAR *)(key.c_str()), &(i->second) ); } } }

void DialogManager::Event (  DialogEventHandler *  pEvtHandler, wxEvent &  event )  [static, protected]

OnCommand message handler. Translates a windows Command message into a DIM. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 16/9/93 Returns: Errors: - See also: - Definition at line 1110 of file dlgmgr.cpp. { WXTYPE EventType = event.GetEventType(); // CDlgMessage DIM = DIM_NONE; ResourceID id = event.GetId(); UINT_PTR DlgMsgParam = 0; INT32 PageID = 0; BOOL HandleMessage=FALSE; BOOL Defer=TRUE; if (!pEvtHandler->pwxWindow || !pEvtHandler->pDialogOp) { // We are in the process of destruction event.Skip(); return; } // First handle events we previously asked to defer processing of if (event.IsKindOf(CLASSINFO(wxCamDialogEvent)) && (EventType == wxEVT_CAMDIALOG_DEFERREDMSG)) { // We posted this event and asked it to come back later, and it duly has wxCamDialogEvent * pDialogEvent = (wxCamDialogEvent *)(&event); pDialogEvent->msg.DlgWndID = pEvtHandler->pwxWindow; // this ensures we are using a valid window pointer // Send it around BROADCAST_TO_CLASS( DialogMsg(pDialogEvent->msg), DialogOp ); return; } wxWindow * pGadget = NULL; if (id) pGadget = GetGadget(pEvtHandler->pwxWindow, id); // We tend to get this second-hand from our child, we handle this differently if( !pGadget && (event.GetEventObject() != pEvtHandler->pwxWindow)) { pGadget = (wxWindow *)event.GetEventObject(); id = pGadget->GetId(); } // Try and find-out whether our control is part of a tabbed dialog page if( NULL != pGadget ) { // pEvtHandler->pwxWindow maybe our immediate wxPanel\wxDialog, but won't // be in case of tabbed dialog wxWindow* pDialog = pGadget->GetParent(); while( NULL != pDialog && !pDialog->IsKindOf( CLASSINFO(wxDialog) ) && !pDialog->IsKindOf( CLASSINFO(wxPanel) ) ) { pDialog = pDialog->GetParent(); } // Could this be part of a tabbed dialog? if( NULL != pDialog && pDialog->IsKindOf( CLASSINFO(wxPanel) ) ) { // A parent of type wxBookCtrlBase would synch it wxWindow *pDialogParent = pDialog->GetParent(); if( NULL != pDialogParent && pDialogParent->IsKindOf( CLASSINFO(wxBookCtrlBase) ) ) PageID = pDialog->GetId(); } } // Make up a default message DialogMsg msg(pEvtHandler->pwxWindow, DIM_NONE, id, DlgMsgParam, PageID); if (!event.IsKindOf(CLASSINFO(wxMouseEvent))) // MouseEvents are too noisy { TRACEUSER("amb",_T("event %d(%s) received, ID=%d(%s), wxw=%llx"), EventType, DialogEventHandler::GetEventName(EventType), id, CamResource::GetObjectName((ResourceID)id), pEvtHandler->pwxWindow); } if ( (EventType == wxEVT_LEFT_DCLICK) || (EventType == wxEVT_MIDDLE_DCLICK) || (EventType == wxEVT_RIGHT_DCLICK) || FALSE) { // OK, these are a bit deadly. We expected there to be TWO mouse up mouse downs. People // don't seem to hang off double clicks themselves, but do their own double click handling // (why oh why). So we generate an extra mouse down and mouse up, and sending them to // ourselves. This may not be necessary on all platforms. wxMouseEvent *MouseDown = (wxMouseEvent *)(event.Clone()); wxMouseEvent *MouseUp = (wxMouseEvent *)(event.Clone()); if (MouseDown && MouseUp) { if (EventType == wxEVT_LEFT_DCLICK) { MouseDown->SetEventType(wxEVT_LEFT_DOWN); MouseUp->SetEventType(wxEVT_LEFT_UP); } else if (EventType == wxEVT_MIDDLE_DCLICK) { MouseDown->SetEventType(wxEVT_MIDDLE_DOWN); MouseUp->SetEventType(wxEVT_MIDDLE_UP); } else { MouseDown->SetEventType(wxEVT_RIGHT_DOWN); MouseUp->SetEventType(wxEVT_RIGHT_UP); } //MouseDown.SetEventObject(pEvtHandler->pwxWindow); // MouseUp.SetEventObject(pEvtHandler->pwxWindow); // set it for processing later pEvtHandler->pwxWindow->GetEventHandler()->ProcessEvent(*MouseDown); pEvtHandler->pwxWindow->GetEventHandler()->ProcessEvent(*MouseUp); } if (MouseDown) delete MouseDown; if (MouseUp) delete MouseUp; } /* Here is a list of possible command events wxEVT_COMMAND_BUTTON_CLICKED wxEVT_COMMAND_CHECKBOX_CLICKED wxEVT_COMMAND_CHOICE_SELECTED wxEVT_COMMAND_LISTBOX_SELECTED wxEVT_COMMAND_LISTBOX_DOUBLECLICKED wxEVT_COMMAND_CHECKLISTBOX_TOGGLED wxEVT_COMMAND_TEXT_UPDATED // only with WXWIN_COMPATIBILITY_EVENT_TYPES wxEVT_COMMAND_TEXT_ENTER // only with WXWIN_COMPATIBILITY_EVENT_TYPES wxEVT_COMMAND_TEXT_URL // only with WXWIN_COMPATIBILITY_EVENT_TYPES wxEVT_COMMAND_TEXT_MAXLEN // only with WXWIN_COMPATIBILITY_EVENT_TYPES wxEVT_COMMAND_MENU_SELECTED wxEVT_COMMAND_SLIDER_UPDATED wxEVT_COMMAND_RADIOBOX_SELECTED wxEVT_COMMAND_RADIOBUTTON_SELECTED wxEVT_COMMAND_SCROLLBAR_UPDATED // Obselete - see wxWVT_SCROLL wxEVT_COMMAND_VLBOX_SELECTED wxEVT_COMMAND_COMBOBOX_SELECTED wxEVT_COMMAND_TOOL_RCLICKED wxEVT_COMMAND_TOOL_ENTER wxEVT_COMMAND_SPINCTRL_UPDATED We can't use switch on these - GRRR! */ if ( (EventType == wxEVT_COMMAND_BUTTON_CLICKED) || FALSE) { // We should cope with Right Button here if ((ResourceID)id == _R(wxID_OK) ) { msg.DlgMsg = DIM_COMMIT; HandleMessage = TRUE; } else if (id == _R(ID_CC_APPLY_NOW)) { // Clicking on the apply now button is the same as a soft commit msg.DlgMsg = DIM_SOFT_COMMIT; HandleMessage = TRUE; } else if (id == _R(wxID_CANCEL)) { msg.DlgMsg = DIM_CANCEL; // Do not defer processing of clicks on the close button because the default handler may destroy the window on // exit from this call Defer=FALSE; HandleMessage = TRUE; } else if (id == _R(wxID_HELP)) { // Our clients expect this ID, so keep them happy msg.DlgMsg = DIM_LFT_BN_CLICKED; msg.GadgetID = _R(ID_HELP); HandleMessage = TRUE; } else { msg.DlgMsg = DIM_LFT_BN_CLICKED; HandleMessage = TRUE; } } else if ( (EventType == wxEVT_COMMAND_CHOICE_SELECTED) || (EventType == wxEVT_COMMAND_LISTBOX_SELECTED) || (EventType == wxEVT_COMMAND_CHECKLISTBOX_TOGGLED) || // We skip this because it's generated when we change the text ourselves. We should probably do something more subtle // (EventType == wxEVT_COMMAND_TEXT_UPDATED) || // only with WXWIN_COMPATIBILITY_EVENT_TYPES (EventType == wxEVT_COMMAND_TEXT_URL) || // only with WXWIN_COMPATIBILITY_EVENT_TYPES // (EventType == wxEVT_COMMAND_TEXT_MAXLEN) || // only with WXWIN_COMPATIBILITY_EVENT_TYPES (EventType == wxEVT_COMMAND_MENU_SELECTED) || // (EventType == wxEVT_COMMAND_SLIDER_UPDATED) || (EventType == wxEVT_COMMAND_RADIOBOX_SELECTED) || (EventType == wxEVT_COMMAND_VLBOX_SELECTED) || (EventType == wxEVT_COMMAND_COMBOBOX_SELECTED) || (EventType == wxEVT_COMMAND_SPINCTRL_UPDATED) || (( (EventType == wxEVT_SCROLL_CHANGED) || (EventType == wxEVT_SCROLL_THUMBTRACK) || (EventType == wxEVT_SCROLL_THUMBRELEASE) || (EventType == wxEVT_SCROLL_LINEUP) || (EventType == wxEVT_SCROLL_LINEDOWN) || (EventType == wxEVT_SCROLL_PAGEUP) || (EventType == wxEVT_SCROLL_PAGEDOWN) ) && !( (pGadget && pGadget->IsKindOf(CLASSINFO(wxSlider))) || (pGadget && pGadget->IsKindOf(CLASSINFO(wxSliderCombo))) ) ) || // Don't handle slider scroll stuff here (EventType == wxEVT_COMMAND_TREE_SEL_CHANGED) || FALSE) { msg.DlgMsg = DIM_SELECTION_CHANGED; msg.DlgMsgParam = NO_COMMIT; HandleMessage = TRUE; } else if( EventType == wxEVT_COMMAND_TEXT_UPDATED && // only with WXWIN_COMPATIBILITY_EVENT_TYPES pGadget == wxWindow::FindFocus() ) { msg.DlgMsg = DIM_TEXT_CHANGED; HandleMessage = TRUE; } else if( (EventType == wxEVT_COMMAND_TEXT_ENTER) || FALSE) { msg.DlgMsg = DIM_SELECTION_CHANGED; msg.DlgMsgParam = ENTER_COMMIT; HandleMessage = TRUE; } else if( (( (EventType == wxEVT_SCROLL_THUMBTRACK) || (EventType == wxEVT_SCROLL_LINEUP) || (EventType == wxEVT_SCROLL_LINEDOWN) || (EventType == wxEVT_SCROLL_PAGEUP) || (EventType == wxEVT_SCROLL_PAGEDOWN) ) && (pGadget && ( pGadget->IsKindOf(CLASSINFO(wxSlider)) || pGadget->IsKindOf(CLASSINFO(wxSliderCombo)) ))) || FALSE) // Handle slider movements - note SCROLL_CHANGED always comes later { msg.DlgMsg = DIM_SLIDER_POS_CHANGING; HandleMessage = TRUE; } else if( // Do not handle THUMB_RELEASE because we get a SCROLL_CHANGED anyway, and having two means we generate two SETs which will generate 2 undo records // on (for instance) transparency and Bevel tools ((/*EventType == wxEVT_SCROLL_THUMBRELEASE ||*/ EventType == wxEVT_SCROLL_CHANGED) && ( (pGadget && pGadget->IsKindOf(CLASSINFO(wxSlider))) || (pGadget && pGadget->IsKindOf(CLASSINFO(wxSliderCombo))) ) ) || // Handle slider changes FALSE) { msg.DlgMsg = DIM_SLIDER_POS_SET; HandleMessage = TRUE; } else if( (EventType == wxEVT_COMMAND_CHECKBOX_CLICKED) || (EventType == wxEVT_COMMAND_RADIOBUTTON_SELECTED) || FALSE) { msg.DlgMsg = DIM_LFT_BN_CLICKED; // apparently not a DIM_SELECTION_CHANGED - the click itself is eaten by the radio control - please do not change - AMB HandleMessage = TRUE; } else if ( (EventType == wxEVT_COMMAND_LISTBOX_DOUBLECLICKED) || FALSE) { msg.DlgMsg = DIM_SELECTION_CHANGED_COMMIT; HandleMessage = TRUE; } else if ( (EventType == wxEVT_LEFT_DOWN) || FALSE) { msg.DlgMsg = DIM_LFT_BN_DOWN; HandleMessage = TRUE; } else if ( (EventType == wxEVT_LEFT_UP) || FALSE) { msg.DlgMsg = DIM_LFT_BN_UP; HandleMessage = TRUE; } else if ( (EventType == wxEVT_RIGHT_DOWN) || FALSE) { msg.DlgMsg = DIM_RGT_BN_DOWN; HandleMessage = TRUE; } else if ( (EventType == wxEVT_RIGHT_UP) || FALSE) { msg.DlgMsg = DIM_RGT_BN_UP; HandleMessage = TRUE; } else if ( (EventType == wxEVT_MIDDLE_DOWN) || FALSE) { msg.DlgMsg = DIM_MID_BN_DOWN; HandleMessage = TRUE; } else if ( (EventType == wxEVT_MIDDLE_UP) || FALSE) { msg.DlgMsg = DIM_MID_BN_UP; HandleMessage = TRUE; } else if ( (EventType == wxEVT_MOTION) || FALSE) { msg.DlgMsg = ((wxMouseEvent *)&event)->Dragging()?DIM_MOUSE_DRAG:DIM_MOUSE_MOVE; HandleMessage = TRUE; } else if ( (EventType == wxEVT_MOUSEWHEEL) || FALSE) { msg.DlgMsg = (((wxMouseEvent *)&event)->GetWheelRotation()>0)?DIM_MOUSEWHEEL_UP:DIM_MOUSEWHEEL_DOWN; HandleMessage = TRUE; } else if ( (EventType == wxEVT_MOVE) || FALSE) { msg.DlgMsg = DIM_DLG_MOVED; HandleMessage = TRUE; } else if ( (EventType == wxEVT_SIZE) || FALSE) { if (event.GetEventObject() != pEvtHandler->pwxWindow) { Defer = FALSE; msg.DlgMsg = DIM_CTRL_RESIZED; HandleMessage = TRUE; } else { msg.DlgMsg = DIM_DLG_RESIZED; HandleMessage = TRUE; } } else if ( (EventType == wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED) && pGadget && pGadget->IsKindOf(CLASSINFO(wxBookCtrlBase))) { msg.DlgMsg = DIM_SET_ACTIVE; wxWindow *pPage = ((wxBookCtrlBase*)pGadget)->GetCurrentPage(); msg.PageID = pPage?(pPage->GetId()):0; HandleMessage = TRUE; } else if ( ((EventType == wxEVT_CAMDIALOG_REDRAW) && (pGadget)) || FALSE) { if (CCamApp::IsDisabled()) { TRACE( _T("kernel-rendered gadget repaint has been aborted: the system is disabled (due to an error/ensure?)\n")); HandleMessage = FALSE; } else { // HDC hDC = pInfo->PaintInfo.hdc; // HPALETTE OldPalette = PaletteManager::StartPaintPalette(hDC); ReDrawInfoType ExtraInfo; ExtraInfo.pMousePos = NULL; // No mouse position info for redraw events // Build a CC dc out of it for rendering to the screen // Get a MFC CDC to put the DC in CCPaintDC MyDc(pGadget); ExtraInfo.pDC = &MyDc; // The devices DPI ExtraInfo.Dpi = OSRenderRegion::GetFixedDCPPI(MyDc).GetHeight(); // How big the window is wxSize WindowSize = pGadget->GetClientSize(); ExtraInfo.dx = (((INT32)WindowSize.GetWidth())*72000) / ExtraInfo.Dpi; ExtraInfo.dy = (((INT32)WindowSize.GetHeight())*72000) / ExtraInfo.Dpi; MyDc.GetDC()->BeginDrawing(); wxRegionIterator upd(pGadget->GetUpdateRegion()); // get the update rect list BOOL Stop = FALSE; while (upd && !Stop) { // Alternatively we can do this: wxRect ClipRect(upd.GetRect()); // Should we clip this to the WindowSize here? For reasons which are not entirely clear, setting the // ClipRect breaks GRenderRegions. But if we don't set the clip rect, it breaks (at least some) // code that uses OSRenderRegion (sigh). Right now this is too painful to debug, so instead we // cop out, and ask the control whether or not it would like a ClipRect set. Those that say no // will paint the entire area, so we only give them one call BOOL UseClipRect = (pGadget->IsKindOf(CLASSINFO(wxCamDrawControl))) && (((wxCamDrawControl*)pGadget)->GetStyle() & wxCDCS_SETCLIPRECT); if (UseClipRect) { MyDc.GetDC()->SetClippingRegion(ClipRect); ClipRect.Inflate(1,1); // work around wxRect problems. } else { ClipRect = wxRect(WindowSize); Stop = TRUE; // cease drawing after this one } DocRect DocClipRect; // Convert to millipoints, Also need to flip the y coords to get a // rectangle in with the origin in the bottom left. DocClipRect.lo.x = (ClipRect.GetLeft() * 72000) / ExtraInfo.Dpi; DocClipRect.lo.y = ExtraInfo.dy - ((ClipRect.GetBottom() * 72000) / ExtraInfo.Dpi); DocClipRect.hi.x = (ClipRect.GetRight() * 72000) / ExtraInfo.Dpi; DocClipRect.hi.y = ExtraInfo.dy - ((ClipRect.GetTop() * 72000) / ExtraInfo.Dpi); // Set the pointer in the extra info structure ExtraInfo.pClipRect = &DocClipRect; // Build the message and send it to the dialog op // It is up to the dialog op to build a render region etc and attach the CCDC to it // and to tidy the region up after it has finished drawing in it CDlgMessage BROADCAST_TO_CLASS(DialogMsg(pEvtHandler->pwxWindow, DIM_REDRAW, id, (UINT_PTR)(void *)&ExtraInfo, PageID), DialogOp); upd ++ ; } MyDc.GetDC()->EndDrawing(); // if (OldPalette) // PaletteManager::StopPaintPalette(hDC, OldPalette); } } //case wxEVT_COMMAND_TOOL_RCLICKED: //case wxEVT_COMMAND_TOOL_ENTER: // Handle filling in ExtraInfo on redraw events if ((msg.DlgMsg != DIM_NONE) && pGadget && pGadget->IsKindOf(CLASSINFO(wxCamDrawControl)) && event.IsKindOf(CLASSINFO(wxMouseEvent))) { switch (msg.DlgMsg) { case DIM_LFT_BN_DOWN: case DIM_LFT_BN_UP: case DIM_LFT_BN_CLICKED: case DIM_RGT_BN_DOWN: case DIM_RGT_BN_UP: case DIM_RGT_BN_CLICKED: case DIM_MID_BN_DOWN: case DIM_MID_BN_UP: case DIM_MID_BN_CLICKED: case DIM_MOUSE_DRAG: case DIM_MOUSE_MOVE: case DIM_MOUSEWHEEL_UP: case DIM_MOUSEWHEEL_DOWN: { // HDC hDC = pInfo->PaintInfo.hdc; // HPALETTE OldPalette = PaletteManager::StartPaintPalette(hDC); ReDrawInfoType ExtraInfo; ExtraInfo.pMousePos = NULL; // No mouse position info for redraw events // Build a CC dc out of it for rendering to the screen // Get a MFC CDC to put the DC in CCPaintDC MyDc(pGadget); ExtraInfo.pDC = NULL; // The devices DPI ExtraInfo.Dpi = OSRenderRegion::GetFixedDCPPI(MyDc).GetHeight(); // How big the window is wxSize WindowSize = pGadget->GetClientSize(); ExtraInfo.dx = (((INT32)WindowSize.GetWidth())*72000) / ExtraInfo.Dpi; ExtraInfo.dy = (((INT32)WindowSize.GetHeight())*72000) / ExtraInfo.Dpi; // Work out the MILLIPOINT coordinates of the mouse position // Note that the Y value is flipped, as the kernel-origin is at the bottom left INT32 XPos = ((wxMouseEvent *)(&event))->GetX(); INT32 YPos = ((wxMouseEvent *)(&event))->GetY(); DocCoord MousePos; MousePos.x = (XPos * 72000) / ExtraInfo.Dpi; MousePos.y = ExtraInfo.dy - ((YPos * 72000) / ExtraInfo.Dpi); ExtraInfo.pMousePos = &MousePos; BROADCAST_TO_CLASS(DialogMsg(pEvtHandler->pwxWindow, msg.DlgMsg, id, (UINT_PTR)(void *)&ExtraInfo, PageID), DialogOp); msg.DlgMsg = DIM_NONE; // Stop further processing } default: break; } } // If we have a message to send, then send it (or defer it for later) if (msg.DlgMsg != DIM_NONE) { // Restore focus after selection change etc. if the dialog Op is non-modal if (!(pEvtHandler->pDialogOp->IsModal()) && (( DIM_SELECTION_CHANGED == msg.DlgMsg ) || ( DIM_SLIDER_POS_SET == msg.DlgMsg ))) { TRACEUSER( "luke", _T("Change focus") ); AfxGetApp().GiveActiveCanvasFocus(); } if (Defer) { // We should send the message out later - we use the same ID wxCamDialogEvent deferredevent (wxEVT_CAMDIALOG_DEFERREDMSG, event.GetId(), msg); deferredevent.SetEventObject(pEvtHandler->pwxWindow); // set it for processing later pEvtHandler->pwxWindow->GetEventHandler()->AddPendingEvent(deferredevent); } else { BROADCAST_TO_CLASS( DialogMsg(msg), DialogOp ); } } // If we haven't marked this message as handled, call Skip() so that others can handle // it if (!HandleMessage) event.Skip(); // we didn't handle it return; }

DialogPosition * DialogManager::FindDialogPositionRecord (  CDlgResID  DialogID  )  [static, private]

Searches the DialogPositionList to see if this dialog has been created before if it has then a pointer to its DialogPosition record is returned, else NULL is retuned. Scope: private. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 5/12/94 Parameters: DialogID,:  The dialog's resource id [INPUTS] Returns: The DialogPosition record for the dialog, or NULL if the dialog has not been created before Definition at line 940 of file dlgmgr.cpp. { // Search the DialogPositionList to see if the dialog has been created before DialogPosition* DlgPos = (DialogPosition*)(DialogPositionList.GetHead()); while (DlgPos != NULL) { if (DlgPos->DlgResourceID == DialogID) // The dialog has been created before { return DlgPos; break; } // Get the next DialogPosition record DlgPos = (DialogPosition*)(DialogPositionList.GetNext((ListItem*)DlgPos)); } return NULL; // Dialog has not been created before }

void DialogManager::FreePaneInfoHash (   )  [static]

Free the pane info hash if it exists Scope: protected. Author: Alex Bligh <alex@alex.org.uk> Date: 25/07/06 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - This function MUST be called ONLY after the preference system has been de-inited. This may be after dialogmanager deinit. Definition at line 798 of file dlgmgr.cpp. { if (s_pPaneInfoHash) { delete s_pPaneInfoHash; s_pPaneInfoHash = NULL; } }

BOOL DialogManager::GadgetRedraw (  CWindowID  WindowID, CGadgetID  Gadget, BOOL  Redraw )  [static]

This function sets a gadgets redraw state. If Redraw = FALSE then the gadget will not be redrawn when changes are made to it. Conversely if Redraw = TRUE then the Gadget will redraw itself after any changes are made. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 9/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Redraw: TRUE to turn on gadget redraw FALSE to turn off gadget redraw -  [OUTPUTS] Returns: TRUE if successful, else FALSE For Windows ----------- This function can be called for all controls Returns: Errors: - See also: DialogOp::GadgetRedraw Definition at line 5324 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if( Redraw ) { pGadget->Thaw(); } else { pGadget->Freeze(); } return TRUE; }

CDlgResID DialogManager::GetActivePage (  CWindowID  WindowID, CGadgetID  Gadget = 0 )  [static]

To find out the currently active page in a tabbed dialog. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Inputs WindowID - The window GadgetID - The gadget of the book control, or zero for none Date: 23/3/2000 Returns: the pageID of the currently active page in an open tabbed dialog, or -1 if there isn't one Alex unbroke this function which used to take no parameters, meaning it would only work reliably if only one tabbed dialog was up at a time... So if you are trying to call it, you now know how to fix your parameters... For an unknown reason this function returns -1 if the gadget is not found. Which I think is wxID_OK. Who knows DONT USE THIS FUNCTION Definition at line 7556 of file dlgmgr.cpp. { // first check to see if we have a property sheet object wxBookCtrlBase * pBookControl = GetBookControl(WindowID, Gadget); if (pBookControl == NULL) return CDlgResID(-1); wxNotebookPage* pOurPage = pBookControl->GetCurrentPage(); if (pOurPage == NULL) return CDlgResID(-1); return pOurPage->GetId(); }

wxBookCtrlBase * DialogManager::GetBookControl (  CWindowID  WindowID, CGadgetID  Gadget = 0 )  [static]

This function will return a pointer to the book control in a window. If the window is of type wxPropertySheetDialog then it Gadget is not required. Author: Alex Bligh <alex@alex.org.uk> Date: 11/05/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Identifier of the gadget OR zero Returns pointer to the book control or NULL Note that the intelligence to use the default gadget won't be there until the window has been created properly and the event handler added. So if this is being called from a window creation function (like AddAPage) it is worth specifying the gadget explicitly. Definition at line 1666 of file dlgmgr.cpp. { // No window ID? Well no book control then if (!WindowID) return NULL; // If it's a property sheet dialog then we know a quick way... if (WindowID->IsKindOf(CLASSINFO(wxPropertySheetDialog))) return ((wxPropertySheetDialog*)WindowID)->GetBookCtrl(); // Let's see if there is a default gadget to use in the DialogOp if (!Gadget) { if ((WindowID->GetEventHandler())->IsKindOf(CLASSINFO(DialogEventHandler))) { DialogOp * pDialogOp = ((DialogEventHandler *)(WindowID->GetEventHandler()))->pDialogOp; // If it's a DialogTabOp, ask it for its default book gadget. If there isn't // one, that's OK too if ((pDialogOp) && (pDialogOp->IS_KIND_OF(DialogTabOp))) Gadget=((DialogTabOp*)pDialogOp)->GetDefaultBookGadget(); } } // If we were passed a gadget ID, we can go use it if (Gadget) { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (pGadget->IsKindOf(CLASSINFO(wxBookCtrlBase))) return (wxBookCtrlBase*)pGadget; else return NULL; } // See if any of the children are wxBookCtrlBase wxWindowList::Node * pNode = WindowID->GetChildren().GetFirst(); while (pNode) { wxWindow * child = pNode->GetData(); if (child->IsKindOf(CLASSINFO(wxBookCtrlBase))) return (wxBookCtrlBase*)child; pNode = pNode->GetNext(); } // OK, they aren't. Recurse through them pNode = WindowID->GetChildren().GetFirst(); while (pNode) { wxBookCtrlBase * pBook=GetBookControl(WindowID, 0); if (pBook) return pBook; pNode = pNode->GetNext(); } return NULL; }

BOOL DialogManager::GetBoolGadgetSelected (  CWindowID  WindowID, CGadgetID  Gadget, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, INT32  ListPos = 0 )  [static]

This function will obtain the gadget value and validate it. Validation will check that a correct INT32 value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. [This does not seem correct - AMB]. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 10/4/94 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Dialog identifier InvalidMsgID: Message displayed to the user when they have entered invalid data (either not the correct type or not in the correct range) This may be 0 if you do not wish an error to be reported ListPos: Specifies which item in a list to read (defaults to 0) Valid,:  Flag indicating if the value entered was valid or not. [OUTPUTS] If the Valid parameter is NULL, then validity of the result will not be checked, and the actual value of the control will be returned even if it was "invalid". If this flag is returned FALSE then the return value will be 0. Returns: The value entered by the user. If Valid is FALSE then FALSE will be returned. For Windows ----------- The function can be used to obtain a BOOL value from the following controls: Button ListBox cc_CheckList For ListBox/cc_CheckList controls the bool value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetLongGadgetValue Definition at line 4215 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { // Support listboxes with multiple selections if (pGadget->IsKindOf(CLASSINFO(wxListBox))) { return ((wxListBox *)pGadget)->IsSelected(ListPos); } if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) return (((wxOwnerDrawnComboBox *)pGadget)->GetSelection() == ListPos); else return (((wxControlWithItems *)pGadget)->GetSelection() == ListPos); } return GetLongGadgetValue(WindowID, Gadget, 0, 1, IDSInvalidMsg, Valid); }

List * DialogManager::GetControlList (  CWindowID  hWnd  )  [static, private]

Hide the mechanism we use to attach our lists to various windows. In fact we use window properties. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 29/4/94 Parameters: A  Window handle [INPUTS] -  [OUTPUTS] Returns: A pointer to its special list, or NULL if it doesn't have one. Errors: - See also: - Scope: Private, static Definition at line 6449 of file dlgmgr.cpp. { PORTNOTETRACE("dialog","DialogManager::GetControlList - do nothing"); #ifndef EXCLUDE_FROM_XARALX HANDLE Prop = GetProp( hWnd, MAKEINTATOM(GetListAtom) ); // Atoms & Properties are fast if (Prop) { #if WIN32 return (List*)(INT32)Prop; #else HANDLE Seg = GetProp( hWnd, MAKEINTATOM(GetListAtomSegment) ); INT32 ptr = MAKEINT32( Prop, Seg ); return (List*)ptr; #endif } else #endif return NULL; }

MILLIPOINT DialogManager::GetDimensionGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, Node *  pNode, BOOL *  Valid = NULL, INT32  ListPos = -1 )  [static]

This is the routine to call for getting user-entered dimensions from a control. The value is scaled from user dimensions to an internal millipoint value. The routine uses DialogManager::GetStringGadgetValue to extract the string from the control. The caller should be aware of the features/limitations of this routine before calling GetDimensionGadgetValue. Returns: The internal millipoint representation of the string in this control Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetDimensionGadgetValue DialogManager::GetStringGadgetValue Definition at line 4483 of file dlgmgr.cpp. { MILLIPOINT Val=72000; DimScale* pDimScale = DimScale::GetPtrDimScale(pNode); String_256 Str; Str = GetStringGadgetValue(WindowID,Gadget,Valid,ListPos); if (Valid != NULL && *Valid) *Valid = pDimScale->ConvertToMillipoints(Str,&Val); return Val; }

BOOL DialogManager::GetDoubleAndUnitGadgetValue (  double *  pMPValue, double *  pUnitValue, UnitType *  pUnitType, CWindowID  WindowID, CGadgetID  Gadget, Node *  pNode )  [static]

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 DialogManager::GetDoubleAndUnitGadgetValue(double* pMPValue, double* pUnitValue, UnitType* pUnitType, CWindowID WindowID, CGadgetID Gadget, Node* pNode) Author: Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/95 Parameters: WindowID  - [INPUTS] Gadget - 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 4521 of file dlgmgr.cpp. { ERROR2IF( pMPValue==NULL,FALSE,"DialogManager::GetDoubleAndUnitGadgetValue() - pMPValue==NULL"); ERROR2IF(pUnitValue==NULL,FALSE,"DialogManager::GetDoubleAndUnitGadgetValue() - pUnitValue==NULL"); ERROR2IF( pUnitType==NULL,FALSE,"DialogManager::GetDoubleAndUnitGadgetValue() - pUnitType==NULL"); ERROR2IF( pNode==NULL,FALSE,"DialogManager::GetDoubleAndUnitGadgetValue() - pNode==NULL"); DimScale* pDimScale = DimScale::GetPtrDimScale(pNode); ERROR2IF( pDimScale==NULL,FALSE,"DialogManager::GetDoubleAndUnitGadgetValue() - pDimScale==NULL"); // separate string into double value and unit type BOOL ok = TRUE; double UnitValue = 1.0; UnitType units; String_256 GadgetString=GetStringGadgetValue(WindowID,Gadget,&ok); if (ok) ok=Convert::StringToComponents(GadgetString, &UnitValue, &units); if (!ok) return FALSE; // if no unit type specified, use units associated with the specified node if (units==NOTYPE) units=pDimScale->GetUnits(); // and get the value in millipoints accounting for scaled units double MPValue = 1.0; ok=pDimScale->ConvertToDouble(GadgetString,&MPValue); if (!ok) return FALSE; // set outputs and return *pMPValue = MPValue; *pUnitValue = UnitValue; *pUnitType = units; return TRUE; }

double DialogManager::GetDoubleGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, double  StartRange, double  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, Convert::PFNSTRINGTODOUBLE  pfnParser = Convert::StringToDouble )  [static]

This function will obtain the gadget value and validate it. Validation will check that a correct double value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. Author: Alex_Bligh (Xara Group Ltd) <camelotdev@xara.com> (liberally copied from GetLongGadgetValue) Date: 16/12/94 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Dialog identifier StartRange: Minimum gadget value EndRange: Maximum gadget value InvalidMsgID: Message displayed to the user when they have entered invalid data (either not the correct type or not in the correct range) This may be 0 if you do not wish an error to be reported pfnParser optional pointer to a function that converts a StringBase to a double. The default is:- double StringToDouble(StringBase* in, Double* out) but any function with a similar prototype will work. This function is called for controls that contain text, eg. a combo-box. Ask JustinF about this if you aren't sure. Valid,:  Flag indicating if the value entered was valid or not. [OUTPUTS] If the Valid parameter is NULL, then validity of the result will not be checked, and the actual value of the control will be returned even if it was out of range. If this flag is returned FALSE then the return value will be 0. Returns: The value entered by the user. If Valid is FALSE then NULL will be returned. For Windows ----------- The function can be used to obtain a double value from the string value of the following controls: Edit ListBox ComboBox Static cc_CheckList Button For ListBox and ComboBox controls the INT32 value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. You can override the conversion from the string value to the double by providing your own pfnParser parameter. This could, for example, remove percentage signs from the text before conversion. For Button controls this function returns back the current state of the button For ScrollBar controls this function returns back the current position of the scroll bars thumb. For cc_Slider controls this function returns the current position of the bar in the slider. Note for some controls, like sliders, the value comes back as an INT32 converted to a double so you might as well use GetLongGadgetValue. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetDoubleGadgetValue, DialogManager::GetLongGadgetValue Definition at line 4113 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if (( pGadget->IsKindOf(CLASSINFO(wxButton))) || ( pGadget->IsKindOf(CLASSINFO(wxBitmapButton))) || ( pGadget->IsKindOf(CLASSINFO(wxCheckBox))) || ( pGadget->IsKindOf(CLASSINFO(wxRadioButton))) || ( pGadget->IsKindOf(CLASSINFO(wxScrollBar))) || ( pGadget->IsKindOf(CLASSINFO(wxSlider))) || ( pGadget->IsKindOf(CLASSINFO(wxSliderCombo))) || ( pGadget->IsKindOf(CLASSINFO(wxGauge))) ) return (double)GetLongGadgetValue( WindowID, Gadget, (INT32)(floor(StartRange+0.5)), (INT32)(floor(EndRange+0.5)), IDSInvalidMsg, Valid); String_256 StrValue = GetStringGadgetValue(WindowID, Gadget, NULL); // Convert the string to an INT32 if it's valid double Value=0.0; BOOL IsValid = (*pfnParser)(StrValue, &Value); if (IsValid) { IsValid = ((Value >= StartRange) && (Value <= EndRange)); } if (Valid != NULL) { *Valid = IsValid; if (!IsValid) // The value is invalid { if (IDSInvalidMsg != 0) InformWarning(IDSInvalidMsg); // Scold the user, if a message was supplied return (0); } } return Value; // Valid input, or caller did not want validation }

INT32 DialogManager::GetFirstSelectedItem (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

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: WindowID  = ID of window that contains the gadget [INPUTS] Gadget = ID of list-type gadget Returns: The index of the firsted selected items in the list-type gadget, or -1 if it fails See also: - Definition at line 4898 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return -1; if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { // Support listboxes with multiple selections if (pGadget->IsKindOf(CLASSINFO(wxListBox))) { wxArrayInt sels; if ( ((wxListBox *)pGadget)->GetSelections(sels) ) { return sels[0]; } return -1; } return ((wxControlWithItems *)pGadget)->GetSelection(); } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) return ((wxOwnerDrawnComboBox *)pGadget)->GetSelection(); return -1; }

wxWindow * DialogManager::GetGadget (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

Author: Alex Bligh (alex@alex.org.uk) Date: 20/12/2005 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier StrID: Resource ID of string Definition at line 2818 of file dlgmgr.cpp. { ERROR2IF(!WindowID || !WindowID->IsKindOf(CLASSINFO(wxWindow)), FALSE, "Bad Window ID passed"); wxWindow * pGadget=WindowID->FindWindow(Gadget); // TRACEUSER("amb",_T("pwxDialog=0x%016llx Gadget=%d(%s) pGadget=0x%016llx"), WindowID, Gadget, CamResource::GetObjectName((ResourceID)Gadget), pGadget); if (!pGadget) { // Some dialogs seem to consciously do this, EG galleries // ERROR3_PF((_T("Bad Gadget ID %d(%s) passed"), Gadget, CamResource::GetObjectName((ResourceID)Gadget))); return NULL; } #if 0 const TCHAR * pGadgetClassName = (const TCHAR *) pGadget->GetClassInfo()->GetClassName(); TRACEUSER("amb",_T("Gadget is a %s"),pGadgetClassName); #endif return pGadget; }

ResourceID DialogManager::GetGadgetBitmap (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

This function will get the bitmaps associated with a gadget. Author: Alex Bligh <alex@alex.org.uk> Date: 07/05/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Identifier of the gadget Returns: The resourse ID of the bitmap Definition at line 2121 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return 0; if ( pGadget->IsKindOf(CLASSINFO(wxCamArtControl)) ) { return ((wxCamArtControl *)pGadget)->GetBitmapId(); } return 0; }

UINT32 DialogManager::GetGadgetImageCount (  CWindowID  wnd, CGadgetID  Gadget )  [static]

To get the number of images set in the trree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier -  [OUTPUTS] Returns: Number of images in tree control Definition at line 9363 of file dlgmgr.cpp. { ERROR3("Unimplemented!"); return 0; }

OpDescriptor * DialogManager::GetGadgetOpDescriptor (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

Author: Alex Bligh (alex@alex.org.uk) Date: 20/12/2005 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Returns: pointer to an OpDescriptor, or NULL if not found Definition at line 2848 of file dlgmgr.cpp. { wxWindow * pWindow = GetGadget(WindowID, Gadget); if (!pWindow) return NULL; // If it's not a wxControl, return if (!pWindow->IsKindOf(CLASSINFO(wxControl))) return NULL; wxControl * pControl = (wxControl *)pWindow; return ControlList::Get()->Find(pControl); }

BOOL DialogManager::GetGadgetPosition (  CWindowID  WindowID, CGadgetID  Gadget, RECT *  pRect )  [static]

Definition at line 7301 of file dlgmgr.cpp. { wxRect Rect; if (!GetGadgetPosition(WindowID, Gadget, &Rect)) return FALSE; pRect->bottom=Rect.GetBottom(); pRect->top=Rect.GetTop(); pRect->left=Rect.GetLeft(); pRect->right=Rect.GetRight(); return TRUE; }

BOOL DialogManager::GetGadgetPosition (  CWindowID  WindowID, CGadgetID  Gadget, wxRect *  pRect )  [static]

Allows the user to get the current position of the specified gadget or icon. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: WindowID  Handle of window [INPUTS] Gadget The icon or gadget that we are interested in. Rect  pointer to the rectangle to fill in [OUTPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::GetGadgetPosition; DialogManager::SetGadgetPosition; Definition at line 7289 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; // We just need to pass back the normal position of the window if (pRect) *pRect = pGadget->GetSize(); return TRUE; }

BOOL DialogManager::GetGadgetRange (  CWindowID  WindowID, CGadgetID  Gadget, INT32 *  Min, INT32 *  Max )  [static]

For obtaining the range of a gadget. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 2/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Min,:  Minimum range value [OUTPUTS] Max: Maximum range value Returns: TRUE if the gadget's range could be read, FALSE otherwise For Windows ----------- The function returns a ScrollBar control's Min and Max values. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetGadgetRange Definition at line 4412 of file dlgmgr.cpp. { INT32 min=0; INT32 max=0; wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if ( pGadget->IsKindOf(CLASSINFO(wxScrollBar)) ) { max = ((wxScrollBar *)pGadget)->GetRange(); } if ( pGadget->IsKindOf(CLASSINFO(wxSlider)) ) { min=((wxSlider *)(pGadget))->GetMin(); max=((wxSlider *)(pGadget))->GetMax(); } if ( pGadget->IsKindOf(CLASSINFO(wxSliderCombo)) ) { min=((wxSliderCombo *)(pGadget))->GetSliderMin(); max=((wxSliderCombo *)(pGadget))->GetSliderMax(); } if ( pGadget->IsKindOf(CLASSINFO(wxGauge)) ) { max = ((wxGauge *)(pGadget))->GetRange(); } if (Min) *Min=min; if (Max) *Max=max; return TRUE; }

BOOL DialogManager::GetKernelRenderedGadgetInfo (  CWindowID  WindowID, CGadgetID  Gadget, ReDrawInfoType *  Result )  [static]

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: WindowID  - The parent window identifier [INPUTS] Gadget - The ID of the gadget that you want info for Returns: FALSE if there was a catastrophic error (it will report an ERROR2 if necessary), 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) Definition at line 5782 of file dlgmgr.cpp. { ERROR3IF(WindowID == 0 || Gadget == 0 || Result == NULL, "DialogManager::GetKernelRenderedGadgetInfo: NULL parameters are illegal!"); // For the time being, we do this by Hide/Unhide wxWindow * pTheWindow = GetGadget(WindowID, Gadget); if (!pTheWindow) return FALSE; Result->pDC = NULL; Result->pClipRect = NULL; Result->pMousePos = NULL; // Install some 'safe' defaults, just in case of serious error Result->dx = Result->dy = 72000; Result->Dpi = 96; // If a totally rampant call, error (debug) and return failure ERROR3IF( NULL == pTheWindow, "DialogManager::GetKernelRenderedGadgetInfo - Illegal window/gadget"); if( pTheWindow == 0 ) return(FALSE); // Get the screen DPI wxScreenDC ScreenDC; PORTNOTE("dialog","Can't handle different DPIs, using X") Result->Dpi = OSRenderRegion::GetFixedDCPPI(ScreenDC).x; // x; // Calculate how big the window is, in MILLIPOINTS wxSize WindowSize( pTheWindow->GetClientSize() ); Result->dx = ( INT32(WindowSize.GetWidth())*72000 ) / Result->Dpi; Result->dy = ( INT32(WindowSize.GetHeight())*72000) / Result->Dpi; return(TRUE); }

INT32 DialogManager::GetLongGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, INT32  StartRange, INT32  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL, Convert::PFNSTRINGTOINT32  pfnParser = Convert::StringToLong )  [static]

This function will obtain the gadget value and validate it. Validation will check that a correct INT32 value has been entered, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Dialog identifier StartRange: Minimum gadget value EndRange: Maximum gadget value InvalidMsgID: Message displayed to the user when they have entered invalid data (either not the correct type or not in the correct range) This may be 0 if you do not wish an error to be reported pfnParser optional pointer to a function that converts a StringBase to a INT32. The default is:- BOOL StringToLong(StringBase* in, INT32* out) but any function with a similar prototype will work. This function is called for controls that contain text, eg. a combo-box. Ask JustinF about this if you aren't sure. Valid,:  Flag indicating if the value entered was valid or not. [OUTPUTS] If the Valid parameter is NULL, then validity of the result will not be checked, and the actual value of the control will be returned even if it was out of range. If this flag is returned FALSE then the return value will be 0. Returns: The value entered by the user. If Valid is FALSE then NULL will be returned. For Windows ----------- The function can be used to obtain a INT32 value from the string value of the following controls: Edit ListBox ComboBox Static cc_CheckList Button For ListBox and ComboBox controls the INT32 value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. You can override the conversion from the string value to the INT32 by providing your own pfnParser parameter. This could, for example, remove percentage signs from the text before conversion. For Button controls this function returns back the current state of the button For ScrollBar controls this function returns back the current position of the scroll bars thumb. For cc_Slider controls this function returns the current position of the bar in the slider. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetLongGadgetValue Definition at line 3928 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if ( pGadget->IsKindOf(CLASSINFO(wxButton)) || pGadget->IsKindOf(CLASSINFO(wxBitmapButton)) ) { // These bitmap buttons are meant to be tristate PORTNOTETRACE("dialog","DialogManager::GetLongGadgetValue on BitmapButton - do nothing"); return 0; } if ( pGadget->IsKindOf(CLASSINFO(wxCheckBox)) ) { if (Valid) *Valid=TRUE; return ((wxCheckBox *)(pGadget))->GetValue() != 0; } if ( pGadget->IsKindOf(CLASSINFO(wxRadioButton)) ) { if (Valid) *Valid=TRUE; return ((wxRadioButton *)(pGadget))->GetValue() != 0; } if ( pGadget->IsKindOf(CLASSINFO(wxScrollBar)) ) { if (Valid) *Valid=TRUE; return (INT32)(((wxScrollBar *)(pGadget))->GetThumbPosition()); } if ( pGadget->IsKindOf(CLASSINFO(wxSlider)) ) { if (Valid) *Valid=TRUE; return (INT32)(((wxSlider *)(pGadget))->GetValue()); } if ( pGadget->IsKindOf(CLASSINFO(wxSliderCombo)) ) { if (Valid) *Valid=TRUE; return (INT32)(((wxSliderCombo *)(pGadget))->GetSliderValue()); } if ( pGadget->IsKindOf(CLASSINFO(wxGauge)) ) { if (Valid) *Valid=TRUE; return (INT32)(((wxGauge *)(pGadget))->GetValue()); } if ( pGadget->IsKindOf(CLASSINFO(wxCamArtControl)) ) { if (Valid) *Valid=TRUE; return (INT32)(((wxCamArtControl *)(pGadget))->GetValue()); } #if 0 // it seems on an edit box we might be meant to set the garet, but it's difficult to know what's // going on here else if (ClassNameStr == String_16(TEXT("cc_CustomEdit")))//? { CCustomEdit* pCEdit = (CCustomEdit*)CWnd::FromHandlePermanent(hGadget); Value = pCEdit->GetPos(); IsValid = ((Value >= StartRange) && (Value <= EndRange)); TRACEUSER( "Marc", _T("dlgmgr.cpp, getting pos %d\n"),Value); } #endif // Hmmm - no luck so far, let's try a string // Obtain the controls text String_256 StrValue = GetStringGadgetValue(WindowID, Gadget, NULL); // Convert the string to an INT32 if it's valid INT32 Value=0; BOOL IsValid = (*pfnParser)(StrValue, &Value); if (IsValid) { IsValid = ((Value >= StartRange) && (Value <= EndRange)); } if (Valid != NULL) { *Valid = IsValid; if (!IsValid) // The value is invalid { if (IDSInvalidMsg != 0) InformWarning(IDSInvalidMsg); // Scold the user, if a message was supplied return (0); } } return Value; // Valid input, or caller did not want validation }

UINT32 DialogManager::GetMemoryGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, UINT32  StartRange, UINT32  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL )  [static]

This function allows a memory value to be read back from a control. It will cope with the memory being specified in bytes, K, M or G bytes and will also validate it. Validation will check that data has been entered in a correct unit type, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 30/1/95 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Dialog identifier StartRange: Minimum gadget value EndRange: Maximum gadget value InvalidMsgID: Message displayed to the user when they have entered invalid data (either not the correct type or not in the correct range) This may be 0 if you do not wish an error to be reported Valid,:  Flag indicating if the value entered was valid or not. [OUTPUTS] If the Valid parameter is NULL, then validity of the result will not be checked, and the actual value of the control will be returned even if it was out of range. If this flag is returned FALSE then the return value will be 0. Returns: The value entered by the user in bytes. If Valid is FALSE then NULL will be returned. For Windows ----------- The function can be used to obtain a memory value from the string value of the following controls: Edit ListBox ComboBox Static For ListBox and ComboBox controls the unit value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetMemoryGadgetValue; DialogOp::SetMemoryGadgetValue Definition at line 4619 of file dlgmgr.cpp. { BOOL IsValid; // Obtain the controls text String_256 StrValue = GetStringGadgetValue(WindowID, Gadget, NULL); // Convert the string to millipoints if it's valid UINT32 Value = Convert::StringToBytes(StrValue, &IsValid); if (Valid == NULL) // If don't want it validated, return the value now return(Value); if (IsValid) { // Check that the value is in the range StartRange..EndRange if ((Value >= StartRange) && (Value <= EndRange)) { *Valid = TRUE; return (Value); // A correct value was entered } } // The value is invalid if (IDSInvalidMsg != 0) InformWarning(IDSInvalidMsg); // Scold the user, if a message was supplied return( 0 ); }

CWindowID DialogManager::GetPageWindow (  CWindowID  Win, CDlgResID  PageID, INT32 *  PageIndex = NULL )  [static]

Returns the Window ID of a page within a property sheet. If the page is NULL then Win is simply returned, It can be called on a non property sheet dialog. Just pretend that they are property sheets without any pages. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/11/94 Parameters: Win,:  The windowID [INPUTS] PageID: A page resource identifier, If this is not NULL then the WindowID must be that of a Property sheet. We ENSURE that this is true. Optionally  returns the page index [OUTPUTS] Returns: Window ID of a page within a property sheet Errors: - See also: - Definition at line 7117 of file dlgmgr.cpp. { if (PageID == 0) { return Win; // A page is not required } wxBookCtrlBase* pBookCtrl = GetBookControl(Win); if (!pBookCtrl) { ERROR3("No BookControl found"); return Win; } wxNotebookPage* pCurrentPage; // Find the window ID of the page for (UINT32 i = 0; i < pBookCtrl->GetPageCount(); i++) { pCurrentPage = (wxNotebookPage*)(pBookCtrl->GetPage(i)); if (pCurrentPage->GetId() == INT32(PageID) ) { if (PageIndex != NULL) { *PageIndex = i; } // Found page so return window id return pCurrentPage; } } ERROR3("The page specified does not exist on this tabbed dialog"); return Win; // Probably safer than NULL }

wxPropertySheetDialog * DialogManager::GetPropertySheetFromOp (  DialogTabOp *  pDialogTabOp  )  [static, private]

Author: Luke_Hart (xara group ltd) <lukeh@xara.com> created: 28/04/06 inputs: pdialogtabop: the operation we wish to find the property sheet for outputs: - returns: The associated Property sheet (or NULL if none) purpose: Find the property sheet associated with the passed DialogTabOp errors: - seealso: - Definition at line 6977 of file dlgmgr.cpp. { wxWindow * pWindow = pDialogTabOp->WindowID; return pWindow->IsKindOf(CLASSINFO(wxPropertySheetDialog))?(wxPropertySheetDialog*)pWindow:NULL; }

INT32 DialogManager::GetScreenDpi (   )  [static]

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: DialogOp::GetScreenDpi; Definition at line 7384 of file dlgmgr.cpp. { // Get the screen DPI wxScreenDC ScreenDC; PORTNOTE("dialog","Can't handle different DPIs, using X") return OSRenderRegion::GetFixedDCPPI(ScreenDC).x; }

BOOL DialogManager::GetScreenSize (  INT32 *  pWidth, INT32 *  pHeight )  [static]

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: DialogOp::GetScreenDpi; Definition at line 7406 of file dlgmgr.cpp. { ERROR2IF(pWidth == NULL || pHeight == NULL,FALSE,"GetScreenSize Bad params!"); // HORZRES Width, in pixels, of the screen. // VERTRES Height, in raster lines, of the screen. INT32 Width = wxSystemSettings::GetMetric( wxSYS_SCREEN_X ); INT32 Height = wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ); // Tell the caller about the new values *pWidth = Width; *pHeight = Height; return TRUE; }

INT32 DialogManager::GetSelectedCount (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

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: WindowID  = ID of window that contains the gadget [INPUTS] Gadget = ID of list-type gadget Returns: The number of selected items in the list-type gadget, or -1 if it fails See also: - Definition at line 4858 of file dlgmgr.cpp. { // INT32 Count = -1; wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { // Support listboxes with multiple selections if (pGadget->IsKindOf(CLASSINFO(wxListBox))) { wxArrayInt sels; return ((wxListBox *)pGadget)->GetSelections(sels); } return (((wxControlWithItems *)pGadget)->GetSelection() == wxNOT_FOUND)?0:1; } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) return (((wxOwnerDrawnComboBox *)pGadget)->GetSelection() == wxNOT_FOUND)?0:1; return -1; }

INT32 * DialogManager::GetSelectedItems (  CWindowID  WindowID, CGadgetID  Gadget )  [static]

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: WindowID  = ID of window that contains the gadget [INPUTS] Gadget = ID of list-type gadget Returns: ptr to the INT32 array, or NULL if it fails NULL is returned if there's no selection, or not enough memory for the required array The caller is responsible for deleting the array that's returned. e.g INT32* pArray = GetSelectedItems(WindowID,Gadget); if (pArray != NULL) { ..... // Use the array delete [] pArray; } See also: - Definition at line 4951 of file dlgmgr.cpp. { INT32* pList = NULL; wxArrayInt sels; wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return NULL; if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { // Support listboxes with multiple selections if (pGadget->IsKindOf(CLASSINFO(wxListBox))) { ((wxListBox *)pGadget)->GetSelections(sels); } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { sels[0]=((wxOwnerDrawnComboBox *)pGadget)->GetSelection(); } else { sels[0]=((wxControlWithItems *)pGadget)->GetSelection(); } size_t Count = sels.GetCount(); pList = new INT32[Count+1]; if (pList) { UINT32 i; for (i=0; i<Count; i++) { pList[i]=sels[i]; } pList[Count] = -1; // terminate the list } return pList; // may be NULL if no memory } return NULL; }

BOOL DialogManager::GetStatusLineText (  String_256 *  ptext, CWindowID  window )  [static]

Fills in the status line text from the help text if over a control Scope: Public. Author: Alex Bligh <alex@alex.org.uk> Date: 15/05/2006 Parameters: window  - the window ID, or NULL for the current mouse position [INPUTS] pText  - pointer to the text to fill in [OUTPUTS] Returns: TRUE on success else FALSE Errors: - See also: - Definition at line 7824 of file dlgmgr.cpp. { if (!ptext) return FALSE; if (!window) window=::wxChildWindowFromPoint(wxGetMousePosition(), FALSE, -1); if (!window) return FALSE; wxHelpProvider * hp = wxHelpProvider::Get(); // Now some controls contain other controls, so we look down the heirarch if we can't find one // immediately wxString help; do { if (!window->IsKindOf(CLASSINFO(wxControl))) return FALSE; if (hp) help = hp->GetHelp(window); else help = ((wxControl *)window)->GetHelpText(); if (help.IsEmpty()) { wxToolTip* pTip = window->GetToolTip(); if (pTip) help=pTip->GetTip(); } window=window->GetParent(); } while (window && help.IsEmpty()); if (help.IsEmpty()) return FALSE; *ptext = help; return TRUE; }

String_256 DialogManager::GetStringGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, BOOL *  Valid = NULL, INT32  ListPos = -1 )  [static]

For finding a gadgets string value. This function can only be used for gadgets with a text value. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 2/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier ListPos: Index into list if needed (defaults to -1 to mean read the text of the selected item. In the case of a combo this is the text in the editable field - which may be a value which does not exist in the combo's list. Valid,:  Flag indicating if the string could be read or not [OUTPUTS] You may pass NULL if you don't care about the validity (if invalid, the returned string will be a NULL string) Returns: The gadgets string value if Valid is TRUE, else a NULL string For Windows ----------- This function returns the string value for the following controls Edit ListBox ComboBox Static Button For ListBox and ComboBox controls the string value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetStringGadgetValue Definition at line 4294 of file dlgmgr.cpp. { if (Valid) *Valid = TRUE; String_256 StrVal; wxWindow * pGadget = GetGadget(WindowID, Gadget); wxString String; if (!pGadget) goto invalid; // if ( pGadget->IsKindOf(CLASSINFO(wxControlWithItems)) ) // Includes wxListBox - this seems to have false positives if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { if (ListPos >=0) { if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { if (ListPos>=(INT32)((wxOwnerDrawnComboBox *)pGadget)->GetCount()) goto invalid; String = ((wxOwnerDrawnComboBox *)pGadget)->GetString(ListPos); } else { if (ListPos>=(INT32)((wxControlWithItems *)pGadget)->GetCount()) goto invalid; String = ((wxControlWithItems *)pGadget)->GetString(ListPos); } goto out; } if (pGadget->IsKindOf(CLASSINFO(wxComboBox))) { String = ((wxComboBox *)pGadget)->GetValue(); goto out; } if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { String = ((wxOwnerDrawnComboBox *)pGadget)->GetValue(); goto out; } INT32 sel; if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) sel = ((wxOwnerDrawnComboBox *)pGadget)->GetSelection(); else sel = ((wxControlWithItems *)pGadget)->GetSelection(); if ( (sel == wxNOT_FOUND) || (sel < 0)) goto invalid; if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) String = ((wxOwnerDrawnComboBox *)pGadget)->GetString(sel); else String = ((wxControlWithItems *)pGadget)->GetString(sel); goto out; } if ( pGadget->IsKindOf(CLASSINFO(wxTextCtrl)) ) { String = ((wxTextCtrl *)pGadget)->GetValue(); goto out; } if ( pGadget->IsKindOf(CLASSINFO(wxSliderCombo)) ) { String = ((wxSliderCombo *)pGadget)->GetValue(); goto out; } String = pGadget->GetLabel(); out: StrVal = String.c_str(); return StrVal; invalid: if (Valid) *Valid=FALSE; return StrVal; }

UINT32 DialogManager::GetTreeGadgetChildrenCount (  CWindowID  wnd, CGadgetID  Gadget, CTreeItemID  hItem, BOOL  bRecursive = FALSE )  [static]

To get the number of children of an item in a tree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier hItem - ID of item bRecursive - TRUE if should count children recursively -  [OUTPUTS] Returns: number of children Definition at line 9332 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return 0; if( pGadget->IsKindOf( CLASSINFO(wxTreeCtrl) ) ) { return UINT32( ((wxTreeCtrl*)pGadget)->GetChildrenCount( hItem, FALSE != bRecursive ) ); } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return 0; }

CTreeItemID DialogManager::GetTreeGadgetFirstChildItem (  CWindowID  wnd, CGadgetID  Gadget, CTreeItemID  hItem )  [static]

To get the ID of the first child item of the specified in the tree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier hItem - ID of item -  [OUTPUTS] Returns: ID of item Definition at line 9297 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return CTreeItemID(); if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { wxTreeItemIdValue sessioncookie; return ((wxTreeCtrl*)pGadget)->GetFirstChild(hItem, sessioncookie); } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return CTreeItemID(); }

CTreeItemID DialogManager::GetTreeGadgetFirstSelectedItem (  CWindowID  wnd, CGadgetID  Gadget )  [static]

To get the ID of the first selected item in the tree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier hItem - ID of item -  [OUTPUTS] Returns: ID of item Definition at line 9195 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return CTreeItemID(); if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { return ((wxTreeCtrl*)pGadget)->GetSelection(); } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return CTreeItemID(); }

CCObject * DialogManager::GetTreeGadgetItemData (  CWindowID  wnd, CGadgetID  Gadget, CTreeItemID  hItem )  [static]

To insert an item into a tree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier -  [OUTPUTS] Returns: TRUE if the gadgets value could be set FALSE if it could not Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::SetStringGadgetValue Definition at line 9087 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return NULL; if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { wxTreeItemData* pData = ((wxTreeCtrl*)pGadget)->GetItemData(hItem); if (pData) // && pData->IsKindOf(CLASSINFO(CamelotTreeItemData))) return ((CamelotTreeItemData*)pData)->GetObject(); return NULL; } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return NULL; }

CTreeItemID DialogManager::GetTreeGadgetNextVisItem (  CWindowID  wnd, CGadgetID  Gadget, CTreeItemID  hItem )  [static]

To get the ID of the next visible item in the tree control after a specified item. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier hItem - ID of item -  [OUTPUTS] Returns: ID of item Definition at line 9264 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return CTreeItemID(); if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { return ((wxTreeCtrl*)pGadget)->GetNextVisible(hItem); } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return CTreeItemID(); }

CTreeItemID DialogManager::GetTreeGadgetRootItem (  CWindowID  wnd, CGadgetID  Gadget )  [static]

To get the ID of the root item in the tree control. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 08/Feb/2006 Parameters: WindowID  - Dialog box window identifier [INPUTS] Gadget - Gadget identifier -  [OUTPUTS] Returns: ID of item Definition at line 9160 of file dlgmgr.cpp. { wxWindow* pGadget = GetGadget(wnd, Gadget); if (!pGadget) return CTreeItemID(); if ( pGadget->IsKindOf(CLASSINFO(wxTreeCtrl)) ) { return ((wxTreeCtrl*)pGadget)->GetRootItem(); return CTreeItemID(); } ERROR3("SetTreeGadgetItem called on non-tree gadget"); return CTreeItemID(); }

MILLIPOINT DialogManager::GetUnitGadgetValue (  CWindowID  WindowID, CGadgetID  Gadget, UnitType  DefaultType, MILLIPOINT  StartRange, MILLIPOINT  EndRange, UINT32  IDSInvalidMsg = 0, BOOL *  Valid = NULL )  [static]

This function will obtain the gadget value and validate it. Validation will check that data has been entered in a correct unit type, and that it is in the range StartRange..EndRange. If the user enters an incorrect value the InvalidMsgID string will be displayed to the user in a dialog box, and Valid will have a FALSE value. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Dialog identifier TheType: The type of the gadgets value StartRange: Minimum gadget value EndRange: Maximum gadget value InvalidMsgID: Message displayed to the user when they have entered invalid data (either not the correct type or not in the correct range) This may be 0 if you do not wish an error to be reported Valid,:  Flag indicating if the value entered was valid or not. [OUTPUTS] If the Valid parameter is NULL, then validity of the result will not be checked, and the actual value of the control will be returned even if it was out of range. If this flag is returned FALSE then the return value will be 0. Returns: The value entered by the user in MILLIPOINTS. If Valid is FALSE then NULL will be returned. For Windows ----------- The function can be used to obtain a unit value from the string value of the following controls: Edit ListBox ComboBox Static For ListBox and ComboBox controls the unit value of the currently selected listitem is returned. This function would normally be called in response to a DIM_SELECTION_CHANGED or DIM_SELECTION_CHANGED_COMMIT message. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetUnitGadgetValue Definition at line 3810 of file dlgmgr.cpp. { MILLIPOINT Value = 0; // The return value BOOL IsValid; // Obtain the controls text String_256 StrValue = GetStringGadgetValue(WindowID, Gadget, NULL); // Convert the string to millipoints if it's valid Value = Convert::StringToMillipoints(StrValue, DefaultType, &IsValid); if (Valid == NULL) // If don't want it validated, return the value now return(Value); if (IsValid) { // Check that the value is in the range StartRange..EndRange if ((Value >= StartRange) && (Value <= EndRange)) { *Valid = TRUE; return (Value); // A correct value was entered } } // The value is invalid if (IDSInvalidMsg != 0) InformWarning(IDSInvalidMsg); // Scold the user, if a message was supplied return( 0 ); }

BOOL DialogManager::GetValueCount (  CWindowID  WindowID, CGadgetID  Gadget, INT32 *  Count )  [static]

For finding the number of values stored in a gadget. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 9/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Count,:  The number of items in the gadget [OUTPUTS] Returns: FALSE if an error occurred For Windows ----------- This function can be called on ListBox and ComboBox controls to obtain the number of values in their lists. Returns: Errors: If the function is called on an invalid control then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetValueCount Definition at line 4816 of file dlgmgr.cpp. { wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; //if ( pGadget->IsKindOf(CLASSINFO(wxControlWithItems)) ) // Includes wxListBox - this seems to have false positives if ( pGadget->IsKindOf(CLASSINFO(wxListBox)) || pGadget->IsKindOf(CLASSINFO(wxComboBox)) || pGadget->IsKindOf(CLASSINFO(wxChoice)) ) { INT32 c = ((wxControlWithItems *)pGadget)->GetCount(); if (Count) *Count=c; return TRUE; } else if (pGadget->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox))) { INT32 c = ((wxOwnerDrawnComboBox *)pGadget)->GetCount(); if (Count) *Count=c; return TRUE; } ERROR3("Invalid control"); return FALSE; }

BOOL DialogManager::GetValueIndex (  CWindowID  WindowID, CGadgetID  Gadget, WORD *  Index )  [static]

For finding the index of the currently selected item in a gadget. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 9/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Index,:  The index of the currently selected item in the gadget. The [OUTPUTS] index value starts at 0 for the first item in the list. Returns: TRUE if the index value could be read, else FALSE. For Windows ----------- The function can be called for ListBox and ComboBox controls (including our custom combobox cc_1dBitmapComboBoxEdit) Returns: Errors: If the function is called on an invalid gadget then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. See also: DialogOp::GetValueIndex Definition at line 5079 of file dlgmgr.cpp. { if (Index) *Index=GetFirstSelectedItem(WindowID, Gadget); return TRUE; }

BOOL DialogManager::GetValueIndex (  CWindowID  WindowID, CGadgetID  Gadget, INT32 *  Index )  [static]

For finding the index of the currently selected item in a gadget. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> / Jason (Based on Simon's stuff...) Date: 11/10/95 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Index,:  The index of the currently selected item in the gadget. The [OUTPUTS] index value starts at 0 for the first item in the list. THIS CAN NOW RETURN -1 AS IT SHOULD ALWAYS OF BEEN ABLE TO DO !!! Returns: TRUE if the index value could be read, else FALSE. For Windows ----------- The function can be called for ListBox and ComboBox controls Returns: Errors: If the function is called on an invalid gadget then an ENSURE failure will occur in a DEBUG build. In a retail build FALSE is returned. Notes: ALWAYS USE THIS ONE IN PREFERENCE TO THE WORD ONE, IE ALWAYS PASS A INT32 IN, NOT A WORD !!! This function now works internally as well, since comparing a INT32 -1 with a word -1 didn't work out too well... See also: DialogOp::GetValueIndex Definition at line 5037 of file dlgmgr.cpp. { INT32 index = GetFirstSelectedItem(WindowID, Gadget); if (Index) *Index=index; TRACEUSER("amb", _T("Index is %d"),index); return TRUE; }

BOOL DialogManager::GetWindowPosition (  CWindowID  WindowID, RECT *  pRect )  [static]

Definition at line 7263 of file dlgmgr.cpp. { wxRect Rect; if (!GetWindowPosition(WindowID, &Rect)) return FALSE; pRect->bottom=Rect.GetBottom(); pRect->top=Rect.GetTop(); pRect->left=Rect.GetLeft(); pRect->right=Rect.GetRight(); return TRUE; }

BOOL DialogManager::GetWindowPosition (  CWindowID  WindowID, wxRect *  pRect )  [static]

Allows the user to get the current window position. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/97 Parameters: WindowID  Handle of window [INPUTS] Rect  pointer to the rectangle to fill in [OUTPUTS] Returns: True if the call was successful, FALSE otherwise. See also: DialogOp::GetWindowPosition; DialogManager::SetWindowPosition; Definition at line 7257 of file dlgmgr.cpp. { *pRect = wxRect(WindowID->GetPosition(), WindowID->GetSize()); return TRUE; }

CWindowID DialogManager::GetWindowUnderPointer (  WinCoord *  wc = NULL  )  [static]

Fills in the status line text from the help text if over a control Scope: Public. Author: Alex Bligh <alex@alex.org.uk> Date: 15/05/2006 Parameters: -  [INPUTS] wc  - if non-NULL, filled in with the pointer coords [OUTPUTS] Returns: the window ID under the pointer or NULL for none Errors: - See also: - Definition at line 7880 of file dlgmgr.cpp. { wxPoint pt=wxGetMousePosition(); wxWindow * w=::wxChildWindowFromPoint(pt, FALSE, -1); if (wc && w) { pt = w->ScreenToClient(pt); wc->x=pt.x; wc->y=pt.y; } return w; }

static BOOL DialogManager::HandleScrollBarMsg (  wxWindow *  pScrollWnd, UINT32  wParam, INT32  lParam, WORD  CurrentThumbPos )  [static, private]

BOOL DialogManager::HideGadget (  CWindowID  WindowID, CGadgetID  Gadget, BOOL  Hide )  [static]

For hiding/showing gadgets. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/93 Parameters: WindowID,:  Dialog box window identifier [INPUTS] Gadget: Gadget identifier Enabled: TRUE if the gadget is to be hidden. FALSE if the gadget is to be shown. -  [OUTPUTS] Returns: TRUE if successful, else FALSE For Windows ----------- This function can be called for all controls Returns: Errors: - See also: DialogOp::HideGadget Definition at line 5263 of file dlgmgr.cpp. { // For the time being, we do this by Hide/Unhide wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; pGadget->Show(!Hide); return TRUE; }

BOOL DialogManager::HighlightText (  CWindowID  WindowID, CGadgetID  Gadget, INT32  nStart = 0, INT32  nEnd = -1 )  [static]

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: WindowID  Window/dialogue box ID (handle) [INPUTS] Gadget control ID within the window/dialogue box 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: DialogOp::HighlightText Definition at line 5472 of file dlgmgr.cpp. { // Find out the window class of the control. Only those with editable text can // be highlighted. // For the time being, we do this by Hide/Unhide wxWindow * pGadget = GetGadget(WindowID, Gadget); if (!pGadget) return FALSE; #ifdef _DEBUG ERROR3IF( !pGadget->IsKindOf( CLASSINFO(wxListBox) ) && !pGadget->IsKindOf( CLASSINFO(wxComboBox) ) && !pGadget->IsKindOf( CLASSINFO(wxOwnerDrawnComboBox) ) && !pGadget->IsKindOf( CLASSINFO(wxTextCtrl) ), "Wrong kind of control in DialogManager::HighlightText"); #endif if( pGadget->IsKindOf( CLASSINFO(wxTextCtrl) ) ) { ( (wxTextCtrl *)pGadget )->SetSelection( -1, -1 ); } else if( pGadget->IsKindOf( CLASSINFO(wxComboBox) ) ) { ( (wxComboBox *)pGadget )->SetSelection( -1, -1 ); } else if( pGadget->IsKindOf( CLASSINFO(wxOwnerDrawnComboBox) ) ) { ( (wxOwnerDrawnComboBox *)pGadget )->SetSelection( -1 ); } return TRUE; }

void DialogManager::InitPaneInfoHash (   )  [static, protected]

Initializes the pane info hash if it has not been previously initialized Scope: protected. Author: Alex Bligh <alex@alex.org.uk> Date: 25/07/06 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 773 of file dlgmgr.cpp. { if (s_pPaneInfoHash) return; s_pPaneInfoHash = new IdToSerializedPaneInfo; }

void DialogManager::InvalidateGadget (  CWindowID  WindowID, CGadgetID  Gadget, ReDrawInfoType *  ExtraInfo, DocRect *  InvalidRect )  [static]

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: WindowID  - The Window identifier [INPUTS] Gadget - The ID of the gadget that you want to be redrawn 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 structures. (or NULL to invalidate the entire window) 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! Definition at line 5594 of file dlgmgr.cpp. { if (InvalidRect == NULL) // No rect - invalidate the entire window { InvalidateGadget(WindowID, Gadget); return; } if (ExtraInfo == NULL || WindowID == 0) { ERROR2RAW("DialogManager::InvalidateGadget was passed illegal NULL parameter(s)"); return; } ERROR3IF(ExtraInfo->Dpi == 0, "Screen DPI is zero? I think not! Divide-by-zeros imminent!"); if (!ExtraInfo->Dpi) return; INT32 PixelSize = 72000 / ExtraInfo->Dpi; // Size of a pixel in MILLIPOINTS DocRect irect=*InvalidRect; if (irect.lo.y > irect.hi.y) { // not an ERROR3 because this is in rendering code TRACEALL( _T("Rectangle upside down in InvalidateGadget\n") ); // swap over the rect Y co-ords INT32 temp=irect.lo.y; irect.lo.y=irect.hi.y; irect.lo.y=temp; } wxRect ToRedraw(irect.lo.x / PixelSize, (ExtraInfo->dy-irect.hi.y) / PixelSize,