Developer

API Reference

Border Support Events

Brew Release
Brew MP 1.0.2
See Also
Model Events StepEvent Border Events AEEEvent Widget Events Border Background Events Border Decoration Events
Description

These events deal with events that every widget that supports border will provide to ensure the full range of border capabilities. They are primarily for the purpose of setting the state of the widget so that the full range of border customization can occur.
Supported Events:
Event                   Description
-----                   ------------------------------------------------------------
EVT_WDG_SETLAYOUT       disables(0) or enables(1) layout.  If a value of 2 is provided, it will
                        force an immediate recalculation of the widget's layout.  This event is not
                        fully supported in all widgets.  A general rule of thumb is that only
                        containers fully support this event, which are generally the only objects
                        that disabling layout is useful for.

EVT_WDG_SETFOCUS        Sets the focus of the widget to the specified value (changes the widget's
                        active state to either TRUE or FALSE).
                            IWidget_SetFocus

EVT_WDG_HASFOCUS        Retrieves whether or not the widget currently has focus (reports the active
                        state of the widget).
                            IWidget_HasFocus

EVT_WDG_CANTAKEFOCUS    Retrieves whether or not the widget is capable of taking focus.
                            IWidget_CanTakeFocus

EVT_WDG_SETPROPERTY     The border handler responds to this event by attempting to set the property
                        identified by the 'wParam' parameter.  The following properties may be set
                        to any widget which supports borders.
                        PROP_SELECTED
                        PROP_APPLYWPROPS
                        PROP_EX
                        >PROPEX_DISABLED
                        >PROPEX_TOUCH_MODE
                            IWidget_SetProperty
                            IWidget_SetPropertyEx

EVT_WDG_GETPROPERTY     The border handler responds to this event by attempting to retrieve the
                        property identified by the 'wParam' parameter.  The following properties may
                        be retrieved from any widget which supports borders.
                        PROP_CLIENTRECT
                        PROP_SELECTED
                        PROP_EX
                        >PROPEX_DISABLED
                            IWidget_GetProperty
                            IWidget_GetPropertyEx
                            IWidget_GetPropBool
                            IWidget_GetPropPtr

Properties:


Property                      Description
--------                      ------------------------------------------------------------
PROP_SELECTED                 Sets or retrieves the current selection state of the widget.
                                 IWidget_SetSelected
                                 IWidget_GetSelected

PROP_APPLYWPROPS              This property will lookup and apply the provided named set of widget
                              properties, using the provided IRESFILE interface.
                                  IWidget_SetProperties

PROP_CLIENTRECT               Returns the rectangle that is being used as the extent of the content
                              of the widget (i.e. the portion of the widget that is not taken up by
                              the shadow, border, and padding).
                                  IWidget_GetClientRect

PROP_EX                       Property used to specify an extended property
                                  IWidget_GetPropertyEx
                                  IWidget_SetPropertyEx

PROPEX_DISABLED               Extended property that sets the disabled state on the border
                              supporting widget.  Note that this property does not necessarily
                              disable any functionality for an attached widget.  Enforcing the
                              disabled state is up to the application logic that receives input from
                              the user.  For example, the default Check Widget event handler will
                              still accept changes in the selected state through PROP_SELECTED or
                              its value model; however, it will ignore select key presses as well as
                              any touches that it receives.
                                  IWidget_SetDisabled

PROPEX_TOUCH_MODE             Extended property that retrieves or sets the current touch mode.
                                  IWidget_SetTouchMode
  • Follow