API Documentation > Interface Classes > Class uifcDialog
Class uifcDialog

# include <uifcDialog.h>

class uifcDialog
: public virtual uifcGridContainer
{
xaideclare(uifcDialog)
...
};


Description
Methods Inherited from Class uifcComponent::
Methods Inherited from Class uifcGridContainer::
Method Summary
void
void
CreateTimer (uifcDialogTimer_ptr timer, xrstring timerName, xbool writeInTrail)
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
StartTimer (xrstring timerName, xint duration)
void
StopTimer (xrstring timerName)
Method Detail
void
MinimizePopup
()
Hide the Dialog without changing the state of ReserveSpace attribute. This should be used for a secondary window of an application when the primary window is being minimized.
Returns:
void
DeletePopupMenu
()
Delete a MenuPane from the component.
Returns:
GetFrameOrigin
()
Determine the position of the component, in pixels, relative to its parent.
Returns:
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 Dialog, in pixels.
Parameters:
value
Returns:
void
MakeForeground
()
Activate the Dialog and also make it the current foreground window, setting the keyboard input focus on to the component specified by FocusComponentName attribute. N.B. This should be used with caution as it will override any window manager settings which control z-order and keyboard input focus.
Returns:
InsertChild
(uifcComponent_ptr component, uifcGridData_ptr gridData)
Parameters:
component
gridData
Returns:
GetFrameMinimumSize
()
Determine the minimum size of the component, in pixels.
Returns:
void
ResetFrameSize
()
Reset the size of the Dialog and all of its children, forcing the size to be completely recalculated.
Returns:
void
SetFrameSize
Set the size of the Dialog, in pixels.
Parameters:
value
Returns:
GetScreenRectangle
()
Determine the size and screen position of the component, in pixels.
Returns:
GetRectangleOfMonitor
()
Determine the rectangle of the screen upon which the majority of the given component is displayed.
Returns:
GetScreenOrigin
()
Determine the screen position of the component, in pixels.
Returns:
void
MakeActive
()
Activate the Dialog, setting the keyboard input focus on to the component specified by FocusComponentName attribute. N.B. This should be used with caution as it will override any window manager settings which control z-order and keyboard input focus.
Returns:
void
MakeFront
()
Raise the Dialog to the top of the z-order.
Returns:
void
SetFrameRectangle
Set the size and screen position of the Dialog, in pixels.
Parameters:
rect
Returns:
void
RestorePopup
()
Show the Dialog without changing the state of ReserveSpace attribute. This should be used for a secondary window of an application when the primary window is being restored.
Returns:
void
DeleteChild
(xrstring name)
Delete a component from the parent.
Parameters:
name
Returns:
GetFrameSize
()
Determine the size of the component, in pixels.
Returns:
GetFrameRectangle
()
Determine the size and position of the component, in pixels.
Returns:
GetBorderBottomSize
()
Returns:
The size of the window-manager decoration at the bottom of the Dialog.
void
SetBorderBottomSize
(xint value)
Sets the size of the window-manager decoration at the bottom of the Dialog.
Parameters:
value
Returns:
DoesMakeActiveOnDisplay
()
Returns:
Specifies in which cases the Dialog should automatically take the focus.
void
SetMakeActiveOnDisplay
(xbool flag)
Sets specifies in which cases the Dialog should automatically take the focus.
Parameters:
flag
Returns:
DoesTrackMoveSize
()
Returns:
Flag indicating whether the Dialog generates a OnMove() or a OnSize() dynamically whilst the Dialog is moved or resized, or whether the actions are generated only once the movement has finished.
void
SetTrackMoveSize
(xbool flag)
Sets flag indicating whether the Dialog generates a OnMove() or a OnSize() dynamically whilst the Dialog is moved or resized, or whether the actions are generated only once the movement has finished.
Parameters:
flag
Returns:
GetFocusComponentName
()
Returns:
The name of the component which should receive the keyboard input focus when the Dialog is activated.
If the Dialog is already active then this is also the name of the component within the Dialog which currently has the keyboard input focus.
void
SetFocusComponentName
(xrstring value)
Sets the name of the component which should receive the keyboard input focus when the Dialog is activated.
If the Dialog is already active then this is also the name of the component within the Dialog which currently has the keyboard input focus.
Parameters:
value
Returns:
GetScreenTopOffset
()
Returns:
The size of the offset between the top of the Dialog and the top of the screen which contains the Dialog.
void
SetScreenTopOffset
(xint value)
Sets the size of the offset between the top of the Dialog and the top of the screen which contains the Dialog.
Parameters:
value
Returns:
GetFrameSizeWidth
()
Returns:
The width in pixels of the Dialog.
void
SetFrameSizeWidth
(xint value)
Sets the width in pixels of the Dialog.
Parameters:
value
Returns:
HasDropShadow
()
Returns:
Flag indicating whether the Dialog displays a drop-shadow around the bottom and right-hand edges of the window, if permitted to do so by the current OS window manager settings.
void
SetHasDropShadow
(xbool flag)
Sets flag indicating whether the Dialog displays a drop-shadow around the bottom and right-hand edges of the window, if permitted to do so by the current OS window manager settings.
Parameters:
flag
Returns:
GetBorderLeftSize
()
Returns:
The size of the window-manager decoration at the left-hand side of the Dialog.
void
SetBorderLeftSize
(xint value)
Sets the size of the window-manager decoration at the left-hand side of the Dialog.
Parameters:
value
Returns:
CanNavigateIntoParent
()
Returns:
Flag indicating whether the parent of the Dialog should allow keyboard focus traversal into the Dialog, and then onwards to any sibling Dialogs which also have this attribute set.
void
SetCanNavigateIntoParent
(xbool flag)
Sets flag indicating whether the parent of the Dialog should allow keyboard focus traversal into the Dialog, and then onwards to any sibling Dialogs which also have this attribute set.
Parameters:
flag
Returns:
GetFrameSizeHeight
()
Returns:
The height in pixels of the Dialog.
void
SetFrameSizeHeight
(xint value)
Sets the height in pixels of the Dialog.
Parameters:
value
Returns:
HasSizeBox
()
Returns:
Flag indicating whether the Dialog contains a resizing box at the bottom right-hand corner of the Dialog.
void
SetHasSizeBox
(xbool flag)
Sets flag indicating whether the Dialog contains a resizing box at the bottom right-hand corner of the Dialog.
Parameters:
flag
Returns:
IsTitleBarVisible
()
Returns:
Flag indicating whether the Dialog has a titlebar.
void
SetTitleBarVisible
(xbool flag)
Sets flag indicating whether the Dialog has a titlebar.
Parameters:
flag
Returns:
GetDefaultButtonName
()
Returns:
The name of the component of the Dialog which is to be treated as the default button of the Dialog.
The default button is automatically activated when the user hits RETURN or presses the middle mouse button within the Dialog.
void
SetDefaultButtonName
(xrstring value)
Sets the name of the component of the Dialog which is to be treated as the default button of the Dialog.
The default button is automatically activated when the user hits RETURN or presses the middle mouse button within the Dialog.
Parameters:
value
Returns:
DoesRememberPosition
()
Returns:
Flag indicating whether the Dialog should remember its position when it is destroyed so that when it is recreated the Dialog will initially be displayed at the same location.
void
SetRememberPosition
(xbool flag)
Sets flag indicating whether the Dialog should remember its position when it is destroyed so that when it is recreated the Dialog will initially be displayed at the same location.
Parameters:
flag
Returns:
GetAcceleratorKey
()
Returns:
The accelerator key which, when pressed, will generate a OnClose() for the Dialog.
void
SetAcceleratorKey
(uifcKey_ptr key)
Sets the accelerator key which, when pressed, will generate a OnClose() for the Dialog.
Parameters:
key
Returns:
GetInFrontOfDialogName
()
Returns:
The name of the existing Dialog above which the Dialog should always maintain its position in the z-order.
void
SetInFrontOfDialogName
(xrstring value)
Sets the name of the existing Dialog above which the Dialog should always maintain its position in the z-order.
Parameters:
value
Returns:
HasSystemMenuButton
()
Returns:
Flag indicating whether the Dialog contains a window-manager system menu button.
void
SetHasSystemMenuButton
(xbool flag)
Sets flag indicating whether the Dialog contains a window-manager system menu button.
Parameters:
flag
Returns:
HasHelpButton
()
Returns:
Flag indicating whether the Dialog contains a window-manager help button.
void
SetHasHelpButton
(xbool flag)
Sets flag indicating whether the Dialog contains a window-manager help button.
Parameters:
flag
Returns:
DoesMakeFrontOnActive
()
Returns:
Flag indicating whether the Dialog should automatically be raised when it is activated.
void
SetMakeFrontOnActive
(xbool flag)
Sets flag indicating whether the Dialog should automatically be raised when it is activated.
Parameters:
flag
Returns:
GetFrameOriginX
()
Returns:
The x co-ordinate of the position of the Dialog.
void
SetFrameOriginX
(xint value)
Sets the x co-ordinate of the position of the Dialog.
Parameters:
value
Returns:
GetTitleImage
()
Returns:
The titlebar icon of the Dialog.
This must be 16x16 pixels and 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 titlebar icon of the Dialog.
This must be 16x16 pixels and may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.
Parameters:
value
Returns:
GetAppNameTag
()
Returns:
The application-defined class name for the Dialog.
void
SetAppNameTag
(xrstring value)
Sets the application-defined class name for the Dialog.
Parameters:
value
Returns:
IsMaximized
()
Returns:
Flag indicating whether the Dialog is maximized (zoomed) (xtrue) or restored (xfalse).
void
SetMaximized
(xbool flag)
Sets flag indicating whether the Dialog is maximized (zoomed) (xtrue) or restored (xfalse).
Parameters:
flag
Returns:
GetTitleTextAlignment
()
Returns:
The justification of the title of the Dialog.
LABEL_ALIGNMENT_LEFT
Left justified
LABEL_ALIGNMENT_CENTER
Center justified
LABEL_ALIGNMENT_RIGHT
Right justified
void
SetTitleTextAlignment
Sets the justification of the title of the Dialog.
LABEL_ALIGNMENT_LEFT
Left justified
LABEL_ALIGNMENT_CENTER
Center justified
LABEL_ALIGNMENT_RIGHT
Right justified
Parameters:
value
Returns:
HasCloseButton
()
Returns:
Flag indicating whether the Dialog contains a window-manager close button. If this attribute is not set then the default value is inherited from the value of SystemMenuButton attribute
void
SetHasCloseButton
(xbool flag)
Sets flag indicating whether the Dialog contains a window-manager close button. If this attribute is not set then the default value is inherited from the value of SystemMenuButton attribute
Parameters:
flag
Returns:
CanTruncateTitleText
()
Returns:
Flag indicating whether to truncate the title of the Dialog with ellipsis if there is insufficient space to display the entire text string.
void
SetCanTruncateTitleText
(xbool flag)
Sets flag indicating whether to truncate the title of the Dialog with ellipsis if there is insufficient space to display the entire text string.
Parameters:
flag
Returns:
GetPaletteName
()
Returns:
The name of the command palette associated with the component.
void
SetPaletteName
(xrstring value)
Sets the name of the command palette associated with the component.
Parameters:
value
Returns:
GetOwnerName
()
Returns:
The name of the Dialog which is to be treated as the owner of the Dialog.
void
SetOwnerName
(xrstring value)
Sets the name of the Dialog which is to be treated as the owner of the Dialog.
Parameters:
value
Returns:
DoesForceOnScreen
()
Returns:
Flag indicating whether the Dialog should automatically be repositioned so that its entire contents are within the bounds of the screen in which the Dialog is contained.
void
SetForceOnScreen
(xbool flag)
Sets flag indicating whether the Dialog should automatically be repositioned so that its entire contents are within the bounds of the screen in which the Dialog is contained.
Parameters:
flag
Returns:
CanMakeFrontInBackground
()
Returns:
Flag indicating whether the Dialog should respond to a MakeFront operation when it is not currently the active foreground process.
void
SetCanMakeFrontInBackground
(xbool flag)
Sets flag indicating whether the Dialog should respond to a MakeFront operation when it is not currently the active foreground process.
Parameters:
flag
Returns:
GetBorderRightSize
()
Returns:
The size of the window-manager decoration at the right-hand side of the Dialog.
void
SetBorderRightSize
(xint value)
Sets the size of the window-manager decoration at the right-hand side of the Dialog.
Parameters:
value
Returns:
IsMinimized
()
Returns:
Flag indicating whether the Dialog is minimized (iconified) (xtrue) or restored (xfalse).
void
SetMinimized
(xbool flag)
Sets flag indicating whether the Dialog is minimized (iconified) (xtrue) or restored (xfalse).
Parameters:
flag
Returns:
IsResizable
()
Returns:
Flag indicating whether the Dialog contains window manager resizing handles on its decorated border, and hence whether it may be resized by the user.
void
SetResizable
(xbool flag)
Sets flag indicating whether the Dialog contains window manager resizing handles on its decorated border, and hence whether it may be resized by the user.
Parameters:
flag
Returns:
HasMaximizeButton
()
Returns:
Flag indicating whether the Dialog contains a window-manager maximize button, and hence whether it may be maximized by the user.
void
SetHasMaximizeButton
(xbool flag)
Sets flag indicating whether the Dialog contains a window-manager maximize button, and hence whether it may be maximized by the user.
Parameters:
flag
Returns:
GetScreenLeftOffset
()
Returns:
The size of the offset between the left-hand side of the Dialog and the left-hand side of the screen which contains the Dialog.
void
SetScreenLeftOffset
(xint value)
Sets the size of the offset between the left-hand side of the Dialog and the left-hand side of the screen which contains the Dialog.
Parameters:
value
Returns:
GetModality
()
Returns:
The modal style of the Dialog.
DIALOG_STYLE_PARENT_AND_MENU_MODAL
Pro/E use only
Modal with respect to Menu Manager menus and other Dialogs.
DIALOG_STYLE_PARENT_MODAL
Use anywhere
Modal with respect to its parent Dialog
DIALOG_STYLE_APPLICATION_MODAL
Use anywhere
Modal with respect to the entire application
DIALOG_STYLE_WORKING
Use anywhere
A transient Dialog used only to display some state information, usually refering to the progress of some kind of lengthy operation.
DIALOG_STYLE_MODELESS
Use anywhere
Modeless
DIALOG_STYLE_MENU_MODELESS
Pro/E use only
Modeless with respect to Menu Manager menus and other Dialogs.
DIALOG_STYLE_MESSAGE_MODELESS
Pro/E use only
Modeless with respect to the Message Input Window, Menu Manager menus and other Dialogs.
void
SetModality
(uifcDialogStyle value)
Sets the modal style of the Dialog.
DIALOG_STYLE_PARENT_AND_MENU_MODAL
Pro/E use only
Modal with respect to Menu Manager menus and other Dialogs.
DIALOG_STYLE_PARENT_MODAL
Use anywhere
Modal with respect to its parent Dialog
DIALOG_STYLE_APPLICATION_MODAL
Use anywhere
Modal with respect to the entire application
DIALOG_STYLE_WORKING
Use anywhere
A transient Dialog used only to display some state information, usually refering to the progress of some kind of lengthy operation.
DIALOG_STYLE_MODELESS
Use anywhere
Modeless
DIALOG_STYLE_MENU_MODELESS
Pro/E use only
Modeless with respect to Menu Manager menus and other Dialogs.
DIALOG_STYLE_MESSAGE_MODELESS
Pro/E use only
Modeless with respect to the Message Input Window, Menu Manager menus and other Dialogs.
Parameters:
value
Returns:
GetFrameOriginY
()
Returns:
The y co-ordinate of the position of the Dialog.
void
SetFrameOriginY
(xint value)
Sets the y co-ordinate of the position of the Dialog.
Parameters:
value
Returns:
DoesSizeToFit
()
Returns:
Flag indicating whether the Dialog should size itself to fit within the given space.
void
SetSizeToFit
(xbool flag)
Sets flag indicating whether the Dialog should size itself to fit within the given space.
Parameters:
flag
Returns:
GetBorderTopSize
()
Returns:
The size of the window-manager decoration at the top of the Dialog.
void
SetBorderTopSize
(xint value)
Sets the size of the window-manager decoration at the top of the Dialog.
Parameters:
value
Returns:
HasMinimizeButton
()
Returns:
Flag indicating whether the Dialog contains a window-manager minimize button, and hence whether it may be minimized by the user.
void
SetHasMinimizeButton
(xbool flag)
Sets flag indicating whether the Dialog contains a window-manager minimize button, and hence whether it may be minimized by the user.
Parameters:
flag
Returns:
GetAnchorLocation
()
Returns:
The corner or edge of the Dialog which should attempt to retain its position on the screen when the size of the Dialog is changed as a result of the contents having been changed in some way.
This may be one of the following values:
ANCHOR_POSITION_TOP_LEFT
Top Left Corner
ANCHOR_POSITION_TOP_RIGHT
Top Right Corner
ANCHOR_POSITION_BOTTOM_LEFT
Bottom Left Corner
ANCHOR_POSITION_BOTTOM_RIGHT
Bottom Right Corner
ANCHOR_POSITION_TOP
Top Edge
ANCHOR_POSITION_BOTTOM
Bottom Edge
ANCHOR_POSITION_LEFT
Left Edge
ANCHOR_POSITION_RIGHT
Right Edge
ANCHOR_POSITION_CENTER
Center of the Dialog
void
SetAnchorLocation
Sets the corner or edge of the Dialog which should attempt to retain its position on the screen when the size of the Dialog is changed as a result of the contents having been changed in some way.
This may be one of the following values:
ANCHOR_POSITION_TOP_LEFT
Top Left Corner
ANCHOR_POSITION_TOP_RIGHT
Top Right Corner
ANCHOR_POSITION_BOTTOM_LEFT
Bottom Left Corner
ANCHOR_POSITION_BOTTOM_RIGHT
Bottom Right Corner
ANCHOR_POSITION_TOP
Top Edge
ANCHOR_POSITION_BOTTOM
Bottom Edge
ANCHOR_POSITION_LEFT
Left Edge
ANCHOR_POSITION_RIGHT
Right Edge
ANCHOR_POSITION_CENTER
Center of the Dialog
Parameters:
value
Returns:
GetStartLocation
()
Returns:
The default start location of the Dialog on the screen.
This may either be one of the following values, or a user-defined start-location.
START_LOCATION_DEFAULT
The default location which will depend upon the parent of the Dialog.
START_LOCATION_TOP_LEFT
Top left of the screen of the parent
START_LOCATION_TOP
Top of the screen of the parent
START_LOCATION_TOP_RIGHT
Top right of the screen of the parent
START_LOCATION_LEFT
Left of the screen of the parent
START_LOCATION_CENTER
Center of the screen of the parent
START_LOCATION_RIGHT
Right of the screen of the parent
START_LOCATION_BOTTOM_LEFT
Bottom left of the screen of the parent
START_LOCATION_BOTTOM
Bottom of the screen of the parent
START_LOCATION_BOTTOM_RIGHT
Bottom right of the screen of the parent
START_LOCATION_CURSOR_TOP_LEFT
Top left corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_TOP
Titlebar of the Dialog centered at the position of the cursor
START_LOCATION_CURSOR_TOP_RIGHT
Top right corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_LEFT
Left side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_CENTER
Center of the Dialog at the position of the cursor
START_LOCATION_CURSOR_RIGHT
Right side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM_LEFT
Bottom left corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM
Bottom side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM_RIGHT
Bottom right corner of the Dialog at the position of the cursor
void
SetStartLocation
Sets the default start location of the Dialog on the screen.
This may either be one of the following values, or a user-defined start-location.
START_LOCATION_DEFAULT
The default location which will depend upon the parent of the Dialog.
START_LOCATION_TOP_LEFT
Top left of the screen of the parent
START_LOCATION_TOP
Top of the screen of the parent
START_LOCATION_TOP_RIGHT
Top right of the screen of the parent
START_LOCATION_LEFT
Left of the screen of the parent
START_LOCATION_CENTER
Center of the screen of the parent
START_LOCATION_RIGHT
Right of the screen of the parent
START_LOCATION_BOTTOM_LEFT
Bottom left of the screen of the parent
START_LOCATION_BOTTOM
Bottom of the screen of the parent
START_LOCATION_BOTTOM_RIGHT
Bottom right of the screen of the parent
START_LOCATION_CURSOR_TOP_LEFT
Top left corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_TOP
Titlebar of the Dialog centered at the position of the cursor
START_LOCATION_CURSOR_TOP_RIGHT
Top right corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_LEFT
Left side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_CENTER
Center of the Dialog at the position of the cursor
START_LOCATION_CURSOR_RIGHT
Right side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM_LEFT
Bottom left corner of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM
Bottom side of the Dialog at the position of the cursor
START_LOCATION_CURSOR_BOTTOM_RIGHT
Bottom right corner of the Dialog at the position of the cursor
Parameters:
value
Returns:
GetScreenRightOffset
()
Returns:
The size of the offset between the right-hand side of the Dialog and the right-hand side of the screen which contains the Dialog.
void
SetScreenRightOffset
(xint value)
Sets the size of the offset between the right-hand side of the Dialog and the right-hand side of the screen which contains the Dialog.
Parameters:
value
Returns:
GetAcceleratorText
()
Returns:
The translated text representation of the current value of AcceleratorKey attribute.
GetScreenBottomOffset
()
Returns:
The size of the offset between the bottom of the Dialog and the bottom of the screen which contains the Dialog.
void
SetScreenBottomOffset
(xint value)
Sets the size of the offset between the bottom of the Dialog and the bottom of the screen which contains the Dialog.
Parameters:
value
Returns:
void
AddActionListener
Parameters:
listener
Returns:
void
PushAction
(uifcDialogAction action)
Parameters:
action
Returns:
void
CreateTimer
(uifcDialogTimer_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?