cvs: peardoc /en/package/html/html-quickform html-quickform-header.xml /en/package/html/html-quickform/html-quickform-header
html_quickform_header.xml
| From: | Alexey Borzov | Date: | Sun, 26 Oct 2003 15:58:14 +0000 |
| Subject: | cvs: peardoc /en/package/html/html-quickform html-quickform-header.xml /en/package/html/html-quickform/html-quickform-header html_quickform_header.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-1758@lists.php.net to get a copy of this message | ||
avb Sun Oct 26 10:58:14 2003 EDT
Added files:
/peardoc/en/package/html/html-quickform html-quickform-header.xml
/peardoc/en/package/html/html-quickform/html-quickform-header
html_quickform_header.xml
Log:
Docs for QF header element
Index: peardoc/en/package/html/html-quickform/html-quickform-header.xml +++ peardoc/en/package/html/html-quickform/html-quickform-header.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-header"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_header</classname></refname> <refpurpose>A pseudo-element used for adding headers to form</refpurpose> </refnamediv> <refsect1> &title.desc; <para> This element is used for adding headers to the form. Unlike usual static elements, the headers are usually rendered using a special template. </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_header</classname></title> <para> <itemizedlist> <listitem><para> HTML_Common <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link> <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-static"><classname>HTML_QuickForm_static</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_header </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_header</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-static"><classname>HTML_QuickForm_static</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-static.html-quickform-static"><function>HTML_QuickForm_static::HTML_QuickForm_static</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_static::exportValue</function></link></entry> <entry>We override this here because we don't want any values from static elements</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_static::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_static::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_static::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_static::setName</function></link></entry> <entry>Sets the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-static.settext"><function>HTML_QuickForm_static::setText</function></link></entry> <entry>Sets the text</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_static::setValue</function></link></entry> <entry>Sets the text (uses the standard setValue call to emulate a form element.</entry> </row> </tbody> </tgroup> </table> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-element.html-quickform-element"><function>HTML_QuickForm_element::HTML_QuickForm_element</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.accept"><function>HTML_QuickForm_element::accept</function></link></entry> <entry>Accepts a renderer</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.apiversion"><function>HTML_QuickForm_element::apiVersion</function></link></entry> <entry>Returns the current API version</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_element::exportValue</function></link></entry> <entry>Returns a 'safe' element's value</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.freeze"><function>HTML_QuickForm_element::freeze</function></link></entry> <entry>Freeze the element so that only its value is returned</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_element::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getlabel"><function>HTML_QuickForm_element::getLabel</function></link></entry> <entry>Returns display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_element::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.gettype"><function>HTML_QuickForm_element::getType</function></link></entry> <entry>Returns element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_element::getValue</function></link></entry> <entry>Returns the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.isfrozen"><function>HTML_QuickForm_element::isFrozen</function></link></entry> <entry>Returns whether or not the element is frozen</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_element::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setlabel"><function>HTML_QuickForm_element::setLabel</function></link></entry> <entry>Sets display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_element::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setpersistantfreeze"><function>HTML_QuickForm_element::setPersistantFreeze</function></link></entry> <entry>Sets wether an element value should be kept in an hidden field when the element is frozen or not</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_element::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-executeMultiple-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/html/html-quickform/html-quickform-header/html_quickform_header.xml +++ peardoc/en/package/html/html-quickform/html-quickform-header/html_quickform_header.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-header.html-quickform-header"> <refnamediv> <refname>constructor HTML_QuickForm_header()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/header.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_header::HTML_QuickForm_header</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$text = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> Header name </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$text</parameter> </term> <listitem> <para> Header text </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
Index: peardoc/en/package/html/html-quickform/html-quickform-header.xml +++ peardoc/en/package/html/html-quickform/html-quickform-header.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-header"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_header</classname></refname> <refpurpose>A pseudo-element used for adding headers to form</refpurpose> </refnamediv> <refsect1> &title.desc; <para> This element is used for adding headers to the form. Unlike usual static elements, the headers are usually rendered using a special template. </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_header</classname></title> <para> <itemizedlist> <listitem><para> HTML_Common <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link> <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-static"><classname>HTML_QuickForm_static</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_header </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_header</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-static"><classname>HTML_QuickForm_static</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-static.html-quickform-static"><function>HTML_QuickForm_static::HTML_QuickForm_static</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_static::exportValue</function></link></entry> <entry>We override this here because we don't want any values from static elements</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_static::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_static::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_static::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_static::setName</function></link></entry> <entry>Sets the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-static.settext"><function>HTML_QuickForm_static::setText</function></link></entry> <entry>Sets the text</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_static::setValue</function></link></entry> <entry>Sets the text (uses the standard setValue call to emulate a form element.</entry> </row> </tbody> </tgroup> </table> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-element.html-quickform-element"><function>HTML_QuickForm_element::HTML_QuickForm_element</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.accept"><function>HTML_QuickForm_element::accept</function></link></entry> <entry>Accepts a renderer</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.apiversion"><function>HTML_QuickForm_element::apiVersion</function></link></entry> <entry>Returns the current API version</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_element::exportValue</function></link></entry> <entry>Returns a 'safe' element's value</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.freeze"><function>HTML_QuickForm_element::freeze</function></link></entry> <entry>Freeze the element so that only its value is returned</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_element::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getlabel"><function>HTML_QuickForm_element::getLabel</function></link></entry> <entry>Returns display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_element::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.gettype"><function>HTML_QuickForm_element::getType</function></link></entry> <entry>Returns element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_element::getValue</function></link></entry> <entry>Returns the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.isfrozen"><function>HTML_QuickForm_element::isFrozen</function></link></entry> <entry>Returns whether or not the element is frozen</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_element::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setlabel"><function>HTML_QuickForm_element::setLabel</function></link></entry> <entry>Sets display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_element::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setpersistantfreeze"><function>HTML_QuickForm_element::setPersistantFreeze</function></link></entry> <entry>Sets wether an element value should be kept in an hidden field when the element is frozen or not</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_element::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-executeMultiple-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/html/html-quickform/html-quickform-header/html_quickform_header.xml +++ peardoc/en/package/html/html-quickform/html-quickform-header/html_quickform_header.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-header.html-quickform-header"> <refnamediv> <refname>constructor HTML_QuickForm_header()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/header.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_header::HTML_QuickForm_header</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$text = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> Header name </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$text</parameter> </term> <listitem> <para> Header text </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-header.html-quickform-header.note"> &title.note; ¬e.notstatic; </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->