cvs: phpdoc /en/reference/printer/functions printer-abort.xml printer-close.xml printer-create-brush.xml printer-create-dc.xml printer-create-font.xml
printer-create-pen.xml printer-delete-brush.xml printer-delete-dc.xml printer-delete-font.xml printer-delete-pen.xml printer-draw-bmp.xml
printer-draw-chord.xml printer-draw-elipse.xml printer-draw-line.xml printer-draw-pie.xml printer-draw-rectangle.xml printer-draw-roundrect.xml
printer-draw-text.xml printer-end-doc.xml printer-end-page.xml printer-get-option.xml printer-list.xml printer-logical-fontheight.xml printer-open.xml
printer-select-brush.xml printer-select-font.xml printer-select-pen.xml printer-set-option.xml printer-start-doc.xml printer-start-page.xml
printer-write.xml

From:	Mehdi Achour	Date:	Sat, 09 Jun 2007 22:17:20 +0000
Subject:	cvs: phpdoc /en/reference/printer/functions printer-abort.xml printer-close.xml printer-create-brush.xml printer-create-dc.xml printer-create-font.xml printer-create-pen.xml printer-delete-brush.xml printer-delete-dc.xml printer-delete-font.xml printer-delete-pen.xml printer-draw-bmp.xml printer-draw-chord.xml printer-draw-elipse.xml printer-draw-line.xml printer-draw-pie.xml printer-draw-rectangle.xml printer-draw-roundrect.xml printer-draw-text.xml printer-end-doc.xml printer-end-page.xml printer-get-option.xml printer-list.xml printer-logical-fontheight.xml printer-open.xml printer-select-brush.xml printer-select-font.xml printer-select-pen.xml printer-set-option.xml printer-start-doc.xml printer-start-page.xml printer-write.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969376610@lists.php.net to get a copy of this message

didou Sat Jun 9 22:17:20 2007 UTC Modified files: /phpdoc/en/reference/printer/functions printer-abort.xml printer-close.xml printer-create-brush.xml printer-create-dc.xml printer-create-font.xml printer-create-pen.xml printer-delete-brush.xml printer-delete-dc.xml printer-delete-font.xml printer-delete-pen.xml printer-draw-bmp.xml printer-draw-chord.xml printer-draw-elipse.xml printer-draw-line.xml printer-draw-pie.xml printer-draw-rectangle.xml printer-draw-roundrect.xml printer-draw-text.xml printer-end-doc.xml printer-end-page.xml printer-get-option.xml printer-list.xml printer-logical-fontheight.xml printer-open.xml printer-select-brush.xml printer-select-font.xml printer-select-pen.xml printer-set-option.xml printer-start-doc.xml printer-start-page.xml printer-write.xml Log: ref.printer: new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/printer/functions/printer-abort.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/printer/functions/printer-abort.xml diff -u phpdoc/en/reference/printer/functions/printer-abort.xml:1.4 phpdoc/en/reference/printer/functions/printer-abort.xml:1.5 --- phpdoc/en/reference/printer/functions/printer-abort.xml:1.4 Sat Jun 9 22:16:47 2007 +++ phpdoc/en/reference/printer/functions/printer-abort.xml Sat Jun 9 22:17:20 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id="function.printer-abort"> <refnamediv> <refname>printer_abort</refname> <refpurpose>Deletes the printer's spool file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_abort</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> This function deletes the printers spool file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a printer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>handle</parameter> must be a valid handle to a printer. + &return.void; </para> - <example> - <title><function>printer_abort</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_abort</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -28,9 +53,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-close"> <refnamediv> <refname>printer_close</refname> <refpurpose>Close an open printer connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_close</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> This function closes the printer connection. <function>printer_close</function> also closes the active device context. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a printer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>handle</parameter> must be a valid handle to a printer. + &return.void; </para> - <example> - <title><function>printer_close</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_close</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-create-brush"> <refnamediv> <refname>printer_create_brush</refname> <refpurpose>Create a new brush</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>printer_create_brush</methodname> <methodparam><type>int</type><parameter>style</parameter></methodparam> <methodparam><type>string</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - The function creates a new brush and returns a handle to it. A brush - is used to fill shapes. For an example see - <function>printer_select_brush</function>. <parameter>color</parameter> - must be a color in RGB hex format, i.e. "000000" for black, - <parameter>style</parameter> must be one of the following constants: - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_SOLID</parameter>: - creates a brush with a solid color. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_DIAGONAL</parameter>: - creates a brush with a 45-degree upward left-to-right hatch ( / ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_CROSS</parameter>: - creates a brush with a cross hatch ( + ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_DIAGCROSS</parameter>: - creates a brush with a 45 cross hatch ( x ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_FDIAGONAL</parameter>: - creates a brush with a 45-degree downward left-to-right hatch ( \ ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_HORIZONTAL</parameter>: - creates a brush with a horizontal hatch ( - ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_VERTICAL</parameter>: - creates a brush with a vertical hatch ( | ). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BRUSH_CUSTOM</parameter>: - creates a custom brush from an BMP file. The second parameter - is used to specify the BMP instead of the RGB color code. - </simpara> - </listitem> - </itemizedlist> + The function creates a new brush and returns a handle to it. A brush is + used to fill shapes. For an example see + <function>printer_select_brush</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>style</parameter></term> + <listitem> + <para> + <parameter>style</parameter> must be one of the following constants: + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_SOLID</constant>: + creates a brush with a solid color. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_DIAGONAL</constant>: + creates a brush with a 45-degree upward left-to-right hatch ( / ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_CROSS</constant>: + creates a brush with a cross hatch ( + ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_DIAGCROSS</constant>: + creates a brush with a 45 cross hatch ( x ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_FDIAGONAL</constant>: + creates a brush with a 45-degree downward left-to-right hatch ( \ ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_HORIZONTAL</constant>: + creates a brush with a horizontal hatch ( - ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_VERTICAL</constant>: + creates a brush with a vertical hatch ( | ). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BRUSH_CUSTOM</constant>: + creates a custom brush from an BMP file. The second parameter + is used to specify the BMP instead of the RGB color code. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + <parameter>color</parameter> must be a color in RGB hex format, i.e. + "<literal>000000</literal>" for black. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a brush handle or &false; on error. + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-create-dc"> <refnamediv> <refname>printer_create_dc</refname> <refpurpose>Create a new device context</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_create_dc</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> The function creates a new device context. A device context is used to customize the graphic objects of the document. - <parameter>handle</parameter> must be a valid handle to a printer. </para> - <example> - <title><function>printer_create_dc</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_create_dc</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -45,9 +72,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-create-font"> <refnamediv> <refname>printer_create_font</refname> <refpurpose>Create a new font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>printer_create_font</methodname> <methodparam><type>string</type><parameter>face</parameter></methodparam> @@ -22,79 +22,143 @@ <para> The function creates a new font and returns a handle to it. A font is used to draw text. For an example see - <function>printer_select_font</function>. <parameter>face</parameter> - must be a string specifying the font face. <parameter>height</parameter> - specifies the font height, and <parameter>width</parameter> the font - width. The <parameter>font_weight</parameter> specifies the font weight - (400 is normal), and can be one of the following predefined constants. - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_FW_THIN</parameter>: - sets the font weight to thin (100). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_ULTRALIGHT</parameter>: - sets the font weight to ultra light (200). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_LIGHT</parameter>: - sets the font weight to light (300). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_NORMAL</parameter>: - sets the font weight to normal (400). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_MEDIUM</parameter>: - sets the font weight to medium (500). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_BOLD</parameter>: - sets the font weight to bold (700). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_ULTRABOLD</parameter>: - sets the font weight to ultra bold (800). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FW_HEAVY</parameter>: - sets the font weight to heavy (900). - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <parameter>italic</parameter> can be &true; or &false;, - and sets whether the font should be italic. - </para> - <para> - <parameter>underline</parameter> can be &true; or &false;, - and sets whether the font should be underlined. + <function>printer_select_font</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>strikeout</parameter> can be &true; or &false;, - and sets whether the font should be stroked out. + <variablelist> + <varlistentry> + <term><parameter>face</parameter></term> + <listitem> + <para> + <parameter>face</parameter> must be a string specifying the font face. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + <parameter>height</parameter> specifies the font height. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + <parameter>width</parameter> specifies the font width. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>font_weight</parameter></term> + <listitem> + <para> + The <parameter>font_weight</parameter> specifies the font weight + (400 is normal), and can be one of the following predefined constants. + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_FW_THIN</constant>: + sets the font weight to thin (100). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_ULTRALIGHT</constant>: + sets the font weight to ultra light (200). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_LIGHT</constant>: + sets the font weight to light (300). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_NORMAL</constant>: + sets the font weight to normal (400). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_MEDIUM</constant>: + sets the font weight to medium (500). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_BOLD</constant>: + sets the font weight to bold (700). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_ULTRABOLD</constant>: + sets the font weight to ultra bold (800). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FW_HEAVY</constant>: + sets the font weight to heavy (900). + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>italic</parameter></term> + <listitem> + <para> + <parameter>italic</parameter> can be &true; or &false;, + and sets whether the font should be italic. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>underline</parameter></term> + <listitem> + <para> + <parameter>underline</parameter> can be &true; or &false;, + and sets whether the font should be underlined. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>strikeout</parameter></term> + <listitem> + <para> + <parameter>strikeout</parameter> can be &true; or &false;, + and sets whether the font should be stroked out. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>orientaton</parameter></term> + <listitem> + <para> + <parameter>orientation</parameter> specifies a rotation. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>orientation</parameter> specifies a rotation. - For an example see <function>printer_select_font</function>. + Returns a font handle on success or &false; on error. </para> </refsect1> + </refentry>  - + <refentry id="function.printer-create-pen"> <refnamediv> <refname>printer_create_pen</refname> <refpurpose>Create a new pen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>printer_create_pen</methodname> <methodparam><type>int</type><parameter>style</parameter></methodparam> @@ -17,50 +17,88 @@ <para> The function creates a new pen and returns a handle to it. A pen is used to draw lines and curves. For an example see - <function>printer_select_pen</function>. <parameter>color</parameter> - must be a color in RGB hex format, i.e. "000000" for black, - <parameter>width</parameter> specifies the width of the pen whereas - <parameter>style</parameter> must be one of the following constants: - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_PEN_SOLID</parameter>: - creates a solid pen. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PEN_DASH</parameter>: - creates a dashed pen. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PEN_DOT</parameter>: - creates a dotted pen. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PEN_DASHDOT</parameter>: - creates a pen with dashes and dots. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PEN_DASHDOTDOT</parameter>: - creates a pen with dashes and double dots. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PEN_INVISIBLE</parameter>: - creates an invisible pen. - </simpara> - </listitem> - </itemizedlist> + <function>printer_select_pen</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>style</parameter></term> + <listitem> + <para> + <parameter>style</parameter> must be one of the following constants: + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_PEN_SOLID</constant>: + creates a solid pen. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PEN_DASH</constant>: + creates a dashed pen. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PEN_DOT</constant>: + creates a dotted pen. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PEN_DASHDOT</constant>: + creates a pen with dashes and dots. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PEN_DASHDOTDOT</constant>: + creates a pen with dashes and double dots. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PEN_INVISIBLE</constant>: + creates an invisible pen. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + <parameter>width</parameter> specifies the width of the pen. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + <parameter>color</parameter> must be a color in RGB hex format, i.e. + "<literal>000000</literal>" for black. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a pen handle or &false; on error. + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-delete-brush"> <refnamediv> <refname>printer_delete_brush</refname> <refpurpose>Delete a brush</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_delete_brush</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>brush_handle</parameter></methodparam> </methodsynopsis> <para> The function deletes the selected brush. For an example see <function>printer_select_brush</function>. - Returns &null; on success or &false; on failure. - <parameter>handle</parameter> - must be a valid handle to a brush. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>brush_handle</parameter></term> + <listitem> + <para> + <parameter>brush_handle</parameter> must be a valid handle to a brush. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-delete-dc"> <refnamediv> <refname>printer_delete_dc</refname> <refpurpose>Delete a device context</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_delete_dc</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> - The function deletes the device context. &return.success; + The function deletes the device context. For an example see <function>printer_create_dc</function>. - <parameter>handle</parameter> - must be a valid handle to a printer. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-delete-font"> <refnamediv> <refname>printer_delete_font</refname> <refpurpose>Delete a font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_delete_font</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>font_handle</parameter></methodparam> </methodsynopsis> <para> The function deletes the selected font. For an example see <function>printer_select_font</function>. - Returns &null; on success or &false; on failure. - <parameter>handle</parameter> must be a valid - handle to a font. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>font_handle</parameter></term> + <listitem> + <para> + <parameter>font_handle</parameter> must be a valid handle to a font. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-delete-pen"> <refnamediv> <refname>printer_delete_pen</refname> <refpurpose>Delete a pen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_delete_pen</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>pen_handle</parameter></methodparam> </methodsynopsis> <para> The function deletes the selected pen. For an example see <function>printer_select_pen</function>. - Returns &null; on success or &false; on failure. - <parameter>handle</parameter> must be a valid - handle to a pen. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pen_handle</parameter></term> + <listitem> + <para> + <parameter>pen_handle</parameter> must be a valid pen handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-draw-bmp"> <refnamediv> <refname>printer_draw_bmp</refname> <refpurpose>Draw a bmp</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_draw_bmp</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> @@ -18,17 +18,79 @@ <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - The function simply draws an bmp the bitmap - <parameter>filename</parameter> at position <parameter>x</parameter>, - <parameter>y</parameter>. <parameter>handle</parameter> must be a - valid handle to a printer. + The function draws an bmp. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the bitmap. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + <parameter>x</parameter> is the upper left x coordinate of the bitmap. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + <parameter>y</parameter> is the upper left y coordinate of the bitmap. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The bitmap width. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The bitmap height. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - <example> - <title><function>printer_draw_bmp</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_draw_bmp</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -42,9 +104,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-chord"> <refnamediv> <refname>printer_draw_chord</refname> <refpurpose>Draw a chord</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_chord</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>rec_x</parameter></methodparam> <methodparam><type>int</type><parameter>rec_y</parameter></methodparam> <methodparam><type>int</type><parameter>rec_x1</parameter></methodparam> @@ -22,43 +22,110 @@ </methodsynopsis> <para> The function simply draws an chord. - <parameter>handle</parameter> must be a valid handle to a printer. - </para> - <para> - <parameter>rec_x</parameter> is the upper left x coordinate of the - bounding rectangle. - </para> - <para> - <parameter>rec_y</parameter> is the upper left y coordinate of the - bounding rectangle. - </para> - <para> - <parameter>rec_x1</parameter> is the lower right x coordinate of the - bounding rectangle. - </para> - <para> - <parameter>rec_y1</parameter> is the lower right y coordinate of - the bounding rectangle. - </para> - <para> - <parameter>rad_x</parameter> is x coordinate of the radial defining - the beginning of the chord. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>rad_y</parameter> is y coordinate of the radial defining - the beginning of the chord. + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_x</parameter></term> + <listitem> + <para> + <parameter>rec_x</parameter> is the upper left x coordinate of the + bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_y</parameter></term> + <listitem> + <para> + <parameter>rec_y</parameter> is the upper left y coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_x1</parameter></term> + <listitem> + <para> + <parameter>rec_x1</parameter> is the lower right x coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_y1</parameter></term> + <listitem> + <para> + <parameter>rec_y1</parameter> is the lower right y coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad_x</parameter></term> + <listitem> + <para> + <parameter>rad_x</parameter> is x coordinate of the radial defining + the beginning of the chord. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad_y</parameter></term> + <listitem> + <para> + <parameter>rad_y</parameter> is y coordinate of the radial defining + the beginning of the chord. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad_x1</parameter></term> + <listitem> + <para> + <parameter>rad_x1</parameter> is x coordinate of the radial defining + the end of the chord. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad_y1</parameter></term> + <listitem> + <para> + <parameter>rad_y1</parameter> is y coordinate of the radial defining + the end of the chord. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>rad_x1</parameter> is x coordinate of the radial defining - the end of the chord. + &return.void; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - <parameter>rad_y1</parameter> is y coordinate of the radial defining - the end of the chord. - </para> - <example> - <title><function>printer_draw_chord</function> example</title> - <programlisting role="php"> + <example> + <title><function>printer_draw_chord</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -81,9 +148,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-elipse"> <refnamediv> <refname>printer_draw_elipse</refname> <refpurpose>Draw an ellipse</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_elipse</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> <methodparam><type>int</type><parameter>lr_y</parameter></methodparam> </methodsynopsis> <para> - The function simply draws an ellipse. - <parameter>handle</parameter> must be a valid handle to a printer. - </para> - <para> - <parameter>ul_x</parameter> is the upper left x coordinate of the ellipse. + The function draws an ellipse. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>ul_y</parameter> is the upper left y coordinate of the ellipse. + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_x</parameter></term> + <listitem> + <para> + <parameter>ul_x</parameter> is the upper left x coordinate of the ellipse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_y</parameter></term> + <listitem> + <para> + <parameter>ul_y</parameter> is the upper left y coordinate of the ellipse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_x</parameter></term> + <listitem> + <para> + <parameter>lr_x</parameter> is the lower right x coordinate of the ellipse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_y</parameter></term> + <listitem> + <para> + <parameter>lr_y</parameter> is the lower right y coordinate of the ellipse. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>lr_x</parameter> is the lower right x coordinate of the ellipse. + &return.void; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - <parameter>lr_y</parameter> is the lower right y coordinate of the ellipse. - </para> - <example> - <title> - <function>printer_draw_elipse</function> example - </title> - <programlisting role="php"> + <example> + <title><function>printer_draw_elipse</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -59,9 +104,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-line"> <refnamediv> <refname>printer_draw_line</refname> <refpurpose>Draw a line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_line</methodname> <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> @@ -17,15 +17,71 @@ <methodparam><type>int</type><parameter>to_y</parameter></methodparam> </methodsynopsis> <para> - The function simply draws a line from position - <parameter>from_x</parameter>, <parameter>from_y</parameter> to - position <parameter>to_x</parameter>, <parameter>to_y</parameter> - using the selected pen. <parameter>printer_handle</parameter> must - be a valid handle to a printer. + The function draws a line using the selected pen. </para> - <example> - <title><function>printer_draw_line</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_x</parameter></term> + <listitem> + <para> + <parameter>from_x</parameter> is the x coordinate of the origin point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>from_y</parameter></term> + <listitem> + <para> + <parameter>from_y</parameter> is the y coordinate of the origin point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>to_x</parameter></term> + <listitem> + <para> + <parameter>to_x</parameter> is the x coordinate of the destination point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>to_y</parameter></term> + <listitem> + <para> + <parameter>to_y</parameter> is the y coordinate of the destination point. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_draw_line</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -45,9 +101,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-pie"> <refnamediv> <refname>printer_draw_pie</refname> <refpurpose>Draw a pie</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_pie</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>rec_x</parameter></methodparam> <methodparam><type>int</type><parameter>rec_y</parameter></methodparam> <methodparam><type>int</type><parameter>rec_x1</parameter></methodparam> @@ -21,44 +21,111 @@ <methodparam><type>int</type><parameter>rad2_y</parameter></methodparam> </methodsynopsis> <para> - The function simply draws an pie. - <parameter>handle</parameter> must be a valid handle to a printer. - </para> - <para> - <parameter>rec_x</parameter> is the upper left x coordinate of - the bounding rectangle. - </para> - <para> - <parameter>rec_y</parameter> is the upper left y coordinate of - the bounding rectangle. - </para> - <para> - <parameter>rec_x1</parameter> is the lower right x coordinate of - the bounding rectangle. - </para> - <para> - <parameter>rec_y1</parameter> is the lower right y coordinate of - the bounding rectangle. - </para> - <para> - <parameter>rad1_x</parameter> is x coordinate of the first - radial's ending. + The function draws an pie. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>rad1_y</parameter> is y coordinate of the first - radial's ending. + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_x</parameter></term> + <listitem> + <para> + <parameter>rec_x</parameter> is the upper left x coordinate of the + bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_y</parameter></term> + <listitem> + <para> + <parameter>rec_y</parameter> is the upper left y coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_x1</parameter></term> + <listitem> + <para> + <parameter>rec_x1</parameter> is the lower right x coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rec_y1</parameter></term> + <listitem> + <para> + <parameter>rec_y1</parameter> is the lower right y coordinate of + the bounding rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad1_x</parameter></term> + <listitem> + <para> + <parameter>rad1_x</parameter> is x coordinate of the first + radial's ending. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad1_y</parameter></term> + <listitem> + <para> + <parameter>rad1_y</parameter> is y coordinate of the first + radial's ending. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad2_x</parameter></term> + <listitem> + <para> + <parameter>rad2_x</parameter> is x coordinate of the second + radial's ending. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>rad2_y</parameter></term> + <listitem> + <para> + <parameter>rad2_y</parameter> is y coordinate of the second + radial's ending. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>rad2_x</parameter> is x coordinate of the second - radial's ending. + &return.void; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - <parameter>rad2_y</parameter> is y coordinate of the second - radial's ending. - </para> - <example> - <title><function>printer_draw_pie</function> example</title> - <programlisting role="php"> + <example> + <title><function>printer_draw_pie</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -81,9 +148,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-rectangle"> <refnamediv> <refname>printer_draw_rectangle</refname> <refpurpose>Draw a rectangle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_rectangle</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> <methodparam><type>int</type><parameter>lr_y</parameter></methodparam> </methodsynopsis> <para> - The function simply draws a rectangle. - </para> - <para> - <parameter>handle</parameter> must be a valid handle to a printer. - </para> - <para> - <parameter>ul_x</parameter> is the upper left x coordinate of the rectangle. + The function draws a rectangle. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>ul_y</parameter> is the upper left y coordinate of the rectangle. + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_x</parameter></term> + <listitem> + <para> + <parameter>ul_x</parameter> is the upper left x coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_y</parameter></term> + <listitem> + <para> + <parameter>ul_y</parameter> is the upper left y coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_x</parameter></term> + <listitem> + <para> + <parameter>lr_x</parameter> is the lower right x coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_y</parameter></term> + <listitem> + <para> + <parameter>lr_y</parameter> is the lower right y coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>lr_x</parameter> is the lower right x coordinate of the rectangle. + &return.void; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - <parameter>lr_y</parameter> is the lower right y coordinate of the rectangle. - </para> - <example> - <title> - <function>printer_draw_rectangle</function> example - </title> - <programlisting role="php"> + <example> + <title><function>printer_draw_rectangle</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -61,9 +104,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-roundrect"> <refnamediv> <refname>printer_draw_roundrect</refname> <refpurpose>Draw a rectangle with rounded corners</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_roundrect</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> @@ -19,33 +19,87 @@ <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - The function simply draws a rectangle with rounded corners. - </para> - <para> - <parameter>handle</parameter> must be a valid handle to a printer. - </para> - <para> - <parameter>ul_x</parameter> is the upper left x coordinate of the rectangle. - </para> - <para> - <parameter>ul_y</parameter> is the upper left y coordinate of the rectangle. - </para> - <para> - <parameter>lr_x</parameter> is the lower right x coordinate of the rectangle. + The function draws a rectangle with rounded corners. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>lr_y</parameter> is the lower right y coordinate of the rectangle. + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_x</parameter></term> + <listitem> + <para> + <parameter>ul_x</parameter> is the upper left x coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ul_y</parameter></term> + <listitem> + <para> + <parameter>ul_y</parameter> is the upper left y coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_x</parameter></term> + <listitem> + <para> + <parameter>lr_x</parameter> is the lower right x coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lr_y</parameter></term> + <listitem> + <para> + <parameter>lr_y</parameter> is the lower right y coordinate of the rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + <parameter>width</parameter> is the width of the ellipse. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + <parameter>height</parameter> is the height of the ellipse. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>width</parameter> is the width of the ellipse. + &return.void; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> - <parameter>height</parameter> is the height of the ellipse. - </para> - <example> - <title> - <function>printer_draw_roundrect</function> example</title> - <programlisting role="php"> + <example> + <title><function>printer_draw_roundrect</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -68,9 +122,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-draw-text"> <refnamediv> <refname>printer_draw_text</refname> <refpurpose>Draw text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_draw_text</methodname> <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> @@ -16,14 +16,66 @@ <methodparam><type>int</type><parameter>y</parameter></methodparam> </methodsynopsis> <para> - The function simply draws <parameter>text</parameter> at position + The function draws <parameter>text</parameter> at position <parameter>x</parameter>, <parameter>y</parameter> using the selected - font. <parameter>printer_handle</parameter> must be a valid handle to - a printer. + font. </para> - <example> - <title><function>printer_draw_text</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a + printer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text to be written. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + <parameter>x</parameter> is the x coordinate of the position. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + <parameter>y</parameter> is the y coordinate of the position. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_draw_text</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -40,9 +92,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-end-doc"> <refnamediv> <refname>printer_end_doc</refname> <refpurpose>Close document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_end_doc</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> Closes a new document in the printer spooler. The document is now ready for printing. For an example see <function>printer_start_doc</function>. - <parameter>handle</parameter> must be a valid handle to a printer. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a + printer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-end-page"> <refnamediv> <refname>printer_end_page</refname> <refpurpose>Close active page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_end_page</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> The function closes the active page in the active document. For an example see <function>printer_start_doc</function>. - <parameter>handle</parameter> must be a valid handle to a printer. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a printer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-get-option"> <refnamediv> <refname>printer_get_option</refname> <refpurpose>Retrieve printer configuration data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>printer_get_option</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>string</type><parameter>option</parameter></methodparam> </methodsynopsis> <para> The function retrieves the configuration setting of <parameter>option</parameter>. - <parameter>handle</parameter> must be a valid handle to a printer. - Take a look at <function>printer_set_option</function> for the settings that can - be retrieved, additionally the following settings can be retrieved: - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_DEVICENAME</parameter> - returns the devicename of the printer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_DRIVERVERSION</parameter> - returns the printer driver version. - </simpara> - </listitem> - </itemizedlist> </para> - <example> - <title><function>printer_get_option</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid handle to a + printer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + Take a look at <function>printer_set_option</function> for the settings that can + be retrieved, additionally the following settings can be retrieved: + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_DEVICENAME</constant> + returns the devicename of the printer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_DRIVERVERSION</constant> + returns the printer driver version. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the value of <parameter>option</parameter>. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_get_option</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -43,9 +78,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-list"> <refnamediv> <refname>printer_list</refname> - <refpurpose>Return an array of printers attached to the server - </refpurpose> + <refpurpose>Return an array of printers attached to the server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>printer_list</methodname> <methodparam><type>int</type><parameter>enumtype</parameter></methodparam> @@ -17,72 +16,117 @@ </methodsynopsis> <para> The function enumerates available printers and their capabilities. - <parameter>level</parameter> sets the level of information request. - Can be 1,2,4 or 5. <parameter>enumtype</parameter> must be one of the - following predefined constants: - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_LOCAL</parameter>: - enumerates the locally installed printers. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_NAME</parameter>: - enumerates the printer of <parameter>name</parameter>, can be a server, - domain or print provider. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_SHARED</parameter>: - this parameter can't be used alone, it has to be OR'ed with other - parameters, i.e. PRINTER_ENUM_LOCAL to detect the locally shared - printers. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_DEFAULT</parameter>: - (Win9.x only) enumerates the default printer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_CONNECTIONS</parameter>: - (WinNT/2000 only) enumerates the printers to which the user has - made connections. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_NETWORK</parameter>: - (WinNT/2000 only) enumerates network printers in the computer's - domain. Only valid if <parameter>level</parameter> is 1. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ENUM_REMOTE</parameter>: - (WinNT/2000 only) enumerates network printers and print servers in the - computer's domain. Only valid if <parameter>level</parameter> is 1. - </simpara> - </listitem> - </itemizedlist> </para> - <example> - <title><function>printer_list</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>enumtype</parameter></term> + <listitem> + <para> + <parameter>enumtype</parameter> must be one of the following predefined + constants: + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_ENUM_LOCAL</constant>: + enumerates the locally installed printers. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_NAME</constant>: + enumerates the printer of <parameter>name</parameter>, can be a server, + domain or print provider. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_SHARED</constant>: + this parameter can't be used alone, it has to be OR'ed with other + parameters, i.e. PRINTER_ENUM_LOCAL to detect the locally shared + printers. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_DEFAULT</constant>: + (Win9.x only) enumerates the default printer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_CONNECTIONS</constant>: + (WinNT/2000 only) enumerates the printers to which the user has + made connections. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_NETWORK</constant>: + (WinNT/2000 only) enumerates network printers in the computer's + domain. Only valid if <parameter>level</parameter> is 1. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ENUM_REMOTE</constant>: + (WinNT/2000 only) enumerates network printers and print servers in the + computer's domain. Only valid if <parameter>level</parameter> is 1. + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + Used with <constant>PRINTER_ENUM_NAME</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>level</parameter></term> + <listitem> + <para> + <parameter>level</parameter> sets the level of information request. + Can be 1,2,4 or 5. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return an array of printers. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_list</function> example</title> + <programlisting role="php"> <![CDATA[ <?php /* detect locally shared printer */ var_dump(printer_list(PRINTER_ENUM_LOCAL | PRINTER_ENUM_SHARED)); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-logical-fontheight"> <refnamediv> <refname>printer_logical_fontheight</refname> <refpurpose>Get logical font height</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>printer_logical_fontheight</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> - The function calculates the logical font height of - <parameter>height</parameter>. <parameter>handle</parameter> must - be a valid handle to a printer. + The function calculates the logical font height of <parameter>height</parameter>. </para> - <example> - <title> - <function>printer_logical_fontheight</function> example - </title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The font height. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the logical font height or &false; on failure. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_logical_fontheight</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -30,9 +62,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-open"> <refnamediv> <refname>printer_open</refname> - <refpurpose>Open connection to a printer</refpurpose> + <refpurpose>Opens a connection to a printer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>printer_open</methodname> - <methodparam choice="opt"><type>string</type><parameter>devicename</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>printername</parameter></methodparam> </methodsynopsis> <para> - This function tries to open a connection to the printer - <parameter>devicename</parameter>, and returns a handle on success - or &false; on failure. + This function tries to open a connection to the given printer. </para> <para> - If no parameter was given it tries to open a - connection to the default printer (if not specified in - &php.ini; as - <literal>printer.default_printer</literal>, PHP tries to detect it). + <function>printer_open</function> also starts a device context. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>printer_open</function> also starts a device context. + <variablelist> + <varlistentry> + <term><parameter>printername</parameter></term> + <listitem> + <para> + The printer name. If no parameter was given it tries to open a + connection to the default printer (if not specified in &php.ini; as + <literal>printer.default_printer</literal>, PHP tries to detect it). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a printer handle on success or &false; on failure. </para> - <example> - <title><function>printer_open</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_open</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open("HP Deskjet 930c"); $handle = printer_open(); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-select-brush"> <refnamediv> <refname>printer_select_brush</refname> <refpurpose>Select a brush</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_select_brush</methodname> <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> @@ -18,16 +18,50 @@ device context. A brush is used to fill shapes. If you draw an rectangle the brush is used to draw the shapes, while the pen is used to draw the border. + </para> + <para> If you haven't selected a brush before drawing shapes, the shape won't - be filled. <parameter>printer_handle</parameter> must be a valid handle - to a printer. <parameter>brush_handle</parameter> must be a valid handle - to a brush. + be filled. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>brush_handle</parameter></term> + <listitem> + <para> + <parameter>brush_handle</parameter> must be a valid brush handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> - <example> - <title> - <function>printer_select_brush</function> example - </title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_select_brush</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -55,9 +89,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-select-font"> <refnamediv> <refname>printer_select_font</refname> <refpurpose>Select a font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_select_font</methodname> <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> @@ -15,15 +15,46 @@ </methodsynopsis> <para> The function selects a font to draw text. - <parameter>printer_handle</parameter> must be a valid handle to a - printer. <parameter>font_handle</parameter> must be a valid handle - to a font. </para> - <example> - <title> - <function>printer_select_font</function> example - </title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>font_handle</parameter></term> + <listitem> + <para> + <parameter>font_handle</parameter> must be a valid font handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_select_font</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -40,9 +71,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-select-pen"> <refnamediv> <refname>printer_select_pen</refname> <refpurpose>Select a pen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>printer_select_pen</methodname> <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> @@ -19,15 +19,47 @@ a single line the pen is used. If you draw an rectangle the pen is used to draw the borders, while the brush is used to fill the shape. If you haven't selected a pen before drawing shapes, the shape won't be - outlined. <parameter>printer_handle</parameter> must be a valid handle - to a printer. <parameter>pen_handle</parameter> must be a valid handle - to a pen. + outlined. </para> - <example> - <title> - <function>printer_select_pen</function> example - </title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pen_handle</parameter></term> + <listitem> + <para> + <parameter>pen_handle</parameter> must be a valid pen handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_select_pen</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -46,9 +78,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-set-option"> <refnamediv> <refname>printer_set_option</refname> <refpurpose>Configure the printer connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_set_option</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>int</type><parameter>option</parameter></methodparam> <methodparam><type>mixed</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The function sets the following options for the current connection. - <parameter>handle</parameter> must be a valid handle to a printer. - For <parameter>option</parameter> can be one of the following constants: - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_COPIES</parameter>: - sets how many copies should be printed, <parameter>value</parameter> - must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_MODE</parameter>: - specifies the type of data (text, raw or emf), - <parameter>value</parameter> must be a string. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TITLE</parameter>: - specifies the name of the document, <parameter>value</parameter> - must be a string. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_ORIENTATION</parameter>: - specifies the orientation of the paper, <parameter>value</parameter> - can be either PRINTER_ORIENTATION_PORTRAIT or - PRINTER_ORIENTATION_LANDSCAPE - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_RESOLUTION_Y</parameter>: - specifies the y-resolution in DPI, <parameter>value</parameter> - must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_RESOLUTION_X</parameter>: - specifies the x-resolution in DPI, <parameter>value</parameter> - must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PAPER_FORMAT</parameter>: - specifies a predefined paper format, set <parameter>value</parameter> - to PRINTER_FORMAT_CUSTOM if you want to specify a custom format with - PRINTER_PAPER_WIDTH and PRINTER_PAPER_LENGTH. <parameter>value</parameter> - can be one of the following constants. - </simpara> - <itemizedlist> - <listitem> - <simpara> - <parameter> PRINTER_FORMAT_CUSTOM</parameter>: - let's you specify a custom paper format. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter> PRINTER_FORMAT_LETTER</parameter>: - specifies standard letter format (8 1/2- by 11-inches). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter> PRINTER_FORMAT_LEGAL</parameter>: - specifies standard legal format (8 1/2- by 14-inches). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_A3</parameter>: - specifies standard A3 format (297- by 420-millimeters). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_A4</parameter>: - specifies standard A4 format (210- by 297-millimeters). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_A5</parameter>: - specifies standard A5 format (148- by 210-millimeters). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_B4</parameter>: - specifies standard B4 format (250- by 354-millimeters). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_B5</parameter>: - specifies standard B5 format (182- by 257-millimeter). - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_FORMAT_FOLIO</parameter>: - specifies standard FOLIO format (8 1/2- by 13-inch). - </simpara> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PAPER_LENGTH</parameter>: - if PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM, - PRINTER_PAPER_LENGTH specifies a custom paper length in mm, - <parameter>value</parameter> must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_PAPER_WIDTH</parameter>: - if PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM, - PRINTER_PAPER_WIDTH specifies a custom paper width in mm, - <parameter>value</parameter> must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_SCALE</parameter>: - specifies the factor by which the printed output is to be scaled. - the page size is scaled from the physical page size by a factor - of scale/100. for example if you set the scale to 50, the output - would be half of its original size. <parameter>value</parameter> - must be an integer. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_BACKGROUND_COLOR</parameter>: - specifies the background color for the actual device context, - <parameter>value</parameter> must be a string containing the rgb - information in hex format i.e. "005533". - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TEXT_COLOR</parameter>: - specifies the text color for the actual device context, - <parameter>value</parameter> must be a string containing the rgb - information in hex format i.e. "005533". - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TEXT_ALIGN</parameter>: - specifies the text alignment for the actual device context, - <parameter>value</parameter> can be combined through OR'ing the - following constants: - </simpara> - <itemizedlist> - <listitem> - <simpara> - <parameter>PRINTER_TA_BASELINE</parameter>: - text will be aligned at the base line. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TA_BOTTOM</parameter>: - text will be aligned at the bottom. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TA_TOP</parameter>: - text will be aligned at the top. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TA_CENTER</parameter>: - text will be aligned at the center. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TA_LEFT</parameter>: - text will be aligned at the left. - </simpara> - </listitem> - <listitem> - <simpara> - <parameter>PRINTER_TA_RIGHT</parameter>: - text will be aligned at the right. - </simpara> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - </para> + The function sets options for the current connection. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + Option can be one of the following constants: + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_COPIES</constant>: + sets how many copies should be printed, <parameter>value</parameter> + must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_MODE</constant>: + specifies the type of data (text, raw or emf), + <parameter>value</parameter> must be a string. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TITLE</constant>: + specifies the name of the document, <parameter>value</parameter> + must be a string. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_ORIENTATION</constant>: + specifies the orientation of the paper, <parameter>value</parameter> + can be either PRINTER_ORIENTATION_PORTRAIT or + PRINTER_ORIENTATION_LANDSCAPE + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_RESOLUTION_Y</constant>: + specifies the y-resolution in DPI, <parameter>value</parameter> + must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_RESOLUTION_X</constant>: + specifies the x-resolution in DPI, <parameter>value</parameter> + must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PAPER_FORMAT</constant>: + specifies a predefined paper format, set <parameter>value</parameter> + to PRINTER_FORMAT_CUSTOM if you want to specify a custom format with + PRINTER_PAPER_WIDTH and PRINTER_PAPER_LENGTH. <parameter>value</parameter> + can be one of the following constants. + </simpara> + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_CUSTOM</constant>: + let's you specify a custom paper format. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_LETTER</constant>: + specifies standard letter format (8 1/2- by 11-inches). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_LEGAL</constant>: + specifies standard legal format (8 1/2- by 14-inches). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_A3</constant>: + specifies standard A3 format (297- by 420-millimeters). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_A4</constant>: + specifies standard A4 format (210- by 297-millimeters). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_A5</constant>: + specifies standard A5 format (148- by 210-millimeters). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_B4</constant>: + specifies standard B4 format (250- by 354-millimeters). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_B5</constant>: + specifies standard B5 format (182- by 257-millimeter). + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_FORMAT_FOLIO</constant>: + specifies standard FOLIO format (8 1/2- by 13-inch). + </simpara> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PAPER_LENGTH</constant>: + if PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM, + PRINTER_PAPER_LENGTH specifies a custom paper length in mm, + <parameter>value</parameter> must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_PAPER_WIDTH</constant>: + if PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM, + PRINTER_PAPER_WIDTH specifies a custom paper width in mm, + <parameter>value</parameter> must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_SCALE</constant>: + specifies the factor by which the printed output is to be scaled. + the page size is scaled from the physical page size by a factor + of scale/100. for example if you set the scale to 50, the output + would be half of its original size. <parameter>value</parameter> + must be an integer. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_BACKGROUND_COLOR</constant>: + specifies the background color for the actual device context, + <parameter>value</parameter> must be a string containing the rgb + information in hex format i.e. "005533". + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TEXT_COLOR</constant>: + specifies the text color for the actual device context, + <parameter>value</parameter> must be a string containing the rgb + information in hex format i.e. "005533". + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TEXT_ALIGN</constant>: + specifies the text alignment for the actual device context, + <parameter>value</parameter> can be combined through OR'ing the + following constants: + </simpara> + <itemizedlist> + <listitem> + <simpara> + <constant>PRINTER_TA_BASELINE</constant>: + text will be aligned at the base line. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TA_BOTTOM</constant>: + text will be aligned at the bottom. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TA_TOP</constant>: + text will be aligned at the top. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TA_CENTER</constant>: + text will be aligned at the center. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TA_LEFT</constant>: + text will be aligned at the left. + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PRINTER_TA_RIGHT</constant>: + text will be aligned at the right. + </simpara> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The <parameter>option</parameter> value. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> - <title><function>printer_set_option</function> example</title> - <programlisting role="php"> + <title><function>printer_set_option</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -228,9 +270,11 @@ printer_close($handle); ?> ]]> - </programlisting> + </programlisting> </example> - </refsect1> + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-start-doc"> <refnamediv> <refname>printer_start_doc</refname> <refpurpose>Start a new document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_start_doc</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>document</parameter></methodparam> </methodsynopsis> <para> The function creates a new document in the printer spooler. A document can contain multiple pages, it's used to schedule the print job in the - spooler. <parameter>handle</parameter> must be a valid handle to a - printer. The optional parameter <parameter>document</parameter> can be - used to set an alternative document name. + spooler. </para> - <example> - <title><function>printer_start_doc</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>document</parameter></term> + <listitem> + <para> + The optional parameter <parameter>document</parameter> can be used to + set an alternative document name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_start_doc</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -34,9 +69,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry>  - + <refentry id="function.printer-start-page"> <refnamediv> <refname>printer_start_page</refname> <refpurpose>Start a new page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_start_page</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> </methodsynopsis> <para> The function creates a new page in the active document. For an example see <function>printer_start_doc</function>. - <parameter>handle</parameter> must be a valid handle to a printer. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.printer-write"> <refnamediv> <refname>printer_write</refname> <refpurpose>Write data to the printer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>printer_write</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> <methodparam><type>string</type><parameter>content</parameter></methodparam> </methodsynopsis> <para> Writes <parameter>content</parameter> directly to the printer. - &return.success; </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>printer_handle</parameter></term> + <listitem> + <para> + <parameter>printer_handle</parameter> must be a valid printer handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>content</parameter></term> + <listitem> + <para> + The data to be written. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>handle</parameter> must be a valid handle to a printer. + &return.success; </para> - <example> - <title><function>printer_write</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>printer_write</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $handle = printer_open(); @@ -30,9 +62,11 @@ printer_close($handle); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file