Developer

API Reference

AEECLSID_BorderWidget

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

The border widget is derived from the decorator object and is used to draw borders and backgrounds for widgets. For example, a border widget may simply draw the background content of a widget as an opaque white rectangle, or could draw a drop shadow effect or a translucent frame around a widget's content rectangle -- or, it could do both, drawing the background content and a frame.

Events:


The Border Widget supports all events that are supported by widgets that support Border Events as well as those described below.
  Event                                               Description
----------             ----------------------------------------------------------------------------
EVT_WDG_MOVEFOCUS      This event does nothing to the BorderWidget because it only has one child;
                       however, it will return that it handles the event because it is an
                       implementer of IContainer.
                           IWidget_MoveFocus

EVT_WDG_ENABLETOUCH    Enables or disables touch events on the border and its children.

EVT_WDG_TRAVERSE       Traverses the widget using the TraverseDesc passed in through the dwParam.
                           IWidget_TraverseContainerTree

EVT_WDG_SETPROPERTY   The Border Widget handler responds to this event by attempting to set the
                      property identified by the 'wParam' parameter.  The following properties may
                      be set by the Border Widget event handler.
                      PROP_EX
                      PROPEX_TOUCH_CONTROLLER
                      PROPEX_USER_DATA
                      PROPEX_TOUCH_MODE
                      PROPEX_WIDGETTC_PRESSED
                          IWidget_SetProperty
                          IWidget_SetPropertyEx

EVT_WDG_GETPROPERTY   The Border Widget handler responds to this event by attempting to retrieve the
                      property identified by the 'wParam' parameter.  The following properties may
                      be retrieved by the Border Widget event handler.
                      PROP_VIEWMODEL
                      PROP_EX
                      PROPEX_TOUCH_CONTROLLER
                      PROPEX_USER_DATA
                      PROPEX_TOUCH_MODE
                          IWidget_GetProperty
                          IWidget_GetPropertyEx
                          IWidget_GetPropBool
                          IWidget_GetPropInt
                          IWidget_GetPropPtr
                          IWidget_GetPropRGB

Any event not handled by the Border Widget will be passed on to its child widget.

Properties:


Property                Description
--------                ---------------------------------------------------------------------------
PROP_VIEWMODEL          Property to retrieve the view model associated with this Border Widget.
                            IWidget_GetViewModel
PROP_EX                 PROPETY used to specify an extended property
                            IWidget_GetPropertyEx
                            IWidget_SetPropertyEx

PROPEX_TOUCH_CONTROLLER Extended property to set/get the touch controller associated with a Border.

PROPEX_WIDGETTC_PRESSED Extended property to set/cancel "pressed" state on a Border

PROPEX_USER_DATA        Extended property to associate some user data with the widget.
                            IWidget_GetUserData
                            IWidget_SetUserData

PROPEX_TOUCH_MODE       Extended property to set/get the current touch mode.



Required Model: None
Instantiaion
The Border Widget is instantiated by passing AEECLSID_BorderWidget into ISHELL_CreateInstance()
Cleanup
The Border Widget is reference-counted. When you are done with your reference to the border widget, you should Release that reference. Any border specific cleanup will be handled for you when all references are released.
Default Interface Name
Other Interfaces
Comment
None
  • Follow