XPWidgetPropertyID

From X-Plane SDK
Revision as of 13:15, 15 April 2009 by Bsupnik (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

XPWidgetPropertyID

Properties are values attached to instances of your widgets. A property is identified by a 32-bit ID and its value is the width of a pointer.

Each widget instance may have a property or not have it. When you set a property on a widget for the first time, the property is added to the widget; it then stays there for the life of the widget.

Some property IDs are predefined by the widget package; you can make up your own property IDs as well.

xpProperty_Refcon0 A window's refcon is an opaque value used by client code to find other data based on it.
xpProperty_Dragging1 These properties are used by the utlities to implement dragging.
xpProperty_DragXOff2
xpProperty_DragYOff3
xpProperty_Hilited4 Is the widget hilited? (For widgets that support this kind of thing.)
xpProperty_Object5 Is there a C++ object attached to this widget?
xpProperty_Clip6 If this property is 1, the widget package will use OpenGL to restrict drawing to the Wiget's exposed rectangle.
xpProperty_Enabled7 Is this widget enabled (for those that have a disabled state too)?
xpProperty_UserStart10000

NOTE: Property IDs 1 - 999 are reserved for the widget's library.

NOTE: Property IDs 1000 - 9999 are allocated to the standard widget classes provided with the library Properties 1000 - 1099 are for widget class 0, 1100 - 1199 for widget class 1, etc.