Class uifcSlider

API Documentation > Interface Classes > Class uifcSlider

Class uifcSlider

# include <uifcSlider.h>

class uifcSlider
: public virtual uifcRange_Controls
{
xaideclare(uifcSlider)
...
};

Description

User Guide References:

User Interface Foundation Classes for Dialogs:uifcSlider

Methods Inherited from Class uifcComponent::

GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Methods Inherited from Class uifcRange_Controls::

GetMaximumIntegerValue, SetMaximumIntegerValue, GetIntegerValue, SetIntegerValue, GetMinimumIntegerValue, SetMinimumIntegerValue, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

Method Summary

void	AddActionListener (uifcSliderListener_ptr listener)



void	ChangeIntegerValue (xint change)



void	CreateTimer (uifcSliderTimer_ptr timer, xrstring timerName, xbool writeInTrail)



void	DeletePopupMenu ()



xbool	DoesDynamicUpdate ()



xint	GetBarIntervals ()



uifcDimension_ptr	GetFrameMinimumSize ()



uifcPoint_ptr	GetFrameOrigin ()



uifcRectangle_ptr	GetFrameRectangle ()



uifcDimension_ptr	GetFrameSize ()



xint	GetLength ()



xint	GetLineIntervals ()



uifcOrientation	GetOrientation ()



uifcRectangle_ptr	GetRectangleOfMonitor ()



uifcPoint_ptr	GetScreenOrigin ()



uifcRectangle_ptr	GetScreenRectangle ()



uifcSliderAlignment	GetSliderDirection ()



xint	InsertPopupMenu (uifcComponent_ptr component)



xbool	IsEnabled ()



void	PushAction (uifcSliderAction action)



void	SetBarIntervals (xint value)



void	SetDynamicUpdate (xbool flag)



void	SetEnabled (xbool flag)



void	SetFrameOrigin (uifcPoint_ptr value)



void	SetFrameRectangle (uifcRectangle_ptr rect)



void	SetFrameSize (uifcDimension_ptr value)



void	SetLength (xint value)



void	SetLineIntervals (xint value)



void	SetOrientation (uifcOrientation value)



void	SetSliderDirection (uifcSliderAlignment value)



void	StartTimer (xrstring timerName, xint duration)



void	StopTimer (xrstring timerName)

Method Detail

void

SetFrameRectangle

(uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

void

DeletePopupMenu

()

Delete a MenuPane from the component.

Returns:

uifcPoint_ptr

GetFrameOrigin

()

Determine the position of the component, in pixels, relative to its parent.

Returns:

xint

InsertPopupMenu

(uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

void

SetFrameOrigin

(uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

void

ChangeIntegerValue

(xint change)

Increment the IntegerValue attribute of the component by the given amount.

Parameters:

change

Returns:

uifcDimension_ptr

GetFrameMinimumSize

()

Determine the minimum size of the component, in pixels.

Returns:

uifcPoint_ptr

GetScreenOrigin

()

Determine the screen position of the component, in pixels.

Returns:

void

SetFrameSize

(uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcRectangle_ptr

GetScreenRectangle

()

Determine the size and screen position of the component, in pixels.

Returns:

uifcRectangle_ptr

GetRectangleOfMonitor

()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

uifcDimension_ptr

GetFrameSize

()

Determine the size of the component, in pixels.

Returns:

uifcRectangle_ptr

GetFrameRectangle

()

Determine the size and position of the component, in pixels.

Returns:

xbool

DoesDynamicUpdate

()

Returns:

Flag indicating whether the Slider generates a OnChange() each time the value changes whilst the value is updating (xtrue) or whether only one OnChange() is generated when the updating is complete (xfalse).

void

SetDynamicUpdate

(xbool flag)

Sets flag indicating whether the Slider generates a OnChange() each time the value changes whilst the value is updating (xtrue) or whether only one OnChange() is generated when the updating is complete (xfalse).

Parameters:

flag

Returns:

uifcOrientation

GetOrientation

()

Returns:

The orientation of the Slider.

ORIENTATION_HORIZONTAL	Horizontal, with the minimum value at the left
ORIENTATION_VERTICAL	Vertical, with the minimum value at the bottom

void

SetOrientation

(uifcOrientation value)

Sets the orientation of the Slider.

ORIENTATION_HORIZONTAL	Horizontal, with the minimum value at the left
ORIENTATION_VERTICAL	Vertical, with the minimum value at the bottom

Parameters:

value

Returns:

uifcSliderAlignment

GetSliderDirection

()

Returns:

The direction in which the button of the Slider will point.

NO_SLIDER_ALIGNMENT	The Slider button will not be pointed
SLIDER_ALIGNMENT_LEFT	To the left, for a vertical Slider
SLIDER_ALIGNMENT_RIGHT	To the right, for a vertical Slider
SLIDER_ALIGNMENT_TOP	Upwards, for a horizontal Slider
SLIDER_ALIGNMENT_BOTTOM	Downwards, for a horizontal Slider

void

SetSliderDirection

(uifcSliderAlignment value)

Sets the direction in which the button of the Slider will point.

NO_SLIDER_ALIGNMENT	The Slider button will not be pointed
SLIDER_ALIGNMENT_LEFT	To the left, for a vertical Slider
SLIDER_ALIGNMENT_RIGHT	To the right, for a vertical Slider
SLIDER_ALIGNMENT_TOP	Upwards, for a horizontal Slider
SLIDER_ALIGNMENT_BOTTOM	Downwards, for a horizontal Slider

Parameters:

value

Returns:

xint

GetLineIntervals

()

Returns:

The number of intervals of the Slider which constitute a line of sliding.

void

SetLineIntervals

(xint value)

Sets the number of intervals of the Slider which constitute a line of sliding.

Parameters:

value

Returns:

xint

GetLength

()

Returns:

The length of the Slider, in character widths.

void

SetLength

(xint value)

Sets the length of the Slider, in character widths.

Parameters:

value

Returns:

xint

GetBarIntervals

()

Returns:

The number of intervals of the range between the maximum and minimum values of the Slider.

void

SetBarIntervals

(xint value)

Sets the number of intervals of the range between the maximum and minimum values of the Slider.

Parameters:

value

Returns:

xbool

IsEnabled

()

Returns:

Flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

void

SetEnabled

(xbool flag)

Sets flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

Parameters:

flag

Returns:

void

AddActionListener

(uifcSliderListener_ptr listener)

Parameters:

listener

Returns:

void

PushAction

(uifcSliderAction action)

Parameters:

action

Returns:

void

CreateTimer

(uifcSliderTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer

timerName

writeInTrail

Returns:

void

StartTimer

(xrstring timerName, xint duration)

Parameters:

timerName

duration

Returns:

void

StopTimer

(xrstring timerName)

Parameters:

timerName

Returns:

Was this helpful?