$CLASSNAME$
	UIWindow
$SUMMARY$
	Class UIWindow.
$LANG_RU$
	 UIWindow.
$ABOUT$
	Class of separate window.
$LANG_RU$
	  .
$SYNTAX$
	UIWindow([<caption>],<parent>,[<name>],[<close>],[<resizeable>])	--> UIWindow object
$LANG_RU$
	UIWindow([<caption>],<parent>,[<name>],[<close>],[<resizeable>])	-->  UIWindow
$ATTRIBUTES$
	<className>	- Class name. Value should be "UIWindow".
	<name>		- Window name defined in constructor.
	<userSpace>	- Layout for widget placement. <link linkend="classuivbox">UIVBox</link> object.
$LANG_RU$
	<className>	-  . : "UIWindow".
	<name>		-     ,   .
	<userSpace>	-   .  <link linkend="classuivbox">UIVBox</link>.

$METHODNAME$
	UIWindow()
$SUMMARY$
	Constructor. Create separate window.
$LANG_RU$
	.   .
$SYNTAX$
	UIWindow([<caption>],<parent>,[<name>],[<close>],[<resizeable>])
$ARGUMENTS$
	<caption> 	- String. Window title.
	<parent>	- Window object. Parent window.
	<name> 		- String. Window name.
	<close>		- Boolean. Quit application if window is closed.
	<resizeable>	- Boolean. Ability of change window size manually.
$LANG_RU$
	<caption> 	- .  .
	<parent>	-  .  .
	<name> 		- .     .
	<close>		-  .      .
	<resizeable>	-  .     .

$METHODNAME$
	close()
$SUMMARY$
	Close window.
$LANG_RU$
	 .
$SYNTAX$
	close()
$ENDMETHOD$

$METHODNAME$
	childClose()
$SUMMARY$
	Close current child window.
$LANG_RU$
	   .
$SYNTAX$
	childClose()
$ENDMETHOD$

$METHODNAME$
	childCloseAll()
$SUMMARY$
	Close all child windows.
$LANG_RU$
	   .
$SYNTAX$
	childCloseAll()
$ENDMETHOD$

$METHODNAME$
	setCaption()
$SUMMARY$
	Set new window caption.
$LANG_RU$
	  .
$SYNTAX$
	setCaption(<caption>)
$ARGUMENTS$
	<caption>	- String. Text of window title.
$LANG_RU$
	<caption>	- .   .
$ENDMETHOD$

$METHODNAME$
	getGeometry()
$SUMMARY$
	Get size and position of window.
$LANG_RU$
	     .
$SYNTAX$
	getGeometry()	--> <aRect>
$RETURNS$
	Array of elements: width, height, x, y in pixels respectively.
$LANG_RU$
	  : , , x, y.
$ENDMETHOD$

$METHODNAME$
	setGeometry()
$SUMMARY$
	Change size and/or position of window.
$LANG_RU$
	  /   .
$SYNTAX$
	setGeometry(<geom>)
$ARGUMENTS$
	<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.
$LANG_RU$
	<geom>		-    .        : , , x, y.          .
$ENDMETHOD$

$METHODNAME$
	setPlacement()
$SUMMARY$
	Set window at center of the screen.
$LANG_RU$
	    .
$SYNTAX$
	setPlacement(<centered>)
$ARGUMENTS$
	<centered>	- Boolean. Flag of placement window at center of the screen.
$LANG_RU$
	<centered>	-  .      .
$ENDMETHOD$

$METHODNAME$
	setMDI()
$SUMMARY$
	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.
$LANG_RU$
	      .      ,  ,      .
$SYNTAX$
	setMDI()
$ENDMETHOD$

$METHODNAME$
	setIcon()
$SUMMARY$
	Set icon for the window.
$LANG_RU$
	  .
$SYNTAX$
	setIcon(<pic>)
$ARGUMENTS$
	<pic> - Object UIImage. Icon object.
$LANG_RU$
	<pic> -  UIImage.  .
$ENDMETHOD$

$METHODNAME$
	setFocus()
$SUMMARY$
	Set focus to specified widget.
$LANG_RU$
	     .
$SYNTAX$
	setFocus(<obj>)
$ARGUMENTS$
	<obj>		- Widget. Focused widget.
$LANG_RU$
	<obj>		- . ,    .
$ENDMETHOD$

$METHODNAME$
	setDefault()
$SUMMARY$
	Set button as default in window.
$LANG_RU$
	     .
$SYNTAX$
	setDefault()
$ARGUMENTS$
	<obj>		- Widget. Default button.
$LANG_RU$
	<obj>		- . ,   .
$ENDMETHOD$

$METHODNAME$
	setKeyEvent()
$SUMMARY$
	Set action to shortcut in the window.
$LANG_RU$
	      .
$SYNTAX$
	setKeyEvent(<cKey>,<action>)
$ARGUMENTS$
	<cKey>		- String. Shortcut definition. For example, "F5" or "Alt+M".
	<action>	- Code block. Action.
$LANG_RU$
	<cKey>		- .   . , "F5"  "Alt+M".
	<action>	-  . .
$ENDMETHOD$

$METHODNAME$
	unSetKeyEvent()
$SUMMARY$
	Unset action from shortcut in the window.
$LANG_RU$
	      .
$SYNTAX$
	unSetKeyEvent(<cKey>)
$ARGUMENTS$
	<cKey>		- String. Shortcut definition. For example, "F5" or "Alt+M".
$LANG_RU$
	<cKey>		- .   . , "F5"  "Alt+M".
$ENDMETHOD$

$METHODNAME$
	setObj()
$SUMMARY$
	Fill widgets by object fields.
$LANG_RU$
	      .
$SYNTAX$
	setObj(<obj>)
$ARGUMENTS$
	<obj> 		- Object. Object contained fields with data.
$LANG_RU$
	<obj> 		- . ,    .
$ENDMETHOD$

$METHODNAME$
	getObj()
$SUMMARY$
	Get object with filled fields from window widgets contents.
$LANG_RU$
	 ,       .
$SYNTAX$
	getObj()	--> <object>
$RETURNS$
	Array of widget values.
$LANG_RU$
	,       .
$ENDMETHOD$

$METHODNAME$
	dialogBox()
$SUMMARY$
	Show dialog window with message.
$LANG_RU$
	  .
$SYNTAX$
	dialogBox(<caption>,<text>,[<buttons>],[<buttonNames>],[<action>])
$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, "'&amp;Save','&amp;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.
$LANG_RU$
	<caption>	- .   .
	<text>		- .    .
	<buttons> 	- .   . , "'&amp;','&amp;'".    ,     'OK'.
	<buttonNames> 	- . C  ͣ . , "'SAVE','CANCEL'".
	<action>	-  .  ,        .         .
$ENDMETHOD$

$METHODNAME$
	show()
$SUMMARY$
	Show window.
$LANG_RU$
	 .
$SYNTAX$
	show()
$ENDMETHOD$

$METHODNAME$
	setPanels()
$SUMMARY$
	Attach to window menubar, toolbar and/or statusbar.
$LANG_RU$
	   ,     .
$SYNTAX$
	setPanels([<menu>],[<toolBar>],[<statusBar>])
$ARGUMENTS$
	<menu>		- Object <link linkend="classuimenu">UIMenu</link>. Menubar.
	<toolBar> 	- Object <link linkend="classuitoolbar">UIToolBar</link>. Toolbar.
	<statusBar> 	- Object <link linkend="classuistatusbar">UIStatusBar</link>. Statusbar.
$LANG_RU$
	<menu>		-  <link linkend="classuimenu">UIMenu</link>. .
	<toolBar> 	-  <link linkend="classuitoolbar">UIToolBar</link>.  .
	<statusBar> 	-  <link linkend="classuistatusbar">UIStatusBar</link>.  .
$ENDMETHOD$

$METHODNAME$
	setName()
$SUMMARY$
	Set name for widget.
$LANG_RU$
	   .
$SYNTAX$
	setName(<name>,<o>) --> <o>
$ARGUMENTS$
	<name>		- String. Field name.
	<o>		- Object. Widget object.
$LANG_RU$
	<name>		- .  .
	<o>		- .  .
$RETURNS$
	Named widget object.
$LANG_RU$
	  .
$ENDMETHOD$

$METHODNAME$
	val()
$SUMMARY$
	Get widget value by its name.
$LANG_RU$
	     .
$SYNTAX$
	val(<name>)
$ARGUMENTS$
	<name>		- String. Widget name. Setting up name for widget should be done by method setName().
$LANG_RU$
	<name>		- .  .  ͣ     setName().
$ENDMETHOD$

$METHODNAME$
	setValues()
$SUMMARY$
	Fill widget values from array.
$LANG_RU$
	     .
$SYNTAX$
	setValues(<values>)
$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.
$LANG_RU$
	<values>	- .   .     ,    :      .
$ENDMETHOD$

$METHODNAME$
	getValues()
$SUMMARY$
	Get array of values from window widgets.
$LANG_RU$
	     .
$SYNTAX$
	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.
$LANG_RU$
	    .     ,    :      .
$ENDMETHOD$

$METHODNAME$
	return()
$SUMMARY$
	Send value to window which initiated creation of this window.
$LANG_RU$
	 ̣   ,    .
$SYNTAX$
	return(<val>)
$ARGUMENTS$
	<val>		- Any type. Value transmitted via return function.
$LANG_RU$
	<val>		-   . ,    .
$ENDMETHOD$

$METHODNAME$
	select()
$SUMMARY$
	Send value for <link linkend="classuichoice">UIChoice</link> to window which initiated creation of this window.
$LANG_RU$
	   <link linkend="classuichoice">UIChoice</link>  ,    .
$SYNTAX$
	select(<table>,<column>)
$ARGUMENTS$
	<table>		- String. Name of <link linkend="classuitable">UITable</link> widget in current window.
	<column>	- Number. Column number from <link linkend="classuitable">UITable</link>.
$LANG_RU$
	<table>		- .    <link linkend="classuitable">UITable</link>   .
	<column>	- .    <link linkend="classuitable">UITable</link>.
$ENDMETHOD$

$METHODNAME$
	isChanged()
$SUMMARY$
	Return true if any field in window was changed.
$LANG_RU$
	  ,          .
$SYNTAX$
	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.
$LANG_RU$
	 .   ,       .         .
$ENDMETHOD$

$METHODNAME$
	setId()
$SUMMARY$
	Set object identifier changed in this window.
$LANG_RU$
	  ,   .
$SYNTAX$
	setId(<id>)
$ARGUMENTS$
	<id>		- String. Object identifier changed in window.
$LANG_RU$
	<id>		- .  ,   .
$ENDMETHOD$

$METHODNAME$
	setSpacing()
$SUMMARY$
	Set space between widgets in window.
$LANG_RU$
	     .
$SYNTAX$
	setSpacing(<space>)
$ARGUMENTS$
	<space>		- Number. Space between widgets in pixels.
$LANG_RU$
	<space>		- .       .
$ENDMETHOD$

$METHODNAME$
	setPadding()
$SUMMARY$
	Set window border width.
$LANG_RU$
	   .
$SYNTAX$
	setPadding(<space>)
$ARGUMENTS$
	<space>		- Number. Width of window border in pixels.
$LANG_RU$
	<space>		- .     .
$ENDMETHOD$


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

$PLATFORMS$
	No dependies of platform.
$LANG_RU$
	   .
$SEEALSO$
$AUTHOR$
	Andrey Cherepanov <skull@eas.lrn.ru>
$LANG_RU$
	  <skull@eas.lrn.ru>
$LASTDATE$
