cvs: phpdoc /en/reference/newt constants.xml reference.xml /en/reference/newt/functions newt-form-add-component.xml newt-form-add-components.xml
newt-form-destroy.xml newt-form-run.xml newt-form.xml newt-run-form.xml
| From: | Michael Spector | Date: | Thu, 20 Oct 2005 12:51:15 +0000 |
| Subject: | cvs: phpdoc /en/reference/newt constants.xml reference.xml /en/reference/newt/functions newt-form-add-component.xml newt-form-add-components.xml newt-form-destroy.xml newt-form-run.xml newt-form.xml newt-run-form.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969370632@lists.php.net to get a copy of this message | ||
michael Thu Oct 20 08:51:15 2005 EDT
Added files:
/phpdoc/en/reference/newt/functions newt-form-destroy.xml
Modified files:
/phpdoc/en/reference/newt constants.xml reference.xml
/phpdoc/en/reference/newt/functions newt-form-add-component.xml
newt-form-add-components.xml
newt-form-run.xml newt-form.xml
newt-run-form.xml
Log:
- organized constants
- documented some form functions
http://cvs.php.net/diff.php/phpdoc/en/reference/newt/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/constants.xml diff -u phpdoc/en/reference/newt/constants.xml:1.1 phpdoc/en/reference/newt/constants.xml:1.2 --- phpdoc/en/reference/newt/constants.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/constants.xml Thu Oct 20 08:51:14 2005 @@ -1,1122 +1,659 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> <section id="newt.constants"> &reftitle.constants; &extension.constants; - <variablelist> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ROOT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_BORDER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> + <section id="constants.newt.reasons"> + <title>Reason</title> + <table> + <title>Newt form exit reasons</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_EXIT_HOTKEY</constant></entry> + <entry>hotkey defined by <function>newt_form_add_hot_key</function> was pressed</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_COMPONENT</constant></entry> + <entry>some component has caused form to exit</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_FDREADY</constant></entry> + <entry>file descriptor specified in + <function>newt_form_watch_fd</function> is ready to be read or written + to</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_TIMER</constant></entry> + <entry>time specified in <function>newt_form_set_timer</function> has + elapsed</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.colorsets"> + <title>Colorset</title> + <table> + <title>Newt colorsets</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_COLORSET_ROOT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_BORDER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_WINDOW</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_SHADOW</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_TITLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_BUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTBUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_CHECKBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTCHECKBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ENTRY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_LABEL</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_LISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTLISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_TEXTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTTEXTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_HELPLINE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ROOTTEXT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ROOTTEXT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_EMPTYSCALE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_FULLSCALE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_DISENTRY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_COMPACTBUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTSELLISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_SELLISTBOX</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.args_flags"> + <title>Arg</title> + <table> + <title>Newt argument flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ARG_LAST</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ARG_APPEND</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.sense_flags"> + <title>Flags Sense</title> + <table> + <title>Newt Flags Sense</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FLAGS_SET</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAGS_RESET</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAGS_TOGGLE</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.components_flags"> + <title>Flag</title> + <table> + <title>Newt Components Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FLAG_RETURNEXIT</constant></entry> + <entry>Exit form, when component is activated</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_HIDDEN</constant></entry> + <entry>Component is hidden</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SCROLL</constant></entry> + <entry>Component is scrollable</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_DISABLED</constant></entry> + <entry>Component is disabled</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_BORDER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAG_WRAP</constant></entry> + <entry>Wrap text</entry> + </row> + <row> + <entry>NEWT_FLAG_NOF12</entry> + <entry>Don't exit form on pressing F12</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_MULTIPLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SELECTED</constant></entry> + <entry>Component is selected</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_CHECKBOX</constant></entry> + <entry>Component is checkbox</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_PASSWORD</constant></entry> + <entry>Entry component is password entry</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SHOWCURSOR</constant></entry> + <entry>Show cursor</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.fd_flags"> + <title>Flag</title> + <table> + <title>File Descriptor Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FD_READ</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FD_WRITE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FD_EXCEPT</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.cbtree_flags"> + <title>Flag</title> + <table> + <title>Checkbox Tree Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_CHECKBOXTREE_UNSELECTABLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_HIDE_BOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_COLLAPSED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_EXPANDED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_UNSELECTED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_SELECTED</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.entry_flags"> + <title>Flag</title> + <table> + <title>Entry Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ENTRY_SCROLL</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_HIDDEN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_RETURNEXIT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_DISABLED</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.listbox_flags"> + <title>Flag</title> + <table> + <title>Listbox Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_LISTBOX_RETURNEXIT</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.textbox_flags"> + <title>Flag</title> + <table> + <title>Textbox Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_TEXTBOX_WRAP</constant></entry> + <entry>Wrap text in the textbox</entry> + </row> + <row> + <entry><constant>NEWT_TEXTBOX_SCROLL</constant></entry> + <entry>Scroll text in the textbox</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.form_flags"> + <title>Flag</title> + <table> + <title>Form Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry>NEWT_FORM_NOF12</entry> + <entry>Don't exit form on F12 press</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.keys"> + <title>Key</title> + <table> + <title>Newt Keys</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_KEY_TAB</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_ENTER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_SUSPEND</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_ESCAPE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RETURN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_EXTRA_BASE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_UP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_DOWN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_LEFT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RIGHT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_BKSPC</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_DELETE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_HOME</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_END</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_UNTAB</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_PGUP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_PGDN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_INSERT</constant></entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F1</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F2</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F3</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F4</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F5</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F6</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F7</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F8</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F9</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F10</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F11</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F12</entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RESIZE</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.anchor"> + <title>Anchor</title> + <table> + <title>Newt Anchors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ANCHOR_LEFT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_RIGHT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_TOP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_BOTTOM</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.grid_flags"> + <title>Flag</title> + <table> + <title>Grid Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_GRID_FLAG_GROWX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_FLAG_GROWY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_EMPTY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_COMPONENT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_SUBGRID</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_WINDOW</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_SHADOW</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_TITLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_BUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTBUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_CHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTCHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ENTRY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_LABEL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_LISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_TEXTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTTEXTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_HELPLINE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ROOTTEXT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_EMPTYSCALE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_FULLSCALE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_DISENTRY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_COMPACTBUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTSELLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_SELLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ARG_LAST</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ARG_APPEND</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_SET</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_RESET</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_TOGGLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_HIDDEN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_DISABLED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_BORDER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_WRAP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_NOF12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_MULTIPLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_CHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_PASSWORD</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SHOWCURSOR</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_READ</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_WRITE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_EXCEPT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_UNSELECTABLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_HIDE_BOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_COLLAPSED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_EXPANDED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_UNSELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_SELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_LISTBOX_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_HIDDEN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_DISABLED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_TEXTBOX_WRAP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_TEXTBOX_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FORM_NOF12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_HOTKEY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_COMPONENT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_FDREADY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_TIMER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_TAB</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_ENTER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_SUSPEND</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_ESCAPE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RETURN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_EXTRA_BASE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_UP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_DOWN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_LEFT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RIGHT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_BKSPC</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_DELETE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_HOME</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_END</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_UNTAB</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_PGUP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_PGDN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_INSERT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F1</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F2</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F3</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F4</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F5</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F6</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F7</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F8</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F9</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F10</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F11</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RESIZE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_LEFT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_RIGHT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_TOP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_BOTTOM</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_FLAG_GROWX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_FLAG_GROWY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_EMPTY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_COMPONENT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_SUBGRID</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - </variablelist> </section> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/newt/reference.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/reference.xml diff -u phpdoc/en/reference/newt/reference.xml:1.1 phpdoc/en/reference/newt/reference.xml:1.2 --- phpdoc/en/reference/newt/reference.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/reference.xml Thu Oct 20 08:51:14 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Purpose: utilspec.cmdline --> <!-- Membership: pecl, external --> <!-- State: experimental --> @@ -42,9 +42,67 @@ returned by newt grid factory functions (for example: <function>newt_create_grid</function>) </para> </section> + <!-- Information found in constants.xml --> &reference.newt.constants; + + <section id="newt.examples"> + &reftitle.examples; + <para> + This example is a PHP port of RedHat 'setup' utility dialog, executed in text + mode. + </para> + <example> + <title>Newt Usage Example</title> + <programlisting role="php"> +<![CDATA[ +<?php + newt_init (); + newt_cls (); + + newt_draw_root_text (0, 0, "Test Mode Setup Utility 1.12"); + newt_push_help_line (null); + newt_draw_root_text (-30, 0, "(c) 1999-2002 RedHat, Inc"); + + newt_get_screen_size (&$rows, &$cols); + + newt_open_window ($rows/2-17, $cols/2-10, 34, 17, "Choose a Tool"); + + $form = newt_form (); + + $list = newt_listbox (3, 2, 10); + + foreach (array ( + "Authentication configuration", + "Firewall configuration", + "Mouse configuration", + "Network configuration", + "Printer configuration", + "System services") as $l_item) + { + newt_listbox_add_entry ($list, $l_item, $l_item); + } + + $b1 = newt_button (5, 12, "Run Tool"); + $b2 = newt_button (21, 12, "Quit"); + + newt_form_add_component ($form, $list); + newt_form_add_components ($form, array($b1, $b2)); + + newt_refresh (); + newt_run_form ($form); + + newt_pop_window (); + newt_pop_help_line (); + newt_finished (); + newt_form_destroy ($form); +?> +]]> + </programlisting> + </example> + </section> </partintro> + &reference.newt.functions; </reference> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-component.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-add-component.xml diff -u phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-component.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-add-component"> <refnamediv> <refname>newt_form_add_component</refname> - <refpurpose></refpurpose> + <refpurpose>Adds a single component to the form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>resource</type><parameter>component</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Adds a single component to the form which is passed as the first parameter. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form to which component will be added </para> </listitem> </varlistentry> @@ -32,100 +32,23 @@ <term><parameter>component</parameter></term> <listitem> <para> - Its description + Component to add to the form </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_add_component</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_add_components</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-components.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-add-components.xml diff -u phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-components.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-add-components"> <refnamediv> <refname>newt_form_add_components</refname> - <refpurpose></refpurpose> + <refpurpose>Add several components to the form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>array</type><parameter>components</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Adds several components to the form which is passed as the first parameter. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form to which components will be added </para> </listitem> </varlistentry> @@ -32,100 +32,22 @@ <term><parameter>components</parameter></term> <listitem> <para> - Its description + Array of components to add to the form </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_add_components</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_add_component</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-run.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-run.xml diff -u phpdoc/en/reference/newt/functions/newt-form-run.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-run.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-run.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-run.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-run"> <refnamediv> <refname>newt_form_run</refname> - <refpurpose></refpurpose> + <refpurpose>Runs a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">exit_struct</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + This function runs the form passed to it. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form component </para> </listitem> </varlistentry> @@ -32,100 +32,61 @@ <term><parameter>exit_struct</parameter></term> <listitem> <para> - Its description + Array, used for returning information after running the form component. + Keys and values are described in the following table: + <table> + <title>Form Exit Structure</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Index Key</entry> + <entry>Value Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>reason</entry> + <entry>integer</entry> + <entry> + The reason, why the form has been exited. Possible values are + defined <link linkend="constants.newt.reasons">here</link>. + </entry> + </row> + <row> + <entry>watch</entry> + <entry>resource</entry> + <entry>Resource link, specified in + <function>newt_form_watch_fd</function></entry> + </row> + <row> + <entry>key</entry> + <entry>integer</entry> + <entry>Hotkey</entry> + </row> + <row> + <entry>component</entry> + <entry>resource</entry> + <entry>Component, which caused the form to exit</entry> + </row> + </tbody> + </tgroup> + </table> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_run</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_run_form</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form.xml diff -u phpdoc/en/reference/newt/functions/newt-form.xml:1.2 phpdoc/en/reference/newt/functions/newt-form.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form"> <refnamediv> <refname>newt_form</refname> - <refpurpose></refpurpose> + <refpurpose>Create a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,9 +13,9 @@ <methodparam choice="opt"><type>string</type><parameter>help</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Create a new form. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -25,7 +25,7 @@ <term><parameter>vert_bar</parameter></term> <listitem> <para> - Its description + Vertical scrollbar which should be associated with the form </para> </listitem> </varlistentry> @@ -33,7 +33,7 @@ <term><parameter>help</parameter></term> <listitem> <para> - Its description + Help text string </para> </listitem> </varlistentry> @@ -41,7 +41,7 @@ <term><parameter>flags</parameter></term> <listitem> <para> - Its description + Various flags </para> </listitem> </varlistentry> @@ -51,90 +51,53 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> + Resource link to the created form component. </para> </refsect1> - --> - - <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>newt_form</function> example</title> <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out + Displays a single button "Quit", which closes the application once it's + pressed. </para> <programlisting role="php"> <![CDATA[ <?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} +newt_init(); +newt_cls(); + +$myform = newt_form(); +$button = newt_button (5, 12, "Quit"); + +newt_form_add_component ($myform, $button); +newt_refresh (); +newt_run_form ($myform); + +newt_finished (); +newt_form_destroy ($myform); ?> ]]> </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> </example> </para> </refsect1> - --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_run</function></member> + <member><function>newt_run_form</function></member> + <member><function>newt_form_add_component</function></member> + <member><function>newt_form_add_components</function></member> + <member><function>newt_form_destroy</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-run-form.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-run-form.xml diff -u phpdoc/en/reference/newt/functions/newt-run-form.xml:1.2 phpdoc/en/reference/newt/functions/newt-run-form.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-run-form.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-run-form.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-run-form"> <refnamediv> <refname>newt_run_form</refname> - <refpurpose></refpurpose> + <refpurpose>Runs a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -11,9 +11,9 @@ <type>resource</type><methodname>newt_run_form</methodname> <methodparam><type>resource</type><parameter>form</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + This function runs the form passed to it. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -23,7 +23,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form component </para> </listitem> </varlistentry> @@ -33,90 +33,29 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_run_form</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> + The component which caused the form to stop running. </para> + <note> + <para> + Notice that this function doesn't fit in with newt's normal naming + convention. It is an older interface which will not work for all forms. It + was left in newt only for legacy applications. It is a simpler interface + than the new <function>newt_form_run</function> though, and is still used quite often as a + result. When an application is done with a form, it destroys the form and + all of the components the form contains. + </para> + </note> </refsect1> - --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_run</function></member> + <member><function>newt_form_destroy</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/co.php/phpdoc/en/reference/newt/functions/newt-form-destroy.xml?r=1.1&p=1 Index: phpdoc/en/reference/newt/functions/newt-form-destroy.xml +++ phpdoc/en/reference/newt/functions/newt-form-destroy.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.newt-form-destroy"> <refnamediv> <refname>newt_form_destroy</refname> <refpurpose>Destroys a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>newt_form_destroy</methodname> <methodparam><type>resource</type><parameter>form</parameter></methodparam> </methodsynopsis> <para> This function frees the memory resources used by the form and all of the components which have been added to the form (including those components which are on subforms). Once a form has been destroyed, none of the form's components can be used. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>form</parameter></term> <listitem> <para> Form component, which is going to be destroyed </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>newt_form_run</function></member> <member><function>newt_run_form</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
http://cvs.php.net/diff.php/phpdoc/en/reference/newt/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/constants.xml diff -u phpdoc/en/reference/newt/constants.xml:1.1 phpdoc/en/reference/newt/constants.xml:1.2 --- phpdoc/en/reference/newt/constants.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/constants.xml Thu Oct 20 08:51:14 2005 @@ -1,1122 +1,659 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> <section id="newt.constants"> &reftitle.constants; &extension.constants; - <variablelist> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ROOT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_BORDER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> + <section id="constants.newt.reasons"> + <title>Reason</title> + <table> + <title>Newt form exit reasons</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_EXIT_HOTKEY</constant></entry> + <entry>hotkey defined by <function>newt_form_add_hot_key</function> was pressed</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_COMPONENT</constant></entry> + <entry>some component has caused form to exit</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_FDREADY</constant></entry> + <entry>file descriptor specified in + <function>newt_form_watch_fd</function> is ready to be read or written + to</entry> + </row> + <row> + <entry><constant>NEWT_EXIT_TIMER</constant></entry> + <entry>time specified in <function>newt_form_set_timer</function> has + elapsed</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.colorsets"> + <title>Colorset</title> + <table> + <title>Newt colorsets</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_COLORSET_ROOT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_BORDER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_WINDOW</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_SHADOW</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_TITLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_BUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTBUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_CHECKBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTCHECKBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ENTRY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_LABEL</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_LISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTLISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_TEXTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTTEXTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_HELPLINE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ROOTTEXT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ROOTTEXT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_EMPTYSCALE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_FULLSCALE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_DISENTRY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_COMPACTBUTTON</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_ACTSELLISTBOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_COLORSET_SELLISTBOX</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.args_flags"> + <title>Arg</title> + <table> + <title>Newt argument flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ARG_LAST</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ARG_APPEND</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.sense_flags"> + <title>Flags Sense</title> + <table> + <title>Newt Flags Sense</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FLAGS_SET</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAGS_RESET</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAGS_TOGGLE</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.components_flags"> + <title>Flag</title> + <table> + <title>Newt Components Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FLAG_RETURNEXIT</constant></entry> + <entry>Exit form, when component is activated</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_HIDDEN</constant></entry> + <entry>Component is hidden</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SCROLL</constant></entry> + <entry>Component is scrollable</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_DISABLED</constant></entry> + <entry>Component is disabled</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_BORDER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAG_WRAP</constant></entry> + <entry>Wrap text</entry> + </row> + <row> + <entry>NEWT_FLAG_NOF12</entry> + <entry>Don't exit form on pressing F12</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_MULTIPLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SELECTED</constant></entry> + <entry>Component is selected</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_CHECKBOX</constant></entry> + <entry>Component is checkbox</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_PASSWORD</constant></entry> + <entry>Entry component is password entry</entry> + </row> + <row> + <entry><constant>NEWT_FLAG_SHOWCURSOR</constant></entry> + <entry>Show cursor</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.fd_flags"> + <title>Flag</title> + <table> + <title>File Descriptor Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_FD_READ</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FD_WRITE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_FD_EXCEPT</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.cbtree_flags"> + <title>Flag</title> + <table> + <title>Checkbox Tree Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_CHECKBOXTREE_UNSELECTABLE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_HIDE_BOX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_COLLAPSED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_EXPANDED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_UNSELECTED</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_CHECKBOXTREE_SELECTED</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.entry_flags"> + <title>Flag</title> + <table> + <title>Entry Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ENTRY_SCROLL</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_HIDDEN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_RETURNEXIT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ENTRY_DISABLED</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.listbox_flags"> + <title>Flag</title> + <table> + <title>Listbox Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_LISTBOX_RETURNEXIT</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.textbox_flags"> + <title>Flag</title> + <table> + <title>Textbox Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_TEXTBOX_WRAP</constant></entry> + <entry>Wrap text in the textbox</entry> + </row> + <row> + <entry><constant>NEWT_TEXTBOX_SCROLL</constant></entry> + <entry>Scroll text in the textbox</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.form_flags"> + <title>Flag</title> + <table> + <title>Form Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry>NEWT_FORM_NOF12</entry> + <entry>Don't exit form on F12 press</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.keys"> + <title>Key</title> + <table> + <title>Newt Keys</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_KEY_TAB</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_ENTER</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_SUSPEND</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_ESCAPE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RETURN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_EXTRA_BASE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_UP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_DOWN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_LEFT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RIGHT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_BKSPC</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_DELETE</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_HOME</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_END</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_UNTAB</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_PGUP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_PGDN</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_INSERT</constant></entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F1</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F2</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F3</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F4</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F5</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F6</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F7</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F8</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F9</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F10</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F11</entry> + <entry></entry> + </row> + <row> + <entry>NEWT_KEY_F12</entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_KEY_RESIZE</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.anchor"> + <title>Anchor</title> + <table> + <title>Newt Anchors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_ANCHOR_LEFT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_RIGHT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_TOP</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_ANCHOR_BOTTOM</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="constants.newt.grid_flags"> + <title>Flag</title> + <table> + <title>Grid Flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>constant</entry> + <entry>meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>NEWT_GRID_FLAG_GROWX</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_FLAG_GROWY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_EMPTY</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_COMPONENT</constant></entry> + <entry></entry> + </row> + <row> + <entry><constant>NEWT_GRID_SUBGRID</constant></entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_WINDOW</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_SHADOW</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_TITLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_BUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTBUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_CHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTCHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ENTRY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_LABEL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_LISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_TEXTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTTEXTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_HELPLINE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ROOTTEXT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_EMPTYSCALE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_FULLSCALE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_DISENTRY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_COMPACTBUTTON</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_ACTSELLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_COLORSET_SELLISTBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ARG_LAST</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ARG_APPEND</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_SET</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_RESET</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAGS_TOGGLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_HIDDEN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_DISABLED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_BORDER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_WRAP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_NOF12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_MULTIPLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_CHECKBOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_PASSWORD</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FLAG_SHOWCURSOR</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_READ</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_WRITE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FD_EXCEPT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_UNSELECTABLE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_HIDE_BOX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_COLLAPSED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_EXPANDED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_UNSELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_CHECKBOXTREE_SELECTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_LISTBOX_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_HIDDEN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_RETURNEXIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ENTRY_DISABLED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_TEXTBOX_WRAP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_TEXTBOX_SCROLL</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_FORM_NOF12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_HOTKEY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_COMPONENT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_FDREADY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_EXIT_TIMER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_TAB</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_ENTER</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_SUSPEND</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_ESCAPE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RETURN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_EXTRA_BASE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_UP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_DOWN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_LEFT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RIGHT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_BKSPC</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_DELETE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_HOME</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_END</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_UNTAB</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_PGUP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_PGDN</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_INSERT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F1</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F2</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F3</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F4</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F5</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F6</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F7</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F8</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F9</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F10</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F11</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_F12</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_KEY_RESIZE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_LEFT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_RIGHT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_TOP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_ANCHOR_BOTTOM</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_FLAG_GROWX</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_FLAG_GROWY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_EMPTY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_COMPONENT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>NEWT_GRID_SUBGRID</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - </variablelist> </section> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/newt/reference.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/reference.xml diff -u phpdoc/en/reference/newt/reference.xml:1.1 phpdoc/en/reference/newt/reference.xml:1.2 --- phpdoc/en/reference/newt/reference.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/reference.xml Thu Oct 20 08:51:14 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Purpose: utilspec.cmdline --> <!-- Membership: pecl, external --> <!-- State: experimental --> @@ -42,9 +42,67 @@ returned by newt grid factory functions (for example: <function>newt_create_grid</function>) </para> </section> + <!-- Information found in constants.xml --> &reference.newt.constants; + + <section id="newt.examples"> + &reftitle.examples; + <para> + This example is a PHP port of RedHat 'setup' utility dialog, executed in text + mode. + </para> + <example> + <title>Newt Usage Example</title> + <programlisting role="php"> +<![CDATA[ +<?php + newt_init (); + newt_cls (); + + newt_draw_root_text (0, 0, "Test Mode Setup Utility 1.12"); + newt_push_help_line (null); + newt_draw_root_text (-30, 0, "(c) 1999-2002 RedHat, Inc"); + + newt_get_screen_size (&$rows, &$cols); + + newt_open_window ($rows/2-17, $cols/2-10, 34, 17, "Choose a Tool"); + + $form = newt_form (); + + $list = newt_listbox (3, 2, 10); + + foreach (array ( + "Authentication configuration", + "Firewall configuration", + "Mouse configuration", + "Network configuration", + "Printer configuration", + "System services") as $l_item) + { + newt_listbox_add_entry ($list, $l_item, $l_item); + } + + $b1 = newt_button (5, 12, "Run Tool"); + $b2 = newt_button (21, 12, "Quit"); + + newt_form_add_component ($form, $list); + newt_form_add_components ($form, array($b1, $b2)); + + newt_refresh (); + newt_run_form ($form); + + newt_pop_window (); + newt_pop_help_line (); + newt_finished (); + newt_form_destroy ($form); +?> +]]> + </programlisting> + </example> + </section> </partintro> + &reference.newt.functions; </reference> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-component.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-add-component.xml diff -u phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-component.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-add-component"> <refnamediv> <refname>newt_form_add_component</refname> - <refpurpose></refpurpose> + <refpurpose>Adds a single component to the form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>resource</type><parameter>component</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Adds a single component to the form which is passed as the first parameter. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form to which component will be added </para> </listitem> </varlistentry> @@ -32,100 +32,23 @@ <term><parameter>component</parameter></term> <listitem> <para> - Its description + Component to add to the form </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_add_component</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_add_components</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-components.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-add-components.xml diff -u phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-components.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-add-components"> <refnamediv> <refname>newt_form_add_components</refname> - <refpurpose></refpurpose> + <refpurpose>Add several components to the form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>array</type><parameter>components</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Adds several components to the form which is passed as the first parameter. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form to which components will be added </para> </listitem> </varlistentry> @@ -32,100 +32,22 @@ <term><parameter>components</parameter></term> <listitem> <para> - Its description + Array of components to add to the form </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_add_components</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_add_component</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-run.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-run.xml diff -u phpdoc/en/reference/newt/functions/newt-form-run.xml:1.2 phpdoc/en/reference/newt/functions/newt-form-run.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form-run.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form-run.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form-run"> <refnamediv> <refname>newt_form_run</refname> - <refpurpose></refpurpose> + <refpurpose>Runs a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +12,9 @@ <methodparam><type>resource</type><parameter>form</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">exit_struct</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + This function runs the form passed to it. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,7 +24,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form component </para> </listitem> </varlistentry> @@ -32,100 +32,61 @@ <term><parameter>exit_struct</parameter></term> <listitem> <para> - Its description + Array, used for returning information after running the form component. + Keys and values are described in the following table: + <table> + <title>Form Exit Structure</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Index Key</entry> + <entry>Value Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>reason</entry> + <entry>integer</entry> + <entry> + The reason, why the form has been exited. Possible values are + defined <link linkend="constants.newt.reasons">here</link>. + </entry> + </row> + <row> + <entry>watch</entry> + <entry>resource</entry> + <entry>Resource link, specified in + <function>newt_form_watch_fd</function></entry> + </row> + <row> + <entry>key</entry> + <entry>integer</entry> + <entry>Hotkey</entry> + </row> + <row> + <entry>component</entry> + <entry>resource</entry> + <entry>Component, which caused the form to exit</entry> + </row> + </tbody> + </tgroup> + </table> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_form_run</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_run_form</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-form.xml diff -u phpdoc/en/reference/newt/functions/newt-form.xml:1.2 phpdoc/en/reference/newt/functions/newt-form.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-form.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-form.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-form"> <refnamediv> <refname>newt_form</refname> - <refpurpose></refpurpose> + <refpurpose>Create a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,9 +13,9 @@ <methodparam choice="opt"><type>string</type><parameter>help</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Create a new form. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -25,7 +25,7 @@ <term><parameter>vert_bar</parameter></term> <listitem> <para> - Its description + Vertical scrollbar which should be associated with the form </para> </listitem> </varlistentry> @@ -33,7 +33,7 @@ <term><parameter>help</parameter></term> <listitem> <para> - Its description + Help text string </para> </listitem> </varlistentry> @@ -41,7 +41,7 @@ <term><parameter>flags</parameter></term> <listitem> <para> - Its description + Various flags </para> </listitem> </varlistentry> @@ -51,90 +51,53 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> + Resource link to the created form component. </para> </refsect1> - --> - - <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>newt_form</function> example</title> <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out + Displays a single button "Quit", which closes the application once it's + pressed. </para> <programlisting role="php"> <![CDATA[ <?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} +newt_init(); +newt_cls(); + +$myform = newt_form(); +$button = newt_button (5, 12, "Quit"); + +newt_form_add_component ($myform, $button); +newt_refresh (); +newt_run_form ($myform); + +newt_finished (); +newt_form_destroy ($myform); ?> ]]> </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> </example> </para> </refsect1> - --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_run</function></member> + <member><function>newt_run_form</function></member> + <member><function>newt_form_add_component</function></member> + <member><function>newt_form_add_components</function></member> + <member><function>newt_form_destroy</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-run-form.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/newt/functions/newt-run-form.xml diff -u phpdoc/en/reference/newt/functions/newt-run-form.xml:1.2 phpdoc/en/reference/newt/functions/newt-run-form.xml:1.3 --- phpdoc/en/reference/newt/functions/newt-run-form.xml:1.2 Mon Oct 10 08:07:56 2005 +++ phpdoc/en/reference/newt/functions/newt-run-form.xml Thu Oct 20 08:51:15 2005 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.newt-run-form"> <refnamediv> <refname>newt_run_form</refname> - <refpurpose></refpurpose> + <refpurpose>Runs a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -11,9 +11,9 @@ <type>resource</type><methodname>newt_run_form</methodname> <methodparam><type>resource</type><parameter>form</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + This function runs the form passed to it. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -23,7 +23,7 @@ <term><parameter>form</parameter></term> <listitem> <para> - Its description + Form component </para> </listitem> </varlistentry> @@ -33,90 +33,29 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_run_form</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> -<![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} -?> -]]> - </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> - </example> + The component which caused the form to stop running. </para> + <note> + <para> + Notice that this function doesn't fit in with newt's normal naming + convention. It is an older interface which will not work for all forms. It + was left in newt only for legacy applications. It is a simpler interface + than the new <function>newt_form_run</function> though, and is still used quite often as a + result. When an application is done with a form, it destroys the form and + all of the components the form contains. + </para> + </note> </refsect1> - --> - - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><function>newt_form_run</function></member> + <member><function>newt_form_destroy</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/co.php/phpdoc/en/reference/newt/functions/newt-form-destroy.xml?r=1.1&p=1 Index: phpdoc/en/reference/newt/functions/newt-form-destroy.xml +++ phpdoc/en/reference/newt/functions/newt-form-destroy.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.newt-form-destroy"> <refnamediv> <refname>newt_form_destroy</refname> <refpurpose>Destroys a form</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>newt_form_destroy</methodname> <methodparam><type>resource</type><parameter>form</parameter></methodparam> </methodsynopsis> <para> This function frees the memory resources used by the form and all of the components which have been added to the form (including those components which are on subforms). Once a form has been destroyed, none of the form's components can be used. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>form</parameter></term> <listitem> <para> Form component, which is going to be destroyed </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>newt_form_run</function></member> <member><function>newt_run_form</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->