xBase and Clipper language compatible compiler
PrevNext

Class UIWINDOW

Name

UIWINDOW  --  Class of separate window.

Synopsis

 UIWindow([<caption>],<parent>,[<name>],[<close>],[<resizeable>])	--> UIWindow object

Description

Class UIWindow.

Attributes

<className> - Class name. Value should be "UIWindow".
<name> - Window name defined in constructor.
<userSpace> - Layout for widget placement. UIVBox object.

Methods

CHILDCLOSE Close current child window.
CHILDCLOSEALL Close all child windows.
CLOSE Close window.
DIALOGBOX Show dialog window with message.
GETGEOMETRY Get size and position of window.
GETOBJ Get object with filled fields from window widgets contents.
GETVALUES Get array of values from window widgets.
ISCHANGED Return true if any field in window was changed.
RETURN Send value to window which initiated creation of this window.
SELECT Send value for UIChoice to window which initiated creation of this window.
SETCAPTION Set new window caption.
SETDEFAULT Set button as default in window.
SETFOCUS Set focus to specified widget.
SETGEOMETRY Change size and/or position of window.
SETICON Set icon for the window.
SETID Set object identifier changed in this window.
SETKEYEVENT Set action to shortcut in the window.
SETMDI Create area for child window placement. This method must be call after placement of menu. toolbar(s), statusbar and/or other fixed element(s) into window.
SETNAME Set name for widget.
SETOBJ Fill widgets by object fields.
SETPADDING Set window border width.
SETPANELS Attach to window menubar, toolbar and/or statusbar.
SETPLACEMENT Set window at center of the screen.
SETSPACING Set space between widgets in window.
SETVALUES Fill widget values from array.
SHOW Show window.
UNSETKEYEVENT Unset action from shortcut in the window.
VAL Get widget value by its name.

Method UIWINDOW:CHILDCLOSE()

 childClose()

Returns :NIL

Method UIWINDOW:CHILDCLOSEALL()

 childCloseAll()

Returns :NIL

Method UIWINDOW:CLOSE()

 close()

Returns :NIL

Method UIWINDOW:DIALOGBOX()

 dialogBox(<caption>,<text>,[<buttons>],[<buttonNames>],[<action>])

<caption>

- String. Caption of dialog.

<text>

- String. Text of message.

<buttons>

- String. In the string defined array of buttons in message window. For example, "'&Save','&Cancel'". If parameter isn't defined, only one button 'OK' will be shown.

<buttonNames>

- String. In the string defined array of name for button. For example, "'SAVE','CANCEL'".

<action>

- Code block. Code block which is executed on any defined button on dialog window. As parameters of this call name of pressed button is used.

Returns :NIL

Method UIWINDOW:GETGEOMETRY()

 getGeometry()	--> <aRect>

Returns :

Array of elements: width, height, x, y in pixels respectively.

Method UIWINDOW:GETOBJ()

 getObj()	--> <object>

Returns :

Array of widget values.

Method UIWINDOW:GETVALUES()

 getValues()	--> <array>

Returns :

Array of values from window widgets. Each element is array consisted from two elements: string with widget name and string with its value.

Method UIWINDOW:ISCHANGED()

 isChanged()	--> <bChanged>

Returns :

Boolean value. If value is true, one or more window fields was/were changed. False is mean that all fields are unchanged.

Method UIWINDOW:RETURN()

 return(<val>)

<val>

- Any type. Value transmitted via return function.

Returns :NIL

Method UIWINDOW:SELECT()

 select(<table>,<column>)

<table>

- String. Name of UITable widget in current window.

<column>

- Number. Column number from UITable.

Returns :NIL

Method UIWINDOW:SETCAPTION()

 setCaption(<caption>)

<caption>

- String. Text of window title.

Returns :NIL

Method UIWINDOW:SETDEFAULT()

 setDefault()

<obj>

- Widget. Default button.

Returns :NIL

Method UIWINDOW:SETFOCUS()

 setFocus(<obj>)

<obj>

- Widget. Focused widget.

Returns :NIL

Method UIWINDOW:SETGEOMETRY()

 setGeometry(<geom>)

<geom>

- Array of number or number. Size and position as array of elements: width, height, x, y in pixels respectively. If parameter type is number it is mean widget width in pixels.

Returns :NIL

Method UIWINDOW:SETICON()

 setIcon(<pic>)

<pic>

- Object UIImage. Icon object.

Returns :NIL

Method UIWINDOW:SETID()

 setId(<id>)

<id>

- String. Object identifier changed in window.

Returns :NIL

Method UIWINDOW:SETKEYEVENT()

 setKeyEvent(<cKey>,<action>)

<cKey>

- String. Shortcut definition. For example, "F5" or "Alt+M".

<action>

- Code block. Action.

Returns :NIL

Method UIWINDOW:SETMDI()

 setMDI()

Returns :NIL

Method UIWINDOW:SETNAME()

 setName(<name>,<o>) --> <o>

<name>

- String. Field name.

<o>

- Object. Widget object.

Returns :

Named widget object.

Method UIWINDOW:SETOBJ()

 setObj(<obj>)

<obj>

- Object. Object contained fields with data.

Returns :NIL

Method UIWINDOW:SETPADDING()

 setPadding(<space>)

<space>

- Number. Width of window border in pixels.

Returns :NIL

Method UIWINDOW:SETPANELS()

 setPanels([<menu>],[<toolBar>],[<statusBar>])

<menu>

- Object UIMenu. Menubar.

<toolBar>

- Object UIToolBar. Toolbar.

<statusBar>

- Object UIStatusBar. Statusbar.

Returns :NIL

Method UIWINDOW:SETPLACEMENT()

 setPlacement(<centered>)

<centered>

- Boolean. Flag of placement window at center of the screen.

Returns :NIL

Method UIWINDOW:SETSPACING()

 setSpacing(<space>)

<space>

- Number. Space between widgets in pixels.

Returns :NIL

Method UIWINDOW:SETVALUES()

 setValues(<values>)

<values>

- Array. Array of named values. Each element must be array consisted from two elements: string with widget name and string with its value.

Returns :NIL

Method UIWINDOW:SHOW()

 show()

Returns :NIL

Method UIWINDOW:UNSETKEYEVENT()

 unSetKeyEvent(<cKey>)

<cKey>

- String. Shortcut definition. For example, "F5" or "Alt+M".

Returns :NIL

Method UIWINDOW:VAL()

 val(<name>)

<name>

- String. Widget name. Setting up name for widget should be done by method setName().

Returns :NIL

Example:

 win := UIWindow("Dialog")
 win:setPlacement( .T. )
 win:show()

Platforms

No dependies of platform.

PrevHomeNext
Class UIVBOXUpClass UIWORKSPACE