Developer

API Reference

Border Decoration Events

Brew Release
Brew MP 1.0.2
See Also
Border Events AEEEvent Widget Events Border Support Events Border Background Events Model Events StepEvent
Description
These border events decorate the widget outside of the widget's content. These events fall into 3 different categories:
- Border Properties - These properties deal with the rectangular border that can be placed around supporting
widgets. The border of a widget is very customizable, allowing the developer to adjust its width, corner style, and color based on the state that the widget currently holds. For example, when developing a menu system, the user may be using a Grid Container where each icon in the menu has a grey 2 pixel border when it is unselected and a blue 3 pixel border when the icon currently has the focus in the menu.
- Padding Properties - These properties deal with internal padding between the external border explained above
and the content of the widget. This allows for the designer to provide visual separation between these two elements.
- Shadow Properties - These properties deal with the drop-shadow that can be used to create the visual
illusion that the widget is floating above other objects on the display. For example, a list or button may possess a drop shadow to give the user interface a 3D appearance.
Supported Events:
Event                   Description
-----                   ------------------------------------------------------------
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_BORDERSTYLE
                        PROP_BORDERWIDTH
                        PROP_ACTIVE_BORDERWIDTH
                        PROP_INACTIVE_BORDERWIDTH
                        PROP_BORDERRADIUS
                        PROP_BORDERCOLOR
                        PROP_SELECTED_BORDERCOLOR
                        PROP_ACTIVE_BORDERCOLOR
                        PROP_INACTIVE_BORDERCOLOR
                        PROP_SACTIVE_BORDERCOLOR
                        PROP_SINACTIVE_BORDERCOLOR
                        PROP_BORDERTRANSPARENCY
                        PROP_PADDING
                        PROP_LEFT_PAD
                        PROP_RIGHT_PAD
                        PROP_TOP_PAD
                        PROP_BOTTOM_PAD
                        PROP_SHADOWOFFSET
                        PROP_SHADOWOFFSETX
                        PROP_SHADOWOFFSETY
                        PROP_SHADOWCOLOR
                        PROP_SELECTED_SHADOWOFFSET
                        PROP_SELECTED_SHADOWOFFSETX
                        PROP_SELECTED_SHADOWOFFSETY
                        PROP_SELECTED_SHADOWCOLOR
                            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_BORDERSTYLE
                        PROP_BORDERTRANSPARENCY
                        PROP_BORDERWIDTH
                        PROP_ACTIVE_BORDERWIDTH
                        PROP_INACTIVE_BORDERWIDTH
                        PROP_BORDERRADIUS
                        PROP_BORDERCOLOR
                        PROP_ACTIVE_BORDERCOLOR
                        PROP_INACTIVE_BORDERCOLOR
                        PROP_SELECTED_BORDERCOLOR
                        PROP_SACTIVE_BORDERCOLOR
                        PROP_SINACTIVE_BORDERCOLOR
                        PROP_LEFT_PAD
                        PROP_RIGHT_PAD
                        PROP_TOP_PAD
                        PROP_BOTTOM_PAD
                        PROP_SHADOWOFFSETX
                        PROP_SHADOWOFFSETY
                        PROP_SELECTED_SHADOWOFFSETX
                        PROP_SELECTED_SHADOWOFFSETY
                        PROP_SHADOWCOLOR
                        PROP_SELECTED_SHADOWCOLOR
                            IWidget_GetProperty
                            IWidget_GetPropInt
                            IWidget_GetPropRGB

Properties:
Property                      Description
--------                      ------------------------------------------------------------
< Border Properties <
PROP_BORDERSTYLE              Sets or retrieves the display style of the border.  The following
                              values are acceptable values for this property.
                              BORDERSTYLE_NORMAL  The widget border will be displayed as a standard
                                                  rectangle
                              BORDERSTYLE_BEVELED The widget border will be displayed with beveled
                                                  corners, inset from the widget's bounding
                                                  rectangle.
                              BORDERSTYLE_ROUNDED The widget border will be displayed with rounded
                                                  corners, inset from the widget's bounding
                                                  rectangle.
                                  IWidget_SetBorderStyle
                                  IWidget_GetBorderStyle

PROP_BORDERWIDTH              Sets or retrieves the width of the border.  When the size of the
                              border differs between the active and inactive states, the size of the
                              active state will be returned.
                                  IWidget_SetBorderWidth
                                  IWidget_GetBorderWidth

PROP_ACTIVE_BORDERWIDTH       Sets or retrieves the width that the border will display with when the
                              widget is the active state (has focus).
                                  IWidget_SetActiveBorderWidth
                                  IWidget_GetActiveBorderWidth

PROP_INACTIVE_BORDERWIDTH     Sets or retrieves the width that the border will display with when the
                              widget is in the inactive state (does not have focus).
                                  IWidget_SetInactiveBorderWidth
                                  IWidget_GetInactiveBorderWidth

PROP_BORDERRADIUS             Sets or retrieves the radius that will be used by the border when it
                              is in the BORDERSTYLE_ROUNDED mode.  This value is constrained to be
                              between 0 and one-half of the smaller of the border's height and
                              width.
                                  IWidget_SetBorderRadius
                                  IWidget_GetBorderRadius

PROP_BORDERCOLOR              Sets or retrieves the color that will be used to display the border
                              for all states of the widget.  If the widget uses multiple border
                              colors, PROP_BORDERCOLOR will retrieve the color that is used in the
                              Active, Unselected state.
                                  IWidget_SetBorderColor

PROP_ACTIVE_BORDERCOLOR       Sets or retrieves the color that will be used to display the border
                              when it is in the Active, Unselected state.
                                  IWidget_SetActiveBorderColor
                                  IWidget_GetActiveBorderColor

PROP_INACTIVE_BORDERCOLOR     Sets or retrieves the color that will be used to display the border
                              when it is in the Inactive, Unselected state.
                                  IWidget_SetInactiveBorderColor
                                  IWidget_GetInactiveBorderColor

PROP_SELECTED_BORDERCOLOR     Sets or retrieves the color that will be used to display the border
                              when it is in either of the Selected states.  If differing colors
                              have been set for the SACTIVE and SINACTIVE states, the SACTIVE color
                              will be retrieved.
                                  IWidget_SetSelectedBorderColor

PROP_SACTIVE_BORDERCOLOR      Sets or retrieves the color that will be used by the widget when it
                              is in the Selected, Active state.
                                  IWidget_SetSelectedActiveBorderColor
                                  IWidget_GetSelectedActiveBorderColor

PROP_SINACTIVE_BORDERCOLOR    Sets or retrieves the color that will be used by the widget when it
                              is in the Selected, Inactive state.
                                  IWidget_SetSelectedInactiveBorderColor
                                  IWidget_GetSelectedInactiveBorderColor

PROP_BORDERTRANSPARENCY       Sets or retrieves the transparency that will be used in all states of
                              widget for the border color.  This property is deprecated due to the
                              inclusion of support in widgets for RGBAVAL's.
                                  IWidget_SetBorderTransparency
                                  IWidget_GetBorderTransparency

< Padding Properties <

PROP_PADDING                  Sets the padding for all four sides of the widget to the specified
                              value.  This padding provides an internal buffer between the inner
                              edge of the border and the outside edge of the contents that the
                              border is wrapping.  This property is only supported on set.
                                  IWidget_SetPadding

PROP_LEFT_PAD                 Sets or retrieves the padding that will be used between the left side
                              of the widget and border.
                                  IWidget_SetLeftPadding
                                  IWidget_GetLeftPadding

PROP_RIGHT_PAD                Sets or retrieves the padding that will be used between the right side
                              of the widget and border.
                                  IWidget_SetRightPadding
                                  IWidget_GetRightPadding

PROP_TOP_PAD                  Sets or retrieves the padding that will be used between the top side
                              of the widget and border.
                                  IWidget_SetTopPadding
                                  IWidget_GetTopPadding

PROP_BOTTOM_PAD               Sets or retrieves the padding that will be used between the top side
                              of the widget and border.
                                  IWidget_SetBottomPadding
                                  IWidget_GetBottomPadding

< Shadow Properties <
PROP_SHADOWOFFSET             Sets the X and Y offsets for the shadow to the passed in value.  If a
                              value is provided that is greater than the horizontal or vertical size
                              of the widget, the shadow will be disjoint from the widget.  In other
                              words, a widget can't cast a shadow that is larger than itself.  This
                              property is set only.
                                  IWidget_SetShadowOffset

PROP_SHADOWOFFSETX            Sets or retrieves the X offset of the shadow.
                                  IWidget_SetShadowOffsetX
                                  IWidget_GetShadowOffsetX

PROP_SHADOWOFFSETY            Sets or retrieves the Y offset of the shadow.
                                  IWidget_SetShadowOffsetY
                                  IWidget_GetShadowOffsetY

PROP_SHADOWCOLOR              Sets or retrieves the color that will be used for the shadow of the
                              widget.
                                  IWidget_SetShadowColor
                                  IWidget_GetShadowColor

PROP_SELECTED_SHADOWOFFSET    As PROP_SHADOWOFFSET except that this property only affects the shadow
                              when the widget is in the selected state.  If this property has not
                              been set, the non-selected shadow will be used in the selected state.
                              This property is set only.
                                  IWidget_SetSelectedShadowOffset

PROP_SELECTED_SHADOWOFFSETX   Sets or retrieves the X offset of the shadow when the widget is in the
                              selected state.
                                  IWidget_SetSelectedShadowOffsetX
                                  IWidget_GetSelectedShadowOffsetX

PROP_SELECTED_SHADOWOFFSETY   Sets or retrieves the Y offset of the shadow when the widget is in the
                              selected state.
                                  IWidget_SetSelectedShadowOffsetY
                                  IWidget_SetSelectedShadowOffsetY

PROP_SELECTED_SHADOWCOLOR     Sets or retrieves the color that will be used for the shadow of the
                              widget when the widget is in the selected state.
                                  IWidget_SetSelectedShadowColor
  • Follow