Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::DrawStates Class Reference

A set of values for different states. More...

#include <vcf/GraphicsKit/DrawUIState.h>

List of all members.

Public Types

enum  {
  dsNone = 0x00000000, dsActive = 0x00000001, dsEnabled = 0x00000002, dsFocused = 0x00000004,
  dsHighlighted = 0x00000008, dsVertical = 0x00000010, dsSelected = 0x00000020, dsPressed = 0x00000040,
  dsTickMarksOnTopLeft = 0x00000080, dsTickMarksOnBottomRight = 0x00000100, dsTabOnTop = 0x00000200, dsTabOnBottom = 0x00000400,
  dsTabOnLeft = 0x00000800, dsTabOnRight = 0x00001000, dsTabInFront = 0x00002000, dsScrollBarIncrArrowPressed = 0x00004000,
  dsScrollBarDecrArrowPressed = 0x00008000, dsScrollBarThumbPressed = 0x00010000, dsDisclosureClosed = 0x00020000, dsDisclosurePartialOpened = 0x00040000,
  dsDisclosureOpened = 0x00080000, dsToggledYes = 0x00100000, dsToggledNo = 0x00200000, dsToggledPartial = 0x00400000,
  dsMenuItemSeparator = 0x00800000, dsDefaultButton = 0x01000000, dsUseCustomProgressColor = 0x02000000, dsUseCustomProgressTextColor = 0x04000000,
  dsMutualExclusiveToggle = 0x08000000, dsItemHasChildren = 0x10000000, dsItemHasImage = 0x20000000
}


Detailed Description

A set of values for different states.

These are masked together to form a single value that represents the actual state of a UI element such as a button.


Member Enumeration Documentation

anonymous enum
 

Enumerator:
dsNone  No state is indicated.
dsActive  The element is "active" - the precise specifics of this may be windowing-platform specific.
dsEnabled  The element is "enabled" and can receive user input.
dsFocused  The element has the keyboard focus and is eligible for keyboard input.

In general, on most windowing platforms only one UI element can have the keyboard focus at any moment.

dsHighlighted  The element is highlighted.
dsVertical  The element is verticallly aligned.

The exact meaning depends on the UI element in question

dsSelected  The element is selected.
dsPressed  The element is "pressed" - this typically only means something with UI elements that are buttons.
dsTickMarksOnTopLeft  The element is a slider and has tick marks either on the top (if it's a horizontal slider) or the left (if it's a vertical slider).
dsTickMarksOnBottomRight  The element is a slider and has tick marks either on the bottom (if it's a horizontal slider) or the right (if it's a vertical slider).
dsTabOnTop  The tab items (or pages) should be on the top of the tab control.
dsTabOnBottom  The tab items (or pages) should be on the bottom of the tab control.
dsTabOnLeft  The tab items (or pages) should be on the left of the tab control.
dsTabOnRight  The tab items (or pages) should be on the right of the tab control.
dsTabInFront  The tab element is in front of all other tabs.
dsScrollBarIncrArrowPressed  the scroll bar increment button has been pressed
dsScrollBarDecrArrowPressed  the scroll bar decrement button has been pressed
dsScrollBarThumbPressed  the scroll bar "thumb" button has been pressed
dsDisclosureClosed  The disclose element is "closed".

On OS X this is usually represented by a triangle that points horizontally to the right. On Win32 this is usually a "+" sign.

dsDisclosurePartialOpened 
dsDisclosureOpened  The disclose element is "open".

On OS X this is usually represented by a triangle that points down. On Win32 this is usually a "-" sign.

dsToggledYes  The element is "toggled" in the affirmative.

In a check box this would typically cause the "check" mark to be visible.

dsToggledNo  The element is "toggled" in the negative.

In a check box this would typically cause the "check" mark to be cleared.

dsToggledPartial  The element is "toggled" in a "partial" state - akin to windows tri-state checkbox.

In a check box this would typically cause the "check" mark to be drawn partially grey with a shaded background.

dsMenuItemSeparator  The ui element is a menu item separator.
dsDefaultButton  The element is a the default button.

Usually, on most windowing platforms, the default button is the button that will be "clicked" if the user hits the enter or return key.

dsUseCustomProgressColor  Indicates that the custom color should be used if the underlying windowing theme API supports this.
dsUseCustomProgressTextColor 
dsMutualExclusiveToggle  This indicates that the UI will be a radio button like look.

In other words only one choice will show up. Its typicalle used in menu items.

dsItemHasChildren 
dsItemHasImage 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information