PMWindow: Difference between revisions
mNo edit summary |
|||
(34 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
Base window class. | Base window class. | ||
The PMWindow class is the base window class and provides | The PMWindow class is the base window class and provides behaviour common to all windows. Although this class contains behaviour requiring the existence of a presentation window, you must construct the presentation window itself using a derived class. | ||
You can construct and destruct objects of this class. | You can construct and destruct objects of this class. | ||
Line 10: | Line 10: | ||
; Source: pm_window.h:49 | ; Source: pm_window.h:49 | ||
; Author: Dmitry A.Steklenev | |||
; Author: Dmitry A.Steklenev | |||
; Version: 1.1 | ; Version: 1.1 | ||
== Contents == | == Contents == | ||
{| | {|class="wikitable" | ||
!Entity||Inherited From||Type||Scope||Short Description | |||
|- | |- | ||
|PMWindow | |||
| | |||
| | |||
| | |||
|constructor | |constructor | ||
|public | |public | ||
| Wraps the window object around an existing | |Wraps the window object around an existing presentation window handle. | ||
|- | |- | ||
| | |PMWindow | ||
| | | | ||
|constructor | |constructor | ||
|public | |public | ||
| Wraps the window object around an existing | |Wraps the window object around an existing child window with the specified identity. | ||
|- | |- | ||
| | |PMWindow | ||
| | | | ||
|constructor | |constructor | ||
|public | |public | ||
| Constructs the presentation window. | |Constructs the presentation window. | ||
|- | |- | ||
| | |PMWindow | ||
| | | | ||
|constructor | |constructor | ||
|public | |public | ||
| Constructs the presentation window from the dialog template. | |Constructs the presentation window from the dialog template. | ||
|- | |- | ||
| | |PMWindow | ||
| | | | ||
|constructor | |constructor | ||
|protected | |protected | ||
| Constructs the presentation window of the specified class. | | Constructs the presentation window of the specified class. | ||
|- | |- | ||
| | |~PMWindow | ||
| | | | ||
|destructor | |destructor | ||
|public | |public | ||
| Destructs the window object. | |Destructs the window object. | ||
|- | |- | ||
|destroy | |destroy | ||
Line 72: | Line 57: | ||
|method | |method | ||
|public | |public | ||
| Destroys the presentation window. | |Destroys the presentation window. | ||
|- | |- | ||
|handle | |handle | ||
Line 80: | Line 64: | ||
|public | |public | ||
|Returns the presentation window handle. | |Returns the presentation window handle. | ||
|- | |- | ||
|id | |id | ||
Line 87: | Line 70: | ||
|public | |public | ||
|Returns the window identifier. | |Returns the window identifier. | ||
|- | |- | ||
|id | |id | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Sets the window identifier. | |Sets the window identifier. | ||
|- | |- | ||
|style | |style | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Returns the window style. | |Returns the window style. | ||
|- | |- | ||
|pid | |pid | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Returns the process identifier that created the window. | |Returns the process identifier that created the window. | ||
|- | |- | ||
|tid | |tid | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Returns the thread identifier that created the window. | |Returns the thread identifier that created the window. | ||
|- | |- | ||
|parent | |parent | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Returns the parent window handle. | |Returns the parent window handle. | ||
|- | |- | ||
|owner | |owner | ||
Line 128: | Line 105: | ||
|method | |method | ||
|public | |public | ||
| Returns the owner window handle. | |Returns the owner window handle. | ||
|- | |- | ||
|child | |child | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Returns the handle of the child window with the specified identity. | |Returns the handle of the child window with the specified identity. | ||
|- | |- | ||
|parent | |parent | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sets the parent window. | |Sets the parent window. | ||
|- | |- | ||
|owner | |owner | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sets the owner window. | |Sets the owner window. | ||
|- | |- | ||
|frame | |frame | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Return the handle of the first frame window associated with this window. | |Return the handle of the first frame window associated with this window. | ||
|- | |- | ||
|text | |text | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Sets the window text. | |Sets the window text. | ||
|- | |- | ||
|rectangle | |rectangle | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Sets the window's position and size. | |Sets the window's position and size. | ||
|- | |- | ||
|center_at | |center_at | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Centers the window concerning his owner window. | |Centers the window concerning his owner window. | ||
|- | |- | ||
|font | |font | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Sets a new font to be used by the window. | |Sets a new font to be used by the window. | ||
|- | |- | ||
|font | |font | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sets a new system font to be used by the window. | |Sets a new system font to be used by the window. | ||
|- | |- | ||
|translate | |translate | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Translates the window text. | |Translates the window text. | ||
|- | |- | ||
|text | |text | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Returns the window text. | |Returns the window text. | ||
|- | |- | ||
|text_len | |text_len | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Returns the length of the window text. | |Returns the length of the window text. | ||
|- | |- | ||
|color | |color | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Returns the specified color value. | |Returns the specified color value. | ||
|- | |- | ||
|color | |color | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sets the specified color value. | |Sets the specified color value. | ||
|- | |- | ||
|rectangle | |rectangle | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Returns the window rectangle. | |Returns the window rectangle. | ||
|- | |- | ||
|rectangle | |rectangle | ||
| | | | ||
|static method | |static method | ||
|public | |public | ||
|Returns the window rectangle. | |Returns the window rectangle. | ||
|- | |- | ||
|show | |show | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Makes the window visible. | |Makes the window visible. | ||
|- | |- | ||
|hide | |hide | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Makes the window invisible. | |Makes the window invisible. | ||
|- | |- | ||
|is_visible | |is_visible | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Is the window visible. | |Is the window visible. | ||
|- | |- | ||
| | |enable | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Enables the window to accept keyboard and mouse input. | |Enables the window to accept keyboard and mouse input. | ||
|- | |- | ||
|disable | |disable | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Prevents keyboard and mouse input from being sent to the window. | |Prevents keyboard and mouse input from being sent to the window. | ||
|- | |- | ||
|is_enabled | |is_enabled | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Is the window enabled. | |Is the window enabled. | ||
|- | |- | ||
|drop_type | |drop_type | ||
| | | | ||
|enum | |enum | ||
|public | |public | ||
| Use these enumerators to specify various object types that can be | |Use these enumerators to specify various object types that can be dropped to window. | ||
|- | |- | ||
| | |enable_drop | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Enables the window to accept dropped objects. | |Enables the window to accept dropped objects. | ||
|- | |- | ||
| | |is_valid | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Is the window valid. | |Is the window valid. | ||
|- | |- | ||
| | |set_focus | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Sets the input focus to the window. | |Sets the input focus to the window. | ||
|- | |- | ||
| | |has_focus | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Has focus. | |Has focus. | ||
|- | |- | ||
| | |invalidate | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method adds a rectangle to a window's update region. | |This method adds a rectangle to a window's update region. | ||
|- | |- | ||
| | |invalidate | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method adds the whole window to a window's update region. | |This method adds the whole window to a window's update region. | ||
|- | |- | ||
| | |validate | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method subtracts a rectangle from a window's update region. | |This method subtracts a rectangle from a window's update region. | ||
|- | |- | ||
| | |validate | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method subtracts the whole window from a window's update region. | |This method subtracts the whole window from a window's update region. | ||
|- | |- | ||
| | |capture_pointer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Captures mouse pointer. | |Captures mouse pointer. | ||
|- | |- | ||
| | |release_pointer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Release mouse pointer. | |Release mouse pointer. | ||
|- | |- | ||
| | |has_pointer_captured | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Has pointer captured. | |Has pointer captured. | ||
|- | |- | ||
| | |pointer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sets the appearance used by the mouse pointer when it is over the window. | |Sets the appearance used by the mouse pointer when it is over the window. | ||
|- | |- | ||
| | |pointer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
|Returns the mouse pointer used when the mouse is over the window. | |Returns the mouse pointer used when the mouse is over the window. | ||
|- | |- | ||
| | |attach_accelerators | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Replaces the accelerator keys used by the window. | |Replaces the accelerator keys used by the window. | ||
|- | |- | ||
| | |detach_accelerators | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Detaches the accelerator keys used by the window. | |Detaches the accelerator keys used by the window. | ||
|- | |- | ||
| | |send | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Sends a message to window. | |Sends a message to window. | ||
|- | |- | ||
| | |post | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Posts a message to window. | |Posts a message to window. | ||
|- | |- | ||
| | |start_timer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method starts a timer. | |This method starts a timer. | ||
|- | |- | ||
| | |stop_timer | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| This method stops a timer. | |This method stops a timer. | ||
|- | |- | ||
| | |auto_delete_object | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| Determines whether to delete the window object when the presentation | |Determines whether to delete the window object when the presentation window is destroyed. | ||
|- | |- | ||
| | |is_auto_delete_object | ||
| | | | ||
|method | |method | ||
|public | |public | ||
| If the window object is deleted when a destroy event is dispatched to | |If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned. | ||
|- | |- | ||
| | |handle_events | ||
| | | | ||
|method | |method | ||
|protected | |protected | ||
| Handle events. | |Handle events. | ||
|- | |- | ||
| | |stop_handling_events | ||
| | | | ||
|method | |method | ||
|protected | |protected | ||
| Stop handling events. | |Stop handling events. | ||
|- | |- | ||
| | |dispatch | ||
| | | | ||
|method | |method | ||
|protected | |protected | ||
| Dispatch system native events. | |Dispatch system native events. | ||
|- | |- | ||
| | |dispatch_everything | ||
| | | | ||
|method | |method | ||
|protected | |protected | ||
| Dispatch all not | |Dispatch all not caught events. | ||
|} | |} | ||
==constructor PMWindow== | ==constructor PMWindow== | ||
Line 477: | Line 401: | ||
The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status. | The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status. | ||
; Source: pm_window.h:61 | |||
; Code: | |||
public PMWindow ( HWND handle ) | public PMWindow ( HWND handle ) | ||
==constructor PMWindow== | ==constructor PMWindow== | ||
Wraps the 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_window.h:75 | |||
; Params: | |||
:; hparent: Specifies the parent-window handle. | |||
:; id : Specifies the identity of the child window. | |||
; Code: | |||
public PMWindow ( HWND hparent , | public PMWindow ( HWND hparent , | ||
SHORT id ) | |||
==constructor PMWindow== | ==constructor PMWindow== | ||
Constructs the presentation window. | |||
; Source: pm_window.h:107 | |||
; Params : | |||
:; id : Specifies the window identifier. | |||
:; text : Specifies the window text. | |||
:; hparent : Specifies the parent-window handle. | |||
:; howner : Specifies the owner-window handle. | |||
:; x,y,cx,cy : Specifies the window rectangle. | |||
:; style : Specifies the window style: | |||
::;WS_CLIPCHILDREN : Prevents a window from painting over its child windows. | |||
::;WS_CLIPSIBLINGS : Prevents a window from painting over its sibling windows. | |||
::;WS_DISABLED : Used by an application to disable a window. | |||
::;WS_GROUP : Specifies the first control of a group of controls. | |||
::;WS_MAXIMIZED : Enlarges a window to the maximum size. | |||
::;WS_MINIMIZED : Reduces a window to the size of an icon. | |||
::;WS_PARENTCLIP : Extends a window's visible region to include that of its parent window. | |||
::;WS_SAVEBITS : Saves the screen area under a window as a bit map. | |||
::;WS_SYNCPAINT : Causes a window to receive WM_PAINT messages immediately after a part of the window becomes invalid. | |||
::;WS_TABSTOP : Specifies one of any number of controls through which the user can move by tabbing. | |||
::;WS_VISIBLE : Makes a window visible. | |||
::;WS_DLGPOINTS : The window rectangle is specified in dialog units. | |||
; Code: | |||
public PMWindow ( SHORT id , | public PMWindow ( SHORT id , | ||
const char * text , | |||
HWND hparent , | |||
HWND howner , | |||
LONG x , | |||
LONG y , | |||
LONG cx , | |||
LONG cy , | |||
ULONG style ) | |||
==constructor PMWindow== | ==constructor PMWindow== | ||
Constructs the presentation window from the dialog template. | |||
; Source: pm_window.h:120 | |||
; Params: | |||
::;hparent : Specifies the parent-window handle. | |||
::;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 window. | |||
::;hmodule :Module handle referencing a dynamic link library containing the resource or NULLHANDLE for the application's module. | |||
; Code: | |||
public PMWindow ( HWND hparent , | public PMWindow ( HWND hparent , | ||
HWND howner , | HWND howner , | ||
Line 568: | Line 476: | ||
==constructor PMWindow== | ==constructor PMWindow== | ||
Constructs the presentation window of the specified class. | |||
; Source: pm_window.h:138 | |||
; Params: | |||
::; classname: Specifies the registered-class name. | |||
::; id: Specifies the window identifier. | |||
::; text: Specifies the window text. | |||
::; hparent: Specifies the parent-window handle. | |||
::; howner: Specifies the owner-window handle. | |||
::; x,y,cx,cy: Specifies the window shape. | |||
::; style: Specifies the window style. | |||
::; classdata: Specifies the pointer to control data. | |||
; Code: | |||
protected PMWindow ( const char * classname , | protected PMWindow ( const char * classname , | ||
SHORT id , | SHORT id , | ||
const char * text , | const char * text , | ||
Line 597: | Line 504: | ||
==destructor ~PMWindow== | ==destructor ~PMWindow== | ||
Destructs the window object. | |||
Cleans up as this window object and destroying the associated presentation window for this object if the object was not created from an existing window handle. | |||
; Source: pm_window.h:149 | |||
; Code: | |||
public virtual ~ PMWindow ( ) | public virtual ~ PMWindow ( ) | ||
==method destroy== | ==method destroy== | ||
Destroys the presentation window. | |||
Destroying the associated presentation window for this object. | |||
; Source: pm_window.h:158 | |||
; Code: | |||
public virtual void destroy ( ) | |||
public virtual void destroy ( ) | |||
==method handle== | ==method handle== | ||
Returns the presentation window handle. | |||
; Source: pm_window.h:161 | |||
; Code: | |||
public HWND handle ( ) const | |||
public HWND handle ( ) const | |||
==method id== | ==method id== | ||
Returns the window identifier. | |||
; Source: pm_window.h:163 | |||
; Code: | |||
public SHORT id ( ) const | |||
public SHORT id ( ) const | |||
==method id== | ==method id== | ||
Sets the window identifier. | |||
; Source: pm_window.h:165 | |||
; Code: | |||
public virtual void id ( SHORT new_id ) | public virtual void id ( SHORT new_id ) | ||
==method style== | ==method style== | ||
Returns the window style. | |||
; Source: pm_window.h:167 | |||
; Code: | |||
public virtual ULONG style ( ) const | |||
public virtual ULONG style ( ) const | |||
==method pid== | ==method pid== | ||
Returns the process identifier that created the window. | |||
; Source: pm_window.h:169 | |||
; Code: | |||
public PID pid ( ) const | |||
public PID pid ( ) const | |||
==method tid== | ==method tid== | ||
Returns the thread identifier that created the window. | |||
; Source: pm_window.h:171 | |||
; Code: | |||
public TID tid ( ) const | |||
public TID tid ( ) const | |||
==method parent== | ==method parent== | ||
Line 700: | Line 592: | ||
==method child== | ==method child== | ||
Returns the handle of the child window with the specified identity. | |||
; Source: pm_window.h:203 | |||
; Param: | |||
::; id : Identifier of the child window. | |||
; Returns: Child-window handle or NULLHANDLE if no child window of the specified identity exists. | |||
; Code: | |||
public HWND child ( SHORT id ) const | public HWND child ( SHORT id ) const | ||
==method parent== | ==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. | |||
; Source: pm_window.h:227 | |||
; 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 ) | |||
public virtual void parent ( HWND hparent , | |||
==method owner== | ==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. | |||
; Source: pm_window.h:240 | |||
; Param: | |||
* howner New owner window handle. | |||
; Code: | |||
public virtual void owner ( HWND howner ) | public virtual void owner ( HWND howner ) | ||
==method frame== | ==method frame== | ||
Return the handle of the first frame window associated with this window. | |||
; Source: pm_window.h:246 | |||
; Code: | |||
public virtual HWND frame ( ) const | |||
public virtual HWND frame ( ) const | |||
==method text== | ==method text== | ||
Sets the window text. | Sets the window text. | ||
; Source: pm_window.h:249 | |||
; Code: | |||
public virtual void text ( const char * text ) | public virtual void text ( const char * text ) | ||
==method rectangle== | ==method rectangle== | ||
Sets the window's position and size. | Sets the window's position and size. | ||
; Source: pm_window.h:251 | |||
; Code: | |||
public virtual void rectangle ( const PMRect & rect ) | public virtual void rectangle ( const PMRect & rect ) | ||
Line 781: | Line 664: | ||
Centers the window concerning his owner window. | Centers the window concerning his owner window. | ||
; Source: pm_window.h:253 | |||
; Code: | |||
public virtual void center_at ( ) | public virtual void center_at ( ) | ||
Line 790: | Line 672: | ||
Sets a new font to be used by the window. | Sets a new font to be used by the window. | ||
; Source: pm_window.h:255 | |||
; Code: | |||
public virtual void font ( const char * font ) | public virtual void font ( const char * font ) | ||
==method font== | ==method font== | ||
Sets a new system font to be used by the window. | Sets a new system font to be used by the window. | ||
; Source: pm_window.h:276 | |||
; Param: | |||
::;id : Font identity: | |||
SYSFNT_WINDOWTEXT | SYSFNT_WINDOWTEXT | ||
Line 814: | Line 695: | ||
SYSFNT_PREFORMATTED | SYSFNT_PREFORMATTED | ||
System-fixed width font for preformatted text. | System-fixed width font for preformatted text. | ||
; Code: | |||
public virtual void font (int id ) | |||
public virtual void font ( int id ) | |||
==method translate== | ==method translate== | ||
Line 843: | Line 723: | ||
==method text_len== | ==method text_len== | ||
Returns the length of the window text. | Returns the length of the window text. | ||
;Source: pm_window.h:306 | |||
; Source: pm_window.h:306 | ;Returns: The length of the window text, excluding any null termination character. | ||
;Code: | |||
; Returns: The length of the window text, excluding any null termination character. | |||
; Code: | |||
public virtual int text_len ( ) const | public virtual int text_len ( ) const | ||
Line 855: | Line 732: | ||
; Source: pm_window.h:371 | ; Source: pm_window.h:371 | ||
; Param: | ; 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 | |||
public LONG color ( LONG type ) const | |||
==method color== | ==method color== | ||
Sets the specified color value. | Sets the specified color value. | ||
; Source: pm_window.h:426 | |||
; 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 | ; See Also: PMWindow::color | ||
; Code: | ; Code: | ||
public void color ( LONG type , | public void color ( LONG type , | ||
LONG color ) | |||
==method rectangle== | ==method rectangle== | ||
Returns the window rectangle. | Returns the window rectangle. | ||
; Source: pm_window.h:429 | |||
; Code: | |||
public virtual PMRect rectangle ( ) const | public virtual PMRect rectangle () const | ||
==static method rectangle== | ==static method rectangle== | ||
Returns the window rectangle. | Returns the window rectangle. | ||
; Source: pm_window.h:431 | |||
; Code: | |||
public static PMRect rectangle ( HWND hwnd ) | public static PMRect rectangle ( HWND hwnd ) | ||
==method show== | ==method show== | ||
Makes the window visible. | Makes the window visible. | ||
; Source: pm_window.h:433 | |||
; Code: | |||
public virtual void show ( BOOL state = TRUE ) | public virtual void show ( BOOL state = TRUE ) | ||
==method hide== | ==method hide== | ||
Makes the window invisible. | Makes the window invisible. | ||
; Source: pm_window.h:435 | |||
; Code: | |||
public virtual void hide ( ) | public virtual void hide ( ) | ||
==method is_visible== | ==method is_visible== | ||
Line 1,105: | Line 884: | ||
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. | 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. | ||
; Source: pm_window.h:445 | |||
; Code: | |||
public virtual BOOL is_visible ( ) | public virtual BOOL is_visible ( ) | ||
==method enable== | ==method enable== | ||
Enables the window to accept keyboard and mouse input. | |||
; Source: pm_window.h:448 | |||
; Code: | |||
public virtual void enable ( BOOL state = TRUE ) | |||
public virtual void enable ( BOOL state = TRUE ) | |||
==method disable== | ==method disable== | ||
Prevents keyboard and mouse input from being sent to the window. | Prevents keyboard and mouse input from being sent to the window. | ||
; Source: pm_window.h:450 | |||
; Code: | |||
public virtual void disable ( ) | public virtual void disable ( ) | ||
Line 1,133: | Line 908: | ||
Is the window enabled. | Is the window enabled. | ||
; Source: pm_window.h:452 | |||
; Code: | |||
public virtual BOOL is_enabled ( ) const | public virtual BOOL is_enabled ( ) const | ||
==enum drop_type== | ==enum drop_type== | ||
Use these enumerators to specify various object types that can be dropped to window. | Use these enumerators to specify various object types that can be dropped to window. | ||
; Source: pm_window.h:460 | |||
; Code: | |||
public enum drop_type { drop_none = 0x0000 , | public enum drop_type { drop_none = 0x0000 , | ||
drop_os2file = 0x0001 } | drop_os2file = 0x0001 } | ||
==method enable_drop== | ==method enable_drop== | ||
Enables the window to accept dropped objects. | |||
; Source: pm_window.h:463 | |||
; Code: | |||
public virtual void enable_drop ( LONG type ) | |||
public virtual void enable_drop ( LONG type ) | |||
==method is_valid== | ==method is_valid== | ||
Line 1,170: | Line 941: | ||
==method set_focus== | ==method set_focus== | ||
Sets the input focus to the window. | |||
; Source: pm_window.h:476 | |||
; Code: | |||
public virtual void set_focus ( ) | public virtual void set_focus ( ) | ||
==method has_focus== | ==method has_focus== | ||
Has focus. | |||
If the window has the input focus, TRUE is returned. Otherwise, FALSE is returned. | |||
; Source: pm_window.h:485 | |||
; Code: | |||
public virtual BOOL has_focus ( ) const | public virtual BOOL has_focus ( ) const | ||
==method invalidate== | ==method invalidate== | ||
This method adds a rectangle 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. | |||
; Source: pm_window.h:495 | |||
; Code: | |||
public virtual void invalidate ( const PMRect & rect , | |||
public virtual void invalidate ( const PMRect & rect , | |||
BOOL include_children = TRUE ) | BOOL include_children = TRUE ) | ||
Line 1,209: | Line 974: | ||
The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing. | The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing. | ||
; Source: pm_window.h:505 | |||
; Code: | |||
public virtual void invalidate ( BOOL include_children = TRUE ) | public virtual void invalidate ( BOOL include_children = TRUE ) | ||
==method validate== | ==method validate== | ||
Line 1,220: | Line 984: | ||
The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing. | The update region is a subregion of a window that is deemed "invalid" or incorrect in visual terms and is in need of redrawing. | ||
; Source: pm_window.h:515 | |||
; Code: | |||
public virtual void validate ( const PMRect & rect , | public virtual void validate ( const PMRect & rect , | ||
BOOL include_children = TRUE ) | BOOL include_children = TRUE ) | ||
==method validate== | ==method validate== | ||
This method subtracts the whole window from 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. | |||
; Source: pm_window.h:525 | |||
; Code: | |||
public virtual void validate ( BOOL include_children = TRUE ) | public virtual void validate ( BOOL include_children = TRUE ) | ||
Line 1,250: | Line 1,011: | ||
==method release_pointer== | ==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. | |||
; Source: pm_window.h:549 | |||
; Code: | |||
public virtual void release_pointer ( ) | |||
public virtual void release_pointer ( ) | |||
==method has_pointer_captured== | ==method has_pointer_captured== | ||
Has pointer captured. | |||
If this window is currently capturing pointer events, true is returned. Otherwise, false is returned. | |||
; Source: pm_window.h:558 | |||
; Code: | |||
public virtual BOOL has_pointer_captured ( ) const | |||
public virtual BOOL has_pointer_captured ( ) const | |||
==method pointer== | ==method pointer== | ||
Sets the appearance used by the mouse pointer when it is over the window. | |||
; Source: pm_window.h:589 | |||
; 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 ) | public virtual void pointer ( LONG id ) | ||
==method pointer== | ==method pointer== | ||
Returns the mouse pointer used when the mouse is over the window. | |||
; Source: pm_window.h:592 | |||
; Code: | |||
public virtual LONG pointer ( ) const | public virtual LONG pointer ( ) const | ||
==method attach_accelerators== | ==method attach_accelerators== | ||
Replaces the accelerator keys used by the window. | |||
; Source: pm_window.h:603 | |||
; 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 ) | |||
public virtual void attach_accelerators ( SHORT res_id , | |||
==method detach_accelerators== | ==method detach_accelerators== | ||
Detaches the accelerator keys used by the window. | |||
;Source: pm_window.h:609 | |||
; Code: | |||
public virtual void detach_accelerators ( ) | |||
public virtual void detach_accelerators ( ) | |||
==method send== | ==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. | |||
; Source: pm_window.h:619 | |||
; Code: | |||
public MRESULT send ( ULONG msg , | |||
public MRESULT send ( ULONG msg , | |||
MPARAM mp1 , | MPARAM mp1 , | ||
MPARAM mp2 ) | MPARAM mp2 ) | ||
==method post== | ==method post== | ||
Posts a message to window. | |||
This method posts a message to the message queue associated with the window. | |||
; Source: pm_window.h:630 | |||
; Returns: Success indicator. | |||
; Code: | |||
public BOOL post ( ULONG msg , | |||
MPARAM mp1 , | MPARAM mp1 , | ||
MPARAM mp2 ) | MPARAM mp2 ) | ||
==method start_timer== | ==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. | |||
; Source: pm_window.h:646 | |||
; Code: | |||
public virtual void start_timer ( ULONG id , | |||
ULONG timeout ) | |||
public virtual void start_timer ( ULONG id , | |||
==method stop_timer== | ==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. | |||
; Source: pm_window.h:655 | |||
; Code: | |||
public virtual void stop_timer ( ULONG id ) | |||
public virtual void stop_timer ( ULONG id ) | |||
==method auto_delete_object== | ==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. | |||
; Source: pm_window.h:665 | |||
; Code: | |||
public virtual void auto_delete_object ( BOOL state = TRUE ) | |||
public virtual void auto_delete_object ( BOOL state = TRUE ) | |||
==method is_auto_delete_object== | ==method is_auto_delete_object== | ||
If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned. | |||
; Source: pm_window.h:672 | |||
; Code: | |||
public virtual BOOL is_auto_delete_object ( ) | |||
public virtual BOOL is_auto_delete_object ( ) | |||
==method handle_events== | ==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. | |||
; Source: pm_window.h:684 | |||
; Code: | |||
protected void handle_events ( ) | protected void handle_events ( ) | ||
Line 1,460: | Line 1,164: | ||
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. | 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. | ||
; Source: pm_window.h:694 | |||
; Code: protected void stop_handling_events () | |||
==method dispatch== | ==method dispatch== | ||
Line 1,472: | Line 1,173: | ||
; Source: pm_window.h:703 | ; Source: pm_window.h:703 | ||
; Code: | ; Code: | ||
protected virtual MRESULT dispatch (ULONG msg , | |||
MPARAM mp1 , | MPARAM mp1 , | ||
MPARAM mp2 ) | MPARAM mp2 ) | ||
==method dispatch_everything== | ==method dispatch_everything== | ||
Dispatch all not | Dispatch all not caught events. | ||
A virtual method that provides default implementation for all events that occur on every window. | A virtual method that provides default implementation for all events that occur on every window. | ||
; Source: pm_window.h:712 | ; Source: pm_window.h:712 | ||
; Code: | ; Code: | ||
protected virtual MRESULT dispatch_everything (ULONG msg , | |||
MPARAM mp1 , | MPARAM mp1 , | ||
MPARAM mp2 ) | MPARAM mp2 ) | ||
[[Category:Glass PM C++ API]] | [[Category:Glass PM C++ API]] |
Latest revision as of 03:52, 12 December 2022
Extends PMNonCopyable as public
Base window class.
The PMWindow class is the base window class and provides behaviour common to all windows. Although this class contains behaviour requiring the existence of a presentation window, you must construct the presentation window itself using a derived class.
You can construct and destruct objects of this class.
Note: Although you can construct objects of this class directly, you do not generally do so.
- Source
- pm_window.h:49
- Author
- Dmitry A.Steklenev
- Version
- 1.1
Contents
Entity | Inherited From | Type | Scope | Short Description |
---|---|---|---|---|
PMWindow | constructor | public | Wraps the window object around an existing presentation window handle. | |
PMWindow | constructor | public | Wraps the window object around an existing child window with the specified identity. | |
PMWindow | constructor | public | Constructs the presentation window. | |
PMWindow | constructor | public | Constructs the presentation window from the dialog template. | |
PMWindow | constructor | protected | Constructs the presentation window of the specified class. | |
~PMWindow | destructor | public | Destructs the window object. | |
destroy | method | public | Destroys the presentation window. | |
handle | method | public | Returns the presentation window handle. | |
id | method | public | Returns the window identifier. | |
id | method | public | Sets the window identifier. | |
style | method | public | Returns the window style. | |
pid | method | public | Returns the process identifier that created the window. | |
tid | method | public | Returns the thread identifier that created the window. | |
parent | method | public | Returns the parent window handle. | |
owner | method | public | Returns the owner window handle. | |
child | method | public | Returns the handle of the child window with the specified identity. | |
parent | method | public | Sets the parent window. | |
owner | method | public | Sets the owner window. | |
frame | method | public | Return the handle of the first frame window associated with this window. | |
text | method | public | Sets the window text. | |
rectangle | method | public | Sets the window's position and size. | |
center_at | method | public | Centers the window concerning his owner window. | |
font | method | public | Sets a new font to be used by the window. | |
font | method | public | Sets a new system font to be used by the window. | |
translate | method | public | Translates the window text. | |
text | method | public | Returns the window text. | |
text_len | method | public | Returns the length of the window text. | |
color | method | public | Returns the specified color value. | |
color | method | public | Sets the specified color value. | |
rectangle | method | public | Returns the window rectangle. | |
rectangle | static method | public | Returns the window rectangle. | |
show | method | public | Makes the window visible. | |
hide | method | public | Makes the window invisible. | |
is_visible | method | public | Is the window visible. | |
enable | method | public | Enables the window to accept keyboard and mouse input. | |
disable | method | public | Prevents keyboard and mouse input from being sent to the window. | |
is_enabled | method | public | Is the window enabled. | |
drop_type | enum | public | Use these enumerators to specify various object types that can be dropped to window. | |
enable_drop | method | public | Enables the window to accept dropped objects. | |
is_valid | method | public | Is the window valid. | |
set_focus | method | public | Sets the input focus to the window. | |
has_focus | method | public | Has focus. | |
invalidate | method | public | This method adds a rectangle to a window's update region. | |
invalidate | method | public | This method adds the whole window to a window's update region. | |
validate | method | public | This method subtracts a rectangle from a window's update region. | |
validate | method | public | This method subtracts the whole window from a window's update region. | |
capture_pointer | method | public | Captures mouse pointer. | |
release_pointer | method | public | Release mouse pointer. | |
has_pointer_captured | method | public | Has pointer captured. | |
pointer | method | public | Sets the appearance used by the mouse pointer when it is over the window. | |
pointer | method | public | Returns the mouse pointer used when the mouse is over the window. | |
attach_accelerators | method | public | Replaces the accelerator keys used by the window. | |
detach_accelerators | method | public | Detaches the accelerator keys used by the window. | |
send | method | public | Sends a message to window. | |
post | method | public | Posts a message to window. | |
start_timer | method | public | This method starts a timer. | |
stop_timer | method | public | This method stops a timer. | |
auto_delete_object | method | public | Determines whether to delete the window object when the presentation window is destroyed. | |
is_auto_delete_object | method | public | If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned. | |
handle_events | method | protected | Handle events. | |
stop_handling_events | method | protected | Stop handling events. | |
dispatch | method | protected | Dispatch system native events. | |
dispatch_everything | method | protected | Dispatch all not caught events. |
constructor PMWindow
Wraps the 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_window.h:61
- Code
public PMWindow ( HWND handle )
constructor PMWindow
Wraps the 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_window.h:75
- Params
-
- hparent
- Specifies the parent-window handle.
- id
- Specifies the identity of the child window.
- Code
public PMWindow ( HWND hparent , SHORT id )
constructor PMWindow
Constructs the presentation window.
- Source
- pm_window.h:107
- Params
-
- id
- Specifies the window identifier.
- text
- Specifies the window text.
- hparent
- Specifies the parent-window handle.
- howner
- Specifies the owner-window handle.
- x,y,cx,cy
- Specifies the window rectangle.
- style
- Specifies the window style:
- WS_CLIPCHILDREN
- Prevents a window from painting over its child windows.
- WS_CLIPSIBLINGS
- Prevents a window from painting over its sibling windows.
- WS_DISABLED
- Used by an application to disable a window.
- WS_GROUP
- Specifies the first control of a group of controls.
- WS_MAXIMIZED
- Enlarges a window to the maximum size.
- WS_MINIMIZED
- Reduces a window to the size of an icon.
- WS_PARENTCLIP
- Extends a window's visible region to include that of its parent window.
- WS_SAVEBITS
- Saves the screen area under a window as a bit map.
- WS_SYNCPAINT
- Causes a window to receive WM_PAINT messages immediately after a part of the window becomes invalid.
- WS_TABSTOP
- Specifies one of any number of controls through which the user can move by tabbing.
- WS_VISIBLE
- Makes a window visible.
- WS_DLGPOINTS
- The window rectangle is specified in dialog units.
- Code
public PMWindow ( SHORT id , const char * text , HWND hparent , HWND howner , LONG x , LONG y , LONG cx , LONG cy , ULONG style )
constructor PMWindow
Constructs the presentation window from the dialog template.
- Source
- pm_window.h:120
- Params
-
- hparent
- Specifies the parent-window handle.
- 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 window.
- hmodule
- Module handle referencing a dynamic link library containing the resource or NULLHANDLE for the application's module.
- Code
public PMWindow ( HWND hparent , HWND howner , SHORT res_id , HMODULE hmodule )
constructor PMWindow
Constructs the presentation window of the specified class.
- Source
- pm_window.h:138
- Params
-
- classname
- Specifies the registered-class name.
- id
- Specifies the window identifier.
- text
- Specifies the window text.
- hparent
- Specifies the parent-window handle.
- howner
- Specifies the owner-window handle.
- x,y,cx,cy
- Specifies the window shape.
- style
- Specifies the window style.
- classdata
- Specifies the pointer to control data.
- Code
protected PMWindow ( const char * classname , SHORT id , const char * text , HWND hparent , HWND howner , LONG x , LONG y , LONG cx , LONG cy , ULONG style , PVOID classdata = NULL )
destructor ~PMWindow
Destructs the window object.
Cleans up as this window object and destroying the associated presentation window for this object if the object was not created from an existing window handle.
- Source
- pm_window.h:149
- Code
public virtual ~ PMWindow ( )
method destroy
Destroys the presentation window.
Destroying the associated presentation window for this object.
- Source
- pm_window.h:158
- Code
public virtual void destroy ( )
method handle
Returns the presentation window handle.
- Source
- pm_window.h:161
- Code
public HWND handle ( ) const
method id
Returns the window identifier.
- Source
- pm_window.h:163
- Code
public SHORT id ( ) const
method id
Sets the window identifier.
- Source
- pm_window.h:165
- Code
public virtual void id ( SHORT new_id )
method style
Returns the window style.
- Source
- pm_window.h:167
- Code
public virtual ULONG style ( ) const
method pid
Returns the process identifier that created the window.
- Source
- pm_window.h:169
- Code
public PID pid ( ) const
method tid
Returns the thread identifier that created the window.
- Source
- pm_window.h:171
- Code
public TID tid ( ) const
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.
- Source
- pm_window.h:181
- Code
public HWND parent ( ) const
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.
- Source
- pm_window.h:192
- Code
public HWND owner ( ) const
method child
Returns the handle of the child window with the specified identity.
- Source
- pm_window.h:203
- Param
-
- id
- Identifier of the child window.
- Returns
- Child-window handle or NULLHANDLE if no child window of the specified identity exists.
- Code
public HWND child ( SHORT id ) 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.
- Source
- pm_window.h:227
- 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 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.
- Source
- pm_window.h:240
- Param
- howner New owner window handle.
- Code
public virtual void owner ( HWND howner )
method frame
Return the handle of the first frame window associated with this window.
- Source
- pm_window.h:246
- Code
public virtual HWND frame ( ) const
method text
Sets the window text.
- Source
- pm_window.h:249
- Code
public virtual void text ( const char * text )
method rectangle
Sets the window's position and size.
- Source
- pm_window.h:251
- Code
public virtual void rectangle ( const PMRect & rect )
method center_at
Centers the window concerning his owner window.
- Source
- pm_window.h:253
- Code
public virtual void center_at ( )
method font
Sets a new font to be used by the window.
- Source
- pm_window.h:255
- Code
public virtual void font ( const char * font )
method font
Sets a new system font to be used by the window.
- Source
- pm_window.h:276
- Param
-
- id
- Font identity:
SYSFNT_WINDOWTEXT System font for window text. SYSFNT_WINDOWTITLES System font for window title text. SYSFNT_MENU System font for menu text. SYSFNT_ICONTEXT System font for icon text. SYSFNT_PREFORMATTED System-fixed width font for preformatted text.
- Code
public virtual void font (int id )
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.
- Source
- pm_window.h:286
- Code
public virtual void translate ( )
method text
Returns the window text.
- Source
- pm_window.h:297
- 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_len
Returns the length of the window text.
- Source
- pm_window.h:306
- Returns
- The length of the window text, excluding any null termination character.
- Code
public virtual int text_len ( ) const
method color
Returns the specified color value.
- Source
- pm_window.h:371
- 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 color
Sets the specified color value.
- Source
- pm_window.h:426
- 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 rectangle
Returns the window rectangle.
- Source
- pm_window.h:429
- Code
public virtual PMRect rectangle () const
static method rectangle
Returns the window rectangle.
- Source
- pm_window.h:431
- Code
public static PMRect rectangle ( HWND hwnd )
method show
Makes the window visible.
- Source
- pm_window.h:433
- Code
public virtual void show ( BOOL state = TRUE )
method hide
Makes the window invisible.
- Source
- pm_window.h:435
- Code
public virtual void hide ( )
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.
- Source
- pm_window.h:445
- Code
public virtual BOOL is_visible ( )
method enable
Enables the window to accept keyboard and mouse input.
- Source
- pm_window.h:448
- Code
public virtual void enable ( BOOL state = TRUE )
method disable
Prevents keyboard and mouse input from being sent to the window.
- Source
- pm_window.h:450
- Code
public virtual void disable ( )
method is_enabled
Is the window enabled.
- Source
- pm_window.h:452
- Code
public virtual BOOL is_enabled ( ) const
enum drop_type
Use these enumerators to specify various object types that can be dropped to window.
- Source
- pm_window.h:460
- Code
public enum drop_type { drop_none = 0x0000 , drop_os2file = 0x0001 }
method enable_drop
Enables the window to accept dropped objects.
- Source
- pm_window.h:463
- Code
public virtual void enable_drop ( LONG type )
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.
- Source
- pm_window.h:473
- Code
public virtual BOOL is_valid ( ) const
method set_focus
Sets the input focus to the window.
- Source
- pm_window.h:476
- Code
public virtual void set_focus ( )
method has_focus
Has focus.
If the window has the input focus, TRUE is returned. Otherwise, FALSE is returned.
- Source
- pm_window.h:485
- Code
public virtual BOOL has_focus ( ) const
method invalidate
This method adds a rectangle 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.
- Source
- pm_window.h:495
- Code
public virtual void invalidate ( const PMRect & rect , BOOL include_children = TRUE )
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.
- Source
- pm_window.h:505
- Code
public virtual void invalidate ( BOOL include_children = TRUE )
method validate
This method subtracts a rectangle from 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.
- Source
- pm_window.h:515
- Code
public virtual void validate ( const PMRect & rect , BOOL include_children = TRUE )
method validate
This method subtracts the whole window from 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.
- Source
- pm_window.h:525
- Code
public virtual void validate ( BOOL include_children = 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.
- Source
- pm_window.h:537
- Code
public virtual void capture_pointer ( BOOL capture = TRUE )
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.
- Source
- pm_window.h:549
- Code
public virtual void release_pointer ( )
method has_pointer_captured
Has pointer captured.
If this window is currently capturing pointer events, true is returned. Otherwise, false is returned.
- Source
- pm_window.h:558
- Code
public virtual BOOL has_pointer_captured ( ) const
method pointer
Sets the appearance used by the mouse pointer when it is over the window.
- Source
- pm_window.h:589
- 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 pointer
Returns the mouse pointer used when the mouse is over the window.
- Source
- pm_window.h:592
- Code
public virtual LONG pointer ( ) const
method attach_accelerators
Replaces the accelerator keys used by the window.
- Source
- pm_window.h:603
- 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_window.h:609
- Code
public virtual void detach_accelerators ( )
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.
- Source
- pm_window.h:619
- Code
public MRESULT send ( ULONG msg , MPARAM mp1 , MPARAM mp2 )
method post
Posts a message to window.
This method posts a message to the message queue associated with the window.
- Source
- pm_window.h:630
- Returns
- Success indicator.
- Code
public BOOL post ( ULONG msg , MPARAM mp1 , MPARAM mp2 )
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.
- Source
- pm_window.h:646
- Code
public virtual void start_timer ( ULONG id , ULONG timeout )
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.
- Source
- pm_window.h:655
- Code
public virtual void stop_timer ( ULONG id )
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.
- Source
- pm_window.h:665
- Code
public virtual void auto_delete_object ( BOOL state = TRUE )
method is_auto_delete_object
If the window object is deleted when a destroy event is dispatched to the window, TRUE is returned.
- Source
- pm_window.h:672
- Code
public virtual BOOL is_auto_delete_object ( )
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.
- Source
- pm_window.h:684
- Code
protected void handle_events ( )
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.
- Source
- pm_window.h:694
- Code
- protected void stop_handling_events ()
method dispatch
Dispatch system native events.
PMWindow calls this function when a system native window event occurs.
- Source
- pm_window.h:703
- Code
protected virtual MRESULT dispatch (ULONG msg , MPARAM mp1 , MPARAM mp2 )
method dispatch_everything
Dispatch all not caught events.
A virtual method that provides default implementation for all events that occur on every window.
- Source
- pm_window.h:712
- Code
protected virtual MRESULT dispatch_everything (ULONG msg , MPARAM mp1 , MPARAM mp2 )