Jump to content

PMButton: Difference between revisions

From EDM2
Created page with "Extends PMWindow as public Push button control window class. The PMButton class creates and manages push button control windows. You can construct and destruct objects of t..."
 
No edit summary
Line 20: Line 20:
!Short Description
!Short Description
|-
|-
|[[PMButton]]
|PMButton
|  
|  
|constructor  
|constructor  
Line 28: Line 28:


|-
|-
|[[PMButton]]
|PMButton
|  
|  
|constructor  
|constructor  
Line 36: Line 36:


|-
|-
|[[PMButton]]
|PMButton
|  
|  
|constructor  
|constructor  
Line 43: Line 43:


|-
|-
|[[attach_accelerators]]
|attach_accelerators
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 50: Line 50:


|-
|-
|[[auto_delete_object]]
|auto_delete_object
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 58: Line 58:


|-
|-
|[[capture_pointer]]
|capture_pointer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 65: Line 65:


|-
|-
|[[center_at]]
|center_at
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 72: Line 72:


|-
|-
|[[child]]
|child
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 79: Line 79:


|-
|-
|[[color]]
|color
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 86: Line 86:


|-
|-
|[[color]]
|color
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 93: Line 93:


|-
|-
|[[destroy]]
|destroy
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 100: Line 100:


|-
|-
|[[detach_accelerators]]
|detach_accelerators
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 107: Line 107:


|-
|-
|[[disable]]
|disable
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 114: Line 114:


|-
|-
|[[dispatch]]
|dispatch
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 121: Line 121:


|-
|-
|[[dispatch_everything]]
|dispatch_everything
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 128: Line 128:


|-
|-
|[[enable]]
|enable
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 135: Line 135:


|-
|-
|[[enable_drop]]
|enable_drop
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 142: Line 142:


|-
|-
|[[font]]
|font
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 149: Line 149:


|-
|-
|[[font]]
|font
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 156: Line 156:


|-
|-
|[[frame]]
|frame
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 163: Line 163:


|-
|-
|[[handle]]
|handle
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 170: Line 170:


|-
|-
|[[handle_events]]
|handle_events
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 177: Line 177:


|-
|-
|[[has_focus]]
|has_focus
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 184: Line 184:


|-
|-
|[[has_pointer_captured]]
|has_pointer_captured
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 191: Line 191:


|-
|-
|[[hide]]
|hide
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 198: Line 198:


|-
|-
|[[id]]
|id
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 205: Line 205:


|-
|-
|[[id]]
|id
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 212: Line 212:


|-
|-
|[[invalidate]]
|invalidate
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 219: Line 219:


|-
|-
|[[invalidate]]
|invalidate
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 226: Line 226:


|-
|-
|[[is_auto_delete_object]]
|is_auto_delete_object
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 234: Line 234:


|-
|-
|[[is_enabled]]
|is_enabled
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 241: Line 241:


|-
|-
|[[is_valid]]
|is_valid
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 248: Line 248:


|-
|-
|[[is_visible]]
|is_visible
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 255: Line 255:


|-
|-
|[[owner]]
|owner
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 262: Line 262:


|-
|-
|[[owner]]
|owner
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 269: Line 269:


|-
|-
|[[parent]]
|parent
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 276: Line 276:


|-
|-
|[[parent]]
|parent
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 283: Line 283:


|-
|-
|[[pid]]
|pid
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 290: Line 290:


|-
|-
|[[pointer]]
|pointer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 297: Line 297:


|-
|-
|[[pointer]]
|pointer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 304: Line 304:


|-
|-
|[[post]]
|post
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 311: Line 311:


|-
|-
|[[rectangle]]
|rectangle
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 318: Line 318:


|-
|-
|[[rectangle]]
|rectangle
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 325: Line 325:


|-
|-
|[[rectangle]]
|rectangle
|[[PMWindow]]
|[[PMWindow]]
|static method  
|static method  
Line 332: Line 332:


|-
|-
|[[release_pointer]]
|release_pointer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 339: Line 339:


|-
|-
|[[send]]
|send
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 346: Line 346:


|-
|-
|[[set_focus]]
|set_focus
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 353: Line 353:


|-
|-
|[[show]]
|show
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 360: Line 360:


|-
|-
|[[start_timer]]
|start_timer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 367: Line 367:


|-
|-
|[[stop_handling_events]]
|stop_handling_events
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 374: Line 374:


|-
|-
|[[stop_timer]]
|stop_timer
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 381: Line 381:


|-
|-
|[[style]]
|style
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 388: Line 388:


|-
|-
|[[text]]
|text
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 395: Line 395:


|-
|-
|[[text]]
|text
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 402: Line 402:


|-
|-
|[[text_len]]
|text_len
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 409: Line 409:


|-
|-
|[[tid]]
|tid
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 424: Line 424:
|-
|-
|validate
|validate
|PMWindow]]
|[[PMWindow]]
|method  
|method  
|public
|public
Line 430: Line 430:


|-
|-
|[[validate]]
|validate
|[[PMWindow]]
|[[PMWindow]]
|method  
|method  
Line 437: Line 437:


|}
|}
==constructor PMButton==
    Wraps the push button control window object around an existing presentation window handle.
    The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.
    Source:
        pm_button.h:36
    Code:
        public PMButton ( HWND handle )
==constructor PMButton==
    Wraps the push button control window object around an existing child window with the specified identifier.
    The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.
    Source:
        pm_button.h:50
    Params:
        hparent Specifies the parent-window handle.
        id Specifies the identity of the child window.
    Code:
        public PMButton ( HWND hparent ,
        SHORT id )
==constructor PMButton==
    Constructs the push button control window.
    Source:
        pm_button.h:103
    Params:
        id Specifies the window identifier.
        text Specifies the window text.
        hparent Specifies the parent-window handle.
        x,y,cx,cy Specifies the window shape.
        style Specifies the window style:
        BS_PUSHBUTTON
            A pushbutton is a box that contains a string. When a button is pushed, by clicking the pointing device on it or pressing the spacebar when it is active, the parent window is notified.
        BS_NOTEBOOKBUTTON
            A notebook button is identical to a pushbutton except that when it is created as a child of a notebook page it becomes a button in the common button area of the notebook page. If the button is not in a notebook page it will be indistinguishable from a pushbutton.
        BS_AUTOSIZE
            Creates a button that is sized automatically to ensure that the contents fit. Note: The cx or cy parameter of must be specified as -1 to implement the autosize feature.
        BS_BITMAP
            Places a bit map instead of text on the push button control.
        BS_DEFAULT
            A BS_DEFAULT pushbutton is one with a thick border box. It has the same properties as a pushbutton. In addition, the user may press a BS_DEFAULT pushbutton by pressing the RETURN or ENTER key.
        BS_HELP
            The button posts a WM_HELP message rather than a WM_COMMAND message. If both BS_HELP and BS_SYSCOMMAND are set, BS_HELP takes precedence.
        BS_ICON
            Places an icon instead of text on the push button control.
        BS_MINIICON
            This enables miniicons (half the size of normal icons) to be placed on the push button control.
        BS_NOBORDER
            The pushbutton is displayed without a border drawn around it. There is no other change in the pushbutton's operation.
        BS_NOPOINTERFOCUS
            Buttons with this style do not set the focus to themselves when clicked with the pointing device. This enables the cursor to stay on a control for which information is required, rather than moving to the button. This style has no effect on keyboard interaction. The tab key can still be used as usual to move the focus to the button.
        BS_SYSCOMMAND
            The button posts a WM_SYSCOMMAND message rather than a WM_COMMAND message.
    See Also:
        PMWindow::PMWindow
    Code:
        public PMButton ( SHORT id ,
        const char * text ,
        HWND hparent ,
        LONG x ,
        LONG y ,
        LONG cx ,
        LONG cy ,
        ULONG style )
==method attach_accelerators==
    Replaces the accelerator keys used by the window.
    Inherited From:
        PMWindow
    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 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:665
    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:537
    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:253
    Code:
        public virtual void center_at ( )
==method child==
    Returns the handle of the child window with the specified identity.
    Inherited From:
        PMWindow
    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 color==
    Returns the specified color value.
    Inherited From:
        PMWindow
    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.
    Inherited From:
        PMWindow
    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 destroy==
    Destroys the presentation window.
    Destroying the associated presentation window for this object.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:158
    Code:
        public virtual void destroy ( )
==method detach_accelerators==
    Detaches the accelerator keys used by the window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:609
    Code:
        public virtual void detach_accelerators ( )
==method disable==
    Prevents keyboard and mouse input from being sent to the window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:450
    Code:
        public virtual void disable ( )
==method dispatch==
    Dispatch system native events.
    PMWindow calls this function when a system native window event occurs.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:703
    Code:
        protected virtual MRESULT dispatch ( ULONG msg ,
        MPARAM mp1 ,
        MPARAM mp2 )
==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:712
    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:448
    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:463
    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:255
    Code:
        public virtual void font ( const char * font )
==method font==
    Sets a new system font to be used by the window.
    Inherited From:
        PMWindow
    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 frame==
    Return the handle of the first frame window associated with this window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:246
    Code:
        public virtual HWND frame ( ) const
==method handle==
    Returns the presentation window handle.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:161
    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:684
    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:485
    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:558
    Code:
        public virtual BOOL has_pointer_captured ( ) const
==method hide==
    Makes the window invisible.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:435
    Code:
        public virtual void hide ( )
==method id==
    Returns the window identifier.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:163
    Code:
        public SHORT id ( ) const
==method id==
    Sets the window identifier.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:165
    Code:
        public virtual void id ( SHORT new_id )
==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:505
    Code:
        public virtual void invalidate ( BOOL include_children = TRUE )
==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.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:495
    Code:
        public virtual void invalidate ( const PMRect & rect ,
        BOOL include_children = TRUE )
==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:672
    Code:
        public virtual BOOL is_auto_delete_object ( )
==method is_enabled==
    Is the window enabled.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:452
    Code:
        public virtual BOOL is_enabled ( ) const
==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:473
    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:445
    Code:
        public virtual BOOL is_visible ( )
==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:192
    Code:
        public HWND owner ( ) const
==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:240
    Param:
        howner New owner window handle.
    Code:
        public virtual void owner ( HWND howner )
==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:181
    Code:
        public HWND parent ( ) 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: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 pid==
    Returns the process identifier that created the window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:169
    Code:
        public PID pid ( ) const
==method pointer==
    Returns the mouse pointer used when the mouse is over the window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:592
    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: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 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:630
    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:251
    Code:
        public virtual void rectangle ( const PMRect & rect )
==method rectangle==
    Returns the window rectangle.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:429
    Code:
        public virtual PMRect rectangle ( ) const
==static method rectangle==
    Returns the window rectangle.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:431
    Code:
        public static PMRect rectangle ( HWND hwnd )
==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:549
    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:619
    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:476
    Code:
        public virtual void set_focus ( )
==method show==
    Makes the window visible.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:433
    Code:
        public virtual void show ( BOOL state = TRUE )
==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:646
    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:694
    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:655
    Code:
        public virtual void stop_timer ( ULONG id )
==method style==
    Returns the window style.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:167
    Code:
        public virtual ULONG style ( ) const
==method text==
    Returns the window text.
    Inherited From:
        PMWindow
    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==
    Sets the window text.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:249
    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:306
    Returns:
        The length of the window text, excluding any null termination character.
    Code:
        public virtual int text_len ( ) const
==method tid==
    Returns the thread identifier that created the window.
    Inherited From:
        PMWindow
    Source:
        pm_window.h:171
    Code:
        public TID tid ( ) 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:286
    Code:
        public virtual void translate ( )
==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.
    Inherited From:
        PMWindow
    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.
    Inherited From:
        PMWindow
; Source:
        pm_window.h:525
; Code:
        public virtual void validate ( BOOL include_children = TRUE )






[[Category:Glass PM C++ API]]
[[Category:Glass PM C++ API]]

Revision as of 22:23, 14 March 2018

Extends PMWindow as public

Push button control window class.

The PMButton class creates and manages push button control windows.

You can construct and destruct objects of this class.

Source
pm_button.h:24
Author
Dmitry A.Steklenev
Version
1.0

Contents

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


constructor PMButton

   Wraps the push button control window object around an existing presentation window handle.
   The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.
   Source:
       pm_button.h:36
   Code:
       public PMButton (	HWND handle )

constructor PMButton

   Wraps the push button control window object around an existing child window with the specified identifier.
   The wrapped window object usually have a limited functionality. You can query and set the window attributes, size, position and visibility status.
   Source:
       pm_button.h:50
   Params:
       hparent 	Specifies the parent-window handle.
       id 	Specifies the identity of the child window.
   Code:
       public PMButton (	HWND hparent ,
       	SHORT id )

constructor PMButton

   Constructs the push button control window.
   Source:
       pm_button.h:103
   Params:
       id 	Specifies the window identifier.
       text 	Specifies the window text.
       hparent 	Specifies the parent-window handle.
       x,y,cx,cy 	Specifies the window shape.
       style 	Specifies the window style:
       BS_PUSHBUTTON
           A pushbutton is a box that contains a string. When a button is pushed, by clicking the pointing device on it or pressing the spacebar when it is active, the parent window is notified. 
       BS_NOTEBOOKBUTTON
           A notebook button is identical to a pushbutton except that when it is created as a child of a notebook page it becomes a button in the common button area of the notebook page. If the button is not in a notebook page it will be indistinguishable from a pushbutton. 
       BS_AUTOSIZE
           Creates a button that is sized automatically to ensure that the contents fit. Note: The cx or cy parameter of must be specified as -1 to implement the autosize feature. 
       BS_BITMAP
           Places a bit map instead of text on the push button control. 
       BS_DEFAULT
           A BS_DEFAULT pushbutton is one with a thick border box. It has the same properties as a pushbutton. In addition, the user may press a BS_DEFAULT pushbutton by pressing the RETURN or ENTER key. 
       BS_HELP
           The button posts a WM_HELP message rather than a WM_COMMAND message. If both BS_HELP and BS_SYSCOMMAND are set, BS_HELP takes precedence. 
       BS_ICON
           Places an icon instead of text on the push button control. 
       BS_MINIICON
           This enables miniicons (half the size of normal icons) to be placed on the push button control. 
       BS_NOBORDER
           The pushbutton is displayed without a border drawn around it. There is no other change in the pushbutton's operation. 
       BS_NOPOINTERFOCUS
           Buttons with this style do not set the focus to themselves when clicked with the pointing device. This enables the cursor to stay on a control for which information is required, rather than moving to the button. This style has no effect on keyboard interaction. The tab key can still be used as usual to move the focus to the button. 
       BS_SYSCOMMAND
           The button posts a WM_SYSCOMMAND message rather than a WM_COMMAND message. 
   See Also:
       PMWindow::PMWindow
   Code:
       public PMButton (	SHORT id ,
       	const char * text ,
       	HWND hparent ,
       	LONG x ,
       	LONG y ,
       	LONG cx ,
       	LONG cy ,
       	ULONG style )

method attach_accelerators

   Replaces the accelerator keys used by the window.
   Inherited From:
       PMWindow
   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 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:665
   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:537
   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:253
   Code:
       public virtual void center_at (	)

method child

   Returns the handle of the child window with the specified identity.
   Inherited From:
       PMWindow
   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 color

   Returns the specified color value.
   Inherited From:
       PMWindow
   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.
   Inherited From:
       PMWindow
   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 destroy

   Destroys the presentation window.
   Destroying the associated presentation window for this object.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:158
   Code:
       public virtual void destroy (	)

method detach_accelerators

   Detaches the accelerator keys used by the window.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:609
   Code:
       public virtual void detach_accelerators (	)

method disable

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

method dispatch

   Dispatch system native events.
   PMWindow calls this function when a system native window event occurs.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:703
   Code:
       protected virtual MRESULT dispatch (	ULONG msg ,
       	MPARAM mp1 ,
       	MPARAM mp2 )

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:712
   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:448
   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:463
   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:255
   Code:
       public virtual void font (	const char * font )

method font

   Sets a new system font to be used by the window.
   Inherited From:
       PMWindow
   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 frame

   Return the handle of the first frame window associated with this window.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:246
   Code:
       public virtual HWND frame (	) const

method handle

   Returns the presentation window handle.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:161
   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:684
   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:485
   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:558
   Code:
       public virtual BOOL has_pointer_captured (	) const

method hide

   Makes the window invisible.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:435
   Code:
       public virtual void hide (	)

method id

   Returns the window identifier.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:163
   Code:
       public SHORT id (	) const

method id

   Sets the window identifier.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:165
   Code:
       public virtual void id (	SHORT new_id )

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:505
   Code:
       public virtual void invalidate (	BOOL include_children = TRUE )

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.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:495
   Code:
       public virtual void invalidate (	const PMRect & rect ,
       	BOOL include_children = TRUE )

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:672
   Code:
       public virtual BOOL is_auto_delete_object (	)

method is_enabled

   Is the window enabled.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:452
   Code:
       public virtual BOOL is_enabled (	) const

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:473
   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:445
   Code:
       public virtual BOOL is_visible (	)

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:192
   Code:
       public HWND owner (	) const

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:240
   Param:
       howner 	New owner window handle.
   Code:
       public virtual void owner (	HWND howner )

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:181
   Code:
       public HWND parent (	) 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: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 pid

   Returns the process identifier that created the window.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:169
   Code:
       public PID pid (	) const

method pointer

   Returns the mouse pointer used when the mouse is over the window.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:592
   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: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 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:630
   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:251
   Code:
       public virtual void rectangle (	const PMRect & rect )

method rectangle

   Returns the window rectangle.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:429
   Code:
       public virtual PMRect rectangle (	) const

static method rectangle

   Returns the window rectangle.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:431
   Code:
       public static PMRect rectangle (	HWND hwnd )

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:549
   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:619
   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:476
   Code:
       public virtual void set_focus (	)

method show

   Makes the window visible.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:433
   Code:
       public virtual void show (	BOOL state = TRUE )

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:646
   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:694
   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:655
   Code:
       public virtual void stop_timer (	ULONG id )

method style

   Returns the window style.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:167
   Code:
       public virtual ULONG style (	) const

method text

   Returns the window text.
   Inherited From:
       PMWindow
   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

   Sets the window text.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:249
   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:306
   Returns:
       The length of the window text, excluding any null termination character. 
   Code:
       public virtual int text_len (	) const

method tid

   Returns the thread identifier that created the window.
   Inherited From:
       PMWindow
   Source:
       pm_window.h:171
   Code:
       public TID tid (	) 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:286
   Code:
       public virtual void translate (	)

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.
   Inherited From:
       PMWindow
   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.
   Inherited From:
       PMWindow
Source
       pm_window.h:525
Code
       public virtual void validate (	BOOL include_children = TRUE )