CBCGPSwitchImpl

Detailed Description

The CBCGPSwitchImpl class implements functionality of the switch control. The switch is an interactive gauge which implements "On/Off" functionality (similar to Win32 check box control). The Switch control has the following features:

• Horizontal or vertical orientations.
• Various shapes such as rectangular or circular.
• Text label for each control state.
• Custom images.

Inheritance diagram for CBCGPSwitchImpl:

Public Types
enum	BCGP_SWITCH_STYLE
Public Types inherited from CBCGPGaugeImpl
enum	BCGP_SUB_GAUGE_POS
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType

Public Member Functions
	CBCGPSwitchImpl	Constructor.
	EnableOnOffLabels	Specifies whether text labels are enabled
	GetAnimationTime	Returns a thumb transition effect time (in milliseconds).
	GetColors	Gets the switch colors.
	GetLabel	Gets a text label of specified state.
	GetLabelTextFormat	Gets text label format.
	GetStyle	Gets the switch style.
	IsDrawTextLabels	Tells whether the text labels are enabled.
	IsFocusRect	Tells whether the switch has a focus rectangle.
	IsOn	Tells whether the switch has an "On" (checked) state.
	IsVisualManagerTheme	Tells whether gauge was created with a visual manager theme.
	SetAnimationTime	Specifies a thumb transition effect time (in milliseconds).
	SetColors	Sets the switch colors.
	SetFocusRect	Specifies whether the focus rectangle should be drawn.
	SetLabel	Sets a custom text label for specific switch state.
	SetLabelTextFormat	Sets text label format.
	SetOn	Modifies the switch's state.
	SetStyle	Sets a style.
	SetVisualManagerTheme	Sets the visual manager theme.
Public Member Functions inherited from CBCGPStaticGaugeImpl
	CBCGPStaticGaugeImpl	Constructor.
	StartFlashing	Begins flash animation.
	StopFlashing	Stops animation.
Public Member Functions inherited from CBCGPGaugeImpl
	AddColoredRange	Adds a new colored range to a gauge.
	AddColoredRange	Adds a new colored range to a gauge.
	AddLevelBar	Adds a new level bar to a gauge.
	AddLevelBar	Adds a new level bar to a gauge.
	GetColoredRange	Returns a colored range for a scale.
	GetCornerRadius	Returns a gauge corner radius (in pixels).
	GetDefaultInteractivePointer	Retrieves an index of pointer used in the interactive mode by default.
	GetDefaultInteractiveScale	Retrieves an index of scale used in the interactive mode by default.
	GetFrameSize	Gets a gauge frame size (in pixels)
	GetLevelBar	Returns a level bar for a scale.
	GetLevelBarsCount	Gets level bars count.
	GetScale	Returns a scale for a gauge.
	GetTextFormat	Returns current text format of gauge labels.
	GetVisualEffects	Retrieves the gauge visual effects.
	IsInteractiveMode	Tells whether an interactive mode is active or not.
	RemoveAllColoredRanges	Removes all colored ranges.
	RemoveAllLevelBars	Removes all level bars.
	RemoveAllScales	Removes scales.
	RemoveLevelBar	Removes the level bar.
	RemoveScale	Removes a scale.
	SetCornerRadius	Specifies a gauge corner radius
	SetDefaultInteractivePointer	Specifies a pointer that will be used in the interactive mode by default.
	SetDefaultInteractiveScale	Specifies a scale that will be used in the interactive mode by default.
	SetFrameSize	Sets a gauge frame size (in pixels).
	SetInteractiveMode	Enabler or disables a gauge interactive mode.
	SetScaleOffsetFromFrame	Sets the scale offset from the gauge frame.
	SetTextFormat	Sets text format for gauge labels.
	SetTickMarkStyle	Specifies the gauge tick mark style.
	SetValue	Sets value for the specified scale.
	SetVisualEffects	Specifies the gauge visual effects.
Public Member Functions inherited from CBCGPBaseVisualObject
	CBCGPBaseVisualObject	Constructor.
	CBCGPBaseVisualObject	Copy constructor.
	CopyToClipboard	Copies visual object to the Clipboard.
	EnableImageCache	Enables or disables visual object image cache.
	ExportToBitmap	Exports the visual object to bitmap.
	ExportToFile	Exports the visual object to a file (BMP or PNG).
	ExportToImage	Exports the visual object to an image.
	GetData	Gets an internal data object.
	GetDataAnimationType	Gets data animation type.
	GetDataCount	Returns a number of data objects.
	GetEditFlags	Gets editing flags.
	GetFillBrush	Retrieves a visual object's background brush
	GetID	Gets the object identifier.
	GetName	Gets the object name.
	GetParentContainer	Gets the parent visual container.
	GetRect	Gets the object bounding rectangle.
	GetSelectedTheme	Obtain a currently selected visual theme.
	GetUserData	Gets user-defined data associated with this object.
	GetValue	Gets the object value.
	GetVisualEffect	Retrieves a visual effect
	IsAutoDestroy	Tells whether this object will be destroyed automatically.
	IsEditMode	Tells whether this object has the edit mode.
	IsEnabled	Tells whether the visual object is enabled.
	IsImageCache	Tells whether image cache is enabled for this object.
	IsSelected	Tells whether this object is selected in the parent container.
	IsVisible	Tells whether the visual object is visible.
	Redraw	Redraws this object.
	RedrawRect	Redraws a specified rectangle.
	SetAutoDestroy	Specifies whether the object should be destroyed automatically.
	SetDataAnimationType	Sets data animation type.
	SetDirty	Invalidates and redraws a visual object.
	SetEditFlags	Sets editing flags.
	SetFillBrush	Sets a new fill brush.
	SetID	Sets the object identifier.
	SetName	Sets an object name.
	SetRect	Sets a new bounding rectangle.
	SetSelected	Selects or unselects the object in the parent container.
	SetUserData	Sets user-defined data associated with this object.
	SetVisible	Shows or hides the visual object.
	SetVisualEffect	Sets a visual effect.
Public Member Functions inherited from CBCGPAnimationManager
	CBCGPAnimationManager	Default constructor.
	GetAnimatedValue	Gets current animated value.
	GetAnimationDuration	Gets animation duration.
	GetLastAnimationError	Gets the animation error returned by recent call to Windows Animation API.
	IsAnimated	Checks if animation is running.
	StartAnimation	Starts an animation.
	StartFlashAnimation	Starts "flash" animation.
	StopAnimation	Stops an animation.

Additional Inherited Members
Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.