Radio button control window class.

The PMRadioButton class creates and manages radio button control windows. A radio button is a circle or a diamond with associated text representing a choice. When a user selects the choice, the radio button is filled to indicate that the choice is selected. The user can clear the radio button by selecting another radio button. Radio buttons are mutually exclusive.

You can construct and destruct objects of this class.

Source:

pm_radiobutton.h:30

Author:

Dmitry A.Steklenev

Version:

$Revision: 1.4 $

Entity	Inherited From	Type	Scope	Short Description
PMRadioButton		constructor	public	Wraps the radio button control window object around an existing presentation window handle.
PMRadioButton		constructor	public	Wraps the radio button control window object around an existing child window with the specified identity.
PMRadioButton		constructor	public	Constructs the radio button control window.
select		method	public	Selects the radio button.
select		method	public	Selects the radio button.
selected		method	public	Returns the selected button index.
attach_accelerators	PMWindow	method	public	Replaces the accelerator keys used by the window.
auto_delete_object	PMWindow	method	public	Determines whether to delete the window object when the presentation window is destroyed.
capture_pointer	PMWindow	method	public	Captures mouse pointer.
center_at	PMWindow	method	public	Centers the window concerning his owner window.
color	PMWindow	method	public	Sets the specified color value.
color	PMWindow	method	public	Returns the specified color value.
destroy	PMWindow	method	public	Destroys the presentation window.
detach_accelerators	PMWindow	method	public	Detaches the accelerator keys used by the window.
disable	PMWindow	method	public	Prevents keyboard and mouse input from being sent to the window.
dispatch	PMWindow	method	protected	Dispatch system native events.
dispatch_everything	PMWindow	method	protected	Dispatch all not catched events.
enable	PMWindow	method	public	Enables the window to accept keyboard and mouse input.
enable_drop	PMWindow	method	public	Enables the window to accept dropped objects.
font	PMWindow	method	public	Sets a new font to be used by the window.
frame	PMWindow	method	public	Return the handle of the first frame window associated with this window.
handle	PMWindow	method	public	Returns the presentation window handle.
handle_events	PMWindow	method	protected	Handle events.
has_focus	PMWindow	method	public	Has focus.
has_pointer_captured	PMWindow	method	public	Has pointer captured.
hide	PMWindow	method	public	Makes the window invisible.
id	PMWindow	method	public	Returns the window identifier.
invalidate	PMWindow	method	public	This method adds the whole window to a window's update region.
invalidate	PMWindow	method	public	This method adds a region to a window's update region.
is_auto_delete_object	PMWindow	method	public	If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned.
is_valid	PMWindow	method	public	Is the window valid.
is_visible	PMWindow	method	public	Is the window visible.
owner	PMWindow	method	public	Sets the owner window.
owner	PMWindow	method	public	Returns the owner window handle.
parent	PMWindow	method	public	Sets the parent window.
parent	PMWindow	method	public	Returns the parent window handle.
pointer	PMWindow	method	public	Returns the mouse pointer used when the mouse is over the window.
pointer	PMWindow	method	public	Sets the appearance used by the mouse pointer when it is over the window.
post	PMWindow	method	public	Posts a message to window.
rectangle	PMWindow	method	public	Sets the window's position and size.
rectangle	PMWindow	method	public	Returns the window rectangle.
release_pointer	PMWindow	method	public	Release mouse pointer.
send	PMWindow	method	public	Sends a message to window.
set_focus	PMWindow	method	public	Sets the input focus to the window.
show	PMWindow	method	public	Makes the window visible.
start_timer	PMWindow	method	public	This method starts a timer.
stop_handling_events	PMWindow	method	protected	Stop handling events.
stop_timer	PMWindow	method	public	This method stops a timer.
text	PMWindow	method	public	Returns the window text.
text	PMWindow	method	public	Sets the window text.
text_len	PMWindow	method	public	Returns the length of the window text.
translate	PMWindow	method	public	Translates the window text.

Wraps the radio button control window object around an existing presentation window handle.

The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.

Source:

pm_radiobutton.h:42

Code:

public PMRadioButton (

HWND handle )

Wraps the radio button control window object around an existing child window with the specified identity.

The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.

Source:

pm_radiobutton.h:56

Params:

hparent	Specifies the parent-window handle.
id	Specifies the identity of the child window.

Code:

public PMRadioButton (	HWND hparent ,
	SHORT id )

Constructs the radio button control window.

Source:

pm_radiobutton.h:101

Params:

id	Specifies the window identifier.
text	Specifies the window text.
hparent	Specifies the parent-window handle.
x,y,cx,cy	Specifies the window shape.
style	Specifies the window style: BS_AUTORADIOBUTTON Creates an auto-radio button (see also BS_RADIOBUTTON). When the user selects an auto-radio button, the system automatically selects the button and removes the selection from the other auto-radio buttons in the group. BS_AUTOSIZE Creates a button that is sized automatically to ensure that the contents fit. Note: The cx or cy parameter of must be specified as -1 to implement the autosize feature. BS_NOCURSORSELECT Creates an auto-radio button that will not be selected automatically when the user moves the cursor to the button using the cursor-movement keys. This style is valid only in combination with the BS_AUTORADIOBUTTON style or the AUTORADIOBUTTON statement in a resource-definition file. BS_RADIOBUTTON Creates a radio button-a small circle that has text displayed to its right. Radio buttons usually are used in groups of related, but exclusive, choices. When the user selects a radio button, the button sends a WM_CONTROL message to its owner window. The user should select the button and remove the selection from the other radio buttons in the group.

See Also:

PMWindow::PMWindow

Code:

public PMRadioButton (	SHORT id ,
	const char * text ,
	HWND hparent ,
	LONG x ,
	LONG y ,
	LONG cx ,
	LONG cy ,
	ULONG style )

Selects the radio button.

Source:

pm_radiobutton.h:104

Code:

public virtual void select (

)

Selects the radio button.

Source:

pm_radiobutton.h:116

Param:

index

The 0-based index of the selected radio button in a group. Note: The index includes all windows that are part of the group, not just radio buttons. To ensure that the index only includes radio buttons, be sure that the group does not contain any other windows.

Code:

public virtual void select (

int index )

Returns the selected button index.

Source:

pm_radiobutton.h:129

Returns:

The 0-based index of the selected radio button in a group. If no radio button is selected, -1 is returned.

Note: The index returned includes all windows that are part of the group, not just radio buttons. To ensure that the index only includes radio buttons, be sure that the group does not contain any other windows.

Code:

public int selected (

) const

Replaces the accelerator keys used by the window.

Inherited From:

PMWindow

Source:

pm_window.h:540

Params:

res_id	Accelerator-table identifier, within the resource file.
hmodule	Module handle referencing a dynamic link library containing the resource or NULLHANDLE for the application's module.

Code:

public virtual void attach_accelerators (	SHORT res_id ,
	HMODULE hmodule )

Determines whether to delete the window object when the presentation window is destroyed.

The deletion occurs when the window system dispatches a destroy event to the window.

Inherited From:

PMWindow

Source:

pm_window.h:602

Code:

public virtual void auto_delete_object (

BOOL state = TRUE )

Captures mouse pointer.

If capture is true, pointer events are sent only to this window even if the pointer is outside of this window. If capture is false, the window releases the pointer capture. If you attempt to capture the pointer when another window currently is capturing the pointer, an exception is thrown.

Inherited From:

PMWindow

Source:

pm_window.h:474

Code:

public virtual void capture_pointer (

BOOL capture = TRUE )

Centers the window concerning his owner window.

Inherited From:

PMWindow

Source:

pm_window.h:235

Code:

public virtual void center_at (

)

Sets the specified color value.

Inherited From:

PMWindow

Source:

pm_window.h:387

Params:

type

Specifies one of window's color.

color

The RGB color value or one of the SYSCLR_* index values: SYSCLR_SHADOWHILITEBGND System color for shadow highlighted background. SYSCLR_SHADOWHILITEFGND System color for shadow highlighted foreground. SYSCLR_SHADOWTEXT System color for shadow text. SYSCLR_ENTRYFIELD System color for entry field. SYSCLR_MENUDISABLEDTEXT System color for disabled menu text. SYSCLR_MENUHILITE System color for highlighted menu text. SYSCLR_MENUHILITEBGND System color for highlighted menu background. SYSCLR_PAGEBACKGROUND System color for page background. SYSCLR_FIELDBACKGROUND System color for field background. SYSCLR_BUTTONLIGHT System color for light button. SYSCLR_BUTTONMIDDLE System color for middle button. SYSCLR_BUTTONDARK System color for dark button. SYSCLR_BUTTONDEFAULT System color for default button. SYSCLR_TITLEBOTTOM System color for title bottom. SYSCLR_SHADOW System color for shadow. SYSCLR_ICONTEXT System color for icon text. SYSCLR_DIALOGBACKGROUND System color for dialog background. SYSCLR_HILITEFOREGROUND System color for highlighted foreground. SYSCLR_HILITEBACKGROUND System color for highlighted background. SYSCLR_TITLETEXT System color for title text. SYSCLR_INACTIVETITLETEXTBGND System color for inactive title text background. SYSCLR_ACTIVETITLETEXTBGND System color for active title text background. SYSCLR_INACTIVETITLETEXT System color for inactive title text. SYSCLR_ACTIVETITLETEXT System color for active title text. SYSCLR_OUTPUTTEXT System color for output text. SYSCLR_WINDOWSTATICTEXT System color for static window text. SYSCLR_SCROLLBAR System color for scroll bar. SYSCLR_BACKGROUND System color for background. SYSCLR_ACTIVETITLE System color for active title. SYSCLR_INACTIVETITLE System color for inactive title. SYSCLR_MENU System color for a menu. SYSCLR_MENUTEXT System color for menu text. SYSCLR_WINDOW System color for a window. SYSCLR_WINDOWTEXT System color for window text. SYSCLR_WINDOWFRAME System color for a window frame. SYSCLR_ACTIVEBORDER System color for active border. SYSCLR_INACTIVEBORDER System color for inactive border. SYSCLR_APPWORKSPACE System color for application work space. SYSCLR_HELPBACKGROUND System color for help background. SYSCLR_HELPTEXT System color for help text. SYSCLR_HELPHILITE System color for help highlighting..

See Also:

PMWindow::color

Code:

public void color (	LONG type ,
	LONG color )

Returns the specified color value.

Inherited From:

PMWindow

Source:

pm_window.h:332

Param:

type

Specify one of window's colors: CCI_FOREGROUND Foreground color. CCI_FOREGROUNDREADONLY Read-only text foreground color. CCI_BACKGROUND Background color. CCI_BACKGROUNDDIALOG Background color (in dialog). CCI_DISABLEDFOREGROUND Disabled foreground color. CCI_DISABLEDFOREGROUNDREADONLY Disabled read-only text foreground color. CCI_DISABLEDBACKGROUND Disabled background color. CCI_DISABLEDBACKGROUNDDIALOG Disabled background color (in dialog). CCI_HIGHLIGHTFOREGROUND Highlight text foreground color. CCI_HIGHLIGHTBACKGROUND Highlight background color. CCI_HIGHLIGHTBACKGROUNDDIALOG Highlight background color (in dialog). CCI_INACTIVEFOREGROUND Inactive foreground color. CCI_INACTIVEFOREGROUNDDIALOG Inactive foreground color (in dialog). CCI_INACTIVEBACKGROUND Inactive background color. CCI_INACTIVEBACKGROUNDTEXT Inactive text background color. CCI_ACTIVEFOREGROUND Active foreground color. CCI_ACTIVEFOREGROUNDDIALOG Active foreground color (in dialog). CCI_ACTIVEBACKGROUND Active background color. CCI_ACTIVEBACKGROUNDTEXT Active text background color. CCI_PAGEBACKGROUND Page background color. CCI_PAGEFOREGROUND Page foreground color. CCI_EDITBACKGROUND Edit area background color. CCI_EDITFOREGROUND Edit area foreground color. CCI_FIELDBACKGROUND Edge (or status line) window color. CCI_BORDER Thin border color. CCI_BORDERLIGHT Light border color. CCI_BORDERDARK Dark border color. CCI_BORDER2 Disabled border, new notebook border or container record emphasis color. CCI_BORDER2LIGHT Light border 2 color. CCI_BORDER2DARK Dark border 2 color. CCI_BORDERDEFAULT Outer button border color. CCI_BUTTONBACKGROUND Sub-button background color. CCI_BUTTONBORDERLIGHT Sub-button light border color. CCI_BUTTONBORDERDARK Sub-button dark border color. CCI_ARROW Arrow color. CCI_DISABLEDARROW Disabled arrow color. CCI_ARROWBORDERLIGHT Arrow light border color. CCI_ARROWBORDERDARK Arrow dark border color. CCI_CHECKLIGHT Light check mark color. CCI_CHECKMIDDLE Middle check mark color. CCI_CHECKDARK Dark check mark color. CCI_ICONFOREGROUND Icon text color. CCI_ICONBACKGROUND Icon text background color. CCI_ICONBACKGROUNDDESKTOP Icon text background color (in desktop). CCI_ICONHILITEFOREGROUND Icon text highlight color. CCI_ICONHILITEBACKGROUND Icon text highlight background color. CCI_MAJORTABFOREGROUND Major tab text color. CCI_MAJORTABBACKGROUND Major tab background color. CCI_MINORTABFOREGROUND Minor tab text color. CCI_MINORTABBACKGROUND Minor tab background color.

Returns:

The RGB color value. If you have not set the specified color, the default color value CLR_DEFAULT is returned.

Code:

public LONG color (

LONG type ) const

Destroys the presentation window.

Destroying the associated presentation window for this object.

Inherited From:

PMWindow

Source:

pm_window.h:159

Code:

public virtual void destroy (

)

Detaches the accelerator keys used by the window.

Inherited From:

PMWindow

Source:

pm_window.h:546

Code:

public virtual void detach_accelerators (

)

Prevents keyboard and mouse input from being sent to the window.

Inherited From:

PMWindow

Source:

pm_window.h:409

Code:

public virtual void disable (

)

Dispatch system native events.

PMWindow calls this function when a system native window event occurs.

Inherited From:

PMWindow

Source:

pm_window.h:640

Code:

protected virtual MRESULT dispatch (	ULONG msg ,
	MPARAM mp1 ,
	MPARAM mp2 )

Dispatch all not catched events.

A virtual method that provides default implementation for all events that occur on every window.

Inherited From:

PMWindow

Source:

pm_window.h:649

Code:

protected virtual MRESULT dispatch_everything (	ULONG msg ,
	MPARAM mp1 ,
	MPARAM mp2 )

Enables the window to accept keyboard and mouse input.

Inherited From:

PMWindow

Source:

pm_window.h:407

Code:

public virtual void enable (

BOOL state = TRUE )

Enables the window to accept dropped objects.

Inherited From:

PMWindow

Source:

pm_window.h:420

Code:

public virtual void enable_drop (

LONG type )

Sets a new font to be used by the window.

Inherited From:

PMWindow

Source:

pm_window.h:237

Code:

public virtual void font (

const char * font )

Return the handle of the first frame window associated with this window.

Inherited From:

PMWindow

Source:

pm_window.h:228

Code:

public HWND frame (

) const

Returns the presentation window handle.

Inherited From:

PMWindow

Source:

pm_window.h:162

Code:

public HWND handle (

) const

Handle events.

Attaches the handler to the PMWindow object. The windows's dispatch function is called to process all events sent or posted to the window.

Inherited From:

PMWindow

Source:

pm_window.h:621

Code:

protected void handle_events (

)

Has focus.

If the window has the input focus, TRUE is returned. Otherwise, FALSE is returned.

Inherited From:

PMWindow

Source:

pm_window.h:442

Code:

public virtual BOOL has_focus (

) const

Has pointer captured.

If this window is currently capturing pointer events, true is returned. Otherwise, false is returned.

Inherited From:

PMWindow

Source:

pm_window.h:495

Code:

public virtual BOOL has_pointer_captured (

) const

Makes the window invisible.

Inherited From:

PMWindow

Source:

pm_window.h:394

Code:

public virtual void hide (

)

Returns the window identifier.

Inherited From:

PMWindow

Source:

pm_window.h:164

Code:

public SHORT id (

) const

This method adds the whole window to a window's update region.

The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing.

Inherited From:

PMWindow

Source:

pm_window.h:462

Code:

public virtual void invalidate (

)

This method adds a region to a window's update region.

The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing.

Inherited From:

PMWindow

Source:

pm_window.h:452

Code:

public virtual void invalidate (

const PMRect & rect )

If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned.

Inherited From:

PMWindow

Source:

pm_window.h:609

Code:

public virtual BOOL is_auto_delete_object (

)

Is the window valid.

If this object represents a valid window in the window system, TRUE is returned. If the window has yet to be created or has already been destroyed, FALSE is returned.

Inherited From:

PMWindow

Source:

pm_window.h:430

Code:

public virtual BOOL is_valid (

) const

Is the window visible.

If the window's style is set to visible, TRUE is returned. Otherwise, FALSE is returned. A window can have the style visible and yet not be showing if it is covered by another window.

Inherited From:

PMWindow

Source:

pm_window.h:404

Code:

public virtual BOOL is_visible (

)

Sets the owner window.

Windows that send messages send them to their owner. When an owner window is destroyed, all windows owned by it are also destroyed. The owner window must belong to the current thread.

Inherited From:

PMWindow

Source:

pm_window.h:222

Param:

howner

New owner window handle.

Code:

public virtual void owner (

HWND howner )

Returns the owner window handle.

Windows that send messages send them to their owner. When an owner window is destroyed, all windows owned by it are also destroyed. The owner window must belong to the current thread.

Inherited From:

PMWindow

Source:

pm_window.h:185

Code:

public HWND owner (

) const

Sets the parent window.

The parent window provides the coordinate system used for positioning a child window. A window whose parent is the desktop window, is called a top-level or overlapped window.

Inherited From:

PMWindow

Source:

pm_window.h:209

Params:

hparent	New parent window handle. This cannot be a descendant of this window. If this parameter is a desktop window handle or HWND_DESKTOP, window becomes a main window. If this parameter is not equal to HWND_OBJECT, it must be a descendant of the same desktop window as this window. If this parameter is HWND_OBJECT or a window handle returned by WinQueryObjectWindow, window becomes an object window.
redraw	Redraw indicator.

Code:

public virtual void parent (	HWND hparent ,
	BOOL redraw = TRUE )

Returns the parent window handle.

The parent window provides the coordinate system used for positioning a child window. A window whose parent is the desktop window, is called a top-level or overlapped window.

Inherited From:

PMWindow

Source:

pm_window.h:174

Code:

public HWND parent (

) const

Returns the mouse pointer used when the mouse is over the window.

Inherited From:

PMWindow

Source:

pm_window.h:529

Code:

public virtual LONG pointer (

) const

Sets the appearance used by the mouse pointer when it is over the window.

Inherited From:

PMWindow

Source:

pm_window.h:526

Param:

id

System-pointer identifier. SPTR_DEFAULT Default pointer, that is chosen by Presentation Manager. SPTR_ARROW Arrow pointer SPTR_TEXT Text I-beam pointer SPTR_WAIT Hourglass pointer SPTR_SIZE Size pointer SPTR_MOVE Move pointer SPTR_SIZENWSE Downward-sloping, double-headed arrow pointer SPTR_SIZENESW Upward-sloping, double-headed arrow pointer SPTR_SIZEWE Horizontal, double-headed arrow pointer SPTR_SIZENS Vertical, double-headed arrow pointer SPTR_APPICON Standard application icon pointer SPTR_ICONINFORMATION Information icon pointer SPTR_ICONQUESTION Question mark icon pointer SPTR_ICONERROR Exclamation mark icon pointer SPTR_ICONWARNING Warning icon pointer SPTR_ILLEGAL Illegal operation icon pointer SPTR_FILE Single file icon pointer SPTR_MULTFILE Multiple files icon pointer SPTR_FOLDER Folder icon pointer SPTR_PROGRAM Application program icon pointer

Code:

public virtual void pointer (

LONG id )

Posts a message to window.

This method posts a message to the message queue associated with the window.

Inherited From:

PMWindow

Source:

pm_window.h:567

Returns:

Success indicator.

Code:

public BOOL post (	ULONG msg ,
	MPARAM mp1 ,
	MPARAM mp2 )

Sets the window's position and size.

Inherited From:

PMWindow

Source:

pm_window.h:233

Code:

public virtual void rectangle (

const PMRect & rect )

Returns the window rectangle.

Inherited From:

PMWindow

Source:

pm_window.h:390

Code:

public virtual PMRect rectangle (

) const

Release mouse pointer.

Causes the window to release the pointer capture (pointer capture is set with the function capture_pointer).

This function causes mouse events to again be dispatched to the window underneath the mouse pointer.

Inherited From:

PMWindow

Source:

pm_window.h:486

Code:

public virtual void release_pointer (

)

Sends a message to window.

This method sends a message with identity msg to window, passing mp1 and mp2 as the parameters to the window.

Inherited From:

PMWindow

Source:

pm_window.h:556

Code:

public MRESULT send (	ULONG msg ,
	MPARAM mp1 ,
	MPARAM mp2 )

Sets the input focus to the window.

Inherited From:

PMWindow

Source:

pm_window.h:433

Code:

public virtual void set_focus (

)

Makes the window visible.

Inherited From:

PMWindow

Source:

pm_window.h:392

Code:

public virtual void show (

BOOL state = TRUE )

This method starts a timer.

This method creates a timer identified by id, set to time out every timeout milliseconds. When a timer times out, a WM_TIMER message is posted.

A timeout value of zero causes the timer to timeout as fast as possible; generally, this is about 1/18 second.

A second call of this method, for a timer that already exists, resets that timer.

Inherited From:

PMWindow

Source:

pm_window.h:583

Code:

public virtual void start_timer (	ULONG id ,
	ULONG timeout )

Stop handling events.

Detaches the handler from the PMWindow object. The window's dispatch function is no longer called to process events sent or posted to the window.

Inherited From:

PMWindow

Source:

pm_window.h:631

Code:

protected void stop_handling_events (

)

This method stops a timer.

When this method is called, no further messages are received from the stopped timer, even if it has timed out.

Inherited From:

PMWindow

Source:

pm_window.h:592

Code:

public virtual void stop_timer (

ULONG id )

Returns the window text.

Inherited From:

PMWindow

Source:

pm_window.h:258

Params:

result	A buffer in which the window text is returned.
size	This is the size of the buffer specified by the result parameter. If the call is successful, this is overwritten with the number of bytes copied into the buffer.

Code:

public virtual char * text (	char * result ,
	int size ) const

Sets the window text.

Inherited From:

PMWindow

Source:

pm_window.h:231

Code:

public virtual void text (

const char * text )

Returns the length of the window text.

Inherited From:

PMWindow

Source:

pm_window.h:267

Returns:

The length of the window text, excluding any null termination character.

Code:

public virtual int text_len (

) const

Translates the window text.

Translates the window text and all the child texts using for this purpose the current instance of the messages management object.

Inherited From:

PMWindow

Source:

pm_window.h:247

Code:

public virtual void translate (

)