cvs: phpdoc /en/reference/newt/functions newt-bell.xml newt-button-bar.xml newt-button.xml newt-centered-window.xml newt-checkbox-get-value.xml
newt-checkbox-set-flags.xml newt-checkbox-set-value.xml newt-checkbox-tree-add-item.xml newt-checkbox-tree-find-item.xml
newt-checkbox-tree-get-current.xml newt-checkbox-tree-get-entry-value.xml newt-checkbox-tree-get-multi-selection.xml
newt-checkbox-tree-get-selection.xml newt-checkbox-tree-multi.xml newt-checkbox-tree-set-current.xml newt-checkbox-tree-set-entry-value.xml
newt-checkbox-tree-set-entry.xml newt-checkbox-tree-set-width.xml newt-checkbox-tree.xml newt-checkbox.xml newt-clear-key-buffer.xml newt-cls.xml
newt-compact-button.xml newt-component-add-callback.xml newt-component-takes-focus.xml newt-create-grid.xml newt-cursor-off.xml newt-cursor-on.xml
newt-delay.xml newt-draw-form.xml newt-draw-root-text.xml newt-entry-get-value.xml newt-entry-set-filter.xml newt-entry-set-flags.xml
newt-entry-set.xml newt-entry.xml newt-finished.xml newt-form-add-component.xml newt-form-add-components.xml newt-form-add-host-key.xml
newt-form-get-current.xml newt-form-run.xml newt-form-set-background.xml newt-form-set-height.xml newt-form-set-size.xml newt-form-set-timer.xml
newt-form-set-width.xml newt-form-watch-fd.xml newt-form.xml newt-get-screen-size.xml newt-grid-add-components-to-form.xml newt-grid-basic-window.xml
newt-grid-free.xml newt-grid-get-size.xml newt-grid-h-close-stacked.xml newt-grid-h-stacked.xml newt-grid-place.xml newt-grid-set-field.xml
newt-grid-simple-window.xml newt-grid-v-close-stacked.xml newt-grid-v-stacked.xml newt-grid-wrapped-window-at.xml newt-grid-wrapped-window.xml
newt-init.xml newt-label-set-text.xml newt-label.xml newt-listbox-append-entry.xml newt-listbox-clear-selection.xml newt-listbox-clear.xml
newt-listbox-delete-entry.xml newt-listbox-get-current.xml newt-listbox-get-selection.xml newt-listbox-insert-entry.xml newt-listbox-item-count.xml
newt-listbox-select-item.xml newt-listbox-set-current-by-key.xml newt-listbox-set-current.xml newt-listbox-set-data.xml newt-listbox-set-entry.xml
newt-listbox-set-width.xml newt-listbox.xml newt-listitem-get-data.xml newt-listitem-set.xml newt-listitem.xml newt-open-window.xml
newt-pop-help-line.xml newt-pop-window.xml newt-push-help-line.xml newt-radio-get-current.xml newt-radiobutton.xml newt-redraw-help-line.xml
newt-reflow-text.xml newt-refresh.xml newt-resize-screen.xml newt-resume.xml newt-run-form.xml newt-scale-set.xml newt-scale.xml
newt-scrollbar-set.xml newt-set-help-callback.xml newt-set-suspend-callback.xml newt-suspend.xml newt-texbox-set-text.xml
newt-textbox-get-num-lines.xml newt-textbox-reflowed.xml newt-textbox-set-height.xml newt-textbox.xml newt-vertical-scrollbar.xml
newt-wait-for-key.xml newt-win-choice.xml newt-win-entries.xml newt-win-menu.xml newt-win-message.xml newt-win-messagev.xml newt-win-ternary.xml

michael Mon Oct 10 08:08:01 2005 EDT Modified files: /phpdoc/en/reference/newt/functions newt-bell.xml newt-button-bar.xml newt-button.xml newt-centered-window.xml newt-checkbox-get-value.xml newt-checkbox-set-flags.xml newt-checkbox-set-value.xml newt-checkbox-tree-add-item.xml newt-checkbox-tree-find-item.xml newt-checkbox-tree-get-current.xml newt-checkbox-tree-get-entry-value.xml newt-checkbox-tree-get-multi-selection.xml newt-checkbox-tree-get-selection.xml newt-checkbox-tree-multi.xml newt-checkbox-tree-set-current.xml newt-checkbox-tree-set-entry-value.xml newt-checkbox-tree-set-entry.xml newt-checkbox-tree-set-width.xml newt-checkbox-tree.xml newt-checkbox.xml newt-clear-key-buffer.xml newt-cls.xml newt-compact-button.xml newt-component-add-callback.xml newt-component-takes-focus.xml newt-create-grid.xml newt-cursor-off.xml newt-cursor-on.xml newt-delay.xml newt-draw-form.xml newt-draw-root-text.xml newt-entry-get-value.xml newt-entry-set-filter.xml newt-entry-set-flags.xml newt-entry-set.xml newt-entry.xml newt-finished.xml newt-form-add-component.xml newt-form-add-components.xml newt-form-add-host-key.xml newt-form-get-current.xml newt-form-run.xml newt-form-set-background.xml newt-form-set-height.xml newt-form-set-size.xml newt-form-set-timer.xml newt-form-set-width.xml newt-form-watch-fd.xml newt-form.xml newt-get-screen-size.xml newt-grid-add-components-to-form.xml newt-grid-basic-window.xml newt-grid-free.xml newt-grid-get-size.xml newt-grid-h-close-stacked.xml newt-grid-h-stacked.xml newt-grid-place.xml newt-grid-set-field.xml newt-grid-simple-window.xml newt-grid-v-close-stacked.xml newt-grid-v-stacked.xml newt-grid-wrapped-window-at.xml newt-grid-wrapped-window.xml newt-init.xml newt-label-set-text.xml newt-label.xml newt-listbox-append-entry.xml newt-listbox-clear-selection.xml newt-listbox-clear.xml newt-listbox-delete-entry.xml newt-listbox-get-current.xml newt-listbox-get-selection.xml newt-listbox-insert-entry.xml newt-listbox-item-count.xml newt-listbox-select-item.xml newt-listbox-set-current-by-key.xml newt-listbox-set-current.xml newt-listbox-set-data.xml newt-listbox-set-entry.xml newt-listbox-set-width.xml newt-listbox.xml newt-listitem-get-data.xml newt-listitem-set.xml newt-listitem.xml newt-open-window.xml newt-pop-help-line.xml newt-pop-window.xml newt-push-help-line.xml newt-radio-get-current.xml newt-radiobutton.xml newt-redraw-help-line.xml newt-reflow-text.xml newt-refresh.xml newt-resize-screen.xml newt-resume.xml newt-run-form.xml newt-scale-set.xml newt-scale.xml newt-scrollbar-set.xml newt-set-help-callback.xml newt-set-suspend-callback.xml newt-suspend.xml newt-texbox-set-text.xml newt-textbox-get-num-lines.xml newt-textbox-reflowed.xml newt-textbox-set-height.xml newt-textbox.xml newt-vertical-scrollbar.xml newt-wait-for-key.xml newt-win-choice.xml newt-win-entries.xml newt-win-menu.xml newt-win-message.xml newt-win-messagev.xml newt-win-ternary.xml Log: documented basic newt functions

http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-bell.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-bell.xml diff -u phpdoc/en/reference/newt/functions/newt-bell.xml:1.1 phpdoc/en/reference/newt/functions/newt-bell.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-bell.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-bell.xml Mon Oct 10 08:07:55 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-bell"> <refnamediv> <refname>newt_bell</refname> - <refpurpose></refpurpose> + <refpurpose>Send a beep to the terminal</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,10 @@ <type>void</type><methodname>newt_bell</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;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_bell</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> + <para>This function sends a beep to the terminal.</para> + <para><note>Depending on the terminal's settings, this been may or may not + be audible.</note></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> - </simplelist> - </para> - </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-button-bar.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-button-bar.xml diff -u phpdoc/en/reference/newt/functions/newt-button-bar.xml:1.1 phpdoc/en/reference/newt/functions/newt-button-bar.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-button-bar.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-button-bar.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-button-bar"> <refnamediv> <refname>newt_button_bar</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-button.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-button.xml diff -u phpdoc/en/reference/newt/functions/newt-button.xml:1.1 phpdoc/en/reference/newt/functions/newt-button.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-button.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-button.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-button"> <refnamediv> <refname>newt_button</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-centered-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-centered-window.xml diff -u phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-centered-window.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-centered-window"> <refnamediv> <refname>newt_centered_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-get-value.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-get-value"> <refnamediv> <refname>newt_checkbox_get_value</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-set-flags.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-set-flags"> <refnamediv> <refname>newt_checkbox_set_flags</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-set-value.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-set-value"> <refnamediv> <refname>newt_checkbox_set_value</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-add-item.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-add-item"> <refnamediv> <refname>newt_checkbox_tree_add_item</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-find-item.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-find-item"> <refnamediv> <refname>newt_checkbox_tree_find_item</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-current.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-get-current"> <refnamediv> <refname>newt_checkbox_tree_get_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-get-entry-value"> <refnamediv> <refname>newt_checkbox_tree_get_entry_value</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-get-multi-selection"> <refnamediv> <refname>newt_checkbox_tree_get_multi_selection</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-get-selection.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-get-selection"> <refnamediv> <refname>newt_checkbox_tree_get_selection</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-multi.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-multi"> <refnamediv> <refname>newt_checkbox_tree_multi</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-current.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-set-current"> <refnamediv> <refname>newt_checkbox_tree_set_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-set-entry-value"> <refnamediv> <refname>newt_checkbox_tree_set_entry_value</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-entry.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-set-entry"> <refnamediv> <refname>newt_checkbox_tree_set_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree-set-width.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree-set-width"> <refnamediv> <refname>newt_checkbox_tree_set_width</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox-tree.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox-tree"> <refnamediv> <refname>newt_checkbox_tree</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-checkbox.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-checkbox.xml diff -u phpdoc/en/reference/newt/functions/newt-checkbox.xml:1.1 phpdoc/en/reference/newt/functions/newt-checkbox.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-checkbox.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-checkbox.xml Mon Oct 10 08:07:55 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-checkbox"> <refnamediv> <refname>newt_checkbox</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml diff -u phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml:1.1 phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-clear-key-buffer.xml Mon Oct 10 08:07:55 2005 @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-clear-key-buffer"> <refnamediv> <refname>newt_clear_key_buffer</refname> - <refpurpose></refpurpose> + <refpurpose>Discards the contents of the terminal's input buffer without + waiting for additional input</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +12,18 @@ <type>void</type><methodname>newt_clear_key_buffer</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> + <para>Discards the contents of the terminal's input buffer without waiting + for additional input.</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_clear_key_buffer</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_wait_for_key</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-cls.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-cls.xml diff -u phpdoc/en/reference/newt/functions/newt-cls.xml:1.1 phpdoc/en/reference/newt/functions/newt-cls.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-cls.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-cls.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-cls"> <refnamediv> <refname>newt_cls</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-compact-button.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-compact-button.xml diff -u phpdoc/en/reference/newt/functions/newt-compact-button.xml:1.1 phpdoc/en/reference/newt/functions/newt-compact-button.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-compact-button.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-compact-button.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-compact-button"> <refnamediv> <refname>newt_compact_button</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-component-add-callback.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-component-add-callback.xml diff -u phpdoc/en/reference/newt/functions/newt-component-add-callback.xml:1.1 phpdoc/en/reference/newt/functions/newt-component-add-callback.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-component-add-callback.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-component-add-callback.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-component-add-callback"> <refnamediv> <refname>newt_component_add_callback</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml diff -u phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml:1.1 phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-component-takes-focus.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-component-takes-focus"> <refnamediv> <refname>newt_component_takes_focus</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-create-grid.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-create-grid.xml diff -u phpdoc/en/reference/newt/functions/newt-create-grid.xml:1.1 phpdoc/en/reference/newt/functions/newt-create-grid.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-create-grid.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-create-grid.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-create-grid"> <refnamediv> <refname>newt_create_grid</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-cursor-off.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-cursor-off.xml diff -u phpdoc/en/reference/newt/functions/newt-cursor-off.xml:1.1 phpdoc/en/reference/newt/functions/newt-cursor-off.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-cursor-off.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-cursor-off.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-cursor-off"> <refnamediv> <refname>newt_cursor_off</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-cursor-on.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-cursor-on.xml diff -u phpdoc/en/reference/newt/functions/newt-cursor-on.xml:1.1 phpdoc/en/reference/newt/functions/newt-cursor-on.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-cursor-on.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-cursor-on.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-cursor-on"> <refnamediv> <refname>newt_cursor_on</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-delay.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-delay.xml diff -u phpdoc/en/reference/newt/functions/newt-delay.xml:1.1 phpdoc/en/reference/newt/functions/newt-delay.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-delay.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-delay.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-delay"> <refnamediv> <refname>newt_delay</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-draw-form.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-draw-form.xml diff -u phpdoc/en/reference/newt/functions/newt-draw-form.xml:1.1 phpdoc/en/reference/newt/functions/newt-draw-form.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-draw-form.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-draw-form.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-draw-form"> <refnamediv> <refname>newt_draw_form</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-draw-root-text.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-draw-root-text.xml diff -u phpdoc/en/reference/newt/functions/newt-draw-root-text.xml:1.1 phpdoc/en/reference/newt/functions/newt-draw-root-text.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-draw-root-text.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-draw-root-text.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-draw-root-text"> <refnamediv> <refname>newt_draw_root_text</refname> - <refpurpose></refpurpose> + <refpurpose>Displays the string text at the position indicated</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,9 +13,7 @@ <methodparam><type>int</type><parameter>top</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para>Displays the string text at the position indicated.</para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -26,116 +23,79 @@ <term><parameter>left</parameter></term> <listitem> <para> - Its description + Column number </para> + <note> + <para> + If left is negative, the position is measured from the opposite side of the screen. + </para> + </note> </listitem> </varlistentry> <varlistentry> <term><parameter>top</parameter></term> <listitem> <para> - Its description + Line number </para> + <note> + <para> + If top is negative, the position is measured from the opposite side of the screen. + </para> + </note> </listitem> </varlistentry> <varlistentry> <term><parameter>text</parameter></term> <listitem> <para> - Its description + Text to display. </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 &amp;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_draw_root_text</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 + This code demonstrates drawing of titles in the both corners of the screen. </para> <programlisting role="php"> <![CDATA[ -<?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} +<? + newt_init(); + newt_cls(); + + newt_draw_root_text (2, 0, "Some root text"); + newt_refresh(); + sleep(1); + + newt_draw_root_text (-30, 0, "Root text in the other corner"); + newt_refresh(); + sleep(1); + + newt_finished(); ?> ]]> </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_push_help_line</function></member> + <member><function>newt_pop_help_line</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-entry-get-value.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-entry-get-value.xml diff -u phpdoc/en/reference/newt/functions/newt-entry-get-value.xml:1.1 phpdoc/en/reference/newt/functions/newt-entry-get-value.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-entry-get-value.xml:1.1 Mon Oct 3 07:25:08 2005 +++ phpdoc/en/reference/newt/functions/newt-entry-get-value.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-entry-get-value"> <refnamediv> <refname>newt_entry_get_value</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml diff -u phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml:1.1 phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-entry-set-filter.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-entry-set-filter"> <refnamediv> <refname>newt_entry_set_filter</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml diff -u phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml:1.1 phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-entry-set-flags.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-entry-set-flags"> <refnamediv> <refname>newt_entry_set_flags</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-entry-set.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-entry-set.xml diff -u phpdoc/en/reference/newt/functions/newt-entry-set.xml:1.1 phpdoc/en/reference/newt/functions/newt-entry-set.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-entry-set.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-entry-set.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-entry-set"> <refnamediv> <refname>newt_entry_set</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-entry.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-entry.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-entry"> <refnamediv> <refname>newt_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-finished.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-finished.xml diff -u phpdoc/en/reference/newt/functions/newt-finished.xml:1.1 phpdoc/en/reference/newt/functions/newt-finished.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-finished.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-finished.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-finished"> <refnamediv> <refname>newt_finished</refname> - <refpurpose>Should be called, when program is ready to exit</refpurpose> + <refpurpose>Uninitializes newt interface.</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,20 @@ <type>void</type><methodname>newt_finished</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;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> + Uninitializes newt interface. This function be called, when program is ready + to exit. </para> </refsect1> - --> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_finished</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_init</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-component.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-add-component.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-component.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-add-component"> <refnamediv> <refname>newt_form_add_component</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-components.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-add-components.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-components.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-add-components"> <refnamediv> <refname>newt_form_add_components</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml diff -u phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-add-host-key.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-add-host-key"> <refnamediv> <refname>newt_form_add_host_key</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-get-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-get-current.xml diff -u phpdoc/en/reference/newt/functions/newt-form-get-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-get-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-get-current.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-get-current.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-get-current"> <refnamediv> <refname>newt_form_get_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-run.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-run.xml diff -u phpdoc/en/reference/newt/functions/newt-form-run.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-run.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-run.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-run.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-run"> <refnamediv> <refname>newt_form_run</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-set-background.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-set-background.xml diff -u phpdoc/en/reference/newt/functions/newt-form-set-background.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-set-background.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-set-background.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-set-background.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-set-background"> <refnamediv> <refname>newt_form_set_background</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-set-height.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-set-height.xml diff -u phpdoc/en/reference/newt/functions/newt-form-set-height.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-set-height.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-set-height.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-set-height.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-set-height"> <refnamediv> <refname>newt_form_set_height</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-set-size.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-set-size.xml diff -u phpdoc/en/reference/newt/functions/newt-form-set-size.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-set-size.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-set-size.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-set-size.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-set-size"> <refnamediv> <refname>newt_form_set_size</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-set-timer.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-set-timer.xml diff -u phpdoc/en/reference/newt/functions/newt-form-set-timer.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-set-timer.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-set-timer.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-set-timer.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-set-timer"> <refnamediv> <refname>newt_form_set_timer</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-set-width.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-set-width.xml diff -u phpdoc/en/reference/newt/functions/newt-form-set-width.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-set-width.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-set-width.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-set-width.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-set-width"> <refnamediv> <refname>newt_form_set_width</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml diff -u phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml:1.1 phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form-watch-fd.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form-watch-fd"> <refnamediv> <refname>newt_form_watch_fd</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-form.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-form.xml diff -u phpdoc/en/reference/newt/functions/newt-form.xml:1.1 phpdoc/en/reference/newt/functions/newt-form.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-form.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-form.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-form"> <refnamediv> <refname>newt_form</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-get-screen-size.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-get-screen-size.xml diff -u phpdoc/en/reference/newt/functions/newt-get-screen-size.xml:1.1 phpdoc/en/reference/newt/functions/newt-get-screen-size.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-get-screen-size.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-get-screen-size.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-get-screen-size"> <refnamediv> <refname>newt_get_screen_size</refname> - <refpurpose></refpurpose> + <refpurpose>Fills in the passed references with the current size of the + terminal</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,9 +13,8 @@ <methodparam><type>int</type><parameter role="reference">cols</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">rows</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para>Fills in the passed references with the current size of the + terminal.</para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -25,7 +24,7 @@ <term><parameter>cols</parameter></term> <listitem> <para> - Its description + Number of columns in the terminal </para> </listitem> </varlistentry> @@ -33,7 +32,7 @@ <term><parameter>rows</parameter></term> <listitem> <para> - Its description + Number of rows in the terminal </para> </listitem> </varlistentry> @@ -43,90 +42,38 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - What the function returns, first on success, then on failure. See - also the &amp;return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? + This function returns values in an arguments, passed by reference. </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_get_screen_size</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 + This code prints out the screen size of your terminal. </para> <programlisting role="php"> <![CDATA[ <?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} + newt_init(); + newt_get_screen_size (&$cols, &$rows); + newt_finished(); + + print "Your terminal size is: {$cols}x{$rows}\n"; ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ -Use the PEAR Coding Standards +Your terminal size is: 138x47 ]]> </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> - </simplelist> - </para> - </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-add-components-to-form.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-add-components-to-form"> <refnamediv> <refname>newt_grid_add_components_to_form</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-basic-window.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-basic-window"> <refnamediv> <refname>newt_grid_basic_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-free.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-free.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-free.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-free.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-free.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-free.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-free"> <refnamediv> <refname>newt_grid_free</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-get-size.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-get-size.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-get-size.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-get-size.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-get-size.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-get-size.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-get-size"> <refnamediv> <refname>newt_grid_get_size</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-h-close-stacked.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-h-close-stacked"> <refnamediv> <refname>newt_grid_h_close_stacked</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-h-stacked.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-h-stacked"> <refnamediv> <refname>newt_grid_h_stacked</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-place.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-place.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-place.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-place.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-place.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-place.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-place"> <refnamediv> <refname>newt_grid_place</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-set-field.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-set-field.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-set-field.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-set-field.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-set-field.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-set-field.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-set-field"> <refnamediv> <refname>newt_grid_set_field</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-simple-window.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-simple-window"> <refnamediv> <refname>newt_grid_simple_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-v-close-stacked.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-v-close-stacked"> <refnamediv> <refname>newt_grid_v_close_stacked</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-v-stacked.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-v-stacked"> <refnamediv> <refname>newt_grid_v_stacked</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-wrapped-window-at.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-wrapped-window-at"> <refnamediv> <refname>newt_grid_wrapped_window_at</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml diff -u phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-grid-wrapped-window.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-grid-wrapped-window"> <refnamediv> <refname>newt_grid_wrapped_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-init.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-init.xml diff -u phpdoc/en/reference/newt/functions/newt-init.xml:1.1 phpdoc/en/reference/newt/functions/newt-init.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-init.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-init.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-init"> <refnamediv> <refname>newt_init</refname> - <refpurpose>Initializes internal data structures and places the terminal in raw mode</refpurpose> + <refpurpose>Initialize newt</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,19 @@ <type>void</type><methodname>newt_init</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;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> + Initializes the newt interface. This function must be called before any other newt function. </para> </refsect1> - --> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_init</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_finished</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-label-set-text.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-label-set-text.xml diff -u phpdoc/en/reference/newt/functions/newt-label-set-text.xml:1.1 phpdoc/en/reference/newt/functions/newt-label-set-text.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-label-set-text.xml:1.1 Mon Oct 3 07:25:09 2005 +++ phpdoc/en/reference/newt/functions/newt-label-set-text.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-label-set-text"> <refnamediv> <refname>newt_label_set_text</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-label.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-label.xml diff -u phpdoc/en/reference/newt/functions/newt-label.xml:1.1 phpdoc/en/reference/newt/functions/newt-label.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-label.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-label.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-label"> <refnamediv> <refname>newt_label</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-append-entry.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-append-entry"> <refnamediv> <refname>newt_listbox_append_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-clear-selection.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-clear-selection"> <refnamediv> <refname>newt_listbox_clear_selection</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-clear.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-clear.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-clear.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-clear.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-clear.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-clear.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-clear"> <refnamediv> <refname>newt_listbox_clear</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-delete-entry.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-delete-entry"> <refnamediv> <refname>newt_listbox_delete_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-get-current.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-get-current"> <refnamediv> <refname>newt_listbox_get_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-get-selection.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-get-selection"> <refnamediv> <refname>newt_listbox_get_selection</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-insert-entry.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-insert-entry"> <refnamediv> <refname>newt_listbox_insert_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-item-count.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-item-count"> <refnamediv> <refname>newt_listbox_item_count</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-select-item.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-select-item"> <refnamediv> <refname>newt_listbox_select_item</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-set-current-by-key.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-set-current-by-key"> <refnamediv> <refname>newt_listbox_set_current_by_key</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-set-current.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-set-current"> <refnamediv> <refname>newt_listbox_set_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-set-data.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-set-data"> <refnamediv> <refname>newt_listbox_set_data</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-set-entry.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-set-entry"> <refnamediv> <refname>newt_listbox_set_entry</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox-set-width.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox-set-width"> <refnamediv> <refname>newt_listbox_set_width</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listbox.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listbox.xml diff -u phpdoc/en/reference/newt/functions/newt-listbox.xml:1.1 phpdoc/en/reference/newt/functions/newt-listbox.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listbox.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listbox.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listbox"> <refnamediv> <refname>newt_listbox</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml diff -u phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml:1.1 phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listitem-get-data.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listitem-get-data"> <refnamediv> <refname>newt_listitem_get_data</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listitem-set.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listitem-set.xml diff -u phpdoc/en/reference/newt/functions/newt-listitem-set.xml:1.1 phpdoc/en/reference/newt/functions/newt-listitem-set.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listitem-set.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listitem-set.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listitem-set"> <refnamediv> <refname>newt_listitem_set</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-listitem.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-listitem.xml diff -u phpdoc/en/reference/newt/functions/newt-listitem.xml:1.1 phpdoc/en/reference/newt/functions/newt-listitem.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-listitem.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-listitem.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-listitem"> <refnamediv> <refname>newt_listitem</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-open-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-open-window.xml diff -u phpdoc/en/reference/newt/functions/newt-open-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-open-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-open-window.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-open-window.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-open-window"> <refnamediv> <refname>newt_open_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-pop-help-line.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-pop-help-line.xml diff -u phpdoc/en/reference/newt/functions/newt-pop-help-line.xml:1.1 phpdoc/en/reference/newt/functions/newt-pop-help-line.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-pop-help-line.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-pop-help-line.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-pop-help-line"> <refnamediv> <refname>newt_pop_help_line</refname> - <refpurpose></refpurpose> + <refpurpose>Replaces the current help line with the one from the stack</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,25 @@ <type>void</type><methodname>newt_pop_help_line</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; <para> - When does this function throw exceptions? + Replaces the current help line with the one from the stack. </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_pop_help_line</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> + <note> + It's important not to call to <function>newt_pop_help_line</function> more then + <function>newt_push_help_line</function>. + </note> </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_push_help_line</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-pop-window.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-pop-window.xml diff -u phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.1 phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-pop-window.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-pop-window"> <refnamediv> <refname>newt_pop_window</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-push-help-line.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-push-help-line.xml diff -u phpdoc/en/reference/newt/functions/newt-push-help-line.xml:1.1 phpdoc/en/reference/newt/functions/newt-push-help-line.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-push-help-line.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-push-help-line.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-push-help-line"> <refnamediv> <refname>newt_push_help_line</refname> - <refpurpose></refpurpose> + <refpurpose>Saves the current help line on a stack, and displays the new line</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,9 +11,8 @@ <type>void</type><methodname>newt_push_help_line</methodname> <methodparam choice="opt"><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para>Saves the current help line on a stack, and displays the new + line.</para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,100 +22,27 @@ <term><parameter>text</parameter></term> <listitem> <para> - Its description + New help text message + </para> + <para> + <note> + If not specified, the help line is cleared. + </note> </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 &amp;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_push_help_line</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_pop_help_line</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-radio-get-current.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-radio-get-current.xml diff -u phpdoc/en/reference/newt/functions/newt-radio-get-current.xml:1.1 phpdoc/en/reference/newt/functions/newt-radio-get-current.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-radio-get-current.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-radio-get-current.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-radio-get-current"> <refnamediv> <refname>newt_radio_get_current</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-radiobutton.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-radiobutton.xml diff -u phpdoc/en/reference/newt/functions/newt-radiobutton.xml:1.1 phpdoc/en/reference/newt/functions/newt-radiobutton.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-radiobutton.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-radiobutton.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-radiobutton"> <refnamediv> <refname>newt_radiobutton</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml diff -u phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml:1.1 phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-redraw-help-line.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-redraw-help-line"> <refnamediv> <refname>newt_redraw_help_line</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-reflow-text.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-reflow-text.xml diff -u phpdoc/en/reference/newt/functions/newt-reflow-text.xml:1.1 phpdoc/en/reference/newt/functions/newt-reflow-text.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-reflow-text.xml:1.1 Mon Oct 3 07:25:11 2005 +++ phpdoc/en/reference/newt/functions/newt-reflow-text.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-reflow-text"> <refnamediv> <refname>newt_reflow_text</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-refresh.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-refresh.xml diff -u phpdoc/en/reference/newt/functions/newt-refresh.xml:1.1 phpdoc/en/reference/newt/functions/newt-refresh.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-refresh.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-refresh.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-refresh"> <refnamediv> <refname>newt_refresh</refname> - <refpurpose></refpurpose> + <refpurpose>Updates modified portions of the screen</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,13 @@ <type>void</type><methodname>newt_refresh</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;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_refresh</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> + To increase performance, newt only updates the display when it needs to, + not when the program tells it to write to the terminal. Applications can + force newt to immediately update modified portions of the screen by calling + this function. </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> - </simplelist> - </para> - </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-resize-screen.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-resize-screen.xml diff -u phpdoc/en/reference/newt/functions/newt-resize-screen.xml:1.1 phpdoc/en/reference/newt/functions/newt-resize-screen.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-resize-screen.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-resize-screen.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-resize-screen"> <refnamediv> <refname>newt_resize_screen</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-resume.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-resume.xml diff -u phpdoc/en/reference/newt/functions/newt-resume.xml:1.1 phpdoc/en/reference/newt/functions/newt-resume.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-resume.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-resume.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-resume"> <refnamediv> <refname>newt_resume</refname> - <refpurpose></refpurpose> + <refpurpose>Resume using the newt interface after calling + <function>newt_suspend</function></refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +12,20 @@ <type>void</type><methodname>newt_resume</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;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> + Resume using the newt interface after calling + <function>newt_suspend</function>. </para> </refsect1> - --> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>newt_resume</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_suspend</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-run-form.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-run-form.xml diff -u phpdoc/en/reference/newt/functions/newt-run-form.xml:1.1 phpdoc/en/reference/newt/functions/newt-run-form.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-run-form.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-run-form.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-run-form"> <refnamediv> <refname>newt_run_form</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-scale-set.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-scale-set.xml diff -u phpdoc/en/reference/newt/functions/newt-scale-set.xml:1.1 phpdoc/en/reference/newt/functions/newt-scale-set.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-scale-set.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-scale-set.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-scale-set"> <refnamediv> <refname>newt_scale_set</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-scale.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-scale.xml diff -u phpdoc/en/reference/newt/functions/newt-scale.xml:1.1 phpdoc/en/reference/newt/functions/newt-scale.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-scale.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-scale.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-scale"> <refnamediv> <refname>newt_scale</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml diff -u phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml:1.1 phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-scrollbar-set.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-scrollbar-set"> <refnamediv> <refname>newt_scrollbar_set</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-set-help-callback.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-set-help-callback.xml diff -u phpdoc/en/reference/newt/functions/newt-set-help-callback.xml:1.1 phpdoc/en/reference/newt/functions/newt-set-help-callback.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-set-help-callback.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-set-help-callback.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-set-help-callback"> <refnamediv> <refname>newt_set_help_callback</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml diff -u phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml:1.1 phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-set-suspend-callback.xml Mon Oct 10 08:07:56 2005 @@ -1,21 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-set-suspend-callback"> <refnamediv> <refname>newt_set_suspend_callback</refname> - <refpurpose></refpurpose> + <refpurpose>Set a callback function which gets invoked when user + presses the suspend key</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>newt_set_suspend_callback</methodname> - <methodparam><type>mixed</type><parameter>function</parameter></methodparam> + <methodparam><type>callback</type><parameter>function</parameter></methodparam> <methodparam><type>mixed</type><parameter>data</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - + <para> + Set a callback function which gets invoked when user presses the suspend + key (normally ^Z). If no suspend callback is registered, the suspend + keystroke is ignored. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -25,7 +27,7 @@ <term><parameter>function</parameter></term> <listitem> <para> - Its description + A callback function, which accepts one argument: data </para> </listitem> </varlistentry> @@ -33,100 +35,23 @@ <term><parameter>data</parameter></term> <listitem> <para> - Its description + This data is been passed to the callback function </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 &amp;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_set_suspend_callback</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_suspend</function></member> + <member><function>newt_resume</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-suspend.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-suspend.xml diff -u phpdoc/en/reference/newt/functions/newt-suspend.xml:1.1 phpdoc/en/reference/newt/functions/newt-suspend.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-suspend.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-suspend.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-suspend"> <refnamediv> <refname>newt_suspend</refname> - <refpurpose></refpurpose> + <refpurpose>Tells newt to return the terminal to its initial state</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,19 @@ <type>void</type><methodname>newt_suspend</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> + <para>Tells newt to return the terminal to its initial state. Once this is + done, the application can suspend itself (by sending itself a SIGTSTP, fork + a child program, or do whatever else it likes.</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_suspend</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_resume</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml diff -u phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml:1.1 phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-texbox-set-text.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-texbox-set-text"> <refnamediv> <refname>newt_texbox_set_text</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml diff -u phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml:1.1 phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-textbox-get-num-lines.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-textbox-get-num-lines"> <refnamediv> <refname>newt_textbox_get_num_lines</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml diff -u phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml:1.1 phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-textbox-reflowed.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-textbox-reflowed"> <refnamediv> <refname>newt_textbox_reflowed</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml diff -u phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml:1.1 phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-textbox-set-height.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-textbox-set-height"> <refnamediv> <refname>newt_textbox_set_height</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-textbox.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-textbox.xml diff -u phpdoc/en/reference/newt/functions/newt-textbox.xml:1.1 phpdoc/en/reference/newt/functions/newt-textbox.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-textbox.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-textbox.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-textbox"> <refnamediv> <refname>newt_textbox</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml diff -u phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml:1.1 phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-vertical-scrollbar.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-vertical-scrollbar"> <refnamediv> <refname>newt_vertical_scrollbar</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-wait-for-key.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-wait-for-key.xml diff -u phpdoc/en/reference/newt/functions/newt-wait-for-key.xml:1.1 phpdoc/en/reference/newt/functions/newt-wait-for-key.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-wait-for-key.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-wait-for-key.xml Mon Oct 10 08:07:56 2005 @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-wait-for-key"> <refnamediv> <refname>newt_wait_for_key</refname> - <refpurpose></refpurpose> + <refpurpose>Doesn't return until a key has been pressed</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,102 +11,19 @@ <type>void</type><methodname>newt_wait_for_key</methodname> <void/> </methodsynopsis> - - &warn.undocumented.func; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - What the function returns, first on success, then on failure. See - also the &amp;return.success; entity - </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> + <para>This function doesn't return until a key has been pressed. The + keystroke is then ignored. If a key is already in the terminal's buffer, + this function discards a keystroke and returns immediately.</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_wait_for_key</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_clear_key_buffer</function></member> </simplelist> </para> </refsect1> - --> - </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-choice.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-choice.xml diff -u phpdoc/en/reference/newt/functions/newt-win-choice.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-choice.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-choice.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-choice.xml Mon Oct 10 08:07:56 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-choice"> <refnamediv> <refname>newt_win_choice</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-entries.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-entries.xml diff -u phpdoc/en/reference/newt/functions/newt-win-entries.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-entries.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-entries.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-entries.xml Mon Oct 10 08:07:57 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-entries"> <refnamediv> <refname>newt_win_entries</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-menu.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-menu.xml diff -u phpdoc/en/reference/newt/functions/newt-win-menu.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-menu.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-menu.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-menu.xml Mon Oct 10 08:07:57 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-menu"> <refnamediv> <refname>newt_win_menu</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-message.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-message.xml diff -u phpdoc/en/reference/newt/functions/newt-win-message.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-message.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-message.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-message.xml Mon Oct 10 08:07:57 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-message"> <refnamediv> <refname>newt_win_message</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-messagev.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-messagev.xml diff -u phpdoc/en/reference/newt/functions/newt-win-messagev.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-messagev.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-messagev.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-messagev.xml Mon Oct 10 08:07:57 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-messagev"> <refnamediv> <refname>newt_win_messagev</refname> http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-win-ternary.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/newt/functions/newt-win-ternary.xml diff -u phpdoc/en/reference/newt/functions/newt-win-ternary.xml:1.1 phpdoc/en/reference/newt/functions/newt-win-ternary.xml:1.2 --- phpdoc/en/reference/newt/functions/newt-win-ternary.xml:1.1 Mon Oct 3 07:25:12 2005 +++ phpdoc/en/reference/newt/functions/newt-win-ternary.xml Mon Oct 10 08:07:57 2005 @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> -<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.2 $ --> <refentry id="function.newt-win-ternary"> <refnamediv> <refname>newt_win_ternary</refname>