Container control window class.

The PMContainer class creates and manages container control windows. A container can display objects in various formats and views. Generally speaking, each view displays different information about each object. If a container's data is too large for the window's work area, scrolling mechanisms are enabled.

You can construct and destruct objects of this class.

Source:

pm_container.h:30

Author:

Dmitry A.Steklenev

Version:

$Revision: 1.17 $

Entity	Inherited From	Type	Scope	Short Description
PMContainer		constructor	public	Constructs the container control window object from an existing presentation window handle.
PMContainer		constructor	public	Constructs the container control window object from an existing child window with the specified identity.
PMContainer		constructor	public	Constructs the container control window.
~PMContainer		destructor	public	Destructs the container control window.
attributes		method	public	Sets the attributes of a container control.
attributes		method	public	Returns the attributes of a container control.
icon_size		method	public	Sets the icon or bitmap size for all objects.
tree_indent		method	public	Sets the amount of horizontal space between levels in the tree view.
title		method	public	Sets the container title.
add_column		method	public	Adds column to the details view of the container control.
splitbar		method	public	Sets the position of the vertical split bar.
splitbar		method	public	Returns the position of the vertical split bar.
count		method	public	Returns the number of records in the container.
count		method	public	Returns the number of child records of rec.
allocate		method	public	Allocates memory for one record.
free		method	public	Frees the memory associated with one record.
insert		method	public	Inserts one record into the container control.
remove		method	public	Removes one record from the container control.
remove		method	public	Removes records from the container control.
move_tree		method	public	Moves a record to a new parent in the container control.
clear		method	public	Removes all records from the container control.
refresh		method	public	Notifies the container control that the record is not valid and must be refreshed.
refresh		method	public	Notifies the container control that all records is not valid and must be refreshed.
sort		method	public	Sorts current and inserted container records in the container control.
filter		method	public	Filters the contents of a container so that a subset of the container items is viewable.
filter		method	public	Filters the contents of a container so that a subset of the container items is viewable.
expand		method	public	Causes one parent item in the tree view to be expanded.
collapse		method	public	Causes one parent item in the tree view to be collapsed.
select		method	public	Specifies that a record will be drawn with selected-state emphasis.
in_use		method	public	Specifies that a record will be drawn with in-use emphasis.
source		method	public	Specifies that a record will be drawn with source emphasis.
scroll_to		method	public	Scrolls the container window so that the specified record became visible.
is_expanded		method	public	Returns the TRUE if the specified parent item in the tree is expanded.
is_collapsed		method	public	Returns the TRUE if the specified parent item in the tree is collapsed.
is_cursored		method	public	Returns the TRUE if the specified item is cursored.
is_selected		method	public	Returns the TRUE if the specified item is selected.
is_in_use		method	public	Returns the TRUE if the specified item is drawn with in-use emphasis.
is_source		method	public	Returns the TRUE if the specified item is drawn with source emphasis.
contains		method	public	If the specified record is in the container, TRUE is returned.
first		method	public	Returns a pointer to the first record in the container.
firstchild		method	public	Returns a pointer to the first child record of rec.
last		method	public	Returns a pointer to the last record in the container.
lastchild		method	public	Returns a pointer to the last child record of rec.
next		method	public	Returns a pointer to the next record of rec.
prev		method	public	Returns a pointer to the previous record of rec.
parentrecord		method	public	Returns a pointer to the parent record of rec.
cursored		method	public	Returns a pointer to the current cursored record.
selected		method	public	Returns a pointer to the current selected record.
selected		method	public	Returns a pointer to the next selected record.
dispatch		method	protected	Dispatch system native events.
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_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.

Constructs the container control window object from an existing presentation window handle.

Source:

pm_container.h:38

Code:

public PMContainer (

HWND handle )

Constructs the container control window object from an existing child window with the specified identity.

Source:

pm_container.h:48

Params:

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

Code:

public PMContainer (	HWND hparent ,
	SHORT id )

Constructs the container control window.

Source:

pm_container.h:86

Params:

id	Specifies the window identifier.
hparent	Specifies the parent-window handle.
x,y,cx,cy	Specifies the window shape.
style	Specifies the window style: CCS_AUTOPOSITION Automatic positioning, which causes container items displayed in the icon view to be arranged. CCS_READONLY A read-only style bit for an entire container, which prevents a user from editing any of the text in a container window. CCS_VERIFYPOINTERS A pointer verification style bit, which verifies that the application pointers are members of the container's linked list before they are used. If it is not set, the container does not verify the pointers. CCS_SINGLESEL Single selection, which allows a user to select only one container item at a time. Each time a user selects a container item, the selection of any other container item is cancelled. CCS_EXTENDSEL Extended selection, which allows a user to select one or more container items. A user can select one item, a range of items, or multiple ranges of items. CCS_MULTIPLESEL Multiple selection, which allows a user to select zero or more container items.

See Also:

PMWindow::PMWindow

Code:

public PMContainer (	SHORT id ,
	HWND hparent ,
	LONG x ,
	LONG y ,
	LONG cx ,
	LONG cy ,
	ULONG style )

Destructs the container control window.

Source:

pm_container.h:92

Code:

public virtual ~ PMContainer ( )

Sets the attributes of a container control.

Source:

pm_container.h:161

Param:

options

Consists of container window attributes: CV_ICON In the icon view, the container items are represented as icon/text or bit-map/text pairs, with text beneath the icons or bit maps. CV_NAME In the name view, the container items are represented as icon/text or bit-map/text pairs, with text to the right of the icons or bit maps. CV_TREE In the tree view, the container items are represented in a hierarchical manner. CV_DETAIL In the details view, the container items are presented in columns. Each column can contain icons or bit maps, text, numbers, dates, or times. CV_MINI Produces a mini-icons. CV_FLOW Dynamically arranges container items in columns in the name and text views. CA_DRAWICON Icons are used for the icon, name, tree, or details views. CA_DRAWBITMAP Bit maps are used for the icon, name, tree, or details views. CA_ORDEREDTARGETEMPH Shows where a container record can be dropped during direct manipulation by drawing a line beneath the record. Ordered target emphasis does not apply to the icon and tree views. CA_MIXEDTARGETEMPH Shows where a container record can be dropped during direct manipulation either by drawing a line between two items or by drawing lines around the container record. Mixed target emphasis does not apply to the icon and tree views. CA_TREELINE Shows the relationship between all items in the tree view. CA_OWNERDRAW Ownerdraw for the container, which allows the application to draw container records. CA_OWNERPAINTBACKGROUND Allows the application to subclass the container and paint the background. If specified, and the container is subclassed, the application receives the CM_PAINTBACKGROUND message in the subclass procedure. CA_CONTAINERTITLE Allows you to include a container title. CA_TITLEREADONLY Prevents the container title from being edited directly. CA_TITLESEPARATOR Puts a separator line between the container title and the records beneath it CA_TITLECENTER Centers the container title. CA_TITLELEFT Left-justifies the container title. CA_TITLERIGHT Right-justifies the container title. CA_DETAILSVIEWTITLES Allows you to include column headings in the details view.

Code:

public void attributes (

ULONG options )

Returns the attributes of a container control.

Source:

pm_container.h:164

Code:

public ULONG attributes (

) const

Sets the icon or bitmap size for all objects.

Source:

pm_container.h:166

Code:

public void icon_size (	long cx ,
	long cy )

Sets the amount of horizontal space between levels in the tree view.

Source:

pm_container.h:176

Param:

cx	The amount of horizontal space (in pels) between levels in the tree view. If you specify a value that is less than 0, a default value is used.

Code:

public void tree_indent (

long cx )

Sets the container title.

Source:

pm_container.h:179

Code:

public void title (

const char * text )

Adds column to the details view of the container control.

Source:

pm_container.h:270

Params:

title	Column heading data, which can be a text string or an icon or bit map. The default is a text string. If the title_options field is set to the CFA_BITMAPORICON attribute, this must be an icon or bit map.
title_options	Column heading attributes: CFA_BITMAPORICON The column heading contains icon or bit-map data. CFA_FITITLEREADONLY Prevents a column heading from being edited directly. CFA_TOP Top-justifies column headings. CFA_BOTTOM Bottom-justifies column headings. CFA_VCENTER Vertically centers column headings. This is the default. CFA_CENTER Horizontally centers column headings. CFA_LEFT Left-justifies column headings. This is the default. CFA_RIGHT Left-Right-justifies column headings.
data_offset	Offset from the beginning of a RECORDCORE structure to the data that is displayed in this column.
data_options	Attributes of the data in a column: CFA_BITMAPORICON The column contains bit-map or icon data. CFA_DATE The data in the column is displayed in date format. National Language Support (NLS) is enabled for date format. Use the data structure described in CDATE. CFA_STRING Character or text data is displayed in this column. CFA_TIME The data in the column is displayed in time format. National Language Support (NLS) is enabled for time format. Use the data structure described in CTIME. CFA_ULONG Unsigned number data is displayed in this column. National Language Support (NLS) is enabled for number format. CFA_FIREADONLY Prevents text from being edited directly. This attribute applies only to columns for which the CFA_STRING attribute has been specified. CFA_HORZSEPARATOR A horizontal separator is provided beneath column headings. CFA_INVISIBLE Invisible container column. The default is visible. CFA_OWNER Ownerdraw is enabled for this container column. CFA_SEPARATOR A vertical separator is drawn after this column. CFA_BOTTOM Bottom-justifies field data. CFA_TOP Top-justifies field data. CFA_VCENTER Vertically centers field data. This is the default. CFA_CENTER Horizontally centers field data. CFA_LEFT Left-justifies field data. This is the default. CFA_RIGHT Right-justifies field data.
pos	Column order: CMA_FIRST Places a column at the front of the list of columns. CMA_END Places a column at the end of the list of columns.
width	Used to specify the width of a column. The default is an automatically sized column that is always the width of its widest element. If this field is set and the data is too wide, the data is truncated.

Code:

public void add_column (	PVOID title ,
	ULONG title_options ,
	ULONG data_offset ,
	ULONG data_options ,
	ULONG pos = CMA_END ,
	ULONG width = 0 )

Sets the position of the vertical split bar.

Source:

pm_container.h:282

Params:

x	The position of the split bar relative to the container, used in the details view. If this value is less than 0, the split bar is not used.
pos	Number of the last column in the left window of the split details view, or 0. The default is 0, which causes all columns to be positioned in the left window.

Code:

public void splitbar (	LONG x ,
	LONG pos = 0 )

Returns the position of the vertical split bar.

Returns the position of the split bar relative to the container, used in the details view. If this value is less than 0, the split bar is not used.

Source:

pm_container.h:292

Code:

public LONG splitbar (

) const

Returns the number of records in the container.

Source:

pm_container.h:295

Code:

public ULONG count (

) const

Returns the number of child records of rec.

Source:

pm_container.h:297

Code:

public ULONG count (

TRecord * rec ) const

Allocates memory for one record.

The container control requires that the application use this method to allocate memory for container records.

Source:

pm_container.h:306

Code:

public TRecord * allocate (

)

Frees the memory associated with one record.

It is the application's responsibility to free all application-allocated memory associated with the container records, such as text strings. You can use class destructor for this purpose.

Source:

pm_container.h:317

Code:

public void free (

TRecord * rec )

Inserts one record into the container control.

Source:

pm_container.h:341

Params:

rec	Pointer to the record to insert.
order	Orders the record relative to other record in the container. The values can be: CMA_FIRST Places a record at the beginning of the list of records. CMA_END Places a record at the end of the list of records. Other Pointer to a record after which this record is to be inserted.
parent	Pointer to a record that is the parent of the records to be inserted. This field is used only with the CMA_FIRST or CMA_END attributes of the order.
refresh	The display is automatically updated after a record is inserted.

Code:

public void insert (	TRecord * rec ,
	TRecord * order = ( TRecord * ) CMA_END ,
	TRecord * parent = NULL ,
	BOOL refresh = TRUE )

Removes one record from the container control.

When parent item records are removed, all associated child item records are removed, as well.

Source:

pm_container.h:363

Params:

rec	Pointer to the record that is to be removed.
option	Flags that show whether memory must be freed and container records invalidated: CMA_FREE If specified, record is removed and memory associated with record is freed. If not specified, record are removed and no memory is freed. CMA_INVALIDATE If specified, after record is removed the container is invalidated and any necessary repositioning of the container records is performed.

Code:

public void remove (	TRecord * rec ,
	USHORT options = CMA_FREE | CMA_INVALIDATE )

Removes records from the container control.

When parent item records are removed, all associated child item records are removed, as well.

Source:

pm_container.h:387

Params:

recs	Pointer to an array of pointers to records that are to be removed.
count	Number of records.
option	Flags that show whether memory must be freed and container records invalidated: CMA_FREE If specified, record is removed and memory associated with record is freed. If not specified, record are removed and no memory is freed. CMA_INVALIDATE If specified, after record is removed the container is invalidated and any necessary repositioning of the container records is performed.

Code:

public void remove (	TRecord * * recs ,
	ULONG count ,
	USHORT options = CMA_FREE | CMA_INVALIDATE )

Moves a record to a new parent in the container control.

Source:

pm_container.h:412

Params:

rec	Record to be moved.
target_rec	New parent for moved record.
order	Record order for siblings. The values can be: CMA_FIRST Record moves to the FIRST child position of parent. If target_rec is NULL, record becomes the first root level record of the container. CMA_END Record moves to the LAST child position of parent. If target_rec is NULL, record becomes the last root level record of the container. Other Record moves after this record in the list of children of parent. If target_rec is NULL, record moves after the record specified by order only if that record is also a root level record. Note: This record must currently exist in the list of children of target_rec.

Code:

public BOOL move_tree (	TRecord * rec ,
	TRecord * target_rec ,
	TRecord * order = ( TRecord * ) CMA_END )

Removes all records from the container control.

Source:

pm_container.h:431

Param:

option

Flags that show whether memory must be freed and container records invalidated: CMA_FREE If specified, records are removed and memory associated with records is freed. If not specified, records are removed and no memory is freed. CMA_INVALIDATE If specified, after records are removed the container is invalidated and any necessary repositioning of the container records is performed.

Code:

public void clear (

USHORT options = CMA_FREE | CMA_INVALIDATE )

Notifies the container control that the record is not valid and must be refreshed.

Source:

pm_container.h:472

Params:

rec

Pointer to a record that are to be refreshed.

options

Flags used to optimize container record invalidation. The CMA_REPOSITION, CMA_NOREPOSITION, and CMA_TEXTCHANGED attributes are mutually exclusive. However, any of them can be combined with the CMA_ERASE attribute: CMA_ERASE Flag used when the icon view is displayed to minimize painting of a container record's background when it has changed. If specified, the background is erased when the display is refreshed. The default is to not erase the background when the display is refreshed. CMA_REPOSITION Flag used to reposition all container records. This flag must be used if container records are inserted or removed, or if many changes have occurred. If a container record is inserted, the rec parameter points to the inserted record. If a container record is removed, the rec parameter points to the record that precedes the removed one. CMA_NOREPOSITION Flag used to indicate that container records do not need to be repositioned. The container draws the record pointed to in the rec parameter. The container does not do any validation; therefore it is the application's responsibility to make sure repositioning is not needed or changing the longest text line is not necessary. CMA_TEXTCHANGED Flag used if text has changed and you do not know whether repositioning is needed. The container determines whether the longest line or the height of the record has changed. If so, the container repositions and redraws the necessary visible container records.

Code:

public void refresh (	TRecord * rec ,
	USHORT options )

Notifies the container control that all records is not valid and must be refreshed.

Source:

pm_container.h:512

Param:

options

Flags used to optimize container record invalidation. The CMA_REPOSITION, CMA_NOREPOSITION, and CMA_TEXTCHANGED attributes are mutually exclusive. However, any of them can be combined with the CMA_ERASE attribute: CMA_ERASE Flag used when the icon view is displayed to minimize painting of a container record's background when it has changed. If specified, the background is erased when the display is refreshed. The default is to not erase the background when the display is refreshed. CMA_REPOSITION Flag used to reposition all container records. This flag must be used if container records are inserted or removed, or if many changes have occurred. If a container record is inserted, the rec parameter points to the inserted record. If a container record is removed, the rec parameter points to the record that precedes the removed one. CMA_NOREPOSITION Flag used to indicate that container records do not need to be repositioned. The container draws the record pointed to in the rec parameter. The container does not do any validation; therefore it is the application's responsibility to make sure repositioning is not needed or changing the longest text line is not necessary. CMA_TEXTCHANGED Flag used if text has changed and you do not know whether repositioning is needed. The container determines whether the longest line or the height of the record has changed. If so, the container repositions and redraws the necessary visible container records.

Code:

public void refresh (

USHORT options = CMA_REPOSITION )

Sorts current and inserted container records in the container control.

Source:

pm_container.h:527

Param:

pcompare

Pointer to a comparison function. If NULL, no sorting is performed. This function is called one or more times during the sorting process and is passed pointers to two TRecord structures on each call. The routine must compare this structures, and then return one of the following values: >0 if p1 is less than p2. =0 if p1 is equal to p2. <0 if p1 is greater than p2.

Code:

public void sort (

SHORT ( EXPENTRY * pcompare ) ( TRecord * p1 , TRecord * p2 , PMContainer * container ) )

Filters the contents of a container so that a subset of the container items is viewable.

Source:

pm_container.h:537

Param:

pfilter

Points to an application-provided function that determines whether a record is to be included in the viewable subset.

Returns:

TRUE A subset was successfully created.

Code:

public BOOL filter (

BOOL ( EXPENTRY * pfilter ) ( TRecord * p , PMContainer * container ) )

Filters the contents of a container so that a subset of the container items is viewable.

Source:

pm_container.h:549

Params:

pfilter	Points to an application-provided function that determines whether a record is to be included in the viewable subset.
storage	Available for application use.

Returns:

TRUE A subset was successfully created.

Code:

public BOOL filter (	BOOL ( EXPENTRY * pfilter ) ( TRecord * p , PVOID storage ) ,
	PVOID storage )

Causes one parent item in the tree view to be expanded.

Source:

pm_container.h:556

Code:

public void expand (	TRecord * rec ,
	BOOL expandtree = TRUE )

Causes one parent item in the tree view to be collapsed.

Source:

pm_container.h:565

Code:

public void collapse (

TRecord * rec )

Specifies that a record will be drawn with selected-state emphasis.

Source:

pm_container.h:572

Code:

public void select (	TRecord * rec ,
	BOOL set = TRUE )

Specifies that a record will be drawn with in-use emphasis.

Source:

pm_container.h:579

Code:

public void in_use (	TRecord * rec ,
	BOOL set = TRUE )

Specifies that a record will be drawn with source emphasis.

Source:

pm_container.h:586

Code:

public void source (	TRecord * rec ,
	BOOL set = TRUE )

Scrolls the container window so that the specified record became visible.

Source:

pm_container.h:593

Code:

public void scroll_to (

TRecord * rec )

Returns the TRUE if the specified parent item in the tree is expanded.

Source:

pm_container.h:605

Code:

public BOOL is_expanded (

TRecord * rec ) const

Returns the TRUE if the specified parent item in the tree is collapsed.

Source:

pm_container.h:614

Code:

public BOOL is_collapsed (

TRecord * rec ) const

Returns the TRUE if the specified item is cursored.

Source:

pm_container.h:622

Code:

public BOOL is_cursored (

TRecord * rec ) const

Returns the TRUE if the specified item is selected.

Source:

pm_container.h:630

Code:

public BOOL is_selected (

TRecord * rec ) const

Returns the TRUE if the specified item is drawn with in-use emphasis.

Source:

pm_container.h:638

Code:

public BOOL is_in_use (

TRecord * rec ) const

Returns the TRUE if the specified item is drawn with source emphasis.

Source:

pm_container.h:646

Code:

public BOOL is_source (

TRecord * rec ) const

If the specified record is in the container, TRUE is returned.

Source:

pm_container.h:649

Code:

public BOOL contains (

TRecord * rec ) const

Returns a pointer to the first record in the container.

Source:

pm_container.h:654

Code:

public TRecord * first (

) const

Returns a pointer to the first child record of rec.

Source:

pm_container.h:659

Code:

public TRecord * firstchild (

TRecord * rec ) const

Returns a pointer to the last record in the container.

Source:

pm_container.h:664

Code:

public TRecord * last (

) const

Returns a pointer to the last child record of rec.

Source:

pm_container.h:669

Code:

public TRecord * lastchild (

TRecord * rec ) const

Returns a pointer to the next record of rec.

Source:

pm_container.h:674

Code:

public TRecord * next (

TRecord * rec ) const

Returns a pointer to the previous record of rec.

Source:

pm_container.h:679

Code:

public TRecord * prev (

TRecord * rec ) const

Returns a pointer to the parent record of rec.

Source:

pm_container.h:684

Code:

public TRecord * parentrecord (

TRecord * rec ) const

Returns a pointer to the current cursored record.

Source:

pm_container.h:689

Code:

public TRecord * cursored (

) const

Returns a pointer to the current selected record.

Source:

pm_container.h:694

Code:

public TRecord * selected (

) const

Returns a pointer to the next selected record.

Source:

pm_container.h:699

Code:

public TRecord * selected (

TRecord * rec ) const

Dispatch system native events.

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

Source:

pm_container.h:710

Code:

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

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 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 (

)