CIP C++ documentation for class "uifcGridContainer"

Class uifcGridContainer

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

Description

Direct Known Subclasses:: uifcDialog, uifcLayout

Method Summary


`xbool`	`DoesRememberSize ()`


`xint`	`GetHeight ()`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`xstring`	`GetTitleImage ()`


`xstring`	`GetTitleText ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetRememberSize (xbool flag)`


`void`	`SetTitleImage (xrstring value)`


`void`	`SetTitleText (xrstring value)`


`void`	`SetWidth (xint value)`

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

xint GetMinimumWidth ()

Returns:: The minimum width of the Layout, in character widths.

void SetMinimumWidth (xint value)

Sets the minimum width of the Layout, in character widths.

Parameters:

value

Returns:

xint GetMinimumHeight ()

Returns:: The minimum height of the Layout, based on the height of a line of text.

void SetMinimumHeight (xint value)

Sets the minimum height of the Layout, based on the height of a line of text.

Parameters:

value

Returns:

xstring GetTitleImage ()

Returns:: The image of the Layout if the Layout is decorated.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetTitleImage (xrstring value)

Sets the image of the Layout if the Layout is decorated.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

value

Returns:

xbool DoesRememberSize ()

Returns:: Flag indicating whether the Layout should remember its size when the Dialog in which it is contained is destroyed so that when the Dialog is recreated the Layout will initially be created with the same size.

void SetRememberSize (xbool flag)

Sets flag indicating whether the Layout should remember its size when the Dialog in which it is contained is destroyed so that when the Dialog is recreated the Layout will initially be created with the same size.

Parameters:

flag

Returns:

xstring GetTitleText ()

Returns:: The label of the Layout if the Layout is decorated.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

void SetTitleText (xrstring value)

Sets the label of the Layout if the Layout is decorated.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

Parameters:

value

Returns:

xint GetHeight ()

Returns:: The height of the Layout, based on the height of a line of text.

void SetHeight (xint value)

Sets the height of the Layout, based on the height of a line of text.

Parameters:

value

Returns:

xint GetWidth ()

Returns:: The width of the Layout, in character widths.

void SetWidth (xint value)

Sets the width of the Layout, in character widths.

Parameters:

value

Returns:

xbool HasBorder ()

Returns:: Flag indicating whether the Layout has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the Layout has a decorated shadow border.

Parameters:

flag

Returns: