xBase and Clipper language compatible compiler
Prev	Chapter 12. CLIP Classes	Next

12.17. Class UICHILDWINDOW

12.17.1. About

12.17.2. Description

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

12.17.2.1. Attributes

<className>	- Class name. Value should be "UIChildWindow".
<name>	- Window name defined in constructor.

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

12.17.2.3. Example

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

12.17.2.4. See also

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

12.17.2.7.1. Arguments

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

12.17.2.7.2. Returns

Returns NIL.

12.17.2.7.3. Description

12.17.2.8. Method UICHILDWINDOW:ADDEND()

Add widget to child window from bottom to top.

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

12.17.2.8.1. Arguments

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

12.17.2.8.2. Returns

Returns NIL.

12.17.2.8.3. Description

12.17.2.9. Method UICHILDWINDOW:CLOSE()

Close child window.

 close()

12.17.2.9.1. Arguments

No arguments

12.17.2.9.2. Returns

Returns NIL.

12.17.2.9.3. Description

12.17.2.10. Method UICHILDWINDOW:DIALOGBOX()

Show dialog window with message.

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

12.17.2.10.1. Arguments

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

12.17.2.10.2. Returns

Returns NIL.

12.17.2.10.3. Description

12.17.2.11. Method UICHILDWINDOW:GETOBJ()

Get object with filled fields from window widgets contents.

 getObj()	--> <object>

12.17.2.11.1. Arguments

No arguments

12.17.2.11.2. Returns

Array of widget values.

12.17.2.11.3. Description

12.17.2.12. Method UICHILDWINDOW:GETVALUES()

Get array of values from window widgets.

 getValues()	--> <array>

12.17.2.12.1. Arguments

No arguments

12.17.2.12.2. Returns

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

12.17.2.12.3. Description

12.17.2.13. Method UICHILDWINDOW:ISCHANGED()

Return true if any field in window was changed.

 isChanged()	--> <bChanged>

12.17.2.13.1. Arguments

No arguments

12.17.2.13.2. Returns

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

12.17.2.13.3. Description

12.17.2.14. Method UICHILDWINDOW:RETURN()

Send value to window which initiated creation of this window.

 return(<val>)

12.17.2.14.1. Arguments

<val>

- Any type. Value transmitted via return function.

12.17.2.14.2. Returns

Returns NIL.

12.17.2.14.3. Description

12.17.2.15. Method UICHILDWINDOW:SETID()

Set object identifier changed in this window.

 setId(<id>)

12.17.2.15.1. Arguments

<id>

- String. Object identifier changed in window.

12.17.2.15.2. Returns

Returns NIL.

12.17.2.15.3. Description

12.17.2.16. Method UICHILDWINDOW:SETNAME()

Set name for widget.

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

12.17.2.16.1. Arguments

<name>	- String. Field name.
<o>	- Object. Widget object.

12.17.2.16.2. Returns

Named widget object.

12.17.2.16.3. Description

12.17.2.17. Method UICHILDWINDOW:SETOBJ()

Fill widgets by object fields.

 setObj(<obj>)

12.17.2.17.1. Arguments

<obj>

- Object. Object contained fields with data.

12.17.2.17.2. Returns

Returns NIL.

12.17.2.17.3. Description

12.17.2.18. Method UICHILDWINDOW:SETPANELS()

Attach to window menubar, toolbar and/or statusbar.

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

12.17.2.18.1. Arguments

<menu>	- Object UIMenu. Menubar.
<toolBar>	- Object UIToolBar. Toolbar.
<statusBar>	- Object UIStatusBar. Statusbar.

12.17.2.18.2. Returns

Returns NIL.

12.17.2.18.3. Description

12.17.2.19. Method UICHILDWINDOW:SETVALUES()

Fill widget values from array.

 setValues(<values>)

12.17.2.19.1. Arguments

<values>

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

12.17.2.19.2. Returns

Returns NIL.

12.17.2.19.3. Description

12.17.2.20. Method UICHILDWINDOW:SHOW()

Show window.

 show()

12.17.2.20.1. Arguments

No arguments

12.17.2.20.2. Returns

Returns NIL.

12.17.2.20.3. Description

12.17.2.21. Method UICHILDWINDOW:VAL()

Get widget value by its name.

 val(<name>)

12.17.2.21.1. Arguments

<name>

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

12.17.2.21.2. Returns

Returns NIL.

Prev	Home	Next
Class UICHECKBOX	Up	Class UICHOICE