CIP C++ documentation for class "uifcProgressBar"

Class uifcProgressBar

# include <uifcProgressBar.h> class uifcProgressBar : public virtual uifcRange_Controls { xaideclare(uifcProgressBar) ... };

Description

Method Summary


`void`	`AddActionListener (uifcProgressBarListener_ptr listener)`


`void`	`ChangeIntegerValue (xint change)`


`void`	`CreateTimer (uifcProgressBarTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeletePopupMenu ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetLength ()`


`uifcOrientation`	`GetOrientation ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsUnbounded ()`


`void`	`PushAction (uifcProgressBarAction action)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetLength (xint value)`


`void`	`SetOrientation (uifcOrientation value)`


`void`	`SetUnbounded (xbool flag)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`

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 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:

uifcOrientation GetOrientation ()

Returns:

The orientation of the ProgressBar.

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 ProgressBar.

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

Parameters:

value

Returns:

xbool IsUnbounded ()

Returns:: Flag indicating whether the ProgressBar value is restricted to its maximum and minimum values (xfalse) or whether it has no limit upon its value (xtrue).
When using this setting, the bar of the ProgressBar is displayed as a scrolling marquee to indicate an indeterminate range.

void SetUnbounded (xbool flag)

Sets flag indicating whether the ProgressBar value is restricted to its maximum and minimum values (xfalse) or whether it has no limit upon its value (xtrue).
When using this setting, the bar of the ProgressBar is displayed as a scrolling marquee to indicate an indeterminate range.

Parameters:

flag

Returns:

xint GetLength ()

Returns:: The length of the ProgressBar, in character widths.

void SetLength (xint value)

Sets the length of the ProgressBar, in character widths.

Parameters:

value

Returns:

void AddActionListener (uifcProgressBarListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcProgressBarAction action)

Parameters:

action

Returns:

void CreateTimer (uifcProgressBarTimer_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: