From 2735ac5fada61995f5a07e9a4ad01ba9a400b69b Mon Sep 17 00:00:00 2001 From: Joe Watkins Date: Sun, 23 Oct 2016 11:12:21 +0000 Subject: [PATCH] ui documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340595 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ui/book.developer.xml | 76 +++ reference/ui/book.xml | 88 +++ reference/ui/configure.xml | 37 ++ reference/ui/constants.xml | 28 + reference/ui/entities.functions.xml | 1 + reference/ui/entities.ui.xml | 10 + .../ui.draw.text.font.fontfamilies.xml | 48 ++ reference/ui/reference.xml | 30 ++ reference/ui/setup.xml | 45 ++ reference/ui/ui.app.xml | 67 +++ reference/ui/ui.area.xml | 159 ++++++ reference/ui/ui.control.xml | 68 +++ reference/ui/ui.controls.box.xml | 114 ++++ reference/ui/ui.controls.button.xml | 79 +++ reference/ui/ui.controls.check.xml | 79 +++ reference/ui/ui.controls.colorbutton.xml | 76 +++ reference/ui/ui.controls.combo.xml | 76 +++ reference/ui/ui.controls.editablecombo.xml | 76 +++ reference/ui/ui.controls.entry.xml | 126 +++++ reference/ui/ui.controls.form.xml | 76 +++ reference/ui/ui.controls.grid.xml | 183 +++++++ reference/ui/ui.controls.group.xml | 79 +++ reference/ui/ui.controls.label.xml | 79 +++ reference/ui/ui.controls.multilineentry.xml | 114 ++++ reference/ui/ui.controls.picker.xml | 123 +++++ reference/ui/ui.controls.progress.xml | 76 +++ reference/ui/ui.controls.radio.xml | 76 +++ reference/ui/ui.controls.separator.xml | 111 ++++ reference/ui/ui.controls.slider.xml | 79 +++ reference/ui/ui.controls.spin.xml | 79 +++ reference/ui/ui.controls.tab.xml | 76 +++ reference/ui/ui.draw.brush.xml | 129 +++++ reference/ui/ui.draw.color.xml | 129 +++++ reference/ui/ui.draw.line.cap.xml | 111 ++++ reference/ui/ui.draw.line.join.xml | 111 ++++ reference/ui/ui.draw.matrix.xml | 67 +++ reference/ui/ui.draw.path.xml | 109 ++++ reference/ui/ui.draw.pen.xml | 68 +++ reference/ui/ui.draw.stroke.xml | 70 +++ reference/ui/ui.draw.text.font.descriptor.xml | 66 +++ reference/ui/ui.draw.text.font.italic.xml | 114 ++++ reference/ui/ui.draw.text.font.stretch.xml | 192 +++++++ reference/ui/ui.draw.text.font.weight.xml | 207 +++++++ reference/ui/ui.draw.text.font.xml | 68 +++ reference/ui/ui.draw.text.layout.xml | 70 +++ reference/ui/ui.menu.xml | 70 +++ reference/ui/ui.menuitem.xml | 67 +++ reference/ui/ui.point.xml | 106 ++++ reference/ui/ui.size.xml | 71 +++ reference/ui/ui.window.xml | 79 +++ reference/ui/ui/app/onshouldquit.xml | 65 +++ reference/ui/ui/app/quit.xml | 56 ++ reference/ui/ui/app/run.xml | 74 +++ reference/ui/ui/area/ondraw.xml | 84 +++ reference/ui/ui/area/onkey.xml | 83 +++ reference/ui/ui/area/onmouse.xml | 75 +++ reference/ui/ui/area/redraw.xml | 56 ++ reference/ui/ui/area/scrollto.xml | 66 +++ reference/ui/ui/area/setsize.xml | 58 ++ reference/ui/ui/control/destroy.xml | 56 ++ reference/ui/ui/control/disable.xml | 56 ++ reference/ui/ui/control/enable.xml | 56 ++ reference/ui/ui/control/getparent.xml | 56 ++ reference/ui/ui/control/gettoplevel.xml | 58 ++ reference/ui/ui/control/hide.xml | 56 ++ reference/ui/ui/control/isenabled.xml | 56 ++ reference/ui/ui/control/isvisible.xml | 56 ++ reference/ui/ui/control/setparent.xml | 65 +++ reference/ui/ui/control/show.xml | 56 ++ reference/ui/ui/controls/box/append.xml | 67 +++ reference/ui/ui/controls/box/construct.xml | 59 ++ reference/ui/ui/controls/box/delete.xml | 58 ++ .../ui/ui/controls/box/getorientation.xml | 48 ++ reference/ui/ui/controls/box/ispadded.xml | 49 ++ reference/ui/ui/controls/box/setpadded.xml | 58 ++ reference/ui/ui/controls/button/construct.xml | 59 ++ reference/ui/ui/controls/button/gettext.xml | 56 ++ reference/ui/ui/controls/button/onclick.xml | 48 ++ reference/ui/ui/controls/button/settext.xml | 57 ++ reference/ui/ui/controls/check/construct.xml | 57 ++ reference/ui/ui/controls/check/gettext.xml | 56 ++ reference/ui/ui/controls/check/ischecked.xml | 49 ++ reference/ui/ui/controls/check/ontoggle.xml | 49 ++ reference/ui/ui/controls/check/setchecked.xml | 58 ++ reference/ui/ui/controls/check/settext.xml | 58 ++ .../ui/ui/controls/colorbutton/getcolor.xml | 56 ++ .../ui/ui/controls/colorbutton/onchange.xml | 49 ++ .../ui/ui/controls/colorbutton/setcolor.xml | 58 ++ reference/ui/ui/controls/combo/append.xml | 58 ++ .../ui/ui/controls/combo/getselected.xml | 49 ++ reference/ui/ui/controls/combo/onselected.xml | 49 ++ .../ui/ui/controls/combo/setselected.xml | 58 ++ .../ui/ui/controls/editablecombo/append.xml | 58 ++ .../ui/ui/controls/editablecombo/gettext.xml | 49 ++ .../ui/ui/controls/editablecombo/onchange.xml | 48 ++ .../ui/ui/controls/editablecombo/settext.xml | 58 ++ reference/ui/ui/controls/entities.box.xml | 6 + reference/ui/ui/controls/entities.button.xml | 4 + reference/ui/ui/controls/entities.check.xml | 6 + .../ui/ui/controls/entities.colorbutton.xml | 3 + reference/ui/ui/controls/entities.combo.xml | 4 + .../ui/ui/controls/entities.editablecombo.xml | 4 + reference/ui/ui/controls/entities.entry.xml | 6 + reference/ui/ui/controls/entities.form.xml | 4 + reference/ui/ui/controls/entities.grid.xml | 3 + reference/ui/ui/controls/entities.group.xml | 6 + reference/ui/ui/controls/entities.label.xml | 3 + .../ui/controls/entities.multilineentry.xml | 7 + reference/ui/ui/controls/entities.picker.xml | 1 + .../ui/ui/controls/entities.progress.xml | 2 + reference/ui/ui/controls/entities.radio.xml | 4 + .../ui/ui/controls/entities.separator.xml | 1 + reference/ui/ui/controls/entities.slider.xml | 4 + reference/ui/ui/controls/entities.spin.xml | 4 + reference/ui/ui/controls/entities.tab.xml | 6 + reference/ui/ui/controls/entry/construct.xml | 57 ++ reference/ui/ui/controls/entry/gettext.xml | 56 ++ reference/ui/ui/controls/entry/isreadonly.xml | 56 ++ reference/ui/ui/controls/entry/onchange.xml | 48 ++ .../ui/ui/controls/entry/setreadonly.xml | 58 ++ reference/ui/ui/controls/entry/settext.xml | 58 ++ reference/ui/ui/controls/form/append.xml | 76 +++ reference/ui/ui/controls/form/delete.xml | 57 ++ reference/ui/ui/controls/form/ispadded.xml | 49 ++ reference/ui/ui/controls/form/setpadded.xml | 58 ++ reference/ui/ui/controls/grid/append.xml | 139 +++++ reference/ui/ui/controls/grid/ispadded.xml | 49 ++ reference/ui/ui/controls/grid/setpadded.xml | 58 ++ reference/ui/ui/controls/group/append.xml | 58 ++ reference/ui/ui/controls/group/construct.xml | 59 ++ reference/ui/ui/controls/group/gettitle.xml | 56 ++ reference/ui/ui/controls/group/hasmargin.xml | 49 ++ reference/ui/ui/controls/group/setmargin.xml | 58 ++ reference/ui/ui/controls/group/settitle.xml | 58 ++ reference/ui/ui/controls/label/construct.xml | 57 ++ reference/ui/ui/controls/label/gettext.xml | 58 ++ reference/ui/ui/controls/label/settext.xml | 57 ++ .../ui/ui/controls/multilineentry/append.xml | 58 ++ .../ui/controls/multilineentry/construct.xml | 59 ++ .../ui/ui/controls/multilineentry/gettext.xml | 49 ++ .../ui/controls/multilineentry/isreadonly.xml | 49 ++ .../ui/controls/multilineentry/onchange.xml | 48 ++ .../controls/multilineentry/setreadonly.xml | 58 ++ .../ui/ui/controls/multilineentry/settext.xml | 57 ++ reference/ui/ui/controls/picker/construct.xml | 59 ++ .../ui/ui/controls/progress/getvalue.xml | 49 ++ .../ui/ui/controls/progress/setvalue.xml | 57 ++ reference/ui/ui/controls/radio/append.xml | 58 ++ .../ui/ui/controls/radio/getselected.xml | 49 ++ reference/ui/ui/controls/radio/onselected.xml | 48 ++ .../ui/ui/controls/radio/setselected.xml | 58 ++ .../ui/ui/controls/separator/construct.xml | 57 ++ reference/ui/ui/controls/slider/construct.xml | 66 +++ reference/ui/ui/controls/slider/getvalue.xml | 49 ++ reference/ui/ui/controls/slider/onchange.xml | 49 ++ reference/ui/ui/controls/slider/setvalue.xml | 57 ++ reference/ui/ui/controls/spin/construct.xml | 68 +++ reference/ui/ui/controls/spin/getvalue.xml | 48 ++ reference/ui/ui/controls/spin/onchange.xml | 49 ++ reference/ui/ui/controls/spin/setvalue.xml | 58 ++ reference/ui/ui/controls/tab/append.xml | 67 +++ reference/ui/ui/controls/tab/delete.xml | 57 ++ reference/ui/ui/controls/tab/hasmargin.xml | 64 +++ reference/ui/ui/controls/tab/insertat.xml | 75 +++ reference/ui/ui/controls/tab/pages.xml | 56 ++ reference/ui/ui/controls/tab/setmargin.xml | 66 +++ reference/ui/ui/draw/brush/construct.xml | 111 ++++ reference/ui/ui/draw/brush/getcolor.xml | 56 ++ reference/ui/ui/draw/brush/gettype.xml | 56 ++ reference/ui/ui/draw/brush/setcolor.xml | 57 ++ reference/ui/ui/draw/brush/settype.xml | 59 ++ reference/ui/ui/draw/color/construct.xml | 68 +++ reference/ui/ui/draw/color/getchannel.xml | 58 ++ reference/ui/ui/draw/color/setchannel.xml | 76 +++ reference/ui/ui/draw/entities.brush.xml | 5 + reference/ui/ui/draw/entities.color.xml | 3 + reference/ui/ui/draw/entities.matrix.xml | 7 + reference/ui/ui/draw/entities.path.xml | 9 + reference/ui/ui/draw/entities.pen.xml | 7 + reference/ui/ui/draw/entities.stroke.xml | 9 + reference/ui/ui/draw/entities.text.xml | 3 + reference/ui/ui/draw/matrix/invert.xml | 49 ++ reference/ui/ui/draw/matrix/isinvertible.xml | 49 ++ reference/ui/ui/draw/matrix/multiply.xml | 55 ++ reference/ui/ui/draw/matrix/rotate.xml | 67 +++ reference/ui/ui/draw/matrix/scale.xml | 67 +++ reference/ui/ui/draw/matrix/skew.xml | 67 +++ reference/ui/ui/draw/matrix/translate.xml | 58 ++ reference/ui/ui/draw/path/addrectangle.xml | 66 +++ reference/ui/ui/draw/path/arcto.xml | 101 ++++ reference/ui/ui/draw/path/bezierto.xml | 94 ++++ reference/ui/ui/draw/path/closefigure.xml | 49 ++ reference/ui/ui/draw/path/construct.xml | 57 ++ reference/ui/ui/draw/path/end.xml | 49 ++ reference/ui/ui/draw/path/lineto.xml | 101 ++++ reference/ui/ui/draw/path/newfigure.xml | 58 ++ .../ui/ui/draw/path/newfigurewitharc.xml | 101 ++++ reference/ui/ui/draw/pen/clip.xml | 58 ++ reference/ui/ui/draw/pen/fill.xml | 67 +++ reference/ui/ui/draw/pen/restore.xml | 49 ++ reference/ui/ui/draw/pen/save.xml | 49 ++ reference/ui/ui/draw/pen/stroke.xml | 75 +++ reference/ui/ui/draw/pen/transform.xml | 57 ++ reference/ui/ui/draw/pen/write.xml | 67 +++ reference/ui/ui/draw/stroke/construct.xml | 86 +++ reference/ui/ui/draw/stroke/getcap.xml | 56 ++ reference/ui/ui/draw/stroke/getjoin.xml | 56 ++ reference/ui/ui/draw/stroke/getmiterlimit.xml | 56 ++ reference/ui/ui/draw/stroke/getthickness.xml | 56 ++ reference/ui/ui/draw/stroke/setcap.xml | 56 ++ reference/ui/ui/draw/stroke/setjoin.xml | 65 +++ reference/ui/ui/draw/stroke/setmiterlimit.xml | 58 ++ reference/ui/ui/draw/stroke/setthickness.xml | 58 ++ .../ui/draw/text/entities.font.descriptor.xml | 1 + reference/ui/ui/draw/text/entities.font.xml | 1 + reference/ui/ui/draw/text/entities.layout.xml | 3 + .../draw/text/font.descriptor/construct.xml | 106 ++++ reference/ui/ui/draw/text/font/construct.xml | 57 ++ .../ui/ui/draw/text/layout/construct.xml | 77 +++ reference/ui/ui/draw/text/layout/setcolor.xml | 76 +++ reference/ui/ui/draw/text/layout/setwidth.xml | 58 ++ reference/ui/ui/entities.app.xml | 3 + reference/ui/ui/entities.area.xml | 6 + reference/ui/ui/entities.control.xml | 10 + reference/ui/ui/entities.controls.xml | 19 + reference/ui/ui/entities.draw.xml | 7 + reference/ui/ui/entities.menu.xml | 7 + reference/ui/ui/entities.menuitem.xml | 5 + reference/ui/ui/entities.point.xml | 5 + reference/ui/ui/entities.size.xml | 5 + reference/ui/ui/entities.window.xml | 17 + reference/ui/ui/menu/append.xml | 74 +++ reference/ui/ui/menu/appendabout.xml | 65 +++ reference/ui/ui/menu/appendcheck.xml | 74 +++ reference/ui/ui/menu/appendpreferences.xml | 65 +++ reference/ui/ui/menu/appendquit.xml | 65 +++ reference/ui/ui/menu/appendseparator.xml | 49 ++ reference/ui/ui/menu/construct.xml | 57 ++ reference/ui/ui/menuitem/disable.xml | 49 ++ reference/ui/ui/menuitem/enable.xml | 49 ++ reference/ui/ui/menuitem/ischecked.xml | 49 ++ reference/ui/ui/menuitem/onclick.xml | 49 ++ reference/ui/ui/menuitem/setchecked.xml | 57 ++ reference/ui/ui/point/construct.xml | 65 +++ reference/ui/ui/point/getx.xml | 55 ++ reference/ui/ui/point/gety.xml | 55 ++ reference/ui/ui/point/setx.xml | 64 +++ reference/ui/ui/point/sety.xml | 64 +++ reference/ui/ui/size/construct.xml | 79 +++ reference/ui/ui/size/getheight.xml | 54 ++ reference/ui/ui/size/getwidth.xml | 56 ++ reference/ui/ui/size/setheight.xml | 65 +++ reference/ui/ui/size/setwidth.xml | 65 +++ reference/ui/ui/window/add.xml | 65 +++ reference/ui/ui/window/construct.xml | 97 ++++ reference/ui/ui/window/error.xml | 67 +++ reference/ui/ui/window/getsize.xml | 56 ++ reference/ui/ui/window/gettitle.xml | 56 ++ reference/ui/ui/window/hasborders.xml | 56 ++ reference/ui/ui/window/hasmargin.xml | 56 ++ reference/ui/ui/window/isfullscreen.xml | 56 ++ reference/ui/ui/window/msg.xml | 67 +++ reference/ui/ui/window/onclosing.xml | 56 ++ reference/ui/ui/window/open.xml | 56 ++ reference/ui/ui/window/save.xml | 56 ++ reference/ui/ui/window/setborders.xml | 58 ++ reference/ui/ui/window/setfullscreen.xml | 60 +++ reference/ui/ui/window/setmargin.xml | 58 ++ reference/ui/ui/window/setsize.xml | 65 +++ reference/ui/ui/window/settitle.xml | 58 ++ reference/ui/versions.xml | 508 ++++++++++++++++++ 271 files changed, 16030 insertions(+) create mode 100644 reference/ui/book.developer.xml create mode 100644 reference/ui/book.xml create mode 100644 reference/ui/configure.xml create mode 100644 reference/ui/constants.xml create mode 100644 reference/ui/entities.functions.xml create mode 100644 reference/ui/entities.ui.xml create mode 100644 reference/ui/functions/ui.draw.text.font.fontfamilies.xml create mode 100644 reference/ui/reference.xml create mode 100644 reference/ui/setup.xml create mode 100644 reference/ui/ui.app.xml create mode 100644 reference/ui/ui.area.xml create mode 100644 reference/ui/ui.control.xml create mode 100644 reference/ui/ui.controls.box.xml create mode 100644 reference/ui/ui.controls.button.xml create mode 100644 reference/ui/ui.controls.check.xml create mode 100644 reference/ui/ui.controls.colorbutton.xml create mode 100644 reference/ui/ui.controls.combo.xml create mode 100644 reference/ui/ui.controls.editablecombo.xml create mode 100644 reference/ui/ui.controls.entry.xml create mode 100644 reference/ui/ui.controls.form.xml create mode 100644 reference/ui/ui.controls.grid.xml create mode 100644 reference/ui/ui.controls.group.xml create mode 100644 reference/ui/ui.controls.label.xml create mode 100644 reference/ui/ui.controls.multilineentry.xml create mode 100644 reference/ui/ui.controls.picker.xml create mode 100644 reference/ui/ui.controls.progress.xml create mode 100644 reference/ui/ui.controls.radio.xml create mode 100644 reference/ui/ui.controls.separator.xml create mode 100644 reference/ui/ui.controls.slider.xml create mode 100644 reference/ui/ui.controls.spin.xml create mode 100644 reference/ui/ui.controls.tab.xml create mode 100644 reference/ui/ui.draw.brush.xml create mode 100644 reference/ui/ui.draw.color.xml create mode 100644 reference/ui/ui.draw.line.cap.xml create mode 100644 reference/ui/ui.draw.line.join.xml create mode 100644 reference/ui/ui.draw.matrix.xml create mode 100644 reference/ui/ui.draw.path.xml create mode 100644 reference/ui/ui.draw.pen.xml create mode 100644 reference/ui/ui.draw.stroke.xml create mode 100644 reference/ui/ui.draw.text.font.descriptor.xml create mode 100644 reference/ui/ui.draw.text.font.italic.xml create mode 100644 reference/ui/ui.draw.text.font.stretch.xml create mode 100644 reference/ui/ui.draw.text.font.weight.xml create mode 100644 reference/ui/ui.draw.text.font.xml create mode 100644 reference/ui/ui.draw.text.layout.xml create mode 100644 reference/ui/ui.menu.xml create mode 100644 reference/ui/ui.menuitem.xml create mode 100644 reference/ui/ui.point.xml create mode 100644 reference/ui/ui.size.xml create mode 100644 reference/ui/ui.window.xml create mode 100644 reference/ui/ui/app/onshouldquit.xml create mode 100644 reference/ui/ui/app/quit.xml create mode 100644 reference/ui/ui/app/run.xml create mode 100644 reference/ui/ui/area/ondraw.xml create mode 100644 reference/ui/ui/area/onkey.xml create mode 100644 reference/ui/ui/area/onmouse.xml create mode 100644 reference/ui/ui/area/redraw.xml create mode 100644 reference/ui/ui/area/scrollto.xml create mode 100644 reference/ui/ui/area/setsize.xml create mode 100644 reference/ui/ui/control/destroy.xml create mode 100644 reference/ui/ui/control/disable.xml create mode 100644 reference/ui/ui/control/enable.xml create mode 100644 reference/ui/ui/control/getparent.xml create mode 100644 reference/ui/ui/control/gettoplevel.xml create mode 100644 reference/ui/ui/control/hide.xml create mode 100644 reference/ui/ui/control/isenabled.xml create mode 100644 reference/ui/ui/control/isvisible.xml create mode 100644 reference/ui/ui/control/setparent.xml create mode 100644 reference/ui/ui/control/show.xml create mode 100644 reference/ui/ui/controls/box/append.xml create mode 100644 reference/ui/ui/controls/box/construct.xml create mode 100644 reference/ui/ui/controls/box/delete.xml create mode 100644 reference/ui/ui/controls/box/getorientation.xml create mode 100644 reference/ui/ui/controls/box/ispadded.xml create mode 100644 reference/ui/ui/controls/box/setpadded.xml create mode 100644 reference/ui/ui/controls/button/construct.xml create mode 100644 reference/ui/ui/controls/button/gettext.xml create mode 100644 reference/ui/ui/controls/button/onclick.xml create mode 100644 reference/ui/ui/controls/button/settext.xml create mode 100644 reference/ui/ui/controls/check/construct.xml create mode 100644 reference/ui/ui/controls/check/gettext.xml create mode 100644 reference/ui/ui/controls/check/ischecked.xml create mode 100644 reference/ui/ui/controls/check/ontoggle.xml create mode 100644 reference/ui/ui/controls/check/setchecked.xml create mode 100644 reference/ui/ui/controls/check/settext.xml create mode 100644 reference/ui/ui/controls/colorbutton/getcolor.xml create mode 100644 reference/ui/ui/controls/colorbutton/onchange.xml create mode 100644 reference/ui/ui/controls/colorbutton/setcolor.xml create mode 100644 reference/ui/ui/controls/combo/append.xml create mode 100644 reference/ui/ui/controls/combo/getselected.xml create mode 100644 reference/ui/ui/controls/combo/onselected.xml create mode 100644 reference/ui/ui/controls/combo/setselected.xml create mode 100644 reference/ui/ui/controls/editablecombo/append.xml create mode 100644 reference/ui/ui/controls/editablecombo/gettext.xml create mode 100644 reference/ui/ui/controls/editablecombo/onchange.xml create mode 100644 reference/ui/ui/controls/editablecombo/settext.xml create mode 100644 reference/ui/ui/controls/entities.box.xml create mode 100644 reference/ui/ui/controls/entities.button.xml create mode 100644 reference/ui/ui/controls/entities.check.xml create mode 100644 reference/ui/ui/controls/entities.colorbutton.xml create mode 100644 reference/ui/ui/controls/entities.combo.xml create mode 100644 reference/ui/ui/controls/entities.editablecombo.xml create mode 100644 reference/ui/ui/controls/entities.entry.xml create mode 100644 reference/ui/ui/controls/entities.form.xml create mode 100644 reference/ui/ui/controls/entities.grid.xml create mode 100644 reference/ui/ui/controls/entities.group.xml create mode 100644 reference/ui/ui/controls/entities.label.xml create mode 100644 reference/ui/ui/controls/entities.multilineentry.xml create mode 100644 reference/ui/ui/controls/entities.picker.xml create mode 100644 reference/ui/ui/controls/entities.progress.xml create mode 100644 reference/ui/ui/controls/entities.radio.xml create mode 100644 reference/ui/ui/controls/entities.separator.xml create mode 100644 reference/ui/ui/controls/entities.slider.xml create mode 100644 reference/ui/ui/controls/entities.spin.xml create mode 100644 reference/ui/ui/controls/entities.tab.xml create mode 100644 reference/ui/ui/controls/entry/construct.xml create mode 100644 reference/ui/ui/controls/entry/gettext.xml create mode 100644 reference/ui/ui/controls/entry/isreadonly.xml create mode 100644 reference/ui/ui/controls/entry/onchange.xml create mode 100644 reference/ui/ui/controls/entry/setreadonly.xml create mode 100644 reference/ui/ui/controls/entry/settext.xml create mode 100644 reference/ui/ui/controls/form/append.xml create mode 100644 reference/ui/ui/controls/form/delete.xml create mode 100644 reference/ui/ui/controls/form/ispadded.xml create mode 100644 reference/ui/ui/controls/form/setpadded.xml create mode 100644 reference/ui/ui/controls/grid/append.xml create mode 100644 reference/ui/ui/controls/grid/ispadded.xml create mode 100644 reference/ui/ui/controls/grid/setpadded.xml create mode 100644 reference/ui/ui/controls/group/append.xml create mode 100644 reference/ui/ui/controls/group/construct.xml create mode 100644 reference/ui/ui/controls/group/gettitle.xml create mode 100644 reference/ui/ui/controls/group/hasmargin.xml create mode 100644 reference/ui/ui/controls/group/setmargin.xml create mode 100644 reference/ui/ui/controls/group/settitle.xml create mode 100644 reference/ui/ui/controls/label/construct.xml create mode 100644 reference/ui/ui/controls/label/gettext.xml create mode 100644 reference/ui/ui/controls/label/settext.xml create mode 100644 reference/ui/ui/controls/multilineentry/append.xml create mode 100644 reference/ui/ui/controls/multilineentry/construct.xml create mode 100644 reference/ui/ui/controls/multilineentry/gettext.xml create mode 100644 reference/ui/ui/controls/multilineentry/isreadonly.xml create mode 100644 reference/ui/ui/controls/multilineentry/onchange.xml create mode 100644 reference/ui/ui/controls/multilineentry/setreadonly.xml create mode 100644 reference/ui/ui/controls/multilineentry/settext.xml create mode 100644 reference/ui/ui/controls/picker/construct.xml create mode 100644 reference/ui/ui/controls/progress/getvalue.xml create mode 100644 reference/ui/ui/controls/progress/setvalue.xml create mode 100644 reference/ui/ui/controls/radio/append.xml create mode 100644 reference/ui/ui/controls/radio/getselected.xml create mode 100644 reference/ui/ui/controls/radio/onselected.xml create mode 100644 reference/ui/ui/controls/radio/setselected.xml create mode 100644 reference/ui/ui/controls/separator/construct.xml create mode 100644 reference/ui/ui/controls/slider/construct.xml create mode 100644 reference/ui/ui/controls/slider/getvalue.xml create mode 100644 reference/ui/ui/controls/slider/onchange.xml create mode 100644 reference/ui/ui/controls/slider/setvalue.xml create mode 100644 reference/ui/ui/controls/spin/construct.xml create mode 100644 reference/ui/ui/controls/spin/getvalue.xml create mode 100644 reference/ui/ui/controls/spin/onchange.xml create mode 100644 reference/ui/ui/controls/spin/setvalue.xml create mode 100644 reference/ui/ui/controls/tab/append.xml create mode 100644 reference/ui/ui/controls/tab/delete.xml create mode 100644 reference/ui/ui/controls/tab/hasmargin.xml create mode 100644 reference/ui/ui/controls/tab/insertat.xml create mode 100644 reference/ui/ui/controls/tab/pages.xml create mode 100644 reference/ui/ui/controls/tab/setmargin.xml create mode 100644 reference/ui/ui/draw/brush/construct.xml create mode 100644 reference/ui/ui/draw/brush/getcolor.xml create mode 100644 reference/ui/ui/draw/brush/gettype.xml create mode 100644 reference/ui/ui/draw/brush/setcolor.xml create mode 100644 reference/ui/ui/draw/brush/settype.xml create mode 100644 reference/ui/ui/draw/color/construct.xml create mode 100644 reference/ui/ui/draw/color/getchannel.xml create mode 100644 reference/ui/ui/draw/color/setchannel.xml create mode 100644 reference/ui/ui/draw/entities.brush.xml create mode 100644 reference/ui/ui/draw/entities.color.xml create mode 100644 reference/ui/ui/draw/entities.matrix.xml create mode 100644 reference/ui/ui/draw/entities.path.xml create mode 100644 reference/ui/ui/draw/entities.pen.xml create mode 100644 reference/ui/ui/draw/entities.stroke.xml create mode 100644 reference/ui/ui/draw/entities.text.xml create mode 100644 reference/ui/ui/draw/matrix/invert.xml create mode 100644 reference/ui/ui/draw/matrix/isinvertible.xml create mode 100644 reference/ui/ui/draw/matrix/multiply.xml create mode 100644 reference/ui/ui/draw/matrix/rotate.xml create mode 100644 reference/ui/ui/draw/matrix/scale.xml create mode 100644 reference/ui/ui/draw/matrix/skew.xml create mode 100644 reference/ui/ui/draw/matrix/translate.xml create mode 100644 reference/ui/ui/draw/path/addrectangle.xml create mode 100644 reference/ui/ui/draw/path/arcto.xml create mode 100644 reference/ui/ui/draw/path/bezierto.xml create mode 100644 reference/ui/ui/draw/path/closefigure.xml create mode 100644 reference/ui/ui/draw/path/construct.xml create mode 100644 reference/ui/ui/draw/path/end.xml create mode 100644 reference/ui/ui/draw/path/lineto.xml create mode 100644 reference/ui/ui/draw/path/newfigure.xml create mode 100644 reference/ui/ui/draw/path/newfigurewitharc.xml create mode 100644 reference/ui/ui/draw/pen/clip.xml create mode 100644 reference/ui/ui/draw/pen/fill.xml create mode 100644 reference/ui/ui/draw/pen/restore.xml create mode 100644 reference/ui/ui/draw/pen/save.xml create mode 100644 reference/ui/ui/draw/pen/stroke.xml create mode 100644 reference/ui/ui/draw/pen/transform.xml create mode 100644 reference/ui/ui/draw/pen/write.xml create mode 100644 reference/ui/ui/draw/stroke/construct.xml create mode 100644 reference/ui/ui/draw/stroke/getcap.xml create mode 100644 reference/ui/ui/draw/stroke/getjoin.xml create mode 100644 reference/ui/ui/draw/stroke/getmiterlimit.xml create mode 100644 reference/ui/ui/draw/stroke/getthickness.xml create mode 100644 reference/ui/ui/draw/stroke/setcap.xml create mode 100644 reference/ui/ui/draw/stroke/setjoin.xml create mode 100644 reference/ui/ui/draw/stroke/setmiterlimit.xml create mode 100644 reference/ui/ui/draw/stroke/setthickness.xml create mode 100644 reference/ui/ui/draw/text/entities.font.descriptor.xml create mode 100644 reference/ui/ui/draw/text/entities.font.xml create mode 100644 reference/ui/ui/draw/text/entities.layout.xml create mode 100644 reference/ui/ui/draw/text/font.descriptor/construct.xml create mode 100644 reference/ui/ui/draw/text/font/construct.xml create mode 100644 reference/ui/ui/draw/text/layout/construct.xml create mode 100644 reference/ui/ui/draw/text/layout/setcolor.xml create mode 100644 reference/ui/ui/draw/text/layout/setwidth.xml create mode 100644 reference/ui/ui/entities.app.xml create mode 100644 reference/ui/ui/entities.area.xml create mode 100644 reference/ui/ui/entities.control.xml create mode 100644 reference/ui/ui/entities.controls.xml create mode 100644 reference/ui/ui/entities.draw.xml create mode 100644 reference/ui/ui/entities.menu.xml create mode 100644 reference/ui/ui/entities.menuitem.xml create mode 100644 reference/ui/ui/entities.point.xml create mode 100644 reference/ui/ui/entities.size.xml create mode 100644 reference/ui/ui/entities.window.xml create mode 100644 reference/ui/ui/menu/append.xml create mode 100644 reference/ui/ui/menu/appendabout.xml create mode 100644 reference/ui/ui/menu/appendcheck.xml create mode 100644 reference/ui/ui/menu/appendpreferences.xml create mode 100644 reference/ui/ui/menu/appendquit.xml create mode 100644 reference/ui/ui/menu/appendseparator.xml create mode 100644 reference/ui/ui/menu/construct.xml create mode 100644 reference/ui/ui/menuitem/disable.xml create mode 100644 reference/ui/ui/menuitem/enable.xml create mode 100644 reference/ui/ui/menuitem/ischecked.xml create mode 100644 reference/ui/ui/menuitem/onclick.xml create mode 100644 reference/ui/ui/menuitem/setchecked.xml create mode 100644 reference/ui/ui/point/construct.xml create mode 100644 reference/ui/ui/point/getx.xml create mode 100644 reference/ui/ui/point/gety.xml create mode 100644 reference/ui/ui/point/setx.xml create mode 100644 reference/ui/ui/point/sety.xml create mode 100644 reference/ui/ui/size/construct.xml create mode 100644 reference/ui/ui/size/getheight.xml create mode 100644 reference/ui/ui/size/getwidth.xml create mode 100644 reference/ui/ui/size/setheight.xml create mode 100644 reference/ui/ui/size/setwidth.xml create mode 100644 reference/ui/ui/window/add.xml create mode 100644 reference/ui/ui/window/construct.xml create mode 100644 reference/ui/ui/window/error.xml create mode 100644 reference/ui/ui/window/getsize.xml create mode 100644 reference/ui/ui/window/gettitle.xml create mode 100644 reference/ui/ui/window/hasborders.xml create mode 100644 reference/ui/ui/window/hasmargin.xml create mode 100644 reference/ui/ui/window/isfullscreen.xml create mode 100644 reference/ui/ui/window/msg.xml create mode 100644 reference/ui/ui/window/onclosing.xml create mode 100644 reference/ui/ui/window/open.xml create mode 100644 reference/ui/ui/window/save.xml create mode 100644 reference/ui/ui/window/setborders.xml create mode 100644 reference/ui/ui/window/setfullscreen.xml create mode 100644 reference/ui/ui/window/setmargin.xml create mode 100644 reference/ui/ui/window/setsize.xml create mode 100644 reference/ui/ui/window/settitle.xml create mode 100644 reference/ui/versions.xml diff --git a/reference/ui/book.developer.xml b/reference/ui/book.developer.xml new file mode 100644 index 0000000000..510b507872 --- /dev/null +++ b/reference/ui/book.developer.xml @@ -0,0 +1,76 @@ + + + + + + + +%xhtml-lat1; +%xhtml-symbol; +%xhtml-special; +%isopub; + + + + + + +%language-defs.default; +%extensions.default; +%language-snippets.default; + + + + + + + + + +%global.entities; +%file.entities; +%frontpage.entities; +]> + + + UI + UI + + + &reftitle.intro; + + + + + + &reference.ui.setup; + &reference.ui.constants; + &reference.ui.examples; + &reference.ui.reference; + + + + + diff --git a/reference/ui/book.xml b/reference/ui/book.xml new file mode 100644 index 0000000000..f731f57118 --- /dev/null +++ b/reference/ui/book.xml @@ -0,0 +1,88 @@ + + + + + UI + UI + + + &reftitle.intro; + + This extension wraps libui to provide an OO API for the cross platform development of native look-and-feel user interfaces . + + + + &reference.ui.setup; + + + &reference.ui.ui.point; + &reference.ui.ui.size; + + &reference.ui.ui.app; + &reference.ui.ui.control; + &reference.ui.ui.window; + &reference.ui.ui.menu; + &reference.ui.ui.menuitem; + &reference.ui.ui.area; + + &reference.ui.ui.controls.tab; + &reference.ui.ui.controls.check; + &reference.ui.ui.controls.button; + &reference.ui.ui.controls.colorbutton; + &reference.ui.ui.controls.label; + &reference.ui.ui.controls.entry; + &reference.ui.ui.controls.multilineentry; + &reference.ui.ui.controls.spin; + &reference.ui.ui.controls.slider; + &reference.ui.ui.controls.progress; + &reference.ui.ui.controls.separator; + &reference.ui.ui.controls.combo; + &reference.ui.ui.controls.editablecombo; + &reference.ui.ui.controls.radio; + &reference.ui.ui.controls.picker; + + &reference.ui.ui.controls.form; + &reference.ui.ui.controls.grid; + &reference.ui.ui.controls.group; + &reference.ui.ui.controls.box; + + &reference.ui.ui.draw.pen; + &reference.ui.ui.draw.path; + &reference.ui.ui.draw.matrix; + &reference.ui.ui.draw.color; + &reference.ui.ui.draw.brush; + &reference.ui.ui.draw.stroke; + + &reference.ui.ui.draw.text.layout; + &reference.ui.ui.draw.text.font; + &reference.ui.ui.draw.text.font.descriptor; + + &reference.ui.reference; + + &reference.ui.ui.draw.text.font.weight; + &reference.ui.ui.draw.text.font.italic; + &reference.ui.ui.draw.text.font.stretch; + &reference.ui.ui.draw.line.cap; + &reference.ui.ui.draw.line.join; + + + diff --git a/reference/ui/configure.xml b/reference/ui/configure.xml new file mode 100644 index 0000000000..fdf622081f --- /dev/null +++ b/reference/ui/configure.xml @@ -0,0 +1,37 @@ + + + +
+ &reftitle.install; + + + Use when compiling PHP. + + + + Windows users should include php_ui.dll into &php.ini; + + +
+ + + diff --git a/reference/ui/constants.xml b/reference/ui/constants.xml new file mode 100644 index 0000000000..5fb05ce541 --- /dev/null +++ b/reference/ui/constants.xml @@ -0,0 +1,28 @@ + + + + + &reftitle.constants; + &no.constants; + + + diff --git a/reference/ui/entities.functions.xml b/reference/ui/entities.functions.xml new file mode 100644 index 0000000000..eb9ce848eb --- /dev/null +++ b/reference/ui/entities.functions.xml @@ -0,0 +1 @@ +&reference.ui.functions.ui.draw.text.font.fontfamilies; diff --git a/reference/ui/entities.ui.xml b/reference/ui/entities.ui.xml new file mode 100644 index 0000000000..bfd27c04e3 --- /dev/null +++ b/reference/ui/entities.ui.xml @@ -0,0 +1,10 @@ +&reference.ui.ui.entities.app; +&reference.ui.ui.entities.area; +&reference.ui.ui.entities.control; +&reference.ui.ui.entities.controls; +&reference.ui.ui.entities.draw; +&reference.ui.ui.entities.menu; +&reference.ui.ui.entities.menuitem; +&reference.ui.ui.entities.point; +&reference.ui.ui.entities.size; +&reference.ui.ui.entities.window; diff --git a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml new file mode 100644 index 0000000000..a167424b23 --- /dev/null +++ b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml @@ -0,0 +1,48 @@ + + + + + + UI\Draw\Text\Font\fontFamilies + Retrieve Font Families + + + + &reftitle.description; + + arrayUI\Draw\Text\Font\fontFamilies + + + + Returns an array of valid font families for the current system + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/reference.xml b/reference/ui/reference.xml new file mode 100644 index 0000000000..7791a1ed35 --- /dev/null +++ b/reference/ui/reference.xml @@ -0,0 +1,30 @@ + + + + + UI &Functions; + + &reference.ui.entities.functions; + + + + diff --git a/reference/ui/setup.xml b/reference/ui/setup.xml new file mode 100644 index 0000000000..363b4a2b2b --- /dev/null +++ b/reference/ui/setup.xml @@ -0,0 +1,45 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + Installation requires libui, and PHP 7. + +
+ +
+ &reftitle.install; + + See libui documentation for pre-requisites. + + + UI is a PECL extension and should be installed using the PECL/pickle installer. + +
+ +
+ + diff --git a/reference/ui/ui.app.xml b/reference/ui/ui.app.xml new file mode 100644 index 0000000000..0a74d33433 --- /dev/null +++ b/reference/ui/ui.app.xml @@ -0,0 +1,67 @@ + + + + + + App + UI\App + + + + +
+ &reftitle.intro; + + The App object represents a libui context, providing methods to enter into, and quit, the main UI loop. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\App + + + + + UI\App + + + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.entities.app; + +
+ + diff --git a/reference/ui/ui.area.xml b/reference/ui/ui.area.xml new file mode 100644 index 0000000000..2a53c169fa --- /dev/null +++ b/reference/ui/ui.area.xml @@ -0,0 +1,159 @@ + + + + + + Area + UI\Area + + + + +
+ &reftitle.intro; + + An Area represents a canvas which can be used to draw, and respond to mouse and key events. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Area + + + + + UI\Area + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Area::Ctrl + + + const + integer + UI\Area::Alt + + + const + integer + UI\Area::Shift + + + const + integer + UI\Area::Super + + + const + integer + UI\Area::Down + + + const + integer + UI\Area::Up + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Area::Ctrl + + Shall be set in the modifiers passed to key and mouse events when the CTRL key is active + + + + + UI\Area::Alt + + Shall be set in the modifiers passed to key and mouse events when the ALT key is active + + + + + UI\Area::Shift + + Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active + + + + + UI\Area::Super + + + + + + + UI\Area::Down + + Shall be set in the modifiers passed to key and mouse events + + + + + UI\Area::Up + + Shall be set in the modifiers passed to key and mouse events + + + + +
+ + + +
+ + &reference.ui.ui.entities.area; + +
+ + diff --git a/reference/ui/ui.control.xml b/reference/ui/ui.control.xml new file mode 100644 index 0000000000..5e0f976487 --- /dev/null +++ b/reference/ui/ui.control.xml @@ -0,0 +1,68 @@ + + + + + + Control + UI\Control + + + + +
+ &reftitle.intro; + + This is the closed base class for all UI Controls. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Control + + + + + final + UI\Control + + + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.entities.control; + +
+ + diff --git a/reference/ui/ui.controls.box.xml b/reference/ui/ui.controls.box.xml new file mode 100644 index 0000000000..8df4c75750 --- /dev/null +++ b/reference/ui/ui.controls.box.xml @@ -0,0 +1,114 @@ + + + + + + Control Box (Arrangement) + UI\Controls\Box + + + + +
+ &reftitle.intro; + + A Box allows the arrangement of other controls + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Box + + + + + UI\Controls\Box + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\Box::Vertical + + + const + integer + UI\Controls\Box::Horizontal + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\Box::Vertical + + + + + + + UI\Controls\Box::Horizontal + + + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.box; + +
+ + diff --git a/reference/ui/ui.controls.button.xml b/reference/ui/ui.controls.button.xml new file mode 100644 index 0000000000..14e1ef332f --- /dev/null +++ b/reference/ui/ui.controls.button.xml @@ -0,0 +1,79 @@ + + + + + + Button Control + UI\Controls\Button + + + + +
+ &reftitle.intro; + + Represents a labelled clickable button + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Button + + + + + UI\Controls\Button + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.button; + +
+ + diff --git a/reference/ui/ui.controls.check.xml b/reference/ui/ui.controls.check.xml new file mode 100644 index 0000000000..807b4f659a --- /dev/null +++ b/reference/ui/ui.controls.check.xml @@ -0,0 +1,79 @@ + + + + + + Check Control + UI\Controls\Check + + + + +
+ &reftitle.intro; + + A Check is a labelled checkable box + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Check + + + + + UI\Controls\Check + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.check; + +
+ + diff --git a/reference/ui/ui.controls.colorbutton.xml b/reference/ui/ui.controls.colorbutton.xml new file mode 100644 index 0000000000..05dfffb2ca --- /dev/null +++ b/reference/ui/ui.controls.colorbutton.xml @@ -0,0 +1,76 @@ + + + + + + ColorButton Control + UI\Controls\ColorButton + + + + +
+ &reftitle.intro; + + A Color Button is a button which displays a color picker when clicked + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\ColorButton + + + + + UI\Controls\ColorButton + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.colorbutton; + +
+ + diff --git a/reference/ui/ui.controls.combo.xml b/reference/ui/ui.controls.combo.xml new file mode 100644 index 0000000000..713ec34947 --- /dev/null +++ b/reference/ui/ui.controls.combo.xml @@ -0,0 +1,76 @@ + + + + + + Combo Control + UI\Controls\Combo + + + + +
+ &reftitle.intro; + + A Combo control represents a list of options, like the familiar select HTML element. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Combo + + + + + UI\Controls\Combo + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.combo; + +
+ + diff --git a/reference/ui/ui.controls.editablecombo.xml b/reference/ui/ui.controls.editablecombo.xml new file mode 100644 index 0000000000..a0ea329133 --- /dev/null +++ b/reference/ui/ui.controls.editablecombo.xml @@ -0,0 +1,76 @@ + + + + + + EdiableCombo Control + UI\Controls\EditableCombo + + + + +
+ &reftitle.intro; + + An Editable Combo is a Combo which allows the user to enter custom options + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\EditableCombo + + + + + UI\Controls\EditableCombo + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.editablecombo; + +
+ + diff --git a/reference/ui/ui.controls.entry.xml b/reference/ui/ui.controls.entry.xml new file mode 100644 index 0000000000..d40273257d --- /dev/null +++ b/reference/ui/ui.controls.entry.xml @@ -0,0 +1,126 @@ + + + + + + Entry Control + UI\Controls\Entry + + + + +
+ &reftitle.intro; + + An Entry is a text entry control, suitable for entering plain text, passwords, or search terms. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Entry + + + + + UI\Controls\Entry + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\Entry::Normal + + + const + integer + UI\Controls\Entry::Password + + + const + integer + UI\Controls\Entry::Search + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\Entry::Normal + + A normal single line entry + + + + + UI\Controls\Entry::Password + + A password entry + + + + + UI\Controls\Entry::Search + + A search entry + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.entry; + +
+ + diff --git a/reference/ui/ui.controls.form.xml b/reference/ui/ui.controls.form.xml new file mode 100644 index 0000000000..4eda84b0a5 --- /dev/null +++ b/reference/ui/ui.controls.form.xml @@ -0,0 +1,76 @@ + + + + + + Control Form (Arrangement) + UI\Controls\Form + + + + +
+ &reftitle.intro; + + A Form is a control which allows the arrangement of other controls into a familiar layout (the form). + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Form + + + + + UI\Controls\Form + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.form; + +
+ + diff --git a/reference/ui/ui.controls.grid.xml b/reference/ui/ui.controls.grid.xml new file mode 100644 index 0000000000..d0a69241a0 --- /dev/null +++ b/reference/ui/ui.controls.grid.xml @@ -0,0 +1,183 @@ + + + + + + Control Grid (Arrangement) + UI\Controls\Grid + + + + +
+ &reftitle.intro; + + A Grid is a control which is allows the arrangement of children into a grid + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Grid + + + + + UI\Controls\Grid + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\Grid::Fill + + + const + integer + UI\Controls\Grid::Start + + + const + integer + UI\Controls\Grid::Center + + + const + integer + UI\Controls\Grid::End + + + const + integer + UI\Controls\Grid::Leading + + + const + integer + UI\Controls\Grid::Top + + + const + integer + UI\Controls\Grid::Trailing + + + const + integer + UI\Controls\Grid::Bottom + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\Grid::Fill + + + + + + + UI\Controls\Grid::Start + + + + + + + UI\Controls\Grid::Center + + + + + + + UI\Controls\Grid::End + + + + + + + UI\Controls\Grid::Leading + + + + + + + UI\Controls\Grid::Top + + + + + + + UI\Controls\Grid::Trailing + + + + + + + UI\Controls\Grid::Bottom + + + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.grid; + +
+ + diff --git a/reference/ui/ui.controls.group.xml b/reference/ui/ui.controls.group.xml new file mode 100644 index 0000000000..c327ddfce1 --- /dev/null +++ b/reference/ui/ui.controls.group.xml @@ -0,0 +1,79 @@ + + + + + + Control Group (Arrangement) + UI\Controls\Group + + + + +
+ &reftitle.intro; + + A Group is a titled container for child controls + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Group + + + + + UI\Controls\Group + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.group; + +
+ + diff --git a/reference/ui/ui.controls.label.xml b/reference/ui/ui.controls.label.xml new file mode 100644 index 0000000000..5a4fbcdd00 --- /dev/null +++ b/reference/ui/ui.controls.label.xml @@ -0,0 +1,79 @@ + + + + + + Label Control + UI\Controls\Label + + + + +
+ &reftitle.intro; + + A Label is a single line of text, meant to identify, for the user, some element of the interface. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Label + + + + + UI\Controls\Label + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.label; + +
+ + diff --git a/reference/ui/ui.controls.multilineentry.xml b/reference/ui/ui.controls.multilineentry.xml new file mode 100644 index 0000000000..d0a446493c --- /dev/null +++ b/reference/ui/ui.controls.multilineentry.xml @@ -0,0 +1,114 @@ + + + + + + MultilineEntry Control + UI\Controls\MultilineEntry + + + + +
+ &reftitle.intro; + + A Multiline Entry is a text entry control able to hold multiple lines of text, with or without wrapping. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\MultilineEntry + + + + + UI\Controls\MultilineEntry + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\MultilineEntry::Wrap + + + const + integer + UI\Controls\MultilineEntry::NoWrap + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\MultilineEntry::Wrap + + Allow lines to wrap + + + + + UI\Controls\MultilineEntry::NoWrap + + Do not allow lines to wrap + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.multilineentry; + +
+ + diff --git a/reference/ui/ui.controls.picker.xml b/reference/ui/ui.controls.picker.xml new file mode 100644 index 0000000000..7627f2735c --- /dev/null +++ b/reference/ui/ui.controls.picker.xml @@ -0,0 +1,123 @@ + + + + + + Picker Control + UI\Controls\Picker + + + + +
+ &reftitle.intro; + + A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker interface to the user. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Picker + + + + + UI\Controls\Picker + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\Picker::Date + + + const + integer + UI\Controls\Picker::Time + + + const + integer + UI\Controls\Picker::DateTime + + + Constructor + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\Picker::Date + + A Date Picker + + + + + UI\Controls\Picker::Time + + A Time Picker + + + + + UI\Controls\Picker::DateTime + + A Date and Time Picker + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.picker; + +
+ + diff --git a/reference/ui/ui.controls.progress.xml b/reference/ui/ui.controls.progress.xml new file mode 100644 index 0000000000..0a73ffb15a --- /dev/null +++ b/reference/ui/ui.controls.progress.xml @@ -0,0 +1,76 @@ + + + + + + Progress Control + UI\Controls\Progress + + + + +
+ &reftitle.intro; + + A Progress control is a familiar Progress bar: It represents progress as a percentage, with a possible range of 0 to 100 (inclusive). + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Progress + + + + + UI\Controls\Progress + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.progress; + +
+ + diff --git a/reference/ui/ui.controls.radio.xml b/reference/ui/ui.controls.radio.xml new file mode 100644 index 0000000000..a5e5ef3a94 --- /dev/null +++ b/reference/ui/ui.controls.radio.xml @@ -0,0 +1,76 @@ + + + + + + Radio Control + UI\Controls\Radio + + + + +
+ &reftitle.intro; + + A Radio is similar to the radio input type familiar from HTML + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Radio + + + + + UI\Controls\Radio + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.radio; + +
+ + diff --git a/reference/ui/ui.controls.separator.xml b/reference/ui/ui.controls.separator.xml new file mode 100644 index 0000000000..05343b4611 --- /dev/null +++ b/reference/ui/ui.controls.separator.xml @@ -0,0 +1,111 @@ + + + + + + Control Separator + UI\Controls\Separator + + + + +
+ &reftitle.intro; + + A Separator represents a control separator, it has no other function. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Separator + + + + + UI\Controls\Separator + + + + extends + UI\Control + + + + Constants + + const + integer + UI\Controls\Separator::Horizontal + + + const + integer + UI\Controls\Separator::Vertical + + + Constructor + + + &InheritedMethods; + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Controls\Separator::Horizontal + + A Horizontal Separator + + + + + UI\Controls\Separator::Vertical + + A Vertical Separator + + + + +
+ + + +
+ + &reference.ui.ui.controls.entities.separator; + +
+ + diff --git a/reference/ui/ui.controls.slider.xml b/reference/ui/ui.controls.slider.xml new file mode 100644 index 0000000000..37f24f7f5e --- /dev/null +++ b/reference/ui/ui.controls.slider.xml @@ -0,0 +1,79 @@ + + + + + + Slider Control + UI\Controls\Slider + + + + +
+ &reftitle.intro; + + A Slider is a control which represents a range, and a current value in the range. The sliding element of the control (sometimes called the "thumb") reflects the value, and can be adjusted within the range. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Slider + + + + + UI\Controls\Slider + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.slider; + +
+ + diff --git a/reference/ui/ui.controls.spin.xml b/reference/ui/ui.controls.spin.xml new file mode 100644 index 0000000000..638aea60df --- /dev/null +++ b/reference/ui/ui.controls.spin.xml @@ -0,0 +1,79 @@ + + + + + + Spin Control + UI\Controls\Spin + + + + +
+ &reftitle.intro; + + A Spin box is a text box with an up-down control which changes the integer value in the box, within a defined range + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Spin + + + + + UI\Controls\Spin + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.spin; + +
+ + diff --git a/reference/ui/ui.controls.tab.xml b/reference/ui/ui.controls.tab.xml new file mode 100644 index 0000000000..719bf1048f --- /dev/null +++ b/reference/ui/ui.controls.tab.xml @@ -0,0 +1,76 @@ + + + + + + Tab Control + UI\Controls\Tab + + + + +
+ &reftitle.intro; + + A Tab can contain many pages of Controls, each with a title, each selectable by the user. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Controls\Tab + + + + + UI\Controls\Tab + + + + extends + UI\Control + + + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.controls.entities.tab; + +
+ + diff --git a/reference/ui/ui.draw.brush.xml b/reference/ui/ui.draw.brush.xml new file mode 100644 index 0000000000..cc8779e9fc --- /dev/null +++ b/reference/ui/ui.draw.brush.xml @@ -0,0 +1,129 @@ + + + + + + Draw Brush + UI\Draw\Brush + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Brush + + + + + UI\Draw\Brush + + + + Constants + + const + integer + UI\Draw\Brush::Solid + + + const + integer + UI\Draw\Brush::LinearGradient + + + const + integer + UI\Draw\Brush::RadialGradient + + + const + integer + UI\Draw\Brush::Image + + + Constructor + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Brush::Solid + + A solid brush + + + + + UI\Draw\Brush::LinearGradient + + A brush with a linear gradient + + + + + UI\Draw\Brush::RadialGradient + + A brush with a radial gradient + + + + + UI\Draw\Brush::Image + + An image brush + + + + +
+ + + +
+ + &reference.ui.ui.draw.entities.brush; + +
+ + diff --git a/reference/ui/ui.draw.color.xml b/reference/ui/ui.draw.color.xml new file mode 100644 index 0000000000..c6783b7b81 --- /dev/null +++ b/reference/ui/ui.draw.color.xml @@ -0,0 +1,129 @@ + + + + + + Draw Color + UI\Draw\Color + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Color + + + + + UI\Draw\Color + + + + Constants + + const + integer + UI\Draw\Color::Red + + + const + integer + UI\Draw\Color::Green + + + const + integer + UI\Draw\Color::Blue + + + const + integer + UI\Draw\Color::Alpha + + + Constructor + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Color::Red + + Represents the red channel + + + + + UI\Draw\Color::Green + + Represents the green channel + + + + + UI\Draw\Color::Blue + + Represents the blue channel + + + + + UI\Draw\Color::Alpha + + Represents the alpha channel + + + + +
+ + + +
+ + &reference.ui.ui.draw.entities.color; + +
+ + diff --git a/reference/ui/ui.draw.line.cap.xml b/reference/ui/ui.draw.line.cap.xml new file mode 100644 index 0000000000..4e301763c3 --- /dev/null +++ b/reference/ui/ui.draw.line.cap.xml @@ -0,0 +1,111 @@ + + + + + + Line Cap Settings + UI\Draw\Line\Cap + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Line\Cap + + + + + final + UI\Draw\Line\Cap + + + + Constants + + const + integer + UI\Draw\Line\Cap::Flat + + + const + integer + UI\Draw\Line\Cap::Round + + + const + integer + UI\Draw\Line\Cap::Square + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Line\Cap::Flat + + + + + + + UI\Draw\Line\Cap::Round + + + + + + + UI\Draw\Line\Cap::Square + + + + + + +
+ + + +
+ +
+ + diff --git a/reference/ui/ui.draw.line.join.xml b/reference/ui/ui.draw.line.join.xml new file mode 100644 index 0000000000..980f1c4bef --- /dev/null +++ b/reference/ui/ui.draw.line.join.xml @@ -0,0 +1,111 @@ + + + + + + Line Join Settings + UI\Draw\Line\Join + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Line\Join + + + + + final + UI\Draw\Line\Join + + + + Constants + + const + integer + UI\Draw\Line\Join::Miter + + + const + integer + UI\Draw\Line\Join::Round + + + const + integer + UI\Draw\Line\Join::Bevel + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Line\Join::Miter + + + + + + + UI\Draw\Line\Join::Round + + + + + + + UI\Draw\Line\Join::Bevel + + + + + + +
+ + + +
+ +
+ + diff --git a/reference/ui/ui.draw.matrix.xml b/reference/ui/ui.draw.matrix.xml new file mode 100644 index 0000000000..d2ef3f66de --- /dev/null +++ b/reference/ui/ui.draw.matrix.xml @@ -0,0 +1,67 @@ + + + + + + Draw Matrix + UI\Draw\Matrix + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Matrix + + + + + UI\Draw\Matrix + + + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.draw.entities.matrix; + +
+ + diff --git a/reference/ui/ui.draw.path.xml b/reference/ui/ui.draw.path.xml new file mode 100644 index 0000000000..c836a72b9f --- /dev/null +++ b/reference/ui/ui.draw.path.xml @@ -0,0 +1,109 @@ + + + + + + Draw Path + UI\Draw\Path + + + + +
+ &reftitle.intro; + + A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Path + + + + + UI\Draw\Path + + + + Constants + + const + integer + UI\Draw\Path::Winding + + + const + integer + UI\Draw\Path::Alternate + + + Constructor + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Path::Winding + + + This is the default draw path mode + + + + + + UI\Draw\Path::Alternate + + + This is the alternate draw path mode + + + + + +
+ + + +
+ + &reference.ui.ui.draw.entities.path; + +
+ + diff --git a/reference/ui/ui.draw.pen.xml b/reference/ui/ui.draw.pen.xml new file mode 100644 index 0000000000..2f8174ed19 --- /dev/null +++ b/reference/ui/ui.draw.pen.xml @@ -0,0 +1,68 @@ + + + + + + Draw Pen + UI\Draw\Pen + + + + +
+ &reftitle.intro; + + The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and writing to Draw Paths. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Pen + + + + + final + UI\Draw\Pen + + + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.draw.entities.pen; + +
+ + diff --git a/reference/ui/ui.draw.stroke.xml b/reference/ui/ui.draw.stroke.xml new file mode 100644 index 0000000000..8baf0d41f2 --- /dev/null +++ b/reference/ui/ui.draw.stroke.xml @@ -0,0 +1,70 @@ + + + + + + Draw Stroke + UI\Draw\Stroke + + + + +
+ &reftitle.intro; + + Holds the configuration for the Pen to perform a stroke + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Stroke + + + + + UI\Draw\Stroke + + + + + Constructor + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.draw.entities.stroke; + +
+ + diff --git a/reference/ui/ui.draw.text.font.descriptor.xml b/reference/ui/ui.draw.text.font.descriptor.xml new file mode 100644 index 0000000000..f6ba7525dc --- /dev/null +++ b/reference/ui/ui.draw.text.font.descriptor.xml @@ -0,0 +1,66 @@ + + + + + + Font Descriptor + UI\Draw\Text\Font\Descriptor + + + + +
+ &reftitle.intro; + + A font descriptor is load to use the closest font matching some criteria + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Font\Descriptor + + + + + UI\Draw\Text\Font\Descriptor + + + + + Constructor + + + +
+ +
+ + &reference.ui.ui.draw.text.entities.font.descriptor; + +
+ + diff --git a/reference/ui/ui.draw.text.font.italic.xml b/reference/ui/ui.draw.text.font.italic.xml new file mode 100644 index 0000000000..f530653abf --- /dev/null +++ b/reference/ui/ui.draw.text.font.italic.xml @@ -0,0 +1,114 @@ + + + + + + Italic Font Settings + UI\Draw\Text\Font\Italic + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Font\Italic + + + + + final + UI\Draw\Text\Font\Italic + + + + Constants + + const + integer + UI\Draw\Text\Font\Italic::Normal + 0 + + + const + integer + UI\Draw\Text\Font\Italic::Oblique + 1 + + + const + integer + UI\Draw\Text\Font\Italic::Italic + 2 + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Text\Font\Italic::Normal + + + + + + + UI\Draw\Text\Font\Italic::Oblique + + + + + + + UI\Draw\Text\Font\Italic::Italic + + + + + + +
+ + + +
+ +
+ + diff --git a/reference/ui/ui.draw.text.font.stretch.xml b/reference/ui/ui.draw.text.font.stretch.xml new file mode 100644 index 0000000000..07fb90214f --- /dev/null +++ b/reference/ui/ui.draw.text.font.stretch.xml @@ -0,0 +1,192 @@ + + + + + + Font Stretch Settings + UI\Draw\Text\Font\Stretch + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Font\Stretch + + + + + final + UI\Draw\Text\Font\Stretch + + + + Constants + + const + integer + UI\Draw\Text\Font\Stretch::UltraCondensed + 0 + + + const + integer + UI\Draw\Text\Font\Stretch::ExtraCondensed + 1 + + + const + integer + UI\Draw\Text\Font\Stretch::Condensed + 2 + + + const + integer + UI\Draw\Text\Font\Stretch::SemiCondensed + 3 + + + const + integer + UI\Draw\Text\Font\Stretch::Normal + 4 + + + const + integer + UI\Draw\Text\Font\Stretch::SemiExpanded + 5 + + + const + integer + UI\Draw\Text\Font\Stretch::Expanded + 6 + + + const + integer + UI\Draw\Text\Font\Stretch::ExtraExpanded + 7 + + + const + integer + UI\Draw\Text\Font\Stretch::UltraExpanded + 8 + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Text\Font\Stretch::UltraCondensed + + + + + + + UI\Draw\Text\Font\Stretch::ExtraCondensed + + + + + + + UI\Draw\Text\Font\Stretch::Condensed + + + + + + + UI\Draw\Text\Font\Stretch::SemiCondensed + + + + + + + UI\Draw\Text\Font\Stretch::Normal + + + + + + + UI\Draw\Text\Font\Stretch::SemiExpanded + + + + + + + UI\Draw\Text\Font\Stretch::Expanded + + + + + + + UI\Draw\Text\Font\Stretch::ExtraExpanded + + + + + + + UI\Draw\Text\Font\Stretch::UltraExpanded + + + + + + +
+ + + +
+ +
+ + diff --git a/reference/ui/ui.draw.text.font.weight.xml b/reference/ui/ui.draw.text.font.weight.xml new file mode 100644 index 0000000000..33b637fec1 --- /dev/null +++ b/reference/ui/ui.draw.text.font.weight.xml @@ -0,0 +1,207 @@ + + + + + + Font Weight Settings + UI\Draw\Text\Font\Weight + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Font\Weight + + + + + final + UI\Draw\Text\Font\Weight + + + + Constants + + const + integer + UI\Draw\Text\Font\Weight::Thin + + + const + integer + UI\Draw\Text\Font\Weight::UltraLight + + + const + integer + UI\Draw\Text\Font\Weight::Light + + + const + integer + UI\Draw\Text\Font\Weight::Book + + + const + integer + UI\Draw\Text\Font\Weight::Normal + + + const + integer + UI\Draw\Text\Font\Weight::Medium + + + const + integer + UI\Draw\Text\Font\Weight::SemiBold + + + const + integer + UI\Draw\Text\Font\Weight::Bold + + + const + integer + UI\Draw\Text\Font\Weight::UltraBold + + + const + integer + UI\Draw\Text\Font\Weight::Heavy + + + const + integer + UI\Draw\Text\Font\Weight::UltraHeavy + + + + + +
+ + +
+ &reftitle.constants; + + + + UI\Draw\Text\Font\Weight::Thin + + + + + + + UI\Draw\Text\Font\Weight::UltraLight + + + + + + + UI\Draw\Text\Font\Weight::Light + + + + + + + UI\Draw\Text\Font\Weight::Book + + + + + + + UI\Draw\Text\Font\Weight::Normal + + + + + + + UI\Draw\Text\Font\Weight::Medium + + + + + + + UI\Draw\Text\Font\Weight::SemiBold + + + + + + + UI\Draw\Text\Font\Weight::Bold + + + + + + + UI\Draw\Text\Font\Weight::UltraBold + + + + + + + UI\Draw\Text\Font\Weight::Heavy + + + + + + + UI\Draw\Text\Font\Weight::UltraHeavy + + + + + + +
+ + + +
+ +
+ + diff --git a/reference/ui/ui.draw.text.font.xml b/reference/ui/ui.draw.text.font.xml new file mode 100644 index 0000000000..43f68bc4cf --- /dev/null +++ b/reference/ui/ui.draw.text.font.xml @@ -0,0 +1,68 @@ + + + + + + Represents a Font + UI\Draw\Text\Font + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Font + + + + + UI\Draw\Text\Font + + + + + Constructor + + + + + +
+ +
+ + &reference.ui.ui.draw.text.entities.font; + +
+ + diff --git a/reference/ui/ui.draw.text.layout.xml b/reference/ui/ui.draw.text.layout.xml new file mode 100644 index 0000000000..32ff7c759b --- /dev/null +++ b/reference/ui/ui.draw.text.layout.xml @@ -0,0 +1,70 @@ + + + + + + Represents Text Layout + UI\Draw\Text\Layout + + + + +
+ &reftitle.intro; + + A Text Layout represents the layout of text which will be drawn by the Pen + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Draw\Text\Layout + + + + + UI\Draw\Text\Layout + + + + + Constructor + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.draw.text.entities.layout; + +
+ + diff --git a/reference/ui/ui.menu.xml b/reference/ui/ui.menu.xml new file mode 100644 index 0000000000..fb58423ceb --- /dev/null +++ b/reference/ui/ui.menu.xml @@ -0,0 +1,70 @@ + + + + + + Menu + UI\Menu + + + + +
+ &reftitle.intro; + + Menus must be constructed before the first Window, and can be shown on any Window + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Menu + + + + + UI\Menu + + + + + Constructor + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.entities.menu; + +
+ + diff --git a/reference/ui/ui.menuitem.xml b/reference/ui/ui.menuitem.xml new file mode 100644 index 0000000000..24eb87bed8 --- /dev/null +++ b/reference/ui/ui.menuitem.xml @@ -0,0 +1,67 @@ + + + + + + Menu Item + UI\MenuItem + + + + +
+ &reftitle.intro; + + Menu Items should only be created by the Menu + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\MenuItem + + + + + UI\MenuItem + + + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.entities.menuitem; + +
+ + diff --git a/reference/ui/ui.point.xml b/reference/ui/ui.point.xml new file mode 100644 index 0000000000..dde4528ef4 --- /dev/null +++ b/reference/ui/ui.point.xml @@ -0,0 +1,106 @@ + + + + + + Represents a position (x,y) + UI\Point + + + + +
+ &reftitle.intro; + + Points are used throughout UI to represent co-ordinates on a screen, control, or area. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Point + + + + + final + UI\Point + + + + &Properties; + + public + x + + + public + y + + + Constructor + + + &Methods; + + + + +
+ + + +
+ &reftitle.properties; + + + x + + + Holds the X co-ordinate, can be read/written directly + + + + + y + + + Holds the Y co-ordinate, can be read/written directly + + + + +
+ + + +
+ + &reference.ui.ui.entities.point; + +
+ + diff --git a/reference/ui/ui.size.xml b/reference/ui/ui.size.xml new file mode 100644 index 0000000000..bad446d051 --- /dev/null +++ b/reference/ui/ui.size.xml @@ -0,0 +1,71 @@ + + + + + + Represents dimenstions (width, height) + UI\Size + + + + +
+ &reftitle.intro; + + Sizes are used throughout UI to represent the size of a screen, control, or area. + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Size + + + + + final + UI\Size + + + + + Constructor + + + &Methods; + + + + +
+ +
+ + &reference.ui.ui.entities.size; + +
+ + diff --git a/reference/ui/ui.window.xml b/reference/ui/ui.window.xml new file mode 100644 index 0000000000..be6714959d --- /dev/null +++ b/reference/ui/ui.window.xml @@ -0,0 +1,79 @@ + + + + + + Window + UI\Window + + + + +
+ &reftitle.intro; + + Represents a UI Window + +
+ + +
+ &reftitle.classsynopsis; + + + + UI\Window + + + + + UI\Window + + + + extends + UI\Control + + + + + Constructor + + + &Methods; + + + &InheritedMethods; + + + + + +
+ +
+ + &reference.ui.ui.entities.window; + +
+ + diff --git a/reference/ui/ui/app/onshouldquit.xml b/reference/ui/ui/app/onshouldquit.xml new file mode 100644 index 0000000000..ffa262419b --- /dev/null +++ b/reference/ui/ui/app/onshouldquit.xml @@ -0,0 +1,65 @@ + + + + + + UI\App::onShouldQuit + Should Quit Callback + + + + &reftitle.description; + + protected integerUI\App::onShouldQuit + arraywindows + + + Should be called when the application is forced to quit + + + + + + &reftitle.parameters; + + + windows + + + All of the windows created for this App + + + + + + + + &reftitle.returnvalues; + + Should return ... + + + + + + + diff --git a/reference/ui/ui/app/quit.xml b/reference/ui/ui/app/quit.xml new file mode 100644 index 0000000000..c8cf731774 --- /dev/null +++ b/reference/ui/ui/app/quit.xml @@ -0,0 +1,56 @@ + + + + + + UI\App::quit + Quit Application + + + + &reftitle.description; + + public UI\App::quit + + + + Will cause the App to return from the main loop + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/app/run.xml b/reference/ui/ui/app/run.xml new file mode 100644 index 0000000000..f0e798b5d8 --- /dev/null +++ b/reference/ui/ui/app/run.xml @@ -0,0 +1,74 @@ + + + + + + UI\App::run + Run Application + + + + &reftitle.description; + + public UI\App::run + booleanloop + booleanblock + + + Will cause the App to enter into the main loop, by default control will not be returned to the caller + + + + + + &reftitle.parameters; + + + loop + + + Should be true if the calling script requires control to be returned so that it may loop + + + + + block + + + Used when loop is true to determine if the call to run should block + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/area/ondraw.xml b/reference/ui/ui/area/ondraw.xml new file mode 100644 index 0000000000..f971e9ef3f --- /dev/null +++ b/reference/ui/ui/area/ondraw.xml @@ -0,0 +1,84 @@ + + + + + + UI\Area::onDraw + Draw Callback + + + + &reftitle.description; + + protected UI\Area::onDraw + UI\Draw\Penpen + UI\SizeareaSize + UI\PointclipPoint + UI\SizeclipSize + + + Shall be invoked when this Area requires redrawing + + + + + + &reftitle.parameters; + + + pen + + + A Pen suitable for drawing in this Area + + + + + areaSize + + + The size of the Area + + + + + clipPoint + + + The clip point of the Area + + + + + clipSize + + + The clip size of the Area + + + + + + + + + diff --git a/reference/ui/ui/area/onkey.xml b/reference/ui/ui/area/onkey.xml new file mode 100644 index 0000000000..2f95ee4ba6 --- /dev/null +++ b/reference/ui/ui/area/onkey.xml @@ -0,0 +1,83 @@ + + + + + + UI\Area::onKey + Key Callback + + + + &reftitle.description; + + protected UI\Area::onKey + stringkey + integerext + integerflags + + + Shall be executed on key events + + + + + + &reftitle.parameters; + + + key + + + The key pressed + + + + + ext + + + The extended key pressed + + + + + flags + + + Event modifiers + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/area/onmouse.xml b/reference/ui/ui/area/onmouse.xml new file mode 100644 index 0000000000..6408d4c631 --- /dev/null +++ b/reference/ui/ui/area/onmouse.xml @@ -0,0 +1,75 @@ + + + + + + UI\Area::onMouse + Mouse Callback + + + + &reftitle.description; + + protected UI\Area::onMouse + UI\PointareaPoint + UI\SizeareaSize + integerflags + + + Shall be executed on mouse events + + + + + + &reftitle.parameters; + + + areaPoint + + + The co-ordinates of the event + + + + + areaSize + + + The size of the area of the event + + + + + flags + + + Event modifiers + + + + + + + + + diff --git a/reference/ui/ui/area/redraw.xml b/reference/ui/ui/area/redraw.xml new file mode 100644 index 0000000000..9fb70ec27a --- /dev/null +++ b/reference/ui/ui/area/redraw.xml @@ -0,0 +1,56 @@ + + + + + + UI\Area::redraw + Redraw Area + + + + &reftitle.description; + + public UI\Area::redraw + + + + Requests that this Area is redrawn + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/area/scrollto.xml b/reference/ui/ui/area/scrollto.xml new file mode 100644 index 0000000000..43ef2d991b --- /dev/null +++ b/reference/ui/ui/area/scrollto.xml @@ -0,0 +1,66 @@ + + + + + + UI\Area::scrollTo + Area Scroll + + + + &reftitle.description; + + public UI\Area::scrollTo + UI\Pointpoint + UI\Sizesize + + + Scroll this Area + + + + + + &reftitle.parameters; + + + point + + + The point to scroll to + + + + + size + + + The size of the scroll pane + + + + + + + + + diff --git a/reference/ui/ui/area/setsize.xml b/reference/ui/ui/area/setsize.xml new file mode 100644 index 0000000000..49d734b23e --- /dev/null +++ b/reference/ui/ui/area/setsize.xml @@ -0,0 +1,58 @@ + + + + + + UI\Area::setSize + Set Size + + + + &reftitle.description; + + public UI\Area::setSize + UI\Sizesize + + + Sets the size of this Area + + + + + + &reftitle.parameters; + + + size + + + The new size + + + + + + + + + + diff --git a/reference/ui/ui/control/destroy.xml b/reference/ui/ui/control/destroy.xml new file mode 100644 index 0000000000..0dfe346966 --- /dev/null +++ b/reference/ui/ui/control/destroy.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::destroy + Destroy Control + + + + &reftitle.description; + + public UI\Control::destroy + + + + Shall destroy this Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/disable.xml b/reference/ui/ui/control/disable.xml new file mode 100644 index 0000000000..b1df41f497 --- /dev/null +++ b/reference/ui/ui/control/disable.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::disable + Disable Control + + + + &reftitle.description; + + public UI\Control::disable + + + + Shall disable this Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/enable.xml b/reference/ui/ui/control/enable.xml new file mode 100644 index 0000000000..907ebc1ce8 --- /dev/null +++ b/reference/ui/ui/control/enable.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::enable + Enable Control + + + + &reftitle.description; + + public UI\Control::enable + + + + Shall enable this Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/getparent.xml b/reference/ui/ui/control/getparent.xml new file mode 100644 index 0000000000..3945071b0d --- /dev/null +++ b/reference/ui/ui/control/getparent.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::getParent + Get Parent Control + + + + &reftitle.description; + + public UI\ControlUI\Control::getParent + + + + Shall return the parent Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/gettoplevel.xml b/reference/ui/ui/control/gettoplevel.xml new file mode 100644 index 0000000000..0fa6de8a43 --- /dev/null +++ b/reference/ui/ui/control/gettoplevel.xml @@ -0,0 +1,58 @@ + + + + + + UI\Control::getTopLevel + Get Top Level + + + + &reftitle.description; + + public intUI\Control::getTopLevel + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/hide.xml b/reference/ui/ui/control/hide.xml new file mode 100644 index 0000000000..b8dd6da8cb --- /dev/null +++ b/reference/ui/ui/control/hide.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::hide + Hide Control + + + + &reftitle.description; + + public UI\Control::hide + + + + Shall hide this Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/isenabled.xml b/reference/ui/ui/control/isenabled.xml new file mode 100644 index 0000000000..07a33918b0 --- /dev/null +++ b/reference/ui/ui/control/isenabled.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::isEnabled + Determine if Control is enabled + + + + &reftitle.description; + + public boolUI\Control::isEnabled + + + + Shall detect if this Control is enabled + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/isvisible.xml b/reference/ui/ui/control/isvisible.xml new file mode 100644 index 0000000000..0d7d70428e --- /dev/null +++ b/reference/ui/ui/control/isvisible.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::isVisible + Determine if Control is visible + + + + &reftitle.description; + + public boolUI\Control::isVisible + + + + Shall detect if this Control is visible + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/setparent.xml b/reference/ui/ui/control/setparent.xml new file mode 100644 index 0000000000..851a728e2a --- /dev/null +++ b/reference/ui/ui/control/setparent.xml @@ -0,0 +1,65 @@ + + + + + + UI\Control::setParent + Set Parent Control + + + + &reftitle.description; + + public UI\Control::setParent + UI\Controlparent + + + Shall set the parent Control of this Control + + + + + + &reftitle.parameters; + + + parent + + + The parent Control + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/control/show.xml b/reference/ui/ui/control/show.xml new file mode 100644 index 0000000000..8fe37f6d1f --- /dev/null +++ b/reference/ui/ui/control/show.xml @@ -0,0 +1,56 @@ + + + + + + UI\Control::show + Control Show + + + + &reftitle.description; + + public UI\Control::show + + + + Shall show this Control + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/box/append.xml b/reference/ui/ui/controls/box/append.xml new file mode 100644 index 0000000000..8c3589afd1 --- /dev/null +++ b/reference/ui/ui/controls/box/append.xml @@ -0,0 +1,67 @@ + + + + + + UI\Controls\Box::append + Append Control + + + + &reftitle.description; + + public UI\Controls\Box::append + Controlcontrol + booleanstretchyfalse + + + Shall append the given control to this Box + + + + + + &reftitle.parameters; + + + control + + + The control to append + + + + + stretchy + + + Set true to stretch the control + + + + + + + + + + diff --git a/reference/ui/ui/controls/box/construct.xml b/reference/ui/ui/controls/box/construct.xml new file mode 100644 index 0000000000..06332f4f2a --- /dev/null +++ b/reference/ui/ui/controls/box/construct.xml @@ -0,0 +1,59 @@ + + + + + + UI\Controls\Box::__construct + Construct a new Box + + + + &reftitle.description; + + public UI\Controls\Box::__construct + integerorientationUI\Controls\Box::Horizontal + + + Shall construct a new box + + + + + + &reftitle.parameters; + + + orientation + + + Box::Horizontal or Box::Vertical + + + + + + + + + + + diff --git a/reference/ui/ui/controls/box/delete.xml b/reference/ui/ui/controls/box/delete.xml new file mode 100644 index 0000000000..9795e00b53 --- /dev/null +++ b/reference/ui/ui/controls/box/delete.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Box::delete + Delete Control + + + + &reftitle.description; + + public UI\Controls\Box::delete + integerindex + + + Shall delete the control at the given index from this Box + + + + + + &reftitle.parameters; + + + index + + + The index of the control to delete + + + + + + + + + + diff --git a/reference/ui/ui/controls/box/getorientation.xml b/reference/ui/ui/controls/box/getorientation.xml new file mode 100644 index 0000000000..857888487f --- /dev/null +++ b/reference/ui/ui/controls/box/getorientation.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\Box::getOrientation + Get Orientation + + + + &reftitle.description; + + public integerUI\Controls\Box::getOrientation + + + + Shall retrieve the orientation of this Box + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/box/ispadded.xml b/reference/ui/ui/controls/box/ispadded.xml new file mode 100644 index 0000000000..beb15d6a40 --- /dev/null +++ b/reference/ui/ui/controls/box/ispadded.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Box::isPadded + Padding Detection + + + + &reftitle.description; + + public boolUI\Controls\Box::isPadded + + + + Shall detect if padding is enabled on this Box + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/box/setpadded.xml b/reference/ui/ui/controls/box/setpadded.xml new file mode 100644 index 0000000000..10e4b4423b --- /dev/null +++ b/reference/ui/ui/controls/box/setpadded.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Box::setPadded + Set Padding + + + + &reftitle.description; + + public UI\Controls\Box::setPadded + booleanpadded + + + Shall enable or disable padding on this Box + + + + + + &reftitle.parameters; + + + padded + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/button/construct.xml b/reference/ui/ui/controls/button/construct.xml new file mode 100644 index 0000000000..36dcb48dd1 --- /dev/null +++ b/reference/ui/ui/controls/button/construct.xml @@ -0,0 +1,59 @@ + + + + + + UI\Controls\Button::__construct + Construct a new Button + + + + &reftitle.description; + + public UI\Controls\Button::__construct + stringtext + + + Shall construct a new Button + + + + + + &reftitle.parameters; + + + text + + + The text (label) for this Button + + + + + + + + + + + diff --git a/reference/ui/ui/controls/button/gettext.xml b/reference/ui/ui/controls/button/gettext.xml new file mode 100644 index 0000000000..fda90a4e6f --- /dev/null +++ b/reference/ui/ui/controls/button/gettext.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Button::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\Button::getText + + + + Shall retrieve the text (label) for this Button + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current text (label) + + + + + + + diff --git a/reference/ui/ui/controls/button/onclick.xml b/reference/ui/ui/controls/button/onclick.xml new file mode 100644 index 0000000000..6fdf9ce4d4 --- /dev/null +++ b/reference/ui/ui/controls/button/onclick.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\Button::onClick + Click Handler + + + + &reftitle.description; + + protected UI\Controls\Button::onClick + + + + Shall be executed when this Button is clicked + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/button/settext.xml b/reference/ui/ui/controls/button/settext.xml new file mode 100644 index 0000000000..6604cddd9d --- /dev/null +++ b/reference/ui/ui/controls/button/settext.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Button::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\Button::setText + stringtext + + + Shall set the text (label) for this Button + + + + + + &reftitle.parameters; + + + text + + + The new text (label) + + + + + + + + + diff --git a/reference/ui/ui/controls/check/construct.xml b/reference/ui/ui/controls/check/construct.xml new file mode 100644 index 0000000000..600c1e9aeb --- /dev/null +++ b/reference/ui/ui/controls/check/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Check::__construct + Construct a new Check + + + + &reftitle.description; + + public UI\Controls\Check::__construct + stringtext + + + Shall construct a new Check + + + + + + &reftitle.parameters; + + + text + + + The text (label) for the Check box + + + + + + + + + diff --git a/reference/ui/ui/controls/check/gettext.xml b/reference/ui/ui/controls/check/gettext.xml new file mode 100644 index 0000000000..4856d3daf3 --- /dev/null +++ b/reference/ui/ui/controls/check/gettext.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Check::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\Check::getText + + + + Shall return the text (label) for this Check + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current text (label) + + + + + + + diff --git a/reference/ui/ui/controls/check/ischecked.xml b/reference/ui/ui/controls/check/ischecked.xml new file mode 100644 index 0000000000..1c35432049 --- /dev/null +++ b/reference/ui/ui/controls/check/ischecked.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Check::isChecked + Checked Detection + + + + &reftitle.description; + + public boolUI\Controls\Check::isChecked + + + + Shall detect the status of this Check + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/check/ontoggle.xml b/reference/ui/ui/controls/check/ontoggle.xml new file mode 100644 index 0000000000..aa2e59effe --- /dev/null +++ b/reference/ui/ui/controls/check/ontoggle.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Check::onToggle + Toggle Callback + + + + &reftitle.description; + + protected UI\Controls\Check::onToggle + + + + Shall be executed when the status of this Check is changed + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/check/setchecked.xml b/reference/ui/ui/controls/check/setchecked.xml new file mode 100644 index 0000000000..85351f3652 --- /dev/null +++ b/reference/ui/ui/controls/check/setchecked.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Check::setChecked + Set Checked + + + + &reftitle.description; + + public UI\Controls\Check::setChecked + booleanchecked + + + Shall change the status of this Check + + + + + + &reftitle.parameters; + + + checked + + + The new status + + + + + + + + + + diff --git a/reference/ui/ui/controls/check/settext.xml b/reference/ui/ui/controls/check/settext.xml new file mode 100644 index 0000000000..de2642afe7 --- /dev/null +++ b/reference/ui/ui/controls/check/settext.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Check::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\Check::setText + stringtext + + + Shall set the text (label) for this Check + + + + + + &reftitle.parameters; + + + text + + + The new text (label) + + + + + + + + + + diff --git a/reference/ui/ui/controls/colorbutton/getcolor.xml b/reference/ui/ui/controls/colorbutton/getcolor.xml new file mode 100644 index 0000000000..f5205749c2 --- /dev/null +++ b/reference/ui/ui/controls/colorbutton/getcolor.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\ColorButton::getColor + Get Color + + + + &reftitle.description; + + public UI\ColorUI\Controls\ColorButton::getColor + + + + Shall retrieve the currently selected Color + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/colorbutton/onchange.xml b/reference/ui/ui/controls/colorbutton/onchange.xml new file mode 100644 index 0000000000..a9256e50a8 --- /dev/null +++ b/reference/ui/ui/controls/colorbutton/onchange.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\ColorButton::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\ColorButton::onChange + + + + Shall be executed when the selected Color is changed + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/colorbutton/setcolor.xml b/reference/ui/ui/controls/colorbutton/setcolor.xml new file mode 100644 index 0000000000..a247dea917 --- /dev/null +++ b/reference/ui/ui/controls/colorbutton/setcolor.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\ColorButton::setColor + Set Color + + + + &reftitle.description; + + public UI\Controls\ColorButton::setColor + UI\Colorcolor + + + Shall set the currently selected Color + + + + + + &reftitle.parameters; + + + color + + + The new Color + + + + + + + + + + diff --git a/reference/ui/ui/controls/combo/append.xml b/reference/ui/ui/controls/combo/append.xml new file mode 100644 index 0000000000..be6012ab79 --- /dev/null +++ b/reference/ui/ui/controls/combo/append.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Combo::append + Append Option + + + + &reftitle.description; + + public UI\Controls\Combo::append + stringtext + + + Append an option to this Combo + + + + + + &reftitle.parameters; + + + text + + + The text for the new option + + + + + + + + + + diff --git a/reference/ui/ui/controls/combo/getselected.xml b/reference/ui/ui/controls/combo/getselected.xml new file mode 100644 index 0000000000..662ab3c150 --- /dev/null +++ b/reference/ui/ui/controls/combo/getselected.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Combo::getSelected + Get Selected Option + + + + &reftitle.description; + + public integerUI\Controls\Combo::getSelected + + + + Shall retrieve the index of the option selected in this Combo + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/combo/onselected.xml b/reference/ui/ui/controls/combo/onselected.xml new file mode 100644 index 0000000000..57f7ff8d68 --- /dev/null +++ b/reference/ui/ui/controls/combo/onselected.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Combo::onSelected + Selected Handler + + + + &reftitle.description; + + protected UI\Controls\Combo::onSelected + + + + Shall be executed when an option is selected in this Combo + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/combo/setselected.xml b/reference/ui/ui/controls/combo/setselected.xml new file mode 100644 index 0000000000..04aec0e979 --- /dev/null +++ b/reference/ui/ui/controls/combo/setselected.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Combo::setSelected + Set Selected Option + + + + &reftitle.description; + + public UI\Controls\Combo::setSelected + integerindex + + + Shall set the currently selected option in this Combo + + + + + + &reftitle.parameters; + + + index + + + The index of the option to select + + + + + + + + + + diff --git a/reference/ui/ui/controls/editablecombo/append.xml b/reference/ui/ui/controls/editablecombo/append.xml new file mode 100644 index 0000000000..333b35c7da --- /dev/null +++ b/reference/ui/ui/controls/editablecombo/append.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\EditableCombo::append + Append Option + + + + &reftitle.description; + + public UI\Controls\EditableCombo::append + stringtext + + + Shall append a new option to this Editable Combo + + + + + + &reftitle.parameters; + + + text + + + The text for the new option + + + + + + + + + + diff --git a/reference/ui/ui/controls/editablecombo/gettext.xml b/reference/ui/ui/controls/editablecombo/gettext.xml new file mode 100644 index 0000000000..f9b151094a --- /dev/null +++ b/reference/ui/ui/controls/editablecombo/gettext.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\EditableCombo::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\EditableCombo::getText + + + + Get the value of the currently selected option in this Editable Combo + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/editablecombo/onchange.xml b/reference/ui/ui/controls/editablecombo/onchange.xml new file mode 100644 index 0000000000..09b9a4735d --- /dev/null +++ b/reference/ui/ui/controls/editablecombo/onchange.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\EditableCombo::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\EditableCombo::onChange + + + + Shall be executed when the value of this Editable Combobox changes + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/editablecombo/settext.xml b/reference/ui/ui/controls/editablecombo/settext.xml new file mode 100644 index 0000000000..82982d41e8 --- /dev/null +++ b/reference/ui/ui/controls/editablecombo/settext.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\EditableCombo::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\EditableCombo::setText + stringtext + + + Shall set the text of the currently selected option in this Editable Combo + + + + + + &reftitle.parameters; + + + text + + + The new text + + + + + + + + + + diff --git a/reference/ui/ui/controls/entities.box.xml b/reference/ui/ui/controls/entities.box.xml new file mode 100644 index 0000000000..4db466b394 --- /dev/null +++ b/reference/ui/ui/controls/entities.box.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.controls.box.append; +&reference.ui.ui.controls.box.construct; +&reference.ui.ui.controls.box.delete; +&reference.ui.ui.controls.box.getorientation; +&reference.ui.ui.controls.box.ispadded; +&reference.ui.ui.controls.box.setpadded; diff --git a/reference/ui/ui/controls/entities.button.xml b/reference/ui/ui/controls/entities.button.xml new file mode 100644 index 0000000000..1badb6ce8e --- /dev/null +++ b/reference/ui/ui/controls/entities.button.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.button.construct; +&reference.ui.ui.controls.button.gettext; +&reference.ui.ui.controls.button.onclick; +&reference.ui.ui.controls.button.settext; diff --git a/reference/ui/ui/controls/entities.check.xml b/reference/ui/ui/controls/entities.check.xml new file mode 100644 index 0000000000..fc1cf97230 --- /dev/null +++ b/reference/ui/ui/controls/entities.check.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.controls.check.construct; +&reference.ui.ui.controls.check.gettext; +&reference.ui.ui.controls.check.ischecked; +&reference.ui.ui.controls.check.ontoggle; +&reference.ui.ui.controls.check.setchecked; +&reference.ui.ui.controls.check.settext; diff --git a/reference/ui/ui/controls/entities.colorbutton.xml b/reference/ui/ui/controls/entities.colorbutton.xml new file mode 100644 index 0000000000..92f2b34fe0 --- /dev/null +++ b/reference/ui/ui/controls/entities.colorbutton.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.controls.colorbutton.getcolor; +&reference.ui.ui.controls.colorbutton.onchange; +&reference.ui.ui.controls.colorbutton.setcolor; diff --git a/reference/ui/ui/controls/entities.combo.xml b/reference/ui/ui/controls/entities.combo.xml new file mode 100644 index 0000000000..451946b08a --- /dev/null +++ b/reference/ui/ui/controls/entities.combo.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.combo.append; +&reference.ui.ui.controls.combo.getselected; +&reference.ui.ui.controls.combo.onselected; +&reference.ui.ui.controls.combo.setselected; diff --git a/reference/ui/ui/controls/entities.editablecombo.xml b/reference/ui/ui/controls/entities.editablecombo.xml new file mode 100644 index 0000000000..9d63b04e00 --- /dev/null +++ b/reference/ui/ui/controls/entities.editablecombo.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.editablecombo.append; +&reference.ui.ui.controls.editablecombo.gettext; +&reference.ui.ui.controls.editablecombo.onchange; +&reference.ui.ui.controls.editablecombo.settext; diff --git a/reference/ui/ui/controls/entities.entry.xml b/reference/ui/ui/controls/entities.entry.xml new file mode 100644 index 0000000000..95aa628e92 --- /dev/null +++ b/reference/ui/ui/controls/entities.entry.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.controls.entry.construct; +&reference.ui.ui.controls.entry.gettext; +&reference.ui.ui.controls.entry.isreadonly; +&reference.ui.ui.controls.entry.onchange; +&reference.ui.ui.controls.entry.setreadonly; +&reference.ui.ui.controls.entry.settext; diff --git a/reference/ui/ui/controls/entities.form.xml b/reference/ui/ui/controls/entities.form.xml new file mode 100644 index 0000000000..4a6bc20cae --- /dev/null +++ b/reference/ui/ui/controls/entities.form.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.form.append; +&reference.ui.ui.controls.form.delete; +&reference.ui.ui.controls.form.ispadded; +&reference.ui.ui.controls.form.setpadded; diff --git a/reference/ui/ui/controls/entities.grid.xml b/reference/ui/ui/controls/entities.grid.xml new file mode 100644 index 0000000000..497f20a83c --- /dev/null +++ b/reference/ui/ui/controls/entities.grid.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.controls.grid.append; +&reference.ui.ui.controls.grid.ispadded; +&reference.ui.ui.controls.grid.setpadded; diff --git a/reference/ui/ui/controls/entities.group.xml b/reference/ui/ui/controls/entities.group.xml new file mode 100644 index 0000000000..6ef79ad1de --- /dev/null +++ b/reference/ui/ui/controls/entities.group.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.controls.group.append; +&reference.ui.ui.controls.group.construct; +&reference.ui.ui.controls.group.gettitle; +&reference.ui.ui.controls.group.hasmargin; +&reference.ui.ui.controls.group.setmargin; +&reference.ui.ui.controls.group.settitle; diff --git a/reference/ui/ui/controls/entities.label.xml b/reference/ui/ui/controls/entities.label.xml new file mode 100644 index 0000000000..6c047314ad --- /dev/null +++ b/reference/ui/ui/controls/entities.label.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.controls.label.construct; +&reference.ui.ui.controls.label.gettext; +&reference.ui.ui.controls.label.settext; diff --git a/reference/ui/ui/controls/entities.multilineentry.xml b/reference/ui/ui/controls/entities.multilineentry.xml new file mode 100644 index 0000000000..f08be50fa2 --- /dev/null +++ b/reference/ui/ui/controls/entities.multilineentry.xml @@ -0,0 +1,7 @@ +&reference.ui.ui.controls.multilineentry.append; +&reference.ui.ui.controls.multilineentry.construct; +&reference.ui.ui.controls.multilineentry.gettext; +&reference.ui.ui.controls.multilineentry.isreadonly; +&reference.ui.ui.controls.multilineentry.onchange; +&reference.ui.ui.controls.multilineentry.setreadonly; +&reference.ui.ui.controls.multilineentry.settext; diff --git a/reference/ui/ui/controls/entities.picker.xml b/reference/ui/ui/controls/entities.picker.xml new file mode 100644 index 0000000000..3e59db48b8 --- /dev/null +++ b/reference/ui/ui/controls/entities.picker.xml @@ -0,0 +1 @@ +&reference.ui.ui.controls.picker.construct; diff --git a/reference/ui/ui/controls/entities.progress.xml b/reference/ui/ui/controls/entities.progress.xml new file mode 100644 index 0000000000..6533f092e7 --- /dev/null +++ b/reference/ui/ui/controls/entities.progress.xml @@ -0,0 +1,2 @@ +&reference.ui.ui.controls.progress.getvalue; +&reference.ui.ui.controls.progress.setvalue; diff --git a/reference/ui/ui/controls/entities.radio.xml b/reference/ui/ui/controls/entities.radio.xml new file mode 100644 index 0000000000..7ac3a865d4 --- /dev/null +++ b/reference/ui/ui/controls/entities.radio.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.radio.append; +&reference.ui.ui.controls.radio.getselected; +&reference.ui.ui.controls.radio.onselected; +&reference.ui.ui.controls.radio.setselected; diff --git a/reference/ui/ui/controls/entities.separator.xml b/reference/ui/ui/controls/entities.separator.xml new file mode 100644 index 0000000000..61c5c27f96 --- /dev/null +++ b/reference/ui/ui/controls/entities.separator.xml @@ -0,0 +1 @@ +&reference.ui.ui.controls.separator.construct; diff --git a/reference/ui/ui/controls/entities.slider.xml b/reference/ui/ui/controls/entities.slider.xml new file mode 100644 index 0000000000..33d902981a --- /dev/null +++ b/reference/ui/ui/controls/entities.slider.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.slider.construct; +&reference.ui.ui.controls.slider.getvalue; +&reference.ui.ui.controls.slider.onchange; +&reference.ui.ui.controls.slider.setvalue; diff --git a/reference/ui/ui/controls/entities.spin.xml b/reference/ui/ui/controls/entities.spin.xml new file mode 100644 index 0000000000..3dfa27c7a3 --- /dev/null +++ b/reference/ui/ui/controls/entities.spin.xml @@ -0,0 +1,4 @@ +&reference.ui.ui.controls.spin.construct; +&reference.ui.ui.controls.spin.getvalue; +&reference.ui.ui.controls.spin.onchange; +&reference.ui.ui.controls.spin.setvalue; diff --git a/reference/ui/ui/controls/entities.tab.xml b/reference/ui/ui/controls/entities.tab.xml new file mode 100644 index 0000000000..cc35d6d8a2 --- /dev/null +++ b/reference/ui/ui/controls/entities.tab.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.controls.tab.append; +&reference.ui.ui.controls.tab.delete; +&reference.ui.ui.controls.tab.hasmargin; +&reference.ui.ui.controls.tab.insertat; +&reference.ui.ui.controls.tab.pages; +&reference.ui.ui.controls.tab.setmargin; diff --git a/reference/ui/ui/controls/entry/construct.xml b/reference/ui/ui/controls/entry/construct.xml new file mode 100644 index 0000000000..69fa3f36ac --- /dev/null +++ b/reference/ui/ui/controls/entry/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Entry::__construct + Construct a new Entry + + + + &reftitle.description; + + public UI\Controls\Entry::__construct + integertypeUI\Controls\Entry::Normal + + + Construct a new entry of the given type + + + + + + &reftitle.parameters; + + + type + + + Entry::Normal, Entry::Password, or Entry::Search + + + + + + + + + diff --git a/reference/ui/ui/controls/entry/gettext.xml b/reference/ui/ui/controls/entry/gettext.xml new file mode 100644 index 0000000000..56d0d914ed --- /dev/null +++ b/reference/ui/ui/controls/entry/gettext.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Entry::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\Entry::getText + + + + Shall return the current text from this Entry + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current text + + + + + + + diff --git a/reference/ui/ui/controls/entry/isreadonly.xml b/reference/ui/ui/controls/entry/isreadonly.xml new file mode 100644 index 0000000000..e6231563e5 --- /dev/null +++ b/reference/ui/ui/controls/entry/isreadonly.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Entry::isReadOnly + Detect Read Only + + + + &reftitle.description; + + public boolUI\Controls\Entry::isReadOnly + + + + Shall detect if this Entry is read only + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/entry/onchange.xml b/reference/ui/ui/controls/entry/onchange.xml new file mode 100644 index 0000000000..570e1eec16 --- /dev/null +++ b/reference/ui/ui/controls/entry/onchange.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\Entry::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\Entry::onChange + + + + Shall be executed when the text in this Entry changes + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/entry/setreadonly.xml b/reference/ui/ui/controls/entry/setreadonly.xml new file mode 100644 index 0000000000..73baf674b6 --- /dev/null +++ b/reference/ui/ui/controls/entry/setreadonly.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Entry::setReadOnly + Set Read Only + + + + &reftitle.description; + + public UI\Controls\Entry::setReadOnly + booleanreadOnly + + + Shall enable or disable read only for this Entry + + + + + + &reftitle.parameters; + + + readOnly + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/entry/settext.xml b/reference/ui/ui/controls/entry/settext.xml new file mode 100644 index 0000000000..2c73993593 --- /dev/null +++ b/reference/ui/ui/controls/entry/settext.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Entry::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\Entry::setText + stringtext + + + Shall set the text for this Entry + + + + + + &reftitle.parameters; + + + text + + + The new text + + + + + + + + + + diff --git a/reference/ui/ui/controls/form/append.xml b/reference/ui/ui/controls/form/append.xml new file mode 100644 index 0000000000..f72ca252a0 --- /dev/null +++ b/reference/ui/ui/controls/form/append.xml @@ -0,0 +1,76 @@ + + + + + + UI\Controls\Form::append + Append Control + + + + &reftitle.description; + + public UI\Controls\Form::append + stringlabel + UI\Controlcontrol + booleanstretchyfalse + + + Shall append the control to the form, and set the label + + + + + + &reftitle.parameters; + + + label + + + The text for the label + + + + + control + + + A control + + + + + stretchy + + + Should be set true to stretch the control + + + + + + + + + + diff --git a/reference/ui/ui/controls/form/delete.xml b/reference/ui/ui/controls/form/delete.xml new file mode 100644 index 0000000000..94565d6bcc --- /dev/null +++ b/reference/ui/ui/controls/form/delete.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Form::delete + Delete Control + + + + &reftitle.description; + + public UI\Controls\Form::delete + integerindex + + + Shall delete the control at the given index in this Form + + + + + &reftitle.parameters; + + + index + + + The index of the control to remove + + + + + + + + + + diff --git a/reference/ui/ui/controls/form/ispadded.xml b/reference/ui/ui/controls/form/ispadded.xml new file mode 100644 index 0000000000..e37a922b1d --- /dev/null +++ b/reference/ui/ui/controls/form/ispadded.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Form::isPadded + Padding Detection + + + + &reftitle.description; + + public boolUI\Controls\Form::isPadded + + + + Shall detect if padding is enabled on this Form + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/form/setpadded.xml b/reference/ui/ui/controls/form/setpadded.xml new file mode 100644 index 0000000000..824ee431eb --- /dev/null +++ b/reference/ui/ui/controls/form/setpadded.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Form::setPadded + Set Padding + + + + &reftitle.description; + + public UI\Controls\Form::setPadded + booleanpadded + + + Shall enable or disable padding on this Form + + + + + + &reftitle.parameters; + + + padded + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/grid/append.xml b/reference/ui/ui/controls/grid/append.xml new file mode 100644 index 0000000000..6feae3c405 --- /dev/null +++ b/reference/ui/ui/controls/grid/append.xml @@ -0,0 +1,139 @@ + + + + + + UI\Controls\Grid::append + Append Control + + + + &reftitle.description; + + public UI\Controls\Grid::append + UI\Controlcontrol + integerleft + integertop + integerxspan + integeryspan + booleanhexpand + integerhalign + booleanvexpand + integervalign + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + control + + + The Control to append + + + + + left + + + + + + + + top + + + + + + + + xspan + + + + + + + + yspan + + + + + + + + hexpand + + + + + + + + halign + + + + + + + + vexpand + + + + + + + + valign + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/grid/ispadded.xml b/reference/ui/ui/controls/grid/ispadded.xml new file mode 100644 index 0000000000..0b2a864866 --- /dev/null +++ b/reference/ui/ui/controls/grid/ispadded.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Grid::isPadded + Padding Detection + + + + &reftitle.description; + + public boolUI\Controls\Grid::isPadded + + + + Shall detect if padding is enabled on this Grid + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/grid/setpadded.xml b/reference/ui/ui/controls/grid/setpadded.xml new file mode 100644 index 0000000000..7703445764 --- /dev/null +++ b/reference/ui/ui/controls/grid/setpadded.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Grid::setPadded + Set Padding + + + + &reftitle.description; + + public UI\Controls\Grid::setPadded + booleanpadding + + + Shall enable or disable padding for this Grid + + + + + + &reftitle.parameters; + + + padding + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/group/append.xml b/reference/ui/ui/controls/group/append.xml new file mode 100644 index 0000000000..3ca0a77ec7 --- /dev/null +++ b/reference/ui/ui/controls/group/append.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Group::append + Append Control + + + + &reftitle.description; + + public UI\Controls\Group::append + UI\Controlcontrol + + + Shall append a control to this Group + + + + + + &reftitle.parameters; + + + control + + + The control to append + + + + + + + + + + diff --git a/reference/ui/ui/controls/group/construct.xml b/reference/ui/ui/controls/group/construct.xml new file mode 100644 index 0000000000..5137f34306 --- /dev/null +++ b/reference/ui/ui/controls/group/construct.xml @@ -0,0 +1,59 @@ + + + + + + UI\Controls\Group::__construct + Construct a new Group + + + + &reftitle.description; + + public UI\Controls\Group::__construct + stringtitle + + + Shall construct a new Group with the given title + + + + + + &reftitle.parameters; + + + title + + + The text for the title label + + + + + + + + + + + diff --git a/reference/ui/ui/controls/group/gettitle.xml b/reference/ui/ui/controls/group/gettitle.xml new file mode 100644 index 0000000000..10e8026b5c --- /dev/null +++ b/reference/ui/ui/controls/group/gettitle.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Group::getTitle + Get Title + + + + &reftitle.description; + + public stringUI\Controls\Group::getTitle + + + + Shall return the current title for this Group + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current title + + + + + + + diff --git a/reference/ui/ui/controls/group/hasmargin.xml b/reference/ui/ui/controls/group/hasmargin.xml new file mode 100644 index 0000000000..34d4f30c95 --- /dev/null +++ b/reference/ui/ui/controls/group/hasmargin.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Group::hasMargin + Margin Detection + + + + &reftitle.description; + + public boolUI\Controls\Group::hasMargin + + + + Shall detect if this Group has a margin + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/group/setmargin.xml b/reference/ui/ui/controls/group/setmargin.xml new file mode 100644 index 0000000000..619cc542dc --- /dev/null +++ b/reference/ui/ui/controls/group/setmargin.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Group::setMargin + Set Margin + + + + &reftitle.description; + + public UI\Controls\Group::setMargin + booleanmargin + + + Shall enable or disable margins for this Group + + + + + + &reftitle.parameters; + + + margin + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/group/settitle.xml b/reference/ui/ui/controls/group/settitle.xml new file mode 100644 index 0000000000..a5b4f1c7f6 --- /dev/null +++ b/reference/ui/ui/controls/group/settitle.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Group::setTitle + Set Title + + + + &reftitle.description; + + public UI\Controls\Group::setTitle + stringtitle + + + Shall set the title for this Group + + + + + + &reftitle.parameters; + + + title + + + The text for the new title + + + + + + + + + + diff --git a/reference/ui/ui/controls/label/construct.xml b/reference/ui/ui/controls/label/construct.xml new file mode 100644 index 0000000000..05544f24a1 --- /dev/null +++ b/reference/ui/ui/controls/label/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Label::__construct + Construct a new Label + + + + &reftitle.description; + + public UI\Controls\Label::__construct + stringtext + + + Shall construct a new Label + + + + + + &reftitle.parameters; + + + text + + + The text for this label + + + + + + + + + diff --git a/reference/ui/ui/controls/label/gettext.xml b/reference/ui/ui/controls/label/gettext.xml new file mode 100644 index 0000000000..e7e2fd5195 --- /dev/null +++ b/reference/ui/ui/controls/label/gettext.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Label::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\Label::getText + + + + Shall return the current text for this Label + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/label/settext.xml b/reference/ui/ui/controls/label/settext.xml new file mode 100644 index 0000000000..bf9391cff0 --- /dev/null +++ b/reference/ui/ui/controls/label/settext.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Label::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\Label::setText + stringtext + + + Shall set the text for this Label + + + + + + &reftitle.parameters; + + + text + + + The new text + + + + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/append.xml b/reference/ui/ui/controls/multilineentry/append.xml new file mode 100644 index 0000000000..3971e70392 --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/append.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\MultilineEntry::append + Append Text + + + + &reftitle.description; + + public UI\Controls\MultilineEntry::append + stringtext + + + Shall append the given text to the text in this Multiline Entry + + + + + + &reftitle.parameters; + + + text + + + The text to append + + + + + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/construct.xml b/reference/ui/ui/controls/multilineentry/construct.xml new file mode 100644 index 0000000000..a30f76a3f6 --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/construct.xml @@ -0,0 +1,59 @@ + + + + + + UI\Controls\MultilineEntry::__construct + Construct a new Multiline Entry + + + + &reftitle.description; + + public UI\Controls\MultilineEntry::__construct + integertype + + + Shall construct a new Multiline Entry of the given type + + + + + + &reftitle.parameters; + + + type + + + MultilineEntry::Wrap or MultilineEntry::NoWrap + + + + + + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/gettext.xml b/reference/ui/ui/controls/multilineentry/gettext.xml new file mode 100644 index 0000000000..9e2d48fd3b --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/gettext.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\MultilineEntry::getText + Get Text + + + + &reftitle.description; + + public stringUI\Controls\MultilineEntry::getText + + + + Shall return the text in this Multiline Entry + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/isreadonly.xml b/reference/ui/ui/controls/multilineentry/isreadonly.xml new file mode 100644 index 0000000000..413e3efc12 --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/isreadonly.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\MultilineEntry::isReadOnly + Read Only Detection + + + + &reftitle.description; + + public boolUI\Controls\MultilineEntry::isReadOnly + + + + Shall detect if this Multiline Entry is read only + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/onchange.xml b/reference/ui/ui/controls/multilineentry/onchange.xml new file mode 100644 index 0000000000..2c9f18bbec --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/onchange.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\MultilineEntry::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\MultilineEntry::onChange + + + + Shall be executed when the text in this Multiline Entry is changed + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/multilineentry/setreadonly.xml b/reference/ui/ui/controls/multilineentry/setreadonly.xml new file mode 100644 index 0000000000..56e21c1f1d --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/setreadonly.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\MultilineEntry::setReadOnly + Set Read Only + + + + &reftitle.description; + + public UI\Controls\MultilineEntry::setReadOnly + booleanreadOnly + + + Shall enable or disable read only on this Multiline Entry + + + + + + &reftitle.parameters; + + + readOnly + + + + + + + + + + + + + diff --git a/reference/ui/ui/controls/multilineentry/settext.xml b/reference/ui/ui/controls/multilineentry/settext.xml new file mode 100644 index 0000000000..367b3a00c6 --- /dev/null +++ b/reference/ui/ui/controls/multilineentry/settext.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\MultilineEntry::setText + Set Text + + + + &reftitle.description; + + public UI\Controls\MultilineEntry::setText + stringtext + + + Shall set the text in this Multiline Entry + + + + + + &reftitle.parameters; + + + text + + + The new text + + + + + + + + + diff --git a/reference/ui/ui/controls/picker/construct.xml b/reference/ui/ui/controls/picker/construct.xml new file mode 100644 index 0000000000..17b99ac059 --- /dev/null +++ b/reference/ui/ui/controls/picker/construct.xml @@ -0,0 +1,59 @@ + + + + + + UI\Controls\Picker::__construct + Construct a new Picker + + + + &reftitle.description; + + public UI\Controls\Picker::__construct + integertypeUI\Controls\Picker::Date + + + Construct a new Picker of the given type + + + + + + &reftitle.parameters; + + + type + + + Picker::Date, Picker::Time, or Picker::DateTime + + + + + + + + + + + diff --git a/reference/ui/ui/controls/progress/getvalue.xml b/reference/ui/ui/controls/progress/getvalue.xml new file mode 100644 index 0000000000..286f05001a --- /dev/null +++ b/reference/ui/ui/controls/progress/getvalue.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Progress::getValue + Get Value + + + + &reftitle.description; + + public intUI\Controls\Progress::getValue + + + + Shall retrieve the current value of this Progress bar + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/progress/setvalue.xml b/reference/ui/ui/controls/progress/setvalue.xml new file mode 100644 index 0000000000..55fbdce0b6 --- /dev/null +++ b/reference/ui/ui/controls/progress/setvalue.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Progress::setValue + Set Value + + + + &reftitle.description; + + public UI\Controls\Progress::setValue + integervalue + + + Shall set the value for this Progress bar + + + + + + &reftitle.parameters; + + + value + + + An integer between 0 and 100 (inclusive) + + + + + + + + + diff --git a/reference/ui/ui/controls/radio/append.xml b/reference/ui/ui/controls/radio/append.xml new file mode 100644 index 0000000000..1ebfd2e02f --- /dev/null +++ b/reference/ui/ui/controls/radio/append.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Radio::append + Append Option + + + + &reftitle.description; + + public UI\Controls\Radio::append + stringtext + + + Shall append a new option to this Radio + + + + + + &reftitle.parameters; + + + text + + + The text (label) for the option + + + + + + + + + + diff --git a/reference/ui/ui/controls/radio/getselected.xml b/reference/ui/ui/controls/radio/getselected.xml new file mode 100644 index 0000000000..2497d674c4 --- /dev/null +++ b/reference/ui/ui/controls/radio/getselected.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Radio::getSelected + Get Selected Option + + + + &reftitle.description; + + public integerUI\Controls\Radio::getSelected + + + + Shall retrieve the index of the currently selected option in this Radio + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/radio/onselected.xml b/reference/ui/ui/controls/radio/onselected.xml new file mode 100644 index 0000000000..63494f1265 --- /dev/null +++ b/reference/ui/ui/controls/radio/onselected.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\Radio::onSelected + Selected Handler + + + + &reftitle.description; + + protected UI\Controls\Radio::onSelected + + + + Shall be executed when the option selected in this Radio changes + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/radio/setselected.xml b/reference/ui/ui/controls/radio/setselected.xml new file mode 100644 index 0000000000..8d0f1c39eb --- /dev/null +++ b/reference/ui/ui/controls/radio/setselected.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Radio::setSelected + Set Selected Option + + + + &reftitle.description; + + public UI\Controls\Radio::setSelected + integerindex + + + Shall set the currently selected option in this Radio + + + + + + &reftitle.parameters; + + + index + + + The index of the option to select + + + + + + + + + + diff --git a/reference/ui/ui/controls/separator/construct.xml b/reference/ui/ui/controls/separator/construct.xml new file mode 100644 index 0000000000..9ce4cfa7aa --- /dev/null +++ b/reference/ui/ui/controls/separator/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Separator::__construct + Construct a new Separator + + + + &reftitle.description; + + public UI\Controls\Separator::__construct + integertypeUI\Controls\Separator::Horizontal + + + Shall construct a new Separator of the given type + + + + + + &reftitle.parameters; + + + type + + + Separator::Horizonal or Separator::Vertical + + + + + + + + + diff --git a/reference/ui/ui/controls/slider/construct.xml b/reference/ui/ui/controls/slider/construct.xml new file mode 100644 index 0000000000..470785ef99 --- /dev/null +++ b/reference/ui/ui/controls/slider/construct.xml @@ -0,0 +1,66 @@ + + + + + + UI\Controls\Slider::__construct + Construct a new Slider + + + + &reftitle.description; + + public UI\Controls\Slider::__construct + integermin + integermax + + + Construct a new Slider with the given range + + + + + + &reftitle.parameters; + + + min + + + The minimum allowed value + + + + + max + + + The maximum allowed value + + + + + + + + + diff --git a/reference/ui/ui/controls/slider/getvalue.xml b/reference/ui/ui/controls/slider/getvalue.xml new file mode 100644 index 0000000000..322dd292f7 --- /dev/null +++ b/reference/ui/ui/controls/slider/getvalue.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Slider::getValue + Get Value + + + + &reftitle.description; + + public integerUI\Controls\Slider::getValue + + + + Get the value from this Slider + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/slider/onchange.xml b/reference/ui/ui/controls/slider/onchange.xml new file mode 100644 index 0000000000..8de3d27710 --- /dev/null +++ b/reference/ui/ui/controls/slider/onchange.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Slider::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\Slider::onChange + + + + Shall be executed when the value of this Slider changes + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/slider/setvalue.xml b/reference/ui/ui/controls/slider/setvalue.xml new file mode 100644 index 0000000000..b6de354300 --- /dev/null +++ b/reference/ui/ui/controls/slider/setvalue.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Slider::setValue + Set Value + + + + &reftitle.description; + + public UI\Controls\Slider::setValue + integervalue + + + Shall set the value for this Slider + + + + + + &reftitle.parameters; + + + value + + + The new value + + + + + + + + + diff --git a/reference/ui/ui/controls/spin/construct.xml b/reference/ui/ui/controls/spin/construct.xml new file mode 100644 index 0000000000..cf0a058185 --- /dev/null +++ b/reference/ui/ui/controls/spin/construct.xml @@ -0,0 +1,68 @@ + + + + + + UI\Controls\Spin::__construct + Construct a new Spin + + + + &reftitle.description; + + public UI\Controls\Spin::__construct + integermin + integermax + + + Constructs a new Spin with the given range + + + + + + &reftitle.parameters; + + + min + + + The minimum value allowed + + + + + max + + + The maximum value allowed + + + + + + + + + + + diff --git a/reference/ui/ui/controls/spin/getvalue.xml b/reference/ui/ui/controls/spin/getvalue.xml new file mode 100644 index 0000000000..929954d22c --- /dev/null +++ b/reference/ui/ui/controls/spin/getvalue.xml @@ -0,0 +1,48 @@ + + + + + + UI\Controls\Spin::getValue + Get Value + + + + &reftitle.description; + + public intUI\Controls\Spin::getValue + + + + Get the value in this Spin + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + diff --git a/reference/ui/ui/controls/spin/onchange.xml b/reference/ui/ui/controls/spin/onchange.xml new file mode 100644 index 0000000000..7a788ec369 --- /dev/null +++ b/reference/ui/ui/controls/spin/onchange.xml @@ -0,0 +1,49 @@ + + + + + + UI\Controls\Spin::onChange + Change Handler + + + + &reftitle.description; + + protected UI\Controls\Spin::onChange + + + + Shall be executed when the value in this Spin changes + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/controls/spin/setvalue.xml b/reference/ui/ui/controls/spin/setvalue.xml new file mode 100644 index 0000000000..2c39a6e3c9 --- /dev/null +++ b/reference/ui/ui/controls/spin/setvalue.xml @@ -0,0 +1,58 @@ + + + + + + UI\Controls\Spin::setValue + Set Value + + + + &reftitle.description; + + public UI\Controls\Spin::setValue + integervalue + + + Set the value in this Spin + + + + + + &reftitle.parameters; + + + value + + + The new value + + + + + + + + + + diff --git a/reference/ui/ui/controls/tab/append.xml b/reference/ui/ui/controls/tab/append.xml new file mode 100644 index 0000000000..e10eac7d21 --- /dev/null +++ b/reference/ui/ui/controls/tab/append.xml @@ -0,0 +1,67 @@ + + + + + + UI\Controls\Tab::append + Append Page + + + + &reftitle.description; + + public UI\Controls\Tab::append + stringname + UI\Controlcontrol + + + Append a new page to this Tab + + + + + + &reftitle.parameters; + + + name + + + The name for the new page + + + + + control + + + The control for the new page + + + + + + + + + + diff --git a/reference/ui/ui/controls/tab/delete.xml b/reference/ui/ui/controls/tab/delete.xml new file mode 100644 index 0000000000..9c22973ca9 --- /dev/null +++ b/reference/ui/ui/controls/tab/delete.xml @@ -0,0 +1,57 @@ + + + + + + UI\Controls\Tab::delete + Delete Page + + + + &reftitle.description; + + public UI\Controls\Tab::delete + integerindex + + + Shall remove the selected page from this Tab + + + + + + &reftitle.parameters; + + + index + + + The index of the page to remove + + + + + + + + + diff --git a/reference/ui/ui/controls/tab/hasmargin.xml b/reference/ui/ui/controls/tab/hasmargin.xml new file mode 100644 index 0000000000..0d5f52d98d --- /dev/null +++ b/reference/ui/ui/controls/tab/hasmargin.xml @@ -0,0 +1,64 @@ + + + + + + UI\Controls\Tab::hasMargin + Margin Detection + + + + &reftitle.description; + + public boolUI\Controls\Tab::hasMargin + integerpage + + + Shall detect if the given page has a margin. + + + + + &reftitle.parameters; + + + page + + + The index of the page + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/controls/tab/insertat.xml b/reference/ui/ui/controls/tab/insertat.xml new file mode 100644 index 0000000000..816305342c --- /dev/null +++ b/reference/ui/ui/controls/tab/insertat.xml @@ -0,0 +1,75 @@ + + + + + + UI\Controls\Tab::insertAt + Insert Page + + + + &reftitle.description; + + public UI\Controls\Tab::insertAt + stringname + integerpage + UI\Controlcontrol + + + Shall insert a new page into this Tab + + + + + + &reftitle.parameters; + + + name + + + The name for the new page + + + + + page + + + The index to perform the insertion before + + + + + control + + + The control for the new page + + + + + + + + + diff --git a/reference/ui/ui/controls/tab/pages.xml b/reference/ui/ui/controls/tab/pages.xml new file mode 100644 index 0000000000..24e243ff30 --- /dev/null +++ b/reference/ui/ui/controls/tab/pages.xml @@ -0,0 +1,56 @@ + + + + + + UI\Controls\Tab::pages + Page Count + + + + &reftitle.description; + + public integerUI\Controls\Tab::pages + + + + Shall return the number of pages in this Tab + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The number of pages in this Tab + + + + + + + diff --git a/reference/ui/ui/controls/tab/setmargin.xml b/reference/ui/ui/controls/tab/setmargin.xml new file mode 100644 index 0000000000..1a57041d35 --- /dev/null +++ b/reference/ui/ui/controls/tab/setmargin.xml @@ -0,0 +1,66 @@ + + + + + + UI\Controls\Tab::setMargin + Set Margin + + + + &reftitle.description; + + public UI\Controls\Tab::setMargin + integerpage + booleanmargin + + + Shall enable or disable margins on the selected page + + + + + + &reftitle.parameters; + + + page + + + The page to select + + + + + margin + + + Margin switch + + + + + + + + + diff --git a/reference/ui/ui/draw/brush/construct.xml b/reference/ui/ui/draw/brush/construct.xml new file mode 100644 index 0000000000..37668105ed --- /dev/null +++ b/reference/ui/ui/draw/brush/construct.xml @@ -0,0 +1,111 @@ + + + + + + UI\Draw\Brush::__construct + Construct a new Brush + + + + &reftitle.description; + + public UI\Draw\Brush::__construct + integertype + UI\Draw\Colorcolor + floatX0 + floatY0 + floatX1 + floatY1 + floatradius + + + Shall construct a new Brush + + + + + + &reftitle.parameters; + + + type + + + Brush::Solid, Brush::LinearGradient, Brush::RadialGradient, or Brush::Image + + + + + color + + + The color of the brush + + + + + X0 + + + + + + + + Y0 + + + + + + + + X1 + + + + + + + + Y1 + + + + + + + + radius + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/brush/getcolor.xml b/reference/ui/ui/draw/brush/getcolor.xml new file mode 100644 index 0000000000..464f09825a --- /dev/null +++ b/reference/ui/ui/draw/brush/getcolor.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Brush::getColor + Get Color + + + + &reftitle.description; + + public UI\Draw\ColorUI\Draw\Brush::getColor + + + + Shall return the color of this Brush + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current color of this Brush + + + + + + + diff --git a/reference/ui/ui/draw/brush/gettype.xml b/reference/ui/ui/draw/brush/gettype.xml new file mode 100644 index 0000000000..780fa7eca0 --- /dev/null +++ b/reference/ui/ui/draw/brush/gettype.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Brush::getType + Get Type + + + + &reftitle.description; + + public integerUI\Draw\Brush::getType + + + + Shall return the type of this Brush + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Brush::Solid, Brush::LinearGradient, Brush::RadialGradient, or Brush::Image + + + + + + + diff --git a/reference/ui/ui/draw/brush/setcolor.xml b/reference/ui/ui/draw/brush/setcolor.xml new file mode 100644 index 0000000000..779d096518 --- /dev/null +++ b/reference/ui/ui/draw/brush/setcolor.xml @@ -0,0 +1,57 @@ + + + + + + UI\Draw\Brush::setColor + Set Color + + + + &reftitle.description; + + public UI\Draw\Brush::setColor + UI\Draw\Colorcolor + + + Shall set the color for this Brush + + + + + + &reftitle.parameters; + + + color + + + The new color + + + + + + + + + diff --git a/reference/ui/ui/draw/brush/settype.xml b/reference/ui/ui/draw/brush/settype.xml new file mode 100644 index 0000000000..d68d6bfa8c --- /dev/null +++ b/reference/ui/ui/draw/brush/settype.xml @@ -0,0 +1,59 @@ + + + + + + UI\Draw\Brush::setType + Set Type + + + + &reftitle.description; + + public UI\Draw\Brush::setType + integertype + + + Shall set the type for this Brush + + + + + + &reftitle.parameters; + + + type + + + Brush::Solid, Brush::LinearGradient, Brush::RadialGradient, or Brush::Image + + + + + + + + + + + diff --git a/reference/ui/ui/draw/color/construct.xml b/reference/ui/ui/draw/color/construct.xml new file mode 100644 index 0000000000..8e6691caf7 --- /dev/null +++ b/reference/ui/ui/draw/color/construct.xml @@ -0,0 +1,68 @@ + + + + + + UI\Draw\Color::__construct + Construct a new Color + + + + &reftitle.description; + + public UI\Draw\Color::__construct + integerrgb + floatalpha1 + + + Shall construct a new Color + + + + + + &reftitle.parameters; + + + rgb + + + The color + + + + + alpha + + + Alpha channel + + + + + + + + + + + diff --git a/reference/ui/ui/draw/color/getchannel.xml b/reference/ui/ui/draw/color/getchannel.xml new file mode 100644 index 0000000000..61fb5d7b41 --- /dev/null +++ b/reference/ui/ui/draw/color/getchannel.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Color::getChannel + Get Channel + + + + &reftitle.description; + + public doubleUI\Draw\Color::getChannel + integerchannel + + + Shall retrieve the value for a channel + + + + + + &reftitle.parameters; + + + channel + + + The channel to retrieve + + + + + + + + + + diff --git a/reference/ui/ui/draw/color/setchannel.xml b/reference/ui/ui/draw/color/setchannel.xml new file mode 100644 index 0000000000..4dd6063855 --- /dev/null +++ b/reference/ui/ui/draw/color/setchannel.xml @@ -0,0 +1,76 @@ + + + + + + UI\Draw\Color::setChannel + Set Channel + + + + &reftitle.description; + + public UI\Draw\Color::setChannel + intchannel + floatvalue + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + channel + + + + + + + + value + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/draw/entities.brush.xml b/reference/ui/ui/draw/entities.brush.xml new file mode 100644 index 0000000000..554e4b5c18 --- /dev/null +++ b/reference/ui/ui/draw/entities.brush.xml @@ -0,0 +1,5 @@ +&reference.ui.ui.draw.brush.construct; +&reference.ui.ui.draw.brush.getcolor; +&reference.ui.ui.draw.brush.gettype; +&reference.ui.ui.draw.brush.setcolor; +&reference.ui.ui.draw.brush.settype; diff --git a/reference/ui/ui/draw/entities.color.xml b/reference/ui/ui/draw/entities.color.xml new file mode 100644 index 0000000000..e5faeb0ab2 --- /dev/null +++ b/reference/ui/ui/draw/entities.color.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.draw.color.construct; +&reference.ui.ui.draw.color.getchannel; +&reference.ui.ui.draw.color.setchannel; diff --git a/reference/ui/ui/draw/entities.matrix.xml b/reference/ui/ui/draw/entities.matrix.xml new file mode 100644 index 0000000000..f0cb4d4267 --- /dev/null +++ b/reference/ui/ui/draw/entities.matrix.xml @@ -0,0 +1,7 @@ +&reference.ui.ui.draw.matrix.invert; +&reference.ui.ui.draw.matrix.isinvertible; +&reference.ui.ui.draw.matrix.multiply; +&reference.ui.ui.draw.matrix.rotate; +&reference.ui.ui.draw.matrix.scale; +&reference.ui.ui.draw.matrix.skew; +&reference.ui.ui.draw.matrix.translate; diff --git a/reference/ui/ui/draw/entities.path.xml b/reference/ui/ui/draw/entities.path.xml new file mode 100644 index 0000000000..86496b2289 --- /dev/null +++ b/reference/ui/ui/draw/entities.path.xml @@ -0,0 +1,9 @@ +&reference.ui.ui.draw.path.addrectangle; +&reference.ui.ui.draw.path.arcto; +&reference.ui.ui.draw.path.bezierto; +&reference.ui.ui.draw.path.closefigure; +&reference.ui.ui.draw.path.construct; +&reference.ui.ui.draw.path.end; +&reference.ui.ui.draw.path.lineto; +&reference.ui.ui.draw.path.newfigure; +&reference.ui.ui.draw.path.newfigurewitharc; diff --git a/reference/ui/ui/draw/entities.pen.xml b/reference/ui/ui/draw/entities.pen.xml new file mode 100644 index 0000000000..15a71afa48 --- /dev/null +++ b/reference/ui/ui/draw/entities.pen.xml @@ -0,0 +1,7 @@ +&reference.ui.ui.draw.pen.clip; +&reference.ui.ui.draw.pen.fill; +&reference.ui.ui.draw.pen.restore; +&reference.ui.ui.draw.pen.save; +&reference.ui.ui.draw.pen.stroke; +&reference.ui.ui.draw.pen.transform; +&reference.ui.ui.draw.pen.write; diff --git a/reference/ui/ui/draw/entities.stroke.xml b/reference/ui/ui/draw/entities.stroke.xml new file mode 100644 index 0000000000..4d0754250b --- /dev/null +++ b/reference/ui/ui/draw/entities.stroke.xml @@ -0,0 +1,9 @@ +&reference.ui.ui.draw.stroke.construct; +&reference.ui.ui.draw.stroke.getcap; +&reference.ui.ui.draw.stroke.getjoin; +&reference.ui.ui.draw.stroke.getmiterlimit; +&reference.ui.ui.draw.stroke.getthickness; +&reference.ui.ui.draw.stroke.setcap; +&reference.ui.ui.draw.stroke.setjoin; +&reference.ui.ui.draw.stroke.setmiterlimit; +&reference.ui.ui.draw.stroke.setthickness; diff --git a/reference/ui/ui/draw/entities.text.xml b/reference/ui/ui/draw/entities.text.xml new file mode 100644 index 0000000000..449c13dde0 --- /dev/null +++ b/reference/ui/ui/draw/entities.text.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.draw.text.entities.font.descriptor; +&reference.ui.ui.draw.text.entities.font; +&reference.ui.ui.draw.text.entities.layout; diff --git a/reference/ui/ui/draw/matrix/invert.xml b/reference/ui/ui/draw/matrix/invert.xml new file mode 100644 index 0000000000..ff8fe35c84 --- /dev/null +++ b/reference/ui/ui/draw/matrix/invert.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Matrix::invert + Invert Matrix + + + + &reftitle.description; + + public UI\Draw\Matrix::invert + + + + Shall invert this matrix + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/matrix/isinvertible.xml b/reference/ui/ui/draw/matrix/isinvertible.xml new file mode 100644 index 0000000000..a8db70be87 --- /dev/null +++ b/reference/ui/ui/draw/matrix/isinvertible.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Matrix::isInvertible + Invertible Detection + + + + &reftitle.description; + + public boolUI\Draw\Matrix::isInvertible + + + + Shall detect if this Matrix may be inverted + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/matrix/multiply.xml b/reference/ui/ui/draw/matrix/multiply.xml new file mode 100644 index 0000000000..a7edc58eda --- /dev/null +++ b/reference/ui/ui/draw/matrix/multiply.xml @@ -0,0 +1,55 @@ + + + + + + UI\Draw\Matrix::multiply + Multiply Matrix + + + + &reftitle.description; + + public UI\Draw\MatrixUI\Draw\Matrix::multiply + UI\Draw\Matrixmatrix + + + Shall multiply this matrix with the given matrix + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The new Matrix + + + + + + diff --git a/reference/ui/ui/draw/matrix/rotate.xml b/reference/ui/ui/draw/matrix/rotate.xml new file mode 100644 index 0000000000..b0c1f13cd0 --- /dev/null +++ b/reference/ui/ui/draw/matrix/rotate.xml @@ -0,0 +1,67 @@ + + + + + + UI\Draw\Matrix::rotate + Rotate Matrix + + + + &reftitle.description; + + public UI\Draw\Matrix::rotate + UI\Pointpoint + floatamount + + + Shall rotate this Matrix + + + + + + &reftitle.parameters; + + + point + + + + + + + + amount + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/matrix/scale.xml b/reference/ui/ui/draw/matrix/scale.xml new file mode 100644 index 0000000000..68471373f4 --- /dev/null +++ b/reference/ui/ui/draw/matrix/scale.xml @@ -0,0 +1,67 @@ + + + + + + UI\Draw\Matrix::scale + Scale Matrix + + + + &reftitle.description; + + public UI\Draw\Matrix::scale + UI\Pointcenter + UI\Pointpoint + + + Shall scale this Matrix + + + + + + &reftitle.parameters; + + + center + + + + + + + + point + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/matrix/skew.xml b/reference/ui/ui/draw/matrix/skew.xml new file mode 100644 index 0000000000..9897d82347 --- /dev/null +++ b/reference/ui/ui/draw/matrix/skew.xml @@ -0,0 +1,67 @@ + + + + + + UI\Draw\Matrix::skew + Skew Matrix + + + + &reftitle.description; + + public UI\Draw\Matrix::skew + UI\Pointpoint + UI\Pointamount + + + Shall skew this Matrix + + + + + + &reftitle.parameters; + + + point + + + + + + + + amount + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/matrix/translate.xml b/reference/ui/ui/draw/matrix/translate.xml new file mode 100644 index 0000000000..ffd9cd1ae8 --- /dev/null +++ b/reference/ui/ui/draw/matrix/translate.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Matrix::translate + Translate Matrix + + + + &reftitle.description; + + public UI\Draw\Matrix::translate + UI\Pointpoint + + + Shall translate this Matrix + + + + + + &reftitle.parameters; + + + point + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/path/addrectangle.xml b/reference/ui/ui/draw/path/addrectangle.xml new file mode 100644 index 0000000000..721818a39c --- /dev/null +++ b/reference/ui/ui/draw/path/addrectangle.xml @@ -0,0 +1,66 @@ + + + + + + UI\Draw\Path::addRectangle + Draw a Rectangle + + + + &reftitle.description; + + public UI\Draw\Path::addRectangle + UI\Pointpoint + UI\Sizesize + + + Shall map the path of a rectangle of the given size, at the given point + + + + + + &reftitle.parameters; + + + point + + + The point to begin the shape + + + + + size + + + The size of the rectangle + + + + + + + + + diff --git a/reference/ui/ui/draw/path/arcto.xml b/reference/ui/ui/draw/path/arcto.xml new file mode 100644 index 0000000000..c427a883cb --- /dev/null +++ b/reference/ui/ui/draw/path/arcto.xml @@ -0,0 +1,101 @@ + + + + + + UI\Draw\Path::arcTo + Draw an Arc + + + + &reftitle.description; + + public UI\Draw\Path::arcTo + UI\Pointpoint + floatradius + floatangle + floatsweep + floatnegative + + + Shall map the path for an arc + + + + + + &reftitle.parameters; + + + point + + + The point to begin mapping + + + + + radius + + + The radius of the arc + + + + + angle + + + The angle of the arc + + + + + sweep + + + The sweep of the arc + + + + + negative + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/draw/path/bezierto.xml b/reference/ui/ui/draw/path/bezierto.xml new file mode 100644 index 0000000000..c06a23f2a8 --- /dev/null +++ b/reference/ui/ui/draw/path/bezierto.xml @@ -0,0 +1,94 @@ + + + + + + UI\Draw\Path::bezierTo + Draw Bezier Curve + + + + &reftitle.description; + + public UI\Draw\Path::bezierTo + UI\Pointpoint + floatradius + floatangle + floatsweep + floatnegative + + + Shall draw a bezier curve + + + + + + &reftitle.parameters; + + + point + + + The point at which to begin mapping + + + + + radius + + + The radius of the curve + + + + + angle + + + The angle of the curve + + + + + sweep + + + The sweep of the curve + + + + + negative + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/path/closefigure.xml b/reference/ui/ui/draw/path/closefigure.xml new file mode 100644 index 0000000000..3342696f2e --- /dev/null +++ b/reference/ui/ui/draw/path/closefigure.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Path::closeFigure + Close Figure + + + + &reftitle.description; + + public UI\Draw\Path::closeFigure + + + + Shall close the current figure + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/path/construct.xml b/reference/ui/ui/draw/path/construct.xml new file mode 100644 index 0000000000..41cb8af0b4 --- /dev/null +++ b/reference/ui/ui/draw/path/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Draw\Path::__construct + Construct a new Path + + + + &reftitle.description; + + public UI\Draw\Path::__construct + integermode + + + Shall construct a new path in the given mode + + + + + + &reftitle.parameters; + + + mode + + + Path::Winding or Path::Alternate + + + + + + + + + diff --git a/reference/ui/ui/draw/path/end.xml b/reference/ui/ui/draw/path/end.xml new file mode 100644 index 0000000000..5f9ea233de --- /dev/null +++ b/reference/ui/ui/draw/path/end.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Path::end + Finalize Path + + + + &reftitle.description; + + public UI\Draw\Path::end + + + + Shall finalize this Path + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/path/lineto.xml b/reference/ui/ui/draw/path/lineto.xml new file mode 100644 index 0000000000..45188835a1 --- /dev/null +++ b/reference/ui/ui/draw/path/lineto.xml @@ -0,0 +1,101 @@ + + + + + + UI\Draw\Path::lineTo + Draw a Line + + + + &reftitle.description; + + public ReturnTypeUI\Draw\Path::lineTo + UI\Pointpoint + floatradius + floatangle + floatsweep + floatnegative + + + Shall map the path for a line + + + + + + &reftitle.parameters; + + + point + + + The point to begin mapping + + + + + radius + + + + + + + + angle + + + + + + + + sweep + + + + + + + + negative + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/draw/path/newfigure.xml b/reference/ui/ui/draw/path/newfigure.xml new file mode 100644 index 0000000000..57cb3b47e4 --- /dev/null +++ b/reference/ui/ui/draw/path/newfigure.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Path::newFigure + Draw Figure + + + + &reftitle.description; + + public UI\Draw\Path::newFigure + UI\Pointpoint + + + Shall map a new figure at the given point + + + + + + &reftitle.parameters; + + + point + + + The point to begin mapping + + + + + + + + + + diff --git a/reference/ui/ui/draw/path/newfigurewitharc.xml b/reference/ui/ui/draw/path/newfigurewitharc.xml new file mode 100644 index 0000000000..d62cb219ee --- /dev/null +++ b/reference/ui/ui/draw/path/newfigurewitharc.xml @@ -0,0 +1,101 @@ + + + + + + UI\Draw\Path::newFigureWithArc + Draw Figure with Arc + + + + &reftitle.description; + + public UI\Draw\Path::newFigureWithArc + UI\Pointpoint + floatradius + floatangle + floatsweep + floatnegative + + + + + + + + + &reftitle.parameters; + + + point + + + + + + + + radius + + + + + + + + angle + + + + + + + + sweep + + + + + + + + negative + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/draw/pen/clip.xml b/reference/ui/ui/draw/pen/clip.xml new file mode 100644 index 0000000000..6bbe11506e --- /dev/null +++ b/reference/ui/ui/draw/pen/clip.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Pen::clip + Clip a Path + + + + &reftitle.description; + + public UI\Draw\Pen::clip + UI\Draw\Pathpath + + + Shall clip the given Path + + + + + + &reftitle.parameters; + + + path + + + The path to clip + + + + + + + + + + diff --git a/reference/ui/ui/draw/pen/fill.xml b/reference/ui/ui/draw/pen/fill.xml new file mode 100644 index 0000000000..da01b1d32e --- /dev/null +++ b/reference/ui/ui/draw/pen/fill.xml @@ -0,0 +1,67 @@ + + + + + + UI\Draw\Pen::fill + Fill a Path + + + + &reftitle.description; + + public UI\Draw\Pen::fill + UI\Draw\Pathpath + UI\Draw\Brushbrush + + + Shall fill the given path using the given brush + + + + + + &reftitle.parameters; + + + path + + + The path to fill + + + + + brush + + + The brush to perform the fill with + + + + + + + + + + diff --git a/reference/ui/ui/draw/pen/restore.xml b/reference/ui/ui/draw/pen/restore.xml new file mode 100644 index 0000000000..ef8f80bf30 --- /dev/null +++ b/reference/ui/ui/draw/pen/restore.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Pen::restore + Restore + + + + &reftitle.description; + + public UI\Draw\Pen::restore + + + + Shall restore a previously saved Pen + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/pen/save.xml b/reference/ui/ui/draw/pen/save.xml new file mode 100644 index 0000000000..7f854f8606 --- /dev/null +++ b/reference/ui/ui/draw/pen/save.xml @@ -0,0 +1,49 @@ + + + + + + UI\Draw\Pen::save + Save + + + + &reftitle.description; + + public UI\Draw\Pen::save + + + + Shall save the Pen + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/draw/pen/stroke.xml b/reference/ui/ui/draw/pen/stroke.xml new file mode 100644 index 0000000000..0d3476331e --- /dev/null +++ b/reference/ui/ui/draw/pen/stroke.xml @@ -0,0 +1,75 @@ + + + + + + UI\Draw\Pen::stroke + Stroke a Path + + + + &reftitle.description; + + public UI\Draw\Pen::stroke + UI\Draw\Pathpath + UI\Draw\Brushbrush + UI\Draw\Strokestroke + + + Shall stroke the given path using the given brush and stroke configuration + + + + + + &reftitle.parameters; + + + path + + + The path to stroke + + + + + brush + + + The brush to use while performing the stroke + + + + + stroke + + + The configuration of the stroke + + + + + + + + + diff --git a/reference/ui/ui/draw/pen/transform.xml b/reference/ui/ui/draw/pen/transform.xml new file mode 100644 index 0000000000..e421240c6a --- /dev/null +++ b/reference/ui/ui/draw/pen/transform.xml @@ -0,0 +1,57 @@ + + + + + + UI\Draw\Pen::transform + Matrix Transform + + + + &reftitle.description; + + public UI\Draw\Pen::transform + UI\Draw\Matrixmatrix + + + Shall perform matrix transformation + + + + + + &reftitle.parameters; + + + matrix + + + The matrix to use + + + + + + + + + diff --git a/reference/ui/ui/draw/pen/write.xml b/reference/ui/ui/draw/pen/write.xml new file mode 100644 index 0000000000..4d0d67c80b --- /dev/null +++ b/reference/ui/ui/draw/pen/write.xml @@ -0,0 +1,67 @@ + + + + + + UI\Draw\Pen::write + Draw Text at Point + + + + &reftitle.description; + + public UI\Draw\Pen::write + UI\Pointpoint + UI\Draw\Text\Layoutlayout + + + Shall draw the given text layout at the given point + + + + + + &reftitle.parameters; + + + point + + + The point to perform the drawing + + + + + layout + + + The layout of the text to draw + + + + + + + + + + diff --git a/reference/ui/ui/draw/stroke/construct.xml b/reference/ui/ui/draw/stroke/construct.xml new file mode 100644 index 0000000000..8e26cca56e --- /dev/null +++ b/reference/ui/ui/draw/stroke/construct.xml @@ -0,0 +1,86 @@ + + + + + + UI\Draw\Stroke::__construct + Construct a new Stroke + + + + &reftitle.description; + + public UI\Draw\Stroke::__construct + integercapUI\Draw\Line\Cap::Flat + integerjoinUI\Draw\Line\Join::Miter + floatthickness1 + floatmiterLimit10 + + + Shall construct a new Stroke + + + + + + &reftitle.parameters; + + + cap + + + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square + + + + + join + + + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel + + + + + thickness + + + The thickness of the stroke + + + + + miterLimit + + + Miter limit (default is sensible for all supported platforms) + + + + + + + + + + + diff --git a/reference/ui/ui/draw/stroke/getcap.xml b/reference/ui/ui/draw/stroke/getcap.xml new file mode 100644 index 0000000000..c8bb75cfb9 --- /dev/null +++ b/reference/ui/ui/draw/stroke/getcap.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Stroke::getCap + Get Line Cap + + + + &reftitle.description; + + public integerUI\Draw\Stroke::getCap + + + + Shall retrieve the line cap setting of this Stroke + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square + + + + + + + diff --git a/reference/ui/ui/draw/stroke/getjoin.xml b/reference/ui/ui/draw/stroke/getjoin.xml new file mode 100644 index 0000000000..25a2ef077e --- /dev/null +++ b/reference/ui/ui/draw/stroke/getjoin.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Stroke::getJoin + Get Line Join + + + + &reftitle.description; + + public integerUI\Draw\Stroke::getJoin + + + + Shall retrieve the line join setting of this Stroke + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel + + + + + + + diff --git a/reference/ui/ui/draw/stroke/getmiterlimit.xml b/reference/ui/ui/draw/stroke/getmiterlimit.xml new file mode 100644 index 0000000000..2548941150 --- /dev/null +++ b/reference/ui/ui/draw/stroke/getmiterlimit.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Stroke::getMiterLimit + Get Miter Limit + + + + &reftitle.description; + + public floatUI\Draw\Stroke::getMiterLimit + + + + Shall retrieve the miter limit of this Stroke + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current miter limit + + + + + + + diff --git a/reference/ui/ui/draw/stroke/getthickness.xml b/reference/ui/ui/draw/stroke/getthickness.xml new file mode 100644 index 0000000000..4a1cf9de6e --- /dev/null +++ b/reference/ui/ui/draw/stroke/getthickness.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Stroke::getThickness + Get Thickness + + + + &reftitle.description; + + public floatUI\Draw\Stroke::getThickness + + + + Shall retrieve the thickness of this Stroke + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current thickness + + + + + + + diff --git a/reference/ui/ui/draw/stroke/setcap.xml b/reference/ui/ui/draw/stroke/setcap.xml new file mode 100644 index 0000000000..13d2c18cf6 --- /dev/null +++ b/reference/ui/ui/draw/stroke/setcap.xml @@ -0,0 +1,56 @@ + + + + + + UI\Draw\Stroke::setCap + Set Line Cap + + + + &reftitle.description; + + public UI\Draw\Stroke::setCap + integercap + + + Shall set the line cap setting for this Stroke + + + + + &reftitle.parameters; + + + cap + + + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square + + + + + + + + + diff --git a/reference/ui/ui/draw/stroke/setjoin.xml b/reference/ui/ui/draw/stroke/setjoin.xml new file mode 100644 index 0000000000..87b6c24a77 --- /dev/null +++ b/reference/ui/ui/draw/stroke/setjoin.xml @@ -0,0 +1,65 @@ + + + + + + UI\Draw\Stroke::setJoin + Set Line Join + + + + &reftitle.description; + + public UI\Draw\Stroke::setJoin + integerjoin + + + Shall set the line join setting for this Stroke + + + + + + &reftitle.parameters; + + + join + + + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/draw/stroke/setmiterlimit.xml b/reference/ui/ui/draw/stroke/setmiterlimit.xml new file mode 100644 index 0000000000..5b9cbb1515 --- /dev/null +++ b/reference/ui/ui/draw/stroke/setmiterlimit.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Stroke::setMiterLimit + Set Miter Limit + + + + &reftitle.description; + + public UI\Draw\Stroke::setMiterLimit + floatlimit + + + Set the miter limit for this Stroke + + + + + + &reftitle.parameters; + + + limit + + + The new limit + + + + + + + + + + diff --git a/reference/ui/ui/draw/stroke/setthickness.xml b/reference/ui/ui/draw/stroke/setthickness.xml new file mode 100644 index 0000000000..e1bc054f3f --- /dev/null +++ b/reference/ui/ui/draw/stroke/setthickness.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Stroke::setThickness + Set Thickness + + + + &reftitle.description; + + public UI\Draw\Stroke::setThickness + floatthickness + + + Shall set the thickness for this Stroke + + + + + + &reftitle.parameters; + + + thickness + + + The new thickness + + + + + + + + + + diff --git a/reference/ui/ui/draw/text/entities.font.descriptor.xml b/reference/ui/ui/draw/text/entities.font.descriptor.xml new file mode 100644 index 0000000000..0e52fc65ba --- /dev/null +++ b/reference/ui/ui/draw/text/entities.font.descriptor.xml @@ -0,0 +1 @@ +&reference.ui.ui.draw.text.font.descriptor.construct; diff --git a/reference/ui/ui/draw/text/entities.font.xml b/reference/ui/ui/draw/text/entities.font.xml new file mode 100644 index 0000000000..0e825f8e3f --- /dev/null +++ b/reference/ui/ui/draw/text/entities.font.xml @@ -0,0 +1 @@ +&reference.ui.ui.draw.text.font.construct; diff --git a/reference/ui/ui/draw/text/entities.layout.xml b/reference/ui/ui/draw/text/entities.layout.xml new file mode 100644 index 0000000000..35fe8b80d2 --- /dev/null +++ b/reference/ui/ui/draw/text/entities.layout.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.draw.text.layout.construct; +&reference.ui.ui.draw.text.layout.setcolor; +&reference.ui.ui.draw.text.layout.setwidth; diff --git a/reference/ui/ui/draw/text/font.descriptor/construct.xml b/reference/ui/ui/draw/text/font.descriptor/construct.xml new file mode 100644 index 0000000000..752ab5dbb7 --- /dev/null +++ b/reference/ui/ui/draw/text/font.descriptor/construct.xml @@ -0,0 +1,106 @@ + + + + + + UI\Draw\Text\Font\Descriptor::__construct + Construct a new Font Descriptor + + + + &reftitle.description; + + public UI\Draw\Text\Font\Descriptor::__construct + stringfamily + floatsize + integerweightUI\Draw\Text\Font\Weight::Normal + integeritalicUI\Draw\Text\Font\Italic::Normal + integerstretchUI\Draw\Text\Font\Stretch::Normal + + + Shall construct a new Font Descriptor + + + + + + &reftitle.parameters; + + + family + + + The name of a valid family of fonts + + + + + size + + + The preferred size + + + + + weight + + + UI\Draw\Text\Font\Weight constant + + + + + italic + + + UI\Draw\Text\Font\Italic constant + + + + + stretch + + + UI\Draw\Text\Font\Stretch constant + + + + + + + + + + + + + diff --git a/reference/ui/ui/draw/text/font/construct.xml b/reference/ui/ui/draw/text/font/construct.xml new file mode 100644 index 0000000000..ff73a497eb --- /dev/null +++ b/reference/ui/ui/draw/text/font/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Draw\Text\Font::__construct + Construct a new Font + + + + &reftitle.description; + + public UI\Draw\Text\Font::__construct + UI\Draw\Text\Font\Descriptordescriptor + + + Shall construct a new Font using the given descriptor + + + + + + &reftitle.parameters; + + + descriptor + + + The descriptor for the Font + + + + + + + + + diff --git a/reference/ui/ui/draw/text/layout/construct.xml b/reference/ui/ui/draw/text/layout/construct.xml new file mode 100644 index 0000000000..e52d13520d --- /dev/null +++ b/reference/ui/ui/draw/text/layout/construct.xml @@ -0,0 +1,77 @@ + + + + + + UI\Draw\Text\Layout::__construct + Construct a new Text Layout + + + + &reftitle.description; + + public UI\Draw\Text\Layout::__construct + stringtext + UI\Draw\Text\Fontfont + floatwidth + + + Shall construct a new Text Layout + + + + + + &reftitle.parameters; + + + text + + + The text for the layout + + + + + font + + + The font to use for writing + + + + + width + + + The width of the layout + + + + + + + + + + + diff --git a/reference/ui/ui/draw/text/layout/setcolor.xml b/reference/ui/ui/draw/text/layout/setcolor.xml new file mode 100644 index 0000000000..e6b3aac4eb --- /dev/null +++ b/reference/ui/ui/draw/text/layout/setcolor.xml @@ -0,0 +1,76 @@ + + + + + + UI\Draw\Text\Layout::setColor + Set Color + + + + &reftitle.description; + + public UI\Draw\Text\Layout::setColor + Colorcolor + integerstart0 + integerend + + + Shall set the Color for all of, or a range of the text in the Layout + + + + + + &reftitle.parameters; + + + color + + + The color to use + + + + + start + + + The starting character + + + + + end + + + The ending character, by default the end of the string + + + + + + + + + + diff --git a/reference/ui/ui/draw/text/layout/setwidth.xml b/reference/ui/ui/draw/text/layout/setwidth.xml new file mode 100644 index 0000000000..031c7f5df5 --- /dev/null +++ b/reference/ui/ui/draw/text/layout/setwidth.xml @@ -0,0 +1,58 @@ + + + + + + UI\Draw\Text\Layout::setWidth + Set Width + + + + &reftitle.description; + + public UI\Draw\Text\Layout::setWidth + floatwidth + + + Shall set the width of this Text Layout + + + + + + &reftitle.parameters; + + + width + + + The new width + + + + + + + + + + diff --git a/reference/ui/ui/entities.app.xml b/reference/ui/ui/entities.app.xml new file mode 100644 index 0000000000..da32655ea9 --- /dev/null +++ b/reference/ui/ui/entities.app.xml @@ -0,0 +1,3 @@ +&reference.ui.ui.app.onshouldquit; +&reference.ui.ui.app.quit; +&reference.ui.ui.app.run; diff --git a/reference/ui/ui/entities.area.xml b/reference/ui/ui/entities.area.xml new file mode 100644 index 0000000000..29d637bc40 --- /dev/null +++ b/reference/ui/ui/entities.area.xml @@ -0,0 +1,6 @@ +&reference.ui.ui.area.ondraw; +&reference.ui.ui.area.onkey; +&reference.ui.ui.area.onmouse; +&reference.ui.ui.area.redraw; +&reference.ui.ui.area.scrollto; +&reference.ui.ui.area.setsize; diff --git a/reference/ui/ui/entities.control.xml b/reference/ui/ui/entities.control.xml new file mode 100644 index 0000000000..ae9e81ff2e --- /dev/null +++ b/reference/ui/ui/entities.control.xml @@ -0,0 +1,10 @@ +&reference.ui.ui.control.destroy; +&reference.ui.ui.control.disable; +&reference.ui.ui.control.enable; +&reference.ui.ui.control.getparent; +&reference.ui.ui.control.gettoplevel; +&reference.ui.ui.control.hide; +&reference.ui.ui.control.isenabled; +&reference.ui.ui.control.isvisible; +&reference.ui.ui.control.setparent; +&reference.ui.ui.control.show; diff --git a/reference/ui/ui/entities.controls.xml b/reference/ui/ui/entities.controls.xml new file mode 100644 index 0000000000..7449b39b74 --- /dev/null +++ b/reference/ui/ui/entities.controls.xml @@ -0,0 +1,19 @@ +&reference.ui.ui.controls.entities.box; +&reference.ui.ui.controls.entities.button; +&reference.ui.ui.controls.entities.check; +&reference.ui.ui.controls.entities.colorbutton; +&reference.ui.ui.controls.entities.combo; +&reference.ui.ui.controls.entities.editablecombo; +&reference.ui.ui.controls.entities.entry; +&reference.ui.ui.controls.entities.form; +&reference.ui.ui.controls.entities.grid; +&reference.ui.ui.controls.entities.group; +&reference.ui.ui.controls.entities.label; +&reference.ui.ui.controls.entities.multilineentry; +&reference.ui.ui.controls.entities.picker; +&reference.ui.ui.controls.entities.progress; +&reference.ui.ui.controls.entities.radio; +&reference.ui.ui.controls.entities.separator; +&reference.ui.ui.controls.entities.slider; +&reference.ui.ui.controls.entities.spin; +&reference.ui.ui.controls.entities.tab; diff --git a/reference/ui/ui/entities.draw.xml b/reference/ui/ui/entities.draw.xml new file mode 100644 index 0000000000..bce4e2d8d1 --- /dev/null +++ b/reference/ui/ui/entities.draw.xml @@ -0,0 +1,7 @@ +&reference.ui.ui.draw.entities.brush; +&reference.ui.ui.draw.entities.color; +&reference.ui.ui.draw.entities.matrix; +&reference.ui.ui.draw.entities.path; +&reference.ui.ui.draw.entities.pen; +&reference.ui.ui.draw.entities.stroke; +&reference.ui.ui.draw.entities.text; diff --git a/reference/ui/ui/entities.menu.xml b/reference/ui/ui/entities.menu.xml new file mode 100644 index 0000000000..8922a70e51 --- /dev/null +++ b/reference/ui/ui/entities.menu.xml @@ -0,0 +1,7 @@ +&reference.ui.ui.menu.append; +&reference.ui.ui.menu.appendabout; +&reference.ui.ui.menu.appendcheck; +&reference.ui.ui.menu.appendpreferences; +&reference.ui.ui.menu.appendquit; +&reference.ui.ui.menu.appendseparator; +&reference.ui.ui.menu.construct; diff --git a/reference/ui/ui/entities.menuitem.xml b/reference/ui/ui/entities.menuitem.xml new file mode 100644 index 0000000000..9bf1e79f4e --- /dev/null +++ b/reference/ui/ui/entities.menuitem.xml @@ -0,0 +1,5 @@ +&reference.ui.ui.menuitem.disable; +&reference.ui.ui.menuitem.enable; +&reference.ui.ui.menuitem.ischecked; +&reference.ui.ui.menuitem.onclick; +&reference.ui.ui.menuitem.setchecked; diff --git a/reference/ui/ui/entities.point.xml b/reference/ui/ui/entities.point.xml new file mode 100644 index 0000000000..4cd8c4278f --- /dev/null +++ b/reference/ui/ui/entities.point.xml @@ -0,0 +1,5 @@ +&reference.ui.ui.point.construct; +&reference.ui.ui.point.getx; +&reference.ui.ui.point.gety; +&reference.ui.ui.point.setx; +&reference.ui.ui.point.sety; diff --git a/reference/ui/ui/entities.size.xml b/reference/ui/ui/entities.size.xml new file mode 100644 index 0000000000..2676883bd9 --- /dev/null +++ b/reference/ui/ui/entities.size.xml @@ -0,0 +1,5 @@ +&reference.ui.ui.size.construct; +&reference.ui.ui.size.getheight; +&reference.ui.ui.size.getwidth; +&reference.ui.ui.size.setheight; +&reference.ui.ui.size.setwidth; diff --git a/reference/ui/ui/entities.window.xml b/reference/ui/ui/entities.window.xml new file mode 100644 index 0000000000..1dafb80196 --- /dev/null +++ b/reference/ui/ui/entities.window.xml @@ -0,0 +1,17 @@ +&reference.ui.ui.window.add; +&reference.ui.ui.window.construct; +&reference.ui.ui.window.error; +&reference.ui.ui.window.getsize; +&reference.ui.ui.window.gettitle; +&reference.ui.ui.window.hasborders; +&reference.ui.ui.window.hasmargin; +&reference.ui.ui.window.isfullscreen; +&reference.ui.ui.window.msg; +&reference.ui.ui.window.onclosing; +&reference.ui.ui.window.open; +&reference.ui.ui.window.save; +&reference.ui.ui.window.setborders; +&reference.ui.ui.window.setfullscreen; +&reference.ui.ui.window.setmargin; +&reference.ui.ui.window.setsize; +&reference.ui.ui.window.settitle; diff --git a/reference/ui/ui/menu/append.xml b/reference/ui/ui/menu/append.xml new file mode 100644 index 0000000000..98e1839279 --- /dev/null +++ b/reference/ui/ui/menu/append.xml @@ -0,0 +1,74 @@ + + + + + + UI\Menu::append + Append Menu Item + + + + &reftitle.description; + + public UI\MenuItemUI\Menu::append + stringname + stringtypeUI\MenuItem::class + + + Shall append a new Menu Item + + + + + + &reftitle.parameters; + + + name + + + The name (text) for the new item + + + + + type + + + The type for the new item + + + + + + + + &reftitle.returnvalues; + + A constructed object of the given type + + + + + + + diff --git a/reference/ui/ui/menu/appendabout.xml b/reference/ui/ui/menu/appendabout.xml new file mode 100644 index 0000000000..c105998668 --- /dev/null +++ b/reference/ui/ui/menu/appendabout.xml @@ -0,0 +1,65 @@ + + + + + + UI\Menu::appendAbout + Append About Menu Item + + + + &reftitle.description; + + public UI\MenuItemUI\Menu::appendAbout + stringtypeUI\MenuItem::class + + + Shall append an About menu item + + + + + + &reftitle.parameters; + + + type + + + The type for the new item + + + + + + + + &reftitle.returnvalues; + + A constructed About menu item of the given type + + + + + + + diff --git a/reference/ui/ui/menu/appendcheck.xml b/reference/ui/ui/menu/appendcheck.xml new file mode 100644 index 0000000000..2c6d7dff22 --- /dev/null +++ b/reference/ui/ui/menu/appendcheck.xml @@ -0,0 +1,74 @@ + + + + + + UI\Menu::appendCheck + Append Checkable Menu Item + + + + &reftitle.description; + + public UI\MenuItemUI\Menu::appendCheck + stringname + stringtypeUI\MenuItem::class + + + Shall append a checkable menu item + + + + + + &reftitle.parameters; + + + name + + + The name (text) for the new item + + + + + type + + + The type for the new item + + + + + + + + &reftitle.returnvalues; + + A constructed checkable menu item of the given type + + + + + + + diff --git a/reference/ui/ui/menu/appendpreferences.xml b/reference/ui/ui/menu/appendpreferences.xml new file mode 100644 index 0000000000..2dbab76563 --- /dev/null +++ b/reference/ui/ui/menu/appendpreferences.xml @@ -0,0 +1,65 @@ + + + + + + UI\Menu::appendPreferences + Append Preferences Menu Item + + + + &reftitle.description; + + public UI\MenuItemUI\Menu::appendPreferences + stringtypeUI\MenuItem::class + + + Shall append a Preferences menu item + + + + + + &reftitle.parameters; + + + type + + + The type for the new item + + + + + + + + &reftitle.returnvalues; + + A constructed Preferences menu item of the given type + + + + + + + diff --git a/reference/ui/ui/menu/appendquit.xml b/reference/ui/ui/menu/appendquit.xml new file mode 100644 index 0000000000..a1d03b0b3c --- /dev/null +++ b/reference/ui/ui/menu/appendquit.xml @@ -0,0 +1,65 @@ + + + + + + UI\Menu::appendQuit + Append Quit Menu Item + + + + &reftitle.description; + + public UI\MenuItemUI\Menu::appendQuit + stringtypeUI\MenuItem::class + + + Shall append a Quit menu item + + + + + + &reftitle.parameters; + + + type + + + The type for the new item + + + + + + + + &reftitle.returnvalues; + + A constructed Quit menu item of the given type + + + + + + + diff --git a/reference/ui/ui/menu/appendseparator.xml b/reference/ui/ui/menu/appendseparator.xml new file mode 100644 index 0000000000..078c254984 --- /dev/null +++ b/reference/ui/ui/menu/appendseparator.xml @@ -0,0 +1,49 @@ + + + + + + UI\Menu::appendSeparator + Append Menu Item Separator + + + + &reftitle.description; + + public UI\Menu::appendSeparator + + + + Shall append a separator + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/menu/construct.xml b/reference/ui/ui/menu/construct.xml new file mode 100644 index 0000000000..cd326d0e90 --- /dev/null +++ b/reference/ui/ui/menu/construct.xml @@ -0,0 +1,57 @@ + + + + + + UI\Menu::__construct + Construct a new Menu + + + + &reftitle.description; + + public UI\Menu::__construct + stringname + + + Shall construct a new Menu + + + + + + &reftitle.parameters; + + + name + + + The name (text) for the menu + + + + + + + + + diff --git a/reference/ui/ui/menuitem/disable.xml b/reference/ui/ui/menuitem/disable.xml new file mode 100644 index 0000000000..16d9dced33 --- /dev/null +++ b/reference/ui/ui/menuitem/disable.xml @@ -0,0 +1,49 @@ + + + + + + UI\MenuItem::disable + Disable Menu Item + + + + &reftitle.description; + + public UI\MenuItem::disable + + + + Shall disable this Menu Item + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/menuitem/enable.xml b/reference/ui/ui/menuitem/enable.xml new file mode 100644 index 0000000000..ff96fe1c21 --- /dev/null +++ b/reference/ui/ui/menuitem/enable.xml @@ -0,0 +1,49 @@ + + + + + + UI\MenuItem::enable + Enable Menu Item + + + + &reftitle.description; + + public UI\MenuItem::enable + + + + Shall enable this Menu Item + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/menuitem/ischecked.xml b/reference/ui/ui/menuitem/ischecked.xml new file mode 100644 index 0000000000..f79262d35f --- /dev/null +++ b/reference/ui/ui/menuitem/ischecked.xml @@ -0,0 +1,49 @@ + + + + + + UI\MenuItem::isChecked + Detect Checked + + + + &reftitle.description; + + public boolUI\MenuItem::isChecked + + + + Shall detect if this Menu Item is checked + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/menuitem/onclick.xml b/reference/ui/ui/menuitem/onclick.xml new file mode 100644 index 0000000000..67192168a4 --- /dev/null +++ b/reference/ui/ui/menuitem/onclick.xml @@ -0,0 +1,49 @@ + + + + + + UI\MenuItem::onClick + On Click Callback + + + + &reftitle.description; + + protected UI\MenuItem::onClick + + + + Shall be executed when this Menu Item is clicked + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + + + diff --git a/reference/ui/ui/menuitem/setchecked.xml b/reference/ui/ui/menuitem/setchecked.xml new file mode 100644 index 0000000000..8116f92c75 --- /dev/null +++ b/reference/ui/ui/menuitem/setchecked.xml @@ -0,0 +1,57 @@ + + + + + + UI\MenuItem::setChecked + Set Checked + + + + &reftitle.description; + + public UI\MenuItem::setChecked + booleanchecked + + + Shall set the checked status of this Menu Item + + + + + + &reftitle.parameters; + + + checked + + + The new status + + + + + + + + + diff --git a/reference/ui/ui/point/construct.xml b/reference/ui/ui/point/construct.xml new file mode 100644 index 0000000000..f6b436eac0 --- /dev/null +++ b/reference/ui/ui/point/construct.xml @@ -0,0 +1,65 @@ + + + + + + UI\Point::__construct + Construct a new Point + + + + &reftitle.description; + + public UI\Point::__construct + floatx + floaty + + + Construct a new Point using new co-ordinates + + + + + &reftitle.parameters; + + + x + + + The new X co-ordinate + + + + + y + + + The new Y co-ordinate + + + + + + + + + diff --git a/reference/ui/ui/point/getx.xml b/reference/ui/ui/point/getx.xml new file mode 100644 index 0000000000..a0ea3ec3ee --- /dev/null +++ b/reference/ui/ui/point/getx.xml @@ -0,0 +1,55 @@ + + + + + + UI\Point::getX + Retrieves X + + + + &reftitle.description; + + public floatUI\Point::getX + + + + Retrieves the X co-ordinate + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current X co-ordinate + + + + + + + diff --git a/reference/ui/ui/point/gety.xml b/reference/ui/ui/point/gety.xml new file mode 100644 index 0000000000..81091f8408 --- /dev/null +++ b/reference/ui/ui/point/gety.xml @@ -0,0 +1,55 @@ + + + + + + UI\Point::getY + Retrieves Y + + + + &reftitle.description; + + public floatUI\Point::getY + + + + Retrieves the Y co-ordinate + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current Y co-ordinate + + + + + + + diff --git a/reference/ui/ui/point/setx.xml b/reference/ui/ui/point/setx.xml new file mode 100644 index 0000000000..89bdaa4fb3 --- /dev/null +++ b/reference/ui/ui/point/setx.xml @@ -0,0 +1,64 @@ + + + + + + UI\Point::setX + Set X + + + + &reftitle.description; + + public UI\Point::setX + floatpoint + + + Set the X co-ordinate + + + + + &reftitle.parameters; + + + point + + + The new X co-ordinate + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/point/sety.xml b/reference/ui/ui/point/sety.xml new file mode 100644 index 0000000000..8032d4bf53 --- /dev/null +++ b/reference/ui/ui/point/sety.xml @@ -0,0 +1,64 @@ + + + + + + UI\Point::setY + Set Y + + + + &reftitle.description; + + public UI\Point::setY + floatpoint + + + Set the Y co-ordinate + + + + + &reftitle.parameters; + + + point + + + The new Y co-ordinate + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/size/construct.xml b/reference/ui/ui/size/construct.xml new file mode 100644 index 0000000000..026366a3ab --- /dev/null +++ b/reference/ui/ui/size/construct.xml @@ -0,0 +1,79 @@ + + + + + + UI\Size::__construct + Construct a new Size + + + + &reftitle.description; + + public UI\Size::__construct + floatwidth + floatheight + + + Construct a new Size using new width and height + + + + + + &reftitle.parameters; + + + width + + + The new width + + + + + height + + + The new height + + + + + + + + + + + + + diff --git a/reference/ui/ui/size/getheight.xml b/reference/ui/ui/size/getheight.xml new file mode 100644 index 0000000000..074078af2c --- /dev/null +++ b/reference/ui/ui/size/getheight.xml @@ -0,0 +1,54 @@ + + + + + + UI\Size::getHeight + Retrieves Height + + + + &reftitle.description; + + public floatUI\Size::getHeight + + + + Retrieves the Height + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current Height + + + + + diff --git a/reference/ui/ui/size/getwidth.xml b/reference/ui/ui/size/getwidth.xml new file mode 100644 index 0000000000..e1d49ba00f --- /dev/null +++ b/reference/ui/ui/size/getwidth.xml @@ -0,0 +1,56 @@ + + + + + + UI\Size::getWidth + Retrives Width + + + + &reftitle.description; + + public floatUI\Size::getWidth + + + + Retrieves the Width + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current Width + + + + + + + diff --git a/reference/ui/ui/size/setheight.xml b/reference/ui/ui/size/setheight.xml new file mode 100644 index 0000000000..2d505cd403 --- /dev/null +++ b/reference/ui/ui/size/setheight.xml @@ -0,0 +1,65 @@ + + + + + + UI\Size::setHeight + Set Height + + + + &reftitle.description; + + public UI\Size::setHeight + floatsize + + + Set new Height + + + + + + &reftitle.parameters; + + + size + + + The new Height + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/size/setwidth.xml b/reference/ui/ui/size/setwidth.xml new file mode 100644 index 0000000000..6269bbb7fd --- /dev/null +++ b/reference/ui/ui/size/setwidth.xml @@ -0,0 +1,65 @@ + + + + + + UI\Size::setWidth + Set Width + + + + &reftitle.description; + + public UI\Size::setWidth + floatsize + + + Set new Width + + + + + + &reftitle.parameters; + + + size + + + The new Width + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/add.xml b/reference/ui/ui/window/add.xml new file mode 100644 index 0000000000..584e36d623 --- /dev/null +++ b/reference/ui/ui/window/add.xml @@ -0,0 +1,65 @@ + + + + + + UI\Window::add + Add a Control + + + + &reftitle.description; + + public UI\Window::add + UI\Controlcontrol + + + Shall add a Control to this Window + + + + + + &reftitle.parameters; + + + control + + + The Control to add + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/construct.xml b/reference/ui/ui/window/construct.xml new file mode 100644 index 0000000000..b5b8624394 --- /dev/null +++ b/reference/ui/ui/window/construct.xml @@ -0,0 +1,97 @@ + + + + + + UI\Window::__construct + Construct a new Window + + + + &reftitle.description; + + public UI\Window::__construct + UI\Appapp + stringtitle + Sizesize + booleanmenu + + + Shall construct a new Window for the App + + + + + + &reftitle.parameters; + + + app + + + The owner of this Window + + + + + title + + + The title of the Window + + + + + size + + + The size of the Window + + + + + menu + + + Menu switch + + + + + + + + + + + + + diff --git a/reference/ui/ui/window/error.xml b/reference/ui/ui/window/error.xml new file mode 100644 index 0000000000..1d19857c7b --- /dev/null +++ b/reference/ui/ui/window/error.xml @@ -0,0 +1,67 @@ + + + + + + UI\Window::error + Show Error Box + + + + &reftitle.description; + + public UI\Window::error + stringtitle + stringmsg + + + Shall show an error box + + + + + + &reftitle.parameters; + + + title + + + The title of the error box + + + + + msg + + + The message for the error box + + + + + + + + + + diff --git a/reference/ui/ui/window/getsize.xml b/reference/ui/ui/window/getsize.xml new file mode 100644 index 0000000000..398db5fd58 --- /dev/null +++ b/reference/ui/ui/window/getsize.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::getSize + Get Window Size + + + + &reftitle.description; + + public UI\SizeUI\Window::getSize + + + + Shall return the size of this Window + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/gettitle.xml b/reference/ui/ui/window/gettitle.xml new file mode 100644 index 0000000000..6687a4411b --- /dev/null +++ b/reference/ui/ui/window/gettitle.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::getTitle + Get Title + + + + &reftitle.description; + + public stringUI\Window::getTitle + + + + Shall retrieve the title of this Window + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/hasborders.xml b/reference/ui/ui/window/hasborders.xml new file mode 100644 index 0000000000..7f601c91b3 --- /dev/null +++ b/reference/ui/ui/window/hasborders.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::hasBorders + Border Detection + + + + &reftitle.description; + + public boolUI\Window::hasBorders + + + + Shall detect if borders are used on this Window + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/hasmargin.xml b/reference/ui/ui/window/hasmargin.xml new file mode 100644 index 0000000000..dd730ad7f7 --- /dev/null +++ b/reference/ui/ui/window/hasmargin.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::hasMargin + Margin Detection + + + + &reftitle.description; + + public boolUI\Window::hasMargin + + + + Shall detect if margins are used on this Window + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/isfullscreen.xml b/reference/ui/ui/window/isfullscreen.xml new file mode 100644 index 0000000000..9c3a2ded5b --- /dev/null +++ b/reference/ui/ui/window/isfullscreen.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::isFullScreen + Full Screen Detection + + + + &reftitle.description; + + public boolUI\Window::isFullScreen + + + + Shall detect if this Window us using the whole screen + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/msg.xml b/reference/ui/ui/window/msg.xml new file mode 100644 index 0000000000..a229906ec6 --- /dev/null +++ b/reference/ui/ui/window/msg.xml @@ -0,0 +1,67 @@ + + + + + + UI\Window::msg + Show Message Box + + + + &reftitle.description; + + public UI\Window::msg + stringtitle + stringmsg + + + Shall show a message box + + + + + + &reftitle.parameters; + + + title + + + The title of the message box + + + + + msg + + + The message + + + + + + + + + + diff --git a/reference/ui/ui/window/onclosing.xml b/reference/ui/ui/window/onclosing.xml new file mode 100644 index 0000000000..6c7653fe16 --- /dev/null +++ b/reference/ui/ui/window/onclosing.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::onClosing + Closing Callback + + + + &reftitle.description; + + protected intUI\Window::onClosing + + + + Should gracefully destroy this Window + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/open.xml b/reference/ui/ui/window/open.xml new file mode 100644 index 0000000000..5e4f799d6a --- /dev/null +++ b/reference/ui/ui/window/open.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::open + Open Dialog + + + + &reftitle.description; + + public stringUI\Window::open + + + + Shall show an open file dialog + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the name of the file selected for opening + + + + + + + diff --git a/reference/ui/ui/window/save.xml b/reference/ui/ui/window/save.xml new file mode 100644 index 0000000000..bebbc89f54 --- /dev/null +++ b/reference/ui/ui/window/save.xml @@ -0,0 +1,56 @@ + + + + + + UI\Window::save + Save Dialog + + + + &reftitle.description; + + public stringUI\Window::save + + + + Shall show a save dialog + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the file name selecting for saving + + + + + + + diff --git a/reference/ui/ui/window/setborders.xml b/reference/ui/ui/window/setborders.xml new file mode 100644 index 0000000000..d658797fda --- /dev/null +++ b/reference/ui/ui/window/setborders.xml @@ -0,0 +1,58 @@ + + + + + + UI\Window::setBorders + Border Use + + + + &reftitle.description; + + public UI\Window::setBorders + booleanborders + + + Shall enable or disable the use of borders on this Window + + + + + + &reftitle.parameters; + + + borders + + + + + + + + + + + + + diff --git a/reference/ui/ui/window/setfullscreen.xml b/reference/ui/ui/window/setfullscreen.xml new file mode 100644 index 0000000000..55cb08fdd5 --- /dev/null +++ b/reference/ui/ui/window/setfullscreen.xml @@ -0,0 +1,60 @@ + + + + + + UI\Window::setFullScreen + Full Screen Use + + + + &reftitle.description; + + public UI\Window::setFullScreen + booleanfull + + + Shall enable or disable the use of the full screen for this Window + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + full + + + + + + + + + + + + + diff --git a/reference/ui/ui/window/setmargin.xml b/reference/ui/ui/window/setmargin.xml new file mode 100644 index 0000000000..05f6a32b56 --- /dev/null +++ b/reference/ui/ui/window/setmargin.xml @@ -0,0 +1,58 @@ + + + + + + UI\Window::setMargin + Margin Use + + + + &reftitle.description; + + public UI\Window::setMargin + booleanmargin + + + Shall enable or disable the use of margins for this Window + + + + + + &reftitle.parameters; + + + margin + + + + + + + + + + + + + diff --git a/reference/ui/ui/window/setsize.xml b/reference/ui/ui/window/setsize.xml new file mode 100644 index 0000000000..3cfa9af1d8 --- /dev/null +++ b/reference/ui/ui/window/setsize.xml @@ -0,0 +1,65 @@ + + + + + + UI\Window::setSize + Set Size + + + + &reftitle.description; + + public UI\Window::setSize + UI\Sizesize + + + Shall set the size of this Window + + + + + + &reftitle.parameters; + + + size + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + + diff --git a/reference/ui/ui/window/settitle.xml b/reference/ui/ui/window/settitle.xml new file mode 100644 index 0000000000..86131fc232 --- /dev/null +++ b/reference/ui/ui/window/settitle.xml @@ -0,0 +1,58 @@ + + + + + + UI\Window::setTitle + Window Title + + + + &reftitle.description; + + public UI\Window::setTitle + stringtitle + + + Shall set the title for this Window + + + + + + &reftitle.parameters; + + + title + + + The new title + + + + + + + + + + diff --git a/reference/ui/versions.xml b/reference/ui/versions.xml new file mode 100644 index 0000000000..d946b88c02 --- /dev/null +++ b/reference/ui/versions.xml @@ -0,0 +1,508 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +