xBase and Clipper language compatible compiler
PrevNext

Class UICHILDWINDOW

Name

UICHILDWINDOW  --  Class of child window.

Synopsis

 UIChildWindow([<caption>],<parent>,[<name>])	--> UIChildWindow object

Description

Class UIChildWindow.

Attributes

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

Methods

ADD Add widget to child window from top to bottom.
ADDEND Add widget to child window from bottom to top.
CLOSE Close child window.
DIALOGBOX Show dialog window with message.
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.
SETCAPTION Set new child window caption.
SETFOCUS Set focus to specified widget.
SETID Set object identifier changed in this window.
SETNAME Set name for widget.
SETOBJ Fill widgets by object fields.
SETPANELS Attach to window menubar, toolbar and/or statusbar.
SETVALUES Fill widget values from array.
SHOW Show window.
VAL Get widget value by its name.

Method UICHILDWINDOW:ADD()

 add(<o>,[<expand>],[<fill>],[<padding>])

<o>

- Widget object. Object of added widget.

<expand>

- Boolean. Expand widget on window resize.

<fill>

- Boolean. Strain widget to maximum free space in child window.

<padding>

- Number. Set indent between widget margin and margin of cell in child window.

Returns :NIL

Method UICHILDWINDOW:ADDEND()

 addEnd(<o>,[<expand>],[<fill>],[<padding>])

<o>

- Widget object. Object of added widget.

<expand>

- Boolean. Expand widget on window resize.

<fill>

- Boolean. Strain widget to maximum free space in child window.

<padding>

- Number. Set indent between widget margin and margin of cell in child window.

Returns :NIL

Method UICHILDWINDOW:CLOSE()

 close()

Returns :NIL

Method UICHILDWINDOW: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 UICHILDWINDOW:GETOBJ()

 getObj()	--> <object>

Returns :

Array of widget values.

Method UICHILDWINDOW: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 UICHILDWINDOW: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 UICHILDWINDOW:RETURN()

 return(<val>)

<val>

- Any type. Value transmitted via return function.

Returns :NIL

Method UICHILDWINDOW:SETCAPTION()

 setCaption(<caption>)

<caption>

- String. Text of child window title.

Returns :NIL

Method UICHILDWINDOW:SETFOCUS()

 setFocus(<obj>)

<obj>

- Widget. Focused widget.

Returns :NIL

Method UICHILDWINDOW:SETID()

 setId(<id>)

<id>

- String. Object identifier changed in window.

Returns :NIL

Method UICHILDWINDOW:SETNAME()

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

<name>

- String. Field name.

<o>

- Object. Widget object.

Returns :

Named widget object.

Method UICHILDWINDOW:SETOBJ()

 setObj(<obj>)

<obj>

- Object. Object contained fields with data.

Returns :NIL

Method UICHILDWINDOW:SETPANELS()

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

<menu>

- Object UIMenu. Menubar.

<toolBar>

- Object UIToolBar. Toolbar.

<statusBar>

- Object UIStatusBar. Statusbar.

Returns :NIL

Method UICHILDWINDOW: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 UICHILDWINDOW:SHOW()

 show()

Returns :NIL

Method UICHILDWINDOW:VAL()

 val(<name>)

<name>

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

Returns :NIL

Example:

 win := UIMainWindow("Main window")
 win:setMDI()
 childWindow := UIChildWindow("Child window", win, "child")
 
 childWindow:show()
 win:show()

Platforms

No dependies of platform.

PrevHomeNext
Class UICHECKBOXUpClass UICHOICE