Represents a modal or modeless dialog window with customizable content. More...

#include <Dialog.h>

Inheritance diagram for Dialog:

Public Member Functions
	Dialog ()
	Constructs a new Dialog instance.
virtual	~Dialog ()
	Destructor.
void	setTitle (const wstring &title)
	Sets the dialog's window title.
wstring	getTitle ()
	Gets the current dialog title.
void	setSize (long width, long height)
	Sets the size of the dialog window.
void	getSize (long &width, long &height)
	Retrieves the current size of the dialog window.
BOOL	setVisible (Component *parent)
	Shows the dialog and attaches it to a parent window.
void	close (long exitCode)
	Closes the dialog with a specific exit code.
void	setExitCode (long exitCode)
	Sets the dialog's exit code without closing.
long	getExitCode ()
	Gets the current exit code of the dialog.
GridPanel *	getContentPane ()
	Gets a pointer to the content pane GridPanel.
WinHandle	getContentPaneNativeHandle ()
	Gets the native window handle of the content pane.
void	setDialogNativeHandle (const wstring &source, WinHandle hDlg)
	Sets the native handle of the dialog window.
void	onWindowMoved ()
	Called when the dialog window has been moved.
virtual BOOL	windowOpening ()
	Called before the dialog window opens.
virtual BOOL	windowOpened ()
	Called after the dialog window has opened.
virtual BOOL	okToClose ()
	Called to determine if the dialog can close.
virtual void	windowClosed ()
	Called after the dialog has closed.
Public Member Functions inherited from Component
	Component ()
	Constructs a new Component instance.
virtual	~Component ()
	Virtual destructor.
long	getId ()
	Gets the unique ID assigned to this component.
void	setParent (Component *parent)
Component *	getParent ()
wstring	getComponentType ()
	Gets the component type string.
BOOL	isWindowCreated ()
	Returns whether the native window has been created.
WinHandle	getWindowHandle ()
	Returns the native WinHandle for this component.
int	createComponent (WinHandle hParent, Bounds rect, long nCmd=-1, BOOL isVisible=TRUE)
	Creates the component's native window as a child of hParent.
void	setFont (long fontSize, BOOL isBold=FALSE, BOOL isItalic=FALSE, BOOL isUnderlined=FALSE, const wstring &fontName=L"Arial")
	Sets the font for the component.
void	showBorder (BOOL bShow=TRUE)
void	setEnabled (BOOL bEnable=TRUE)
	Enables or disables the component.
void	setVisible (BOOL bShow=TRUE)
	Shows or hides the component.
void	GetClientRect (Bounds &rect)
void	GetWindowRect (Bounds &rect)
void	moveWindow (long x, long y, long width, long height, BOOL bRedraw=TRUE)
	Moves and resizes the component window.
void	reconfigureScrollBar ()
	Forces the component to recalculate the scrollbar info.
void	setMouseWheelDelta (int delta)
	Sets the accumulated mouse wheel delta.
int	getMouseWheelDelta ()
	Gets the current mouse wheel delta.
virtual int	getMinimumHeight ()
	Returns the minimum height the component can have.
virtual int	getPreferredHeight ()
	Returns the preferred height of the component.
void	repaint (WinHandle hWnd=NULL)
	Requests the component to repaint itself.
void	clearQueuedPaintRequest ()
	clears the queued paint request. This function should only be called internally from the library.
virtual void	onPaint (Graphics *g)
	Called to paint the component's client area.
virtual void	onWindowResized ()
	Called when the component's window is resized.
virtual void	onAction (WinHandle hTarget, long actionId, const ProcParams &procParams)
	Called when an action occurs on the component.
virtual void	onSelectionChanged (WinHandle hTarget, int itemIndex, const wstring &itemText, BOOL itemChecked, const ProcParams &procParams)
	Called when the selection changes.
virtual void	onDataChanged (WinHandle hTarget, const wstring &newValue, const ProcParams &procParams)
	Called when data changes in the component.
virtual BOOL	onHorzScroll (WinHandle hTarget, const ProcParams &procParams)
	Called on horizontal scroll events.
virtual BOOL	onDrawMeasureItem (LPMEASUREITEMSTRUCT dis, const ProcParams &procParams)
	Called when measuring an item for owner-draw controls.
virtual BOOL	onDrawItem (LPDRAWITEMSTRUCT dis, const ProcParams &procParams)
	Called when drawing an item for owner-draw controls.
virtual void	onMousePressed (WinHandle hWnd, int x, int y, int clickCount, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the mouse is pressed within the component.
virtual void	onMouseReleased (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the mouse button is released within the component.
virtual void	onMouseRightClicked (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the right mouse button is clicked within the component.
virtual void	onMouseMoved (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the mouse is moved within the component.
virtual BOOL	onMouseWheel (WinHandle hWnd, int x, int y, int delta)
	Called when the mouse wheel is used over the component.
virtual void	onArrowLeft (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowRight (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onPageUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onPageDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyHome (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyEnd (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyInsert (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyDelete (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyBackSpace (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyTyped (wchar_t ch, BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyTab (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyEnter (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF1 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF2 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF3 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF4 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF5 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF6 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF7 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF8 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF9 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF10 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF11 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF12 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onFocusGained ()
	Called when the component gains keyboard focus.
virtual void	onFocusLost ()
	Called when the component loses keyboard focus.
virtual void	onTimer (unsigned int timerId)
	Called on timer events.
virtual BOOL	getScrollingInfo (__int64 &scrollMin, __int64 &scrollMax, __int64 &pageSize)
	Provides scrolling information if supported.
virtual void	setScrollbarTopOffset (__int64 firstVisibleRow)
	Sets the scrollbar's top offset.
void	updateScrollbarTopOffset (__int64 firstVisibleRow)
	Updates the scrollbar's top offset based on the current first visible row.

Protected Member Functions
BOOL	getCreateWindowOptions (wstring &title, UINT &widownStyles, wstring &wndClassName, BOOL &isCustomWndProc)
	Retrieves window creation options such as title, styles, and class name.
void	windowCreated ()
	Called after the native window has been created.
Protected Member Functions inherited from Component
long	getActionId ()
	Returns the component's action command ID.
void	doNotSubclass ()
	Marks this component's native window to avoid subclassing.
void	startTimer (unsigned int timerId, unsigned int milliseconds)
	Starts a timer with the given ID and interval.
void	stopTimer (unsigned int timerId)
	Stops the timer identified by timerId.
void	protectedAddDataChangedListener (DataChangeListener *l)
	Adds a data change listener.
void	protectedAddSelectionChangedListener (SelectionChangeListener *l)
	Adds a selection change listener.
void	protectedAddActionListener (ActionListener *l)
	Adds an action listener.
void	protectedAddItemDoubleClickedListener (RowDoubleClickListener *l)
	Adds a row double-click listener.
void	protectedFireDataChangedEvent (const wstring &oldValue, const wstring &newValue)
	Fires a data changed event to registered listeners.
void	protectedFireSelectionChangedEvent (long selectionIndex=-1, const wstring &selectionValue=L"", BOOL checked=FALSE)
	Fires a selection changed event to registered listeners.
void	protectedFireActionEvent (long actionId=-1, const wstring &actionName=L"")
	Fires an action event to registered listeners.
void	protectedFireItemDoubleClickedEvent (__int64 rowIndex)
	Fires a row double-click event to registered listeners.

Additional Inherited Members
Protected Attributes inherited from Component
WinHandle	_hWnd
	Handle to the native window associated with this component.
wstring	_componentType
	String representing the component type (e.g., "Button", "ComboBox").
BOOL	_showBorder

Detailed Description

Represents a modal or modeless dialog window with customizable content.

This class manages a dialog window including its title, size, visibility, exit code, and content pane. It provides overridable hooks for dialog lifecycle events.

Constructor & Destructor Documentation

◆ Dialog()

Dialog::Dialog ( )

Constructs a new Dialog instance.

◆ ~Dialog()

virtual Dialog::~Dialog ( )

virtual

Destructor.

Member Function Documentation

◆ close()

void Dialog::close ( long exitCode )

Closes the dialog with a specific exit code.

Parameters

exitCode Exit code to set (e.g., DIALOG_OK, DIALOG_CANCEL).

◆ getContentPane()

GridPanel * Dialog::getContentPane ( )

Gets a pointer to the content pane GridPanel.

Returns: Pointer to the GridPanel used as content pane.

◆ getContentPaneNativeHandle()

WinHandle Dialog::getContentPaneNativeHandle ( )

Gets the native window handle of the content pane.

Returns: WinHandle of the content pane.

◆ getCreateWindowOptions()

BOOL Dialog::getCreateWindowOptions	(	wstring &	title,
		UINT &	widownStyles,
		wstring &	wndClassName,
		BOOL &	isCustomWndProc )

protectedvirtual

Retrieves window creation options such as title, styles, and class name.

Parameters

title	Output parameter for window title.
widownStyles	Output parameter for window styles.
wndClassName	Output parameter for window class name.
isCustomWndProc	Output flag indicating custom window procedure usage.

Returns: TRUE if options retrieved successfully; otherwise FALSE.

Implements Component.

◆ getExitCode()

long Dialog::getExitCode ( )

Gets the current exit code of the dialog.

Returns: The exit code (e.g., DIALOG_OK, DIALOG_CANCEL).

◆ getSize()

void Dialog::getSize	(	long &	width,
		long &	height )

Retrieves the current size of the dialog window.

Parameters

width	Output parameter for dialog width.
height	Output parameter for dialog height.

◆ getTitle()

wstring Dialog::getTitle ( )

Gets the current dialog title.

Returns: The dialog's title string.

◆ okToClose()

virtual BOOL Dialog::okToClose ( )

virtual

Called to determine if the dialog can close.

Returns: TRUE to allow closing, FALSE to prevent.

◆ onWindowMoved()

void Dialog::onWindowMoved ( )

virtual

Called when the dialog window has been moved.

Reimplemented from Component.

◆ setDialogNativeHandle()

void Dialog::setDialogNativeHandle	(	const wstring &	source,
		WinHandle	hDlg )

Sets the native handle of the dialog window.

Parameters

source	Debug string or source identifier.
hDlg	Handle to the native dialog window.

◆ setExitCode()

void Dialog::setExitCode ( long exitCode )

Sets the dialog's exit code without closing.

Parameters

exitCode Exit code value.

◆ setSize()

void Dialog::setSize	(	long	width,
		long	height )

Sets the size of the dialog window.

Parameters

width	Width of the dialog in pixels.
height	Height of the dialog in pixels.

◆ setTitle()

void Dialog::setTitle ( const wstring & title )

Sets the dialog's window title.

Parameters

title The title string to display on the dialog.

◆ setVisible()

BOOL Dialog::setVisible ( Component * parent )

Shows the dialog and attaches it to a parent window.

Parameters

hWndParent Handle to the parent window.

Returns: TRUE if the dialog was successfully made visible.

◆ windowClosed()

virtual void Dialog::windowClosed ( )

virtual

Called after the dialog has closed.

◆ windowCreated()

void Dialog::windowCreated ( )

protectedvirtual

Called after the native window has been created.

Implements Component.

◆ windowOpened()

virtual BOOL Dialog::windowOpened ( )

virtual

Called after the dialog window has opened.

Returns: TRUE if the dialog opened successfully.

◆ windowOpening()

virtual BOOL Dialog::windowOpening ( )

virtual

Called before the dialog window opens.

Returns: TRUE to allow the dialog to open, FALSE to cancel.

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

Dialog.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Dialog()

◆ ~Dialog()

Member Function Documentation

◆ close()

◆ getContentPane()

◆ getContentPaneNativeHandle()

◆ getCreateWindowOptions()

◆ getExitCode()

◆ getSize()

◆ getTitle()

◆ okToClose()

◆ onWindowMoved()

◆ setDialogNativeHandle()

◆ setExitCode()

◆ setSize()

◆ setTitle()

◆ setVisible()

◆ windowClosed()

◆ windowCreated()

◆ windowOpened()

◆ windowOpening()