File: printer-create-pen.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (123 lines) | stat: -rw-r--r-- 3,342 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.printer-create-pen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>printer_create_pen</refname>
  <refpurpose>Create a new pen</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>printer_create_pen</methodname>
   <methodparam><type>int</type><parameter>style</parameter></methodparam>
   <methodparam><type>int</type><parameter>width</parameter></methodparam>
   <methodparam><type>string</type><parameter>color</parameter></methodparam>
  </methodsynopsis>
  <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>.
  </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>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->