PM Library classes

class PMFrame

? ^ 
    extends PMWindow as public

Frame window class.

A composite window class that can contain child windows of many of the other window classes.

The frame's client window is the control corresponding to the rectangular portion of the frame window not occupied by frame extensions and accessory windows that can be added through frame styles (such as the title bar, system menu, and borders). You do not give the client area an initial size because the client area is automatically sized to fill the frame window.

You can construct and destruct objects of this class.

Source:
pm_frame.h:31
Author:
Dmitry A.Steklenev
Version:
$Revision: 1.14 $

Contents

^ 
EntityInherited FromTypeScopeShort Description
PMFrameconstructor public Wraps the frame window object around an existing presentation window handle.
PMFrameconstructor public Constructs the frame window.
PMFrameconstructor public Constructs the frame window from the dialog template.
~PMFramedestructor public Destructs the frame window object.
clientmethod publicSets the window used as the frame window's client area.
menumethod publicSets the menu used as the frame window's menu bar.
clientmethod publicReturns the handle of the window used as the frame window's client area.
menumethod publicReturns the handle of the menu used as the frame window's menu bar.
client_rectanglemethod public Calculates a client rectangle.
showmethod public Displays the frame window.
show_modallymethod public Displays the frame window modally.
dismissmethod public Dismiss the frame window.
attach_acceleratorsmethod public Replaces the accelerator keys used by the window.
detach_acceleratorsmethod public Detaches the accelerator keys used by the window.
location_typeenum public Use these enumerators to specify the possible locations for a frame extension.
attach_extensionmethod publicAttaches a window to frame as a frame extension.
detach_extensionmethod publicDetaches a frame extension from frame.
set_as_topmostmethod publicSets the window as topmost window.
is_topmostmethod publicReturns TRUE if the window is a topmost window.
dispatchmethod protected Dispatch system native events.
auto_delete_objectPMWindowmethod public Determines whether to delete the window object when the presentation window is destroyed.
capture_pointerPMWindowmethod public Captures mouse pointer.
center_atPMWindowmethod publicCenters the window concerning his owner window.
colorPMWindowmethod public Sets the specified color value.
colorPMWindowmethod public Returns the specified color value.
destroyPMWindowmethod public Destroys the presentation window.
disablePMWindowmethod publicPrevents keyboard and mouse input from being sent to the window.
dispatch_everythingPMWindowmethod protected Dispatch all not catched events.
enablePMWindowmethod publicEnables the window to accept keyboard and mouse input.
enable_dropPMWindowmethod publicEnables the window to accept dropped objects.
fontPMWindowmethod publicSets a new font to be used by the window.
framePMWindowmethod public Return the handle of the first frame window associated with this window.
handlePMWindowmethod publicReturns the presentation window handle.
handle_eventsPMWindowmethod protected Handle events.
has_focusPMWindowmethod public Has focus.
has_pointer_capturedPMWindowmethod public Has pointer captured.
hidePMWindowmethod publicMakes the window invisible.
idPMWindowmethod publicReturns the window identifier.
invalidatePMWindowmethod public This method adds the whole window to a window's update region.
invalidatePMWindowmethod public This method adds a region to a window's update region.
is_auto_delete_objectPMWindowmethod public If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned.
is_validPMWindowmethod public Is the window valid.
is_visiblePMWindowmethod public Is the window visible.
ownerPMWindowmethod public Sets the owner window.
ownerPMWindowmethod public Returns the owner window handle.
parentPMWindowmethod public Sets the parent window.
parentPMWindowmethod public Returns the parent window handle.
pointerPMWindowmethod publicReturns the mouse pointer used when the mouse is over the window.
pointerPMWindowmethod public Sets the appearance used by the mouse pointer when it is over the window.
postPMWindowmethod public Posts a message to window.
rectanglePMWindowmethod publicSets the window's position and size.
rectanglePMWindowmethod publicReturns the window rectangle.
release_pointerPMWindowmethod public Release mouse pointer.
sendPMWindowmethod public Sends a message to window.
set_focusPMWindowmethod publicSets the input focus to the window.
start_timerPMWindowmethod public This method starts a timer.
stop_handling_eventsPMWindowmethod protected Stop handling events.
stop_timerPMWindowmethod public This method stops a timer.
textPMWindowmethod public Returns the window text.
textPMWindowmethod publicSets the window text.
text_lenPMWindowmethod public Returns the length of the window text.
translatePMWindowmethod public Translates the window text.

constructor PMFrame

? ^  > 
Wraps the frame 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_frame.h:44
Code:
public PMFrame ( HWND handle )

constructor PMFrame

? ^  < > 
Constructs the frame window.

Source:
pm_frame.h:99
Params:
id Specifies the window identifier.
text Specifies the window text.
howner Specifies the owner-window handle.
x,y,cx,cy Specifies the window shape.
frame_style Specifies the frame window style:

FCF_TITLEBAR
Title bar.
FCF_SYSMENU
System menu.
FCF_MENU
Application menu.
FCF_MINMAX
Minimize and Maximize buttons.
FCF_MINBUTTON
Minimize button.
FCF_MAXBUTTON
Maximize button.
FCF_VERTSCROLL
Vertical scroll bar.
FCF_HORZSCROLL
Horizontal scroll bar.
FCF_SIZEBORDER
Sizing border.
FCF_BORDER
Window is drawn with a thin border.
FCF_DLGBORDER
Window is drawn with a standard dialog border.
FCF_ACCELTABLE
Causes an accelerator table to be loaded.
FCF_ICON
Window is created with an icon associated with it.
FCF_SHELLPOSITION
The window is created with a size and position determined by the shell.
FCF_SYSMODAL
The frame window is System Modal.
FCF_NOBYTEALIGN
When this flag is not set, the frame window is adjusted so that window operations, such as moving, can be performed in an optimized manner.
FCF_TASKLIST
When this flag is set, the program title is added to the front of the frame window text, the resulting string is used as the window title and is also entered on the task list.
FCF_NOMOVEWITHOWNER
The window should not be moved when its owner is moved.
FCF_STANDARD
Same as (FCF_TITLEBAR | FCF_SYSMENU | FCF_MINBUTTON | FCF_MAXBUTTON | FCF_SIZEBORDER | FCF_ICON | FCF_MENU | FCF_ACCELTABLE | FCF_SHELLPOSITION | FCF_TASKLIST).
FCF_SCREENALIGN
See FS_SCREENALIGN.
FCF_MOUSEALIGN
See FS_MOUSEALIGN.
FCF_AUTOICON
Performance optimization. When repainting iconized frames, the system will redraw the icon and will not send a WM_PAINT message to the application.
FCF_HIDEBUTTON
Hide button.
FCF_HIDEMAX
Hide and maximize buttons.
FCF_CLOSEBUTTON
Close button.

style Specifies the window style.

See Also:
PMWindow::PMWindow
Code:
public PMFrame ( SHORT id ,
const char * text ,
HWND howner ,
LONG x ,
LONG y ,
LONG cx ,
LONG cy ,
ULONG frame_style ,
ULONG style = 0 )

constructor PMFrame

? ^  < > 
Constructs the frame window from the dialog template.

Source:
pm_frame.h:112
Params:
howner Specifies the owner-window handle.
res_id Dialog-template identity within the resource file. It is also used as the identity of the created dialog window.
hmodule Module handle referencing a dynamic link library containing the resource or NULLHANDLE for the application's module.
Code:
public PMFrame ( HWND howner ,
SHORT res_id ,
HMODULE hmodule )

destructor ~PMFrame

? ^  < > 
Destructs the frame window object.

Cleans up as this window object and destroying the associated presentation window for this object if the object was not wrapped around an existing window handle.

Source:
pm_frame.h:122
Code:
public virtual ~ PMFrame ( )

method client

? ^  < > 
Sets the window used as the frame window's client area.
Source:
pm_frame.h:125
Code:
public virtual void client ( HWND client )

method menu

? ^  < > 
Sets the menu used as the frame window's menu bar.
Source:
pm_frame.h:127
Code:
public virtual void menu ( HWND hmenu )

method client

? ^  < > 
Returns the handle of the window used as the frame window's client area.
Source:
pm_frame.h:130
Code:
public virtual HWND client ( )

method menu

? ^  < > 
Returns the handle of the menu used as the frame window's menu bar.
Source:
pm_frame.h:132
Code:
public virtual HWND menu ( )

method client_rectangle

? ^  < > 
Calculates a client rectangle.

This method calculates a client rectangle from a frame rectangle.

Source:
pm_frame.h:141
Code:
public virtual PMRect client_rectangle ( ) const

method show

? ^  < > 
Displays the frame window.

The frame window is made the topmost window also.

Source:
pm_frame.h:149
Code:
public virtual void show ( BOOL state = TRUE )

method show_modally

? ^  < > 
Displays the frame window modally.

While the frame window is being shown modally, its parent or owner or both windows are disabled. Other top level windows belonging to the application are not disabled.

Source:
pm_frame.h:161
Returns:
Value established by the dismiss method.
Code:
public virtual ULONG show_modally ( )

method dismiss

? ^  < > 
Dismiss the frame window.

This method hides the modeless frame window, and causes show_modally to return.

Source:
pm_frame.h:173
Param:
rc Reply value. Returned to the caller of show_modally.
Code:
public virtual void dismiss ( ULONG rc )

method attach_accelerators

? ^  < > 
Replaces the accelerator keys used by the window.

Source:
pm_frame.h:184
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 )

method detach_accelerators

? ^  < > 
Detaches the accelerator keys used by the window.
Source:
pm_frame.h:190
Code:
public virtual void detach_accelerators ( )

enum location_type

? ^  < > 
Use these enumerators to specify the possible locations for a frame extension.

left
Specifies the left-hand side of the client area.
right
Specifies the right-hand side of the client area.
above
Specifies the top of the client area.
below
Specifies the bottom of the client area.
Source:
pm_frame.h:207
Code:
public enum location_type { left = 0 ,
right = 1 ,
above = 2 ,
below = 3 }

method attach_extension

? ^  < > 
Attaches a window to frame as a frame extension.
Source:
pm_frame.h:210
Code:
public virtual void attach_extension ( HWND hwnd ,
location_type location )

method detach_extension

? ^  < > 
Detaches a frame extension from frame.
Source:
pm_frame.h:212
Code:
public virtual void detach_extension ( HWND hwnd )

method set_as_topmost

? ^  < > 
Sets the window as topmost window.
Source:
pm_frame.h:215
Code:
public virtual void set_as_topmost ( BOOL topmost = TRUE )

method is_topmost

? ^  < > 
Returns TRUE if the window is a topmost window.
Source:
pm_frame.h:217
Code:
public virtual BOOL is_topmost ( ) const

method dispatch

? ^  < > 
Dispatch system native events.

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

Source:
pm_frame.h:228
Code:
protected virtual MRESULT dispatch ( ULONG msg ,
MPARAM mp1 ,
MPARAM mp2 )

method auto_delete_object

? ^  < > 
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 )

method capture_pointer

? ^  < > 
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 )

method center_at

? ^  < > 
Centers the window concerning his owner window.
Inherited From:
PMWindow
Source:
pm_window.h:235
Code:
public virtual void center_at ( )

method color

? ^  < > 
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 )

method 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

method destroy

? ^  < > 
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 ( )

method disable

? ^  < > 
Prevents keyboard and mouse input from being sent to the window.
Inherited From:
PMWindow
Source:
pm_window.h:409
Code:
public virtual void disable ( )

method dispatch_everything

? ^  < > 
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 )

method enable

? ^  < > 
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 )

method enable_drop

? ^  < > 
Enables the window to accept dropped objects.
Inherited From:
PMWindow
Source:
pm_window.h:420
Code:
public virtual void enable_drop ( LONG type )

method font

? ^  < > 
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 )

method frame

? ^  < > 
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

method handle

? ^  < > 
Returns the presentation window handle.
Inherited From:
PMWindow
Source:
pm_window.h:162
Code:
public HWND handle ( ) const

method handle_events

? ^  < > 
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 ( )

method has_focus

? ^  < > 
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

method has_pointer_captured

? ^  < > 
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

method hide

? ^  < > 
Makes the window invisible.
Inherited From:
PMWindow
Source:
pm_window.h:394
Code:
public virtual void hide ( )

method id

? ^  < > 
Returns the window identifier.
Inherited From:
PMWindow
Source:
pm_window.h:164
Code:
public SHORT id ( ) const

method invalidate

? ^  < > 
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 ( )

method 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 )

method is_auto_delete_object

? ^  < > 
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 ( )

method is_valid

? ^  < > 
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

method is_visible

? ^  < > 
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 ( )

method owner

? ^  < > 
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 )

method owner

? ^  < > 
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

method parent

? ^  < > 
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 )

method parent

? ^  < > 
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

method pointer

? ^  < > 
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

method pointer

? ^  < > 
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 )

method post

? ^  < > 
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 )

method rectangle

? ^  < > 
Sets the window's position and size.
Inherited From:
PMWindow
Source:
pm_window.h:233
Code:
public virtual void rectangle ( const PMRect & rect )

method rectangle

? ^  < > 
Returns the window rectangle.
Inherited From:
PMWindow
Source:
pm_window.h:390
Code:
public virtual PMRect rectangle ( ) const

method release_pointer

? ^  < > 
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 ( )

method send

? ^  < > 
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 )

method set_focus

? ^  < > 
Sets the input focus to the window.
Inherited From:
PMWindow
Source:
pm_window.h:433
Code:
public virtual void set_focus ( )

method start_timer

? ^  < > 
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 )

method stop_handling_events

? ^  < > 
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 ( )

method stop_timer

? ^  < > 
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 )

method text

? ^  < > 
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

method text

? ^  < > 
Sets the window text.
Inherited From:
PMWindow
Source:
pm_window.h:231
Code:
public virtual void text ( const char * text )

method text_len

? ^  < > 
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

method translate

? ^  < > 
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 ( )

Created Fri Aug 3 09:13:16 2012.
This documentation was generated automatically by
ccdoc v08r39 2003/02/27 bin_opt_emx_os2-2.30.
Click here to submit a bug report or feature request for ccdoc.
Click here to return to the top of the page.