CIP C++ documentation for class "uifcSeparator"

Class uifcSeparator

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

Description

Method Summary


`void`	`AddActionListener (uifcSeparatorListener_ptr listener)`


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


`void`	`DeletePopupMenu ()`


`xbool`	`DoesUseOffsets ()`


`uifcFontClass`	`GetFontClass ()`


`xstring`	`GetFontName ()`


`xreal`	`GetFontSize ()`


`uifcFontStyle`	`GetFontStyle ()`


`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)`


`void`	`PushAction (uifcSeparatorAction action)`


`void`	`SetFontClass (uifcFontClass value)`


`void`	`SetFontName (xrstring value)`


`void`	`SetFontSize (xreal value)`


`void`	`SetFontStyle (uifcFontStyle value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetLength (xint value)`


`void`	`SetOrientation (uifcOrientation value)`


`void`	`SetUseOffsets (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

Method Detail

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

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:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size 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:

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:

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

ORIENTATION_HORIZONTAL	Horizontal
ORIENTATION_VERTICAL	Vertical

void SetOrientation (uifcOrientation value)

Sets the orientation of the Separator.

ORIENTATION_HORIZONTAL	Horizontal
ORIENTATION_VERTICAL	Vertical

Parameters:

value

Returns:

xstring GetFontName ()

Returns:: The name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

void SetFontName (xrstring value)

Sets the name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

Parameters:

value

Returns:

uifcFontClass GetFontClass ()

Returns:

The base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

void SetFontClass (uifcFontClass value)

Sets the base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

Parameters:

value

Returns:

xbool DoesUseOffsets ()

Returns:: Flag indicating whether the Separator should take into account the any offset attributes that associated with it.

void SetUseOffsets (xbool flag)

Sets flag indicating whether the Separator should take into account the any offset attributes that associated with it.

Parameters:

flag

Returns:

xint GetLength ()

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

void SetLength (xint value)

Sets the length of the Separator, in character widths.

Parameters:

value

Returns:

xreal GetFontSize ()

Returns:: The point-size of the font used to draw text in the component.

void SetFontSize (xreal value)

Sets the point-size of the font used to draw text in the component.

Parameters:

value

Returns:

uifcFontStyle GetFontStyle ()

Returns:

A bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

void SetFontStyle (uifcFontStyle value)

Sets a bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

Parameters:

value

Returns:

void AddActionListener (uifcSeparatorListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcSeparatorAction action)

Parameters:

action

Returns:

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