sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.haru extension wide commit

Browse source 
- added missing roles, namely returnvalues and parameters
- and related changes


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@253949 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-02-28 22:32:26 +00:00
parent c1183e7825
commit 0f2a8161c7
107 changed files with 1356 additions and 190 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
reference/haru/harudestination/setfit.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudestination-setfit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDestination::setFit</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudestination/setfitb.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudestination-setfitb" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDestination::setFitB</refname>
@ -18,6 +18,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

17
reference/haru/harudoc/addpage.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-addpage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::addPage</refname>
@ -13,8 +13,19 @@
<void/>
</methodsynopsis>
<para>
Adds new page to the document and returns new
<classname>HaruPage</classname> instance.
Adds a new page to the document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruPage</classname> instance.
</para>
</refsect1>

14
reference/haru/harudoc/construct.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::__construct</refname>
@ -17,6 +17,18 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

12
reference/haru/harudoc/createoutline.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-createoutline" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::createOutline</refname>
@ -15,7 +15,7 @@
<methodparam choice="opt"><type>object</type><parameter>encoder</parameter></methodparam>
</methodsynopsis>
<para>
Creates and returns new <classname>HaruOutline</classname> instance.
Create a <classname>HaruOutline</classname> instance.
</para>
</refsect1>
@ -50,6 +50,14 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruOutline</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/harudoc/getcurrentencoder.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getcurrentencoder" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getCurrentEncoder</refname>
@ -12,6 +12,18 @@
<type>object</type><methodname>HaruDoc::getCurrentEncoder</methodname>
<void/>
</methodsynopsis>
<para>
Get the <classname>HaruEncoder</classname> currently used in the document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <classname>HaruEncoder</classname> currently used in the document
or &false; if encoder is not set.

13
reference/haru/harudoc/getcurrentpage.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getcurrentpage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getCurrentPage</refname>
@ -14,6 +14,17 @@
</methodsynopsis>
<para>
Get current page of the document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <classname>HaruPage</classname> instance on success or &false;
if there is no current page at the moment.
</para>

12
reference/haru/harudoc/getencoder.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getencoder" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getEncoder</refname>
@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Returns <classname>HaruEncoder</classname> instance for the specified encoding.
Get the <classname>HaruEncoder</classname> instance for the specified encoding.
</para>
</refsect1>
@ -33,6 +33,14 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <classname>HaruEncoder</classname> instance for the specified encoding.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

18
reference/haru/harudoc/getfont.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getfont" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getFont</refname>
@ -14,9 +14,7 @@
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Creates and returns <classname>HaruFont</classname> instance with the
specified <parameter>fontname</parameter> and
<parameter>encoding</parameter>.
Get a <classname>HaruFont</classname> instance.
</para>
</refsect1>
@ -46,13 +44,23 @@
<listitem>
<para>
The encoding to use. See <link linkend="haru.builtin.encodings">Builtin
Encodings</link> for the list of supported encodings.
Encodings</link> for the list of supported encodings.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <classname>HaruFont</classname> instance with the
specified <parameter>fontname</parameter> and
<parameter>encoding</parameter>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

12
reference/haru/harudoc/getinfoattr.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getinfoattr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getInfoAttr</refname>
@ -13,7 +13,7 @@
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
Returns the string value of the specified document attribute.
Get the current value of the specified document attribute.
</para>
</refsect1>
@ -55,6 +55,14 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <type>string</type> value of the specified document attribute.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

17
reference/haru/harudoc/getpagelayout.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getpagelayout" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getPageLayout</refname>
@ -12,6 +12,20 @@
<type>int</type><methodname>HaruDoc::getPageLayout</methodname>
<void/>
</methodsynopsis>
<para>
Get the current page layout.
See <link linkend="function.harudoc-setpagelayout"><classname>HaruDoc</classname>::<function>setPageLayout</function></link>
for the list of possible values.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the page layout currently set in the document or &false; if page
layout was not set.
@ -19,6 +33,7 @@
for the list of possible values.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

18
reference/haru/harudoc/getpagemode.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getpagemode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getPageMode</refname>
@ -12,9 +12,23 @@
<type>int</type><methodname>HaruDoc::getPageMode</methodname>
<void/>
</methodsynopsis>
<para>
Get the current page mode.
See <link linkend="function.harudoc-setpagemode"><classname>HaruDoc</classname>::<function>setPageMode</function></link>
for the list of possible values.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the page mode currently set in the document. See <link
linkend="function.harudoc-setpagemode"><classname>HaruDoc</classname>::<function>setPageMode</function></link>
linkend="function.harudoc-setpagemode"><classname>HaruDoc</classname>::<function>setPageMode</function></link>
for the list of possible values.
</para>
</refsect1>

14
reference/haru/harudoc/getstreamsize.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-getstreamsize" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::getStreamSize</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruDoc::getStreamSize</methodname>
<void/>
</methodsynopsis>
<para>
Get the size of the temporary stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the size of the data in the temporary stream of the document.
The size is zero if the document was not saved to the temporary stream.

12
reference/haru/harudoc/insertpage.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-insertpage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::insertPage</refname>
@ -13,8 +13,7 @@
<methodparam><type>object</type><parameter>page</parameter></methodparam>
</methodsynopsis>
<para>
Creates new page and inserts just before the specified page.
Returns new <classname>HaruPage</classname> instance.
Creates a new page and inserts just before the specified page.
</para>
</refsect1>
@ -34,6 +33,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruPage</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/harudoc/loadjpeg.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-loadjpeg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::loadJPEG</refname>
<refpurpose>Load JPEG image and return new <classname>HaruImage</classname> instance</refpurpose>
<refpurpose>Load a JPEG image.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -13,8 +13,7 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Loads the specified JPEG image and returns new
<classname>HaruImage</classname> instance.
Loads the specified JPEG image.
</para>
</refsect1>
@ -34,6 +33,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruImage</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

17
reference/haru/harudoc/loadpng.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-loadpng" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::loadPNG</refname>
@ -14,10 +14,7 @@
<methodparam choice="opt"><type>bool</type><parameter>deferred</parameter></methodparam>
</methodsynopsis>
<para>
Loads PNG image and returns <classname>HaruImage</classname> instance.
You can set <parameter>deferred</parameter> parameter to &true; for
deferred data loading, in this case only size and color are loaded
immediately. Default value of <parameter>deferred</parameter> is &false;.
Loads a PNG image.
</para>
<para>
Libharu might be built without libpng support, in this case each call to
@ -42,6 +39,9 @@
<listitem>
<para>
Do not load data immediately. Defaults to &false;.
You can set <parameter>deferred</parameter> parameter to &true; for
deferred data loading, in this case only size and color are loaded
immediately.
</para>
</listitem>
</varlistentry>
@ -49,6 +49,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <classname>HaruImage</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

13
reference/haru/harudoc/loadraw.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-loadraw" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::loadRaw</refname>
<refpurpose>Load RAW image and return HaruImage instance</refpurpose>
<refpurpose>Load a RAW image</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -16,7 +16,7 @@
<methodparam><type>int</type><parameter>color_space</parameter></methodparam>
</methodsynopsis>
<para>
Loads RAW image and returns new <classname>HaruImage</classname> instance.
Loads a RAW image.
</para>
</refsect1>
@ -71,6 +71,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <classname>HaruImage</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

7
reference/haru/harudoc/output.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::output</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

30
reference/haru/harudoc/readfromstream.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-readfromstream" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::readFromStream</refname>
@ -13,9 +13,31 @@
<methodparam><type>int</type><parameter>bytes</parameter></methodparam>
</methodsynopsis>
<para>
Returns data from the temporary stream. The <parameter>bytes</parameter>
parameter specifies how much bytes to read, though the stream may contain
less bytes than requested.
Read data from the temporary stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bytes</parameter></term>
<listitem>
<para>
The <parameter>bytes</parameter> parameter specifies how many bytes
to read, though the stream may contain less bytes than requested.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns data from the temporary stream.
</para>
</refsect1>

9
reference/haru/harudoc/reseterror.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-reseterror" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::resetError</refname>
@ -20,10 +20,15 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Always succeedes and returns &true;.
Always succeeds and returns &true;.
</para>
</refsect1>

7
reference/haru/harudoc/resetstream.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-resetstream" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::resetStream</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/savetostream.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-savetostream" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::saveToStream</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usecnsencodings.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usecnsencodings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useCNSEncodings</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

9
reference/haru/harudoc/usecnsfonts.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usecnsfonts" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useCNSFonts</refname>
@ -13,10 +13,15 @@
<void/>
</methodsynopsis>
<para>
Enableis builtin Chinese simplified fonts.
Enables builtin Chinese simplified fonts.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usecntencodings.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usecntencodings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useCNTEncodings</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usecntfonts.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usecntfonts" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useCNTFonts</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usejpencodings.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usejpencodings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useJPEncodings</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usejpfonts.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usejpfonts" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useJPFonts</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usekrencodings.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usekrencodings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useKREncodings</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harudoc/usekrfonts.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-usekrfonts" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::useKRFonts</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

49
reference/haru/haruencoder/getbytetype.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruencoder-getbytetype" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruEncoder::getByteType</refname>
@ -14,26 +14,7 @@
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
<para>
Returns the type of the byte in the text on the specified position.
The result is one of the following values:
<simplelist>
<member>
<constant>HaruEncoder::BYTE_TYPE_SINGLE</constant> - single byte
character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_LEAD</constant> - lead byte of a
double-byte character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_TRAIL</constant> - trailing byte of a
double-byte character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_UNKNOWN</constant> - invalid encoder or
cannot detect the byte type.
</member>
</simplelist>
Get the type of the byte in the text.
</para>
</refsect1>
@ -60,6 +41,32 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the type of the byte in the text on the specified position.
The result is one of the following values:
<simplelist>
<member>
<constant>HaruEncoder::BYTE_TYPE_SINGLE</constant> - single byte
character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_LEAD</constant> - lead byte of a
double-byte character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_TRAIL</constant> - trailing byte of a
double-byte character.
</member>
<member>
<constant>HaruEncoder::BYTE_TYPE_UNKNOWN</constant> - invalid encoder or
cannot detect the byte type.
</member>
</simplelist>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;

16
reference/haru/haruencoder/gettype.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruencoder-gettype" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruEncoder::getType</refname>
@ -13,7 +13,19 @@
<void/>
</methodsynopsis>
<para>
Returns the type of the encoder. The result is one of the followin values:
Get the type of the encoder.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the type of the encoder. The result is one of the following values:
<simplelist>
<member>
<constant>HaruEncoder::TYPE_SINGLE_BYTE</constant> - the encoder is for single

9
reference/haru/haruencoder/getunicode.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruencoder-getunicode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruEncoder::getUnicode</refname>
@ -33,6 +33,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<!-- FIXME -->
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/haruencoder/getwritingmode.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruencoder-getwritingmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruEncoder::getWritingMode</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruEncoder::getWritingMode</methodname>
<void/>
</methodsynopsis>
<para>
Get the writing mode of the encoder.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the writing mode of the encoder. The result value is on of the
following:

14
reference/haru/harufont/getascent.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getascent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getAscent</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruFont::getAscent</methodname>
<void/>
</methodsynopsis>
<para>
Get the vertical ascent of the font.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the vertical ascent of the font.
</para>

14
reference/haru/harufont/getcapheight.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getcapheight" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getCapHeight</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruFont::getCapHeight</methodname>
<void/>
</methodsynopsis>
<para>
Get the distance from the baseline of uppercase letters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the distance from the baseline of uppercase letters.
</para>

14
reference/haru/harufont/getdescent.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getdescent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getDescent</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruFont::getDescent</methodname>
<void/>
</methodsynopsis>
<para>
Get the vertical descent of the font.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return the vertical descent of the font.
</para>

14
reference/haru/harufont/getencodingname.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getencodingname" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getEncodingName</refname>
@ -12,6 +12,18 @@
<type>string</type><methodname>HaruFont::getEncodingName</methodname>
<void/>
</methodsynopsis>
<para>
Get the name of the font encoding.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the font encoding.
</para>

14
reference/haru/harufont/getfontname.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getfontname" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getFontName</refname>
@ -12,6 +12,18 @@
<type>string</type><methodname>HaruFont::getFontName</methodname>
<void/>
</methodsynopsis>
<para>
Get the name of the font.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the font.
</para>

14
reference/haru/harufont/gettextwidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-gettextwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getTextWidth</refname>
@ -13,8 +13,8 @@
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Returns the total width of the text, number of characters, number of words
and number of spaces in the given text.
Get the total width of the text, number of characters, number of words and
number of spaces.
</para>
</refsect1>
@ -34,6 +34,14 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the total width of the text, number of characters, number of words
and number of spaces in the given text.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

11
reference/haru/harufont/getunicodewidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getunicodewidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getUnicodeWidth</refname>
@ -13,7 +13,7 @@
<methodparam><type>int</type><parameter>character</parameter></methodparam>
</methodsynopsis>
<para>
Returns the width of the character in the font.
Get the width of the character in the font.
</para>
</refsect1>
@ -33,6 +33,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the width of the character in the font.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/harufont/getxheight.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-getxheight" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::getXHeight</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruFont::getXHeight</methodname>
<void/>
</methodsynopsis>
<para>
Gets the distance from the baseline of lowercase letters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the distance from the baseline of lowercase letters.
</para>

13
reference/haru/harufont/measuretext.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harufont-measuretext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruFont::measureText</refname>
@ -18,7 +18,7 @@
<methodparam choice="opt"><type>bool</type><parameter>word_wrap</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of characters which can be included within the
Calculate the number of characters which can be included within the
specified width.
</para>
</refsect1>
@ -80,6 +80,15 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of characters which can be included within the
specified width.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

15
reference/haru/haruimage/getbitspercomponent.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruimage-getbitspercomponent" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruImage::getBitsPerComponent</refname>
@ -12,6 +12,19 @@
<type>int</type><methodname>HaruImage::getBitsPerComponent</methodname>
<void/>
</methodsynopsis>
<para>
Gets the number of bits used to describe each color component of the
image.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of bits used to describe each color component of the
image.

14
reference/haru/haruimage/getcolorspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruimage-getcolorspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruImage::getColorSpace</refname>
@ -12,6 +12,18 @@
<type>string</type><methodname>HaruImage::getColorSpace</methodname>
<void/>
</methodsynopsis>
<para>
Get the name of the color space.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the color space of the image. The name is one of the
following values:

14
reference/haru/haruimage/getheight.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruimage-getheight" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruImage::getHeight</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruImage::getHeight</methodname>
<void/>
</methodsynopsis>
<para>
Get the height of the image.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the height of the image.
</para>

14
reference/haru/haruimage/getsize.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruimage-getsize" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruImage::getSize</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruImage::getSize</methodname>
<void/>
</methodsynopsis>
<para>
Get the size of the image.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with two elements: width and height, which contain
appropriate dimensions of the image.

14
reference/haru/haruimage/getwidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.haruimage-getwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruImage::getWidth</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruImage::getWidth</methodname>
<void/>
</methodsynopsis>
<para>
Get the width of the image.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the width of the image.
</para>

7
reference/haru/harupage/begintext.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-begintext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::beginText</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harupage/closepath.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-closepath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::closePath</refname>
@ -18,6 +18,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

5
reference/haru/harupage/concat.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-concat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::concat</refname>
@ -23,7 +23,7 @@
</para>
</refsect1>
<!--
<!-- FIXME -->
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -79,7 +79,6 @@
</variablelist>
</para>
</refsect1>
-->
<refsect1 role="returnvalues">
&reftitle.returnvalues;

16
reference/haru/harupage/createdestination.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-createdestination" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::createDestination</refname>
@ -13,7 +13,19 @@
<void/>
</methodsynopsis>
<para>
Creates and returns new <classname>HaruDestination</classname> instance.
Create a new <classname>HaruDestination</classname> instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruDestination</classname> instance.
</para>
</refsect1>

11
reference/haru/harupage/createlinkannotation.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-createlinkannotation" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::createLinkAnnotation</refname>
@ -14,7 +14,7 @@
<methodparam><type>object</type><parameter>destination</parameter></methodparam>
</methodsynopsis>
<para>
Creates and returns new <classname>HaruAnnotation</classname> instance.
Creates a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
@ -42,6 +42,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

11
reference/haru/harupage/createtextannotation.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-createtextannotation" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::createTextAnnotation</refname>
@ -15,7 +15,7 @@
<methodparam choice="opt"><type>object</type><parameter>encoder</parameter></methodparam>
</methodsynopsis>
<para>
Creates and returns new <classname>HaruAnnotation</classname> instance.
Creates a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
@ -50,6 +50,13 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;

13
reference/haru/harupage/createurlannotation.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-createurlannotation" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::createURLAnnotation</refname>
@ -14,7 +14,7 @@
<methodparam><type>string</type><parameter>url</parameter></methodparam>
</methodsynopsis>
<para>
Creates and returns new <classname>HaruAnnotation</classname> instance.
Creates a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
@ -41,7 +41,14 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>HaruAnnotation</classname> instance.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

58
reference/haru/harupage/curveto.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-curveto" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::curveTo</refname>
@ -24,6 +24,62 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

42
reference/haru/harupage/curveto2.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-curveto2" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::curveTo2</refname>
@ -22,6 +22,46 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

42
reference/haru/harupage/curveto3.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-curveto3" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::curveTo3</refname>
@ -22,6 +22,46 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
A Bezier curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
The current point moves here.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harupage/endpath.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-endpath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::endPath</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harupage/endtext.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-endtext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::endText</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harupage/eofill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-eofill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::eofill</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

7
reference/haru/harupage/fill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-fill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::fill</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

14
reference/haru/harupage/getcharspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcharspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCharSpace</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getCharSpace</methodname>
<void/>
</methodsynopsis>
<para>
Get the current value of character spacing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current value of character spacing.
</para>

14
reference/haru/harupage/getcmykfill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcmykfill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCMYKFill</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getCMYKFill</methodname>
<void/>
</methodsynopsis>
<para>
Returns the current filling color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current filling color as an array with 4 elements ("c", "m",
"y" and "k").

14
reference/haru/harupage/getcmykstroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcmykstroke" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCMYKStroke</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getCMYKStroke</methodname>
<void/>
</methodsynopsis>
<para>
Get the current stroking color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current stroking color as an array with 4 elements ("c", "m",
"y" and "k").

16
reference/haru/harupage/getcurrentfont.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcurrentfont" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCurrentFont</refname>
@ -13,7 +13,19 @@
<void/>
</methodsynopsis>
<para>
Returns the currently used font as an instance of <classname>HaruFont</classname>.
Get the currently used font.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the currently used font as an instance of <classname>HaruFont</classname>.
</para>
</refsect1>

14
reference/haru/harupage/getcurrentfontsize.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcurrentfontsize" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCurrentFontSize</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getCurrentFontSize</methodname>
<void/>
</methodsynopsis>
<para>
Get the current font size.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current font size.
</para>

14
reference/haru/harupage/getcurrentpos.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcurrentpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCurrentPos</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getCurrentPos</methodname>
<void/>
</methodsynopsis>
<para>
Get the current position for path painting.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current position for path painting as an array of with two
elements - "x" and "y".

14
reference/haru/harupage/getcurrenttextpos.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getcurrenttextpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getCurrentTextPos</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getCurrentTextPos</methodname>
<void/>
</methodsynopsis>
<para>
Get the current position for text printing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current position for text printing as an array with 2 elements
- "x" and "y".

18
reference/haru/harupage/getdash.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getdash" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getDash</refname>
@ -13,13 +13,25 @@
<void/>
</methodsynopsis>
<para>
Returns the current dash pattern as an array of two elements - "pattern"
and "phase" or &false; if dash pattern was not set. See
Get the current dash pattern. See
<link linkend="function.harupage-setdash"><classname>HaruPage</classname>::<function>setDash</function></link>
for more information on dash patterns.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current dash pattern as an array of two elements - "pattern"
and "phase" or &false; if dash pattern was not set.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/harupage/getfillingcolorspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getfillingcolorspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getFillingColorSpace</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruPage::getFillingColorSpace</methodname>
<void/>
</methodsynopsis>
<para>
Get the current filling color space.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current filling color space. The result value is one of the following:
<simplelist>

14
reference/haru/harupage/getflatness.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getflatness" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getFlatness</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getFlatness</methodname>
<void/>
</methodsynopsis>
<para>
Get the flatness of the page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the flatness of the page.
</para>

16
reference/haru/harupage/getgmode.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getgmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getGMode</refname>
@ -12,8 +12,22 @@
<type>int</type><methodname>HaruPage::getGMode</methodname>
<void/>
</methodsynopsis>
<para>
Get the current graphics mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current graphics mode. The result value is one of the following:
</para>
<para>
<simplelist>
<member>
<constant>HaruPage::GMODE_PAGE_DESCRIPTION</constant>

14
reference/haru/harupage/getgrayfill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getgrayfill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getGrayFill</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getGrayFill</methodname>
<void/>
</methodsynopsis>
<para>
Get the current filling color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current filling color.
</para>

14
reference/haru/harupage/getgraystroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getgraystroke" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getGrayStroke</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getGrayStroke</methodname>
<void/>
</methodsynopsis>
<para>
Get the current stroking color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current stroking color.
</para>

14
reference/haru/harupage/getheight.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getheight" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getHeight</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getHeight</methodname>
<void/>
</methodsynopsis>
<para>
Get the height of the page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the height of the page.
</para>

14
reference/haru/harupage/gethorizontalscaling.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gethorizontalscaling" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getHorizontalScaling</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getHorizontalScaling</methodname>
<void/>
</methodsynopsis>
<para>
Get the current value of the horizontal scaling.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current value of horizontal scaling.
</para>

14
reference/haru/harupage/getlinecap.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getlinecap" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getLineCap</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruPage::getLineCap</methodname>
<void/>
</methodsynopsis>
<para>
Get the current line cap style.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current line cap style. The result value is one of the following:
<simplelist>

14
reference/haru/harupage/getlinejoin.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getlinejoin" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getLineJoin</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruPage::getLineJoin</methodname>
<void/>
</methodsynopsis>
<para>
Get the current line join style.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current line join style. The result value is one of the following:
<simplelist>

14
reference/haru/harupage/getlinewidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getlinewidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getLineWidth</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getLineWidth</methodname>
<void/>
</methodsynopsis>
<para>
Get the current line width.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current line width.
</para>

16
reference/haru/harupage/getmiterlimit.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getmiterlimit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getMiterLimit</refname>
@ -13,7 +13,19 @@
<void/>
</methodsynopsis>
<para>
Returns the value of miter limit.
Get the value of the miter limit.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the miter limit.
</para>
</refsect1>

14
reference/haru/harupage/getrgbfill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getrgbfill" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getRGBFill</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getRGBFill</methodname>
<void/>
</methodsynopsis>
<para>
Get the current filling color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current filling color as an array with 3 elements: "r", "g" and "b".
</para>

14
reference/haru/harupage/getrgbstroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getrgbstroke" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getRGBStroke</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getRGBStroke</methodname>
<void/>
</methodsynopsis>
<para>
Get the current stroking color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current stroking color.
</para>

14
reference/haru/harupage/getstrokingcolorspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getstrokingcolorspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getStrokingColorSpace</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruPage::getStrokingColorSpace</methodname>
<void/>
</methodsynopsis>
<para>
Get the current stroking color space.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current stroking color space. The list of return values is the same as for
<link linkend="function.harupage-getfillingcolorspace"><classname>HaruPage</classname>::<function>getFillingColorSpace</function></link>.

14
reference/haru/harupage/gettextleading.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettextleading" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTextLeading</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getTextLeading</methodname>
<void/>
</methodsynopsis>
<para>
Get the current value of line spacing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current value of line spacing.
</para>

9
reference/haru/harupage/gettextmatrix.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettextmatrix" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTextMatrix</refname>
@ -12,6 +12,13 @@
<type>array</type><methodname>HaruPage::getTextMatrix</methodname>
<void/>
</methodsynopsis>
<para>
Get the current text transformation matrix of the page.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current text transformation matrix of the page as an array of 6 elements:
"a", "b", "c", "d", "x" and "y".

14
reference/haru/harupage/gettextrenderingmode.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettextrenderingmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTextRenderingMode</refname>
@ -12,6 +12,18 @@
<type>int</type><methodname>HaruPage::getTextRenderingMode</methodname>
<void/>
</methodsynopsis>
<para>
Get the current text rendering mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current text rendering mode. The result value is one of the following:
<simplelist>

14
reference/haru/harupage/gettextrise.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettextrise" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTextRise</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getTextRise</methodname>
<void/>
</methodsynopsis>
<para>
Get the current value of text rising.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current value of text rising.
</para>

11
reference/haru/harupage/gettextwidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettextwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTextWidth</refname>
@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Returns the width of the text using current fontsize, character spacing and word spacing.
Get the width of the text using current fontsize, character spacing and word spacing
</para>
</refsect1>
@ -33,6 +33,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the width of the text using current fontsize, character spacing and word spacing.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

14
reference/haru/harupage/gettransmatrix.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-gettransmatrix" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getTransMatrix</refname>
@ -12,6 +12,18 @@
<type>array</type><methodname>HaruPage::getTransMatrix</methodname>
<void/>
</methodsynopsis>
<para>
Get the current transformation matrix of the page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current transformation matrix of the page as an array of 6 elements:
"a", "b", "c", "d", "x" and "y".

14
reference/haru/harupage/getwidth.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getwidth" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getWidth</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getWidth</methodname>
<void/>
</methodsynopsis>
<para>
Get the width of the page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the width of the page.
</para>

14
reference/haru/harupage/getwordspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-getwordspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::getWordSpace</refname>
@ -12,6 +12,18 @@
<type>float</type><methodname>HaruPage::getWordSpace</methodname>
<void/>
</methodsynopsis>
<para>
Get the current value of word spacing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current value of word spacing.
</para>

11
reference/haru/harupage/measuretext.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-measuretext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::measureText</refname>
@ -15,7 +15,7 @@
<methodparam choice="opt"><type>bool</type><parameter>wordwrap</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of characters which can be included within the specified width.
Get the number of characters which can be included within the specified width.
</para>
</refsect1>
@ -53,6 +53,13 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of characters which can be included within the specified width.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

39
reference/haru/harupage/movetextpos.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-movetextpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::moveTextPos</refname>
@ -17,9 +17,40 @@
<para>
Moves text position to the specified offset. If the start position of the current
line is (x1, y1), the start of the next line is (x1 + <parameter>x</parameter>,
y1 + <parameter>y</parameter>). If optional parameter <parameter>set_leading</parameter>
is &true;, the function sets the text leading to -<parameter>y</parameter>. The default
value of <parameter>set_leading</parameter> is &false;.
y1 + <parameter>y</parameter>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
The specified text position offset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
The specified text position offset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>set_leading</parameter></term>
<listitem>
<para>
If set to &true;, the function sets the text leading to -<parameter>y</parameter>.
The default value of <parameter>set_leading</parameter> is &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

8
reference/haru/harupage/moveto.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-moveto" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::moveTo</refname>
@ -18,7 +18,6 @@
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +26,7 @@
<term><parameter>x</parameter></term>
<listitem>
<para>
A new starting point coordinate.
</para>
</listitem>
</varlistentry>
@ -35,14 +34,13 @@
<term><parameter>y</parameter></term>
<listitem>
<para>
A new starting point coordinate.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
-->
<refsect1 role="returnvalues">
&reftitle.returnvalues;

7
reference/haru/harupage/movetonextline.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-movetonextline" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::moveToNextLine</refname>
@ -17,6 +17,11 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

18
reference/haru/harupage/setcharspace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-setcharspace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::setCharSpace</refname>
@ -17,6 +17,22 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>char_space</parameter></term>
<listitem>
<para>
The new character spacing for the page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

18
reference/haru/harupage/setflatness.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-setflatness" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::setFlatness</refname>
@ -17,6 +17,22 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flatness</parameter></term>
<listitem>
<para>
The defined flatness for the page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

18
reference/haru/harupage/setheight.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-setheight" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::setHeight</refname>
@ -17,6 +17,22 @@
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
The defined height for the page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

22
reference/haru/harupage/sethorizontalscaling.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harupage-sethorizontalscaling" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruPage::setHorizontalScaling</refname>
@ -13,8 +13,24 @@
<methodparam><type>float</type><parameter>scaling</parameter></methodparam>
</methodsynopsis>
<para>
Defines horizontal scaling for text showing on the page. The initial value
is 100.
Set the horizontal scaling for the page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>scaling</parameter></term>
<listitem>
<para>
The horizontal scaling for text showing on the page.
The initial value is 100.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

Some files were not shown because too many files have changed in this diff Show more