diff --git a/reference/haru/harudestination/setfit.xml b/reference/haru/harudestination/setfit.xml index 8d2ed1b4bc..628b455c72 100644 --- a/reference/haru/harudestination/setfit.xml +++ b/reference/haru/harudestination/setfit.xml @@ -1,5 +1,5 @@ - + HaruDestination::setFit @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudestination/setfitb.xml b/reference/haru/harudestination/setfitb.xml index 1ab7a97f08..9efe64e075 100644 --- a/reference/haru/harudestination/setfitb.xml +++ b/reference/haru/harudestination/setfitb.xml @@ -1,5 +1,5 @@ - + HaruDestination::setFitB @@ -18,6 +18,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/addpage.xml b/reference/haru/harudoc/addpage.xml index b8171ccc4f..d15fa212dd 100644 --- a/reference/haru/harudoc/addpage.xml +++ b/reference/haru/harudoc/addpage.xml @@ -1,5 +1,5 @@ - + HaruDoc::addPage @@ -13,8 +13,19 @@ - Adds new page to the document and returns new - HaruPage instance. + Adds a new page to the document. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a new HaruPage instance. diff --git a/reference/haru/harudoc/construct.xml b/reference/haru/harudoc/construct.xml index b2fca0dcf1..cb72c23ca5 100644 --- a/reference/haru/harudoc/construct.xml +++ b/reference/haru/harudoc/construct.xml @@ -1,5 +1,5 @@ - + HaruDoc::__construct @@ -17,6 +17,18 @@ + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + &reftitle.errors; diff --git a/reference/haru/harudoc/createoutline.xml b/reference/haru/harudoc/createoutline.xml index 886112d187..6f9b7456aa 100644 --- a/reference/haru/harudoc/createoutline.xml +++ b/reference/haru/harudoc/createoutline.xml @@ -1,5 +1,5 @@ - + HaruDoc::createOutline @@ -15,7 +15,7 @@ objectencoder - Creates and returns new HaruOutline instance. + Create a HaruOutline instance. @@ -50,6 +50,14 @@ + + + &reftitle.returnvalues; + + Returns a new HaruOutline instance. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/getcurrentencoder.xml b/reference/haru/harudoc/getcurrentencoder.xml index 2a90848215..886e93392b 100644 --- a/reference/haru/harudoc/getcurrentencoder.xml +++ b/reference/haru/harudoc/getcurrentencoder.xml @@ -1,5 +1,5 @@ - + HaruDoc::getCurrentEncoder @@ -12,6 +12,18 @@ objectHaruDoc::getCurrentEncoder + + Get the HaruEncoder currently used in the document. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns HaruEncoder currently used in the document or &false; if encoder is not set. diff --git a/reference/haru/harudoc/getcurrentpage.xml b/reference/haru/harudoc/getcurrentpage.xml index 57b7c22215..8a2d699c2a 100644 --- a/reference/haru/harudoc/getcurrentpage.xml +++ b/reference/haru/harudoc/getcurrentpage.xml @@ -1,5 +1,5 @@ - + HaruDoc::getCurrentPage @@ -14,6 +14,17 @@ Get current page of the document. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + Returns HaruPage instance on success or &false; if there is no current page at the moment. diff --git a/reference/haru/harudoc/getencoder.xml b/reference/haru/harudoc/getencoder.xml index 6089e71813..c3c503f40b 100644 --- a/reference/haru/harudoc/getencoder.xml +++ b/reference/haru/harudoc/getencoder.xml @@ -1,5 +1,5 @@ - + HaruDoc::getEncoder @@ -13,7 +13,7 @@ stringencoding - Returns HaruEncoder instance for the specified encoding. + Get the HaruEncoder instance for the specified encoding. @@ -33,6 +33,14 @@ + + + &reftitle.returnvalues; + + Returns a HaruEncoder instance for the specified encoding. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/getfont.xml b/reference/haru/harudoc/getfont.xml index 21a43ee9ed..e8f2987587 100644 --- a/reference/haru/harudoc/getfont.xml +++ b/reference/haru/harudoc/getfont.xml @@ -1,5 +1,5 @@ - + HaruDoc::getFont @@ -14,9 +14,7 @@ stringencoding - Creates and returns HaruFont instance with the - specified fontname and - encoding. + Get a HaruFont instance. @@ -46,13 +44,23 @@ The encoding to use. See Builtin - Encodings for the list of supported encodings. + Encodings for the list of supported encodings. + + + &reftitle.returnvalues; + + Returns a HaruFont instance with the + specified fontname and + encoding. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/getinfoattr.xml b/reference/haru/harudoc/getinfoattr.xml index e130642886..d936807a96 100644 --- a/reference/haru/harudoc/getinfoattr.xml +++ b/reference/haru/harudoc/getinfoattr.xml @@ -1,5 +1,5 @@ - + HaruDoc::getInfoAttr @@ -13,7 +13,7 @@ inttype - Returns the string value of the specified document attribute. + Get the current value of the specified document attribute. @@ -55,6 +55,14 @@ + + + &reftitle.returnvalues; + + Returns the string value of the specified document attribute. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/getpagelayout.xml b/reference/haru/harudoc/getpagelayout.xml index 540c7a0a67..276c1142c0 100644 --- a/reference/haru/harudoc/getpagelayout.xml +++ b/reference/haru/harudoc/getpagelayout.xml @@ -1,5 +1,5 @@ - + HaruDoc::getPageLayout @@ -12,6 +12,20 @@ intHaruDoc::getPageLayout + + Get the current page layout. + See HaruDoc::setPageLayout + for the list of possible values. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; 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. + &reftitle.errors; diff --git a/reference/haru/harudoc/getpagemode.xml b/reference/haru/harudoc/getpagemode.xml index f74f933f38..46e85d79fa 100644 --- a/reference/haru/harudoc/getpagemode.xml +++ b/reference/haru/harudoc/getpagemode.xml @@ -1,5 +1,5 @@ - + HaruDoc::getPageMode @@ -12,9 +12,23 @@ intHaruDoc::getPageMode + + Get the current page mode. + See HaruDoc::setPageMode + for the list of possible values. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the page mode currently set in the document. See HaruDoc::setPageMode + linkend="function.harudoc-setpagemode">HaruDoc::setPageMode for the list of possible values. diff --git a/reference/haru/harudoc/getstreamsize.xml b/reference/haru/harudoc/getstreamsize.xml index fd6ab58438..daa1fe249d 100644 --- a/reference/haru/harudoc/getstreamsize.xml +++ b/reference/haru/harudoc/getstreamsize.xml @@ -1,5 +1,5 @@ - + HaruDoc::getStreamSize @@ -12,6 +12,18 @@ intHaruDoc::getStreamSize + + Get the size of the temporary stream. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; 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. diff --git a/reference/haru/harudoc/insertpage.xml b/reference/haru/harudoc/insertpage.xml index 45bb5fa6f4..dcca890b57 100644 --- a/reference/haru/harudoc/insertpage.xml +++ b/reference/haru/harudoc/insertpage.xml @@ -1,5 +1,5 @@ - + HaruDoc::insertPage @@ -13,8 +13,7 @@ objectpage - Creates new page and inserts just before the specified page. - Returns new HaruPage instance. + Creates a new page and inserts just before the specified page. @@ -34,6 +33,13 @@ + + &reftitle.returnvalues; + + Returns a new HaruPage instance. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/loadjpeg.xml b/reference/haru/harudoc/loadjpeg.xml index 84ef460d87..749b285915 100644 --- a/reference/haru/harudoc/loadjpeg.xml +++ b/reference/haru/harudoc/loadjpeg.xml @@ -1,9 +1,9 @@ - + HaruDoc::loadJPEG - Load JPEG image and return new HaruImage instance + Load a JPEG image. @@ -13,8 +13,7 @@ stringfilename - Loads the specified JPEG image and returns new - HaruImage instance. + Loads the specified JPEG image. @@ -34,6 +33,13 @@ + + &reftitle.returnvalues; + + Returns a new HaruImage instance. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/loadpng.xml b/reference/haru/harudoc/loadpng.xml index dd2a9e134b..9282ed4713 100644 --- a/reference/haru/harudoc/loadpng.xml +++ b/reference/haru/harudoc/loadpng.xml @@ -1,5 +1,5 @@ - + HaruDoc::loadPNG @@ -14,10 +14,7 @@ booldeferred - Loads PNG image and returns HaruImage instance. - You can set deferred parameter to &true; for - deferred data loading, in this case only size and color are loaded - immediately. Default value of deferred is &false;. + Loads a PNG image. Libharu might be built without libpng support, in this case each call to @@ -42,6 +39,9 @@ Do not load data immediately. Defaults to &false;. + You can set deferred parameter to &true; for + deferred data loading, in this case only size and color are loaded + immediately. @@ -49,6 +49,13 @@ + + &reftitle.returnvalues; + + Returns a HaruImage instance. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/loadraw.xml b/reference/haru/harudoc/loadraw.xml index ece88f00f7..c8277716d2 100644 --- a/reference/haru/harudoc/loadraw.xml +++ b/reference/haru/harudoc/loadraw.xml @@ -1,9 +1,9 @@ - + HaruDoc::loadRaw - Load RAW image and return HaruImage instance + Load a RAW image @@ -16,7 +16,7 @@ intcolor_space - Loads RAW image and returns new HaruImage instance. + Loads a RAW image. @@ -71,6 +71,13 @@ + + &reftitle.returnvalues; + + Returns a HaruImage instance. + + + &reftitle.errors; diff --git a/reference/haru/harudoc/output.xml b/reference/haru/harudoc/output.xml index 297a5100e1..e94a609eb4 100644 --- a/reference/haru/harudoc/output.xml +++ b/reference/haru/harudoc/output.xml @@ -1,5 +1,5 @@ - + HaruDoc::output @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/readfromstream.xml b/reference/haru/harudoc/readfromstream.xml index 2e97631535..66199df3fe 100644 --- a/reference/haru/harudoc/readfromstream.xml +++ b/reference/haru/harudoc/readfromstream.xml @@ -1,5 +1,5 @@ - + HaruDoc::readFromStream @@ -13,9 +13,31 @@ intbytes - Returns data from the temporary stream. The bytes - parameter specifies how much bytes to read, though the stream may contain - less bytes than requested. + Read data from the temporary stream. + + + + + &reftitle.parameters; + + + + bytes + + + The bytes parameter specifies how many bytes + to read, though the stream may contain less bytes than requested. + + + + + + + + + &reftitle.returnvalues; + + Returns data from the temporary stream. diff --git a/reference/haru/harudoc/reseterror.xml b/reference/haru/harudoc/reseterror.xml index 2877783d84..a2fc147c26 100644 --- a/reference/haru/harudoc/reseterror.xml +++ b/reference/haru/harudoc/reseterror.xml @@ -1,5 +1,5 @@ - + HaruDoc::resetError @@ -20,10 +20,15 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; - Always succeedes and returns &true;. + Always succeeds and returns &true;. diff --git a/reference/haru/harudoc/resetstream.xml b/reference/haru/harudoc/resetstream.xml index df24e5e04d..50f8592cf5 100644 --- a/reference/haru/harudoc/resetstream.xml +++ b/reference/haru/harudoc/resetstream.xml @@ -1,5 +1,5 @@ - + HaruDoc::resetStream @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/savetostream.xml b/reference/haru/harudoc/savetostream.xml index 18c5216f85..90aae41440 100644 --- a/reference/haru/harudoc/savetostream.xml +++ b/reference/haru/harudoc/savetostream.xml @@ -1,5 +1,5 @@ - + HaruDoc::saveToStream @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usecnsencodings.xml b/reference/haru/harudoc/usecnsencodings.xml index 4029407932..0fd65481ba 100644 --- a/reference/haru/harudoc/usecnsencodings.xml +++ b/reference/haru/harudoc/usecnsencodings.xml @@ -1,5 +1,5 @@ - + HaruDoc::useCNSEncodings @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usecnsfonts.xml b/reference/haru/harudoc/usecnsfonts.xml index 02a5d7d832..17baf00cdf 100644 --- a/reference/haru/harudoc/usecnsfonts.xml +++ b/reference/haru/harudoc/usecnsfonts.xml @@ -1,5 +1,5 @@ - + HaruDoc::useCNSFonts @@ -13,10 +13,15 @@ - Enableis builtin Chinese simplified fonts. + Enables builtin Chinese simplified fonts. + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usecntencodings.xml b/reference/haru/harudoc/usecntencodings.xml index 4e239ae6cf..1bd4d887b1 100644 --- a/reference/haru/harudoc/usecntencodings.xml +++ b/reference/haru/harudoc/usecntencodings.xml @@ -1,5 +1,5 @@ - + HaruDoc::useCNTEncodings @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usecntfonts.xml b/reference/haru/harudoc/usecntfonts.xml index 991e6cdb3d..14f34fa3a7 100644 --- a/reference/haru/harudoc/usecntfonts.xml +++ b/reference/haru/harudoc/usecntfonts.xml @@ -1,5 +1,5 @@ - + HaruDoc::useCNTFonts @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usejpencodings.xml b/reference/haru/harudoc/usejpencodings.xml index a25b7c4eaa..d7adc7e8fa 100644 --- a/reference/haru/harudoc/usejpencodings.xml +++ b/reference/haru/harudoc/usejpencodings.xml @@ -1,5 +1,5 @@ - + HaruDoc::useJPEncodings @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usejpfonts.xml b/reference/haru/harudoc/usejpfonts.xml index c70b0db6ef..3097ecc009 100644 --- a/reference/haru/harudoc/usejpfonts.xml +++ b/reference/haru/harudoc/usejpfonts.xml @@ -1,5 +1,5 @@ - + HaruDoc::useJPFonts @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usekrencodings.xml b/reference/haru/harudoc/usekrencodings.xml index bc4502b5b2..11c3f16dcd 100644 --- a/reference/haru/harudoc/usekrencodings.xml +++ b/reference/haru/harudoc/usekrencodings.xml @@ -1,5 +1,5 @@ - + HaruDoc::useKREncodings @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harudoc/usekrfonts.xml b/reference/haru/harudoc/usekrfonts.xml index 4e3599bcbd..d0c054dd5a 100644 --- a/reference/haru/harudoc/usekrfonts.xml +++ b/reference/haru/harudoc/usekrfonts.xml @@ -1,5 +1,5 @@ - + HaruDoc::useKRFonts @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/haruencoder/getbytetype.xml b/reference/haru/haruencoder/getbytetype.xml index afc6047f19..21d49fc5e5 100644 --- a/reference/haru/haruencoder/getbytetype.xml +++ b/reference/haru/haruencoder/getbytetype.xml @@ -1,5 +1,5 @@ - + HaruEncoder::getByteType @@ -14,26 +14,7 @@ intindex - Returns the type of the byte in the text on the specified position. - The result is one of the following values: - - - HaruEncoder::BYTE_TYPE_SINGLE - single byte - character. - - - HaruEncoder::BYTE_TYPE_LEAD - lead byte of a - double-byte character. - - - HaruEncoder::BYTE_TYPE_TRAIL - trailing byte of a - double-byte character. - - - HaruEncoder::BYTE_TYPE_UNKNOWN - invalid encoder or - cannot detect the byte type. - - + Get the type of the byte in the text. @@ -60,6 +41,32 @@ + + + &reftitle.returnvalues; + + Returns the type of the byte in the text on the specified position. + The result is one of the following values: + + + HaruEncoder::BYTE_TYPE_SINGLE - single byte + character. + + + HaruEncoder::BYTE_TYPE_LEAD - lead byte of a + double-byte character. + + + HaruEncoder::BYTE_TYPE_TRAIL - trailing byte of a + double-byte character. + + + HaruEncoder::BYTE_TYPE_UNKNOWN - invalid encoder or + cannot detect the byte type. + + + + &reftitle.errors; diff --git a/reference/haru/haruencoder/gettype.xml b/reference/haru/haruencoder/gettype.xml index c8d780748e..c1674478e7 100644 --- a/reference/haru/haruencoder/gettype.xml +++ b/reference/haru/haruencoder/gettype.xml @@ -1,5 +1,5 @@ - + HaruEncoder::getType @@ -13,7 +13,19 @@ - Returns the type of the encoder. The result is one of the followin values: + Get the type of the encoder. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the type of the encoder. The result is one of the following values: HaruEncoder::TYPE_SINGLE_BYTE - the encoder is for single diff --git a/reference/haru/haruencoder/getunicode.xml b/reference/haru/haruencoder/getunicode.xml index d042dcc82f..e86c61fe4d 100644 --- a/reference/haru/haruencoder/getunicode.xml +++ b/reference/haru/haruencoder/getunicode.xml @@ -1,5 +1,5 @@ - + HaruEncoder::getUnicode @@ -33,6 +33,13 @@ + + &reftitle.returnvalues; + + + + + &reftitle.errors; diff --git a/reference/haru/haruencoder/getwritingmode.xml b/reference/haru/haruencoder/getwritingmode.xml index 1e70ffc843..efb4bdddd7 100644 --- a/reference/haru/haruencoder/getwritingmode.xml +++ b/reference/haru/haruencoder/getwritingmode.xml @@ -1,5 +1,5 @@ - + HaruEncoder::getWritingMode @@ -12,6 +12,18 @@ intHaruEncoder::getWritingMode + + Get the writing mode of the encoder. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the writing mode of the encoder. The result value is on of the following: diff --git a/reference/haru/harufont/getascent.xml b/reference/haru/harufont/getascent.xml index b556c47f63..211bf11ca0 100644 --- a/reference/haru/harufont/getascent.xml +++ b/reference/haru/harufont/getascent.xml @@ -1,5 +1,5 @@ - + HaruFont::getAscent @@ -12,6 +12,18 @@ intHaruFont::getAscent + + Get the vertical ascent of the font. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the vertical ascent of the font. diff --git a/reference/haru/harufont/getcapheight.xml b/reference/haru/harufont/getcapheight.xml index 8b81be00d4..ac7b22e936 100644 --- a/reference/haru/harufont/getcapheight.xml +++ b/reference/haru/harufont/getcapheight.xml @@ -1,5 +1,5 @@ - + HaruFont::getCapHeight @@ -12,6 +12,18 @@ intHaruFont::getCapHeight + + Get the distance from the baseline of uppercase letters. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the distance from the baseline of uppercase letters. diff --git a/reference/haru/harufont/getdescent.xml b/reference/haru/harufont/getdescent.xml index fa555f1404..db945f4b62 100644 --- a/reference/haru/harufont/getdescent.xml +++ b/reference/haru/harufont/getdescent.xml @@ -1,5 +1,5 @@ - + HaruFont::getDescent @@ -12,6 +12,18 @@ intHaruFont::getDescent + + Get the vertical descent of the font. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Return the vertical descent of the font. diff --git a/reference/haru/harufont/getencodingname.xml b/reference/haru/harufont/getencodingname.xml index 1267ebd7c5..a5432d50e3 100644 --- a/reference/haru/harufont/getencodingname.xml +++ b/reference/haru/harufont/getencodingname.xml @@ -1,5 +1,5 @@ - + HaruFont::getEncodingName @@ -12,6 +12,18 @@ stringHaruFont::getEncodingName + + Get the name of the font encoding. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the name of the font encoding. diff --git a/reference/haru/harufont/getfontname.xml b/reference/haru/harufont/getfontname.xml index 9487e9e597..e4205315a3 100644 --- a/reference/haru/harufont/getfontname.xml +++ b/reference/haru/harufont/getfontname.xml @@ -1,5 +1,5 @@ - + HaruFont::getFontName @@ -12,6 +12,18 @@ stringHaruFont::getFontName + + Get the name of the font. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the name of the font. diff --git a/reference/haru/harufont/gettextwidth.xml b/reference/haru/harufont/gettextwidth.xml index 109c082123..dd49078e07 100644 --- a/reference/haru/harufont/gettextwidth.xml +++ b/reference/haru/harufont/gettextwidth.xml @@ -1,5 +1,5 @@ - + HaruFont::getTextWidth @@ -13,8 +13,8 @@ stringtext - 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. @@ -34,6 +34,14 @@ + + &reftitle.returnvalues; + + Returns the total width of the text, number of characters, number of words + and number of spaces in the given text. + + + &reftitle.errors; diff --git a/reference/haru/harufont/getunicodewidth.xml b/reference/haru/harufont/getunicodewidth.xml index 210fcebc38..6e315ac9a8 100644 --- a/reference/haru/harufont/getunicodewidth.xml +++ b/reference/haru/harufont/getunicodewidth.xml @@ -1,5 +1,5 @@ - + HaruFont::getUnicodeWidth @@ -13,7 +13,7 @@ intcharacter - Returns the width of the character in the font. + Get the width of the character in the font. @@ -33,6 +33,13 @@ + + &reftitle.returnvalues; + + Returns the width of the character in the font. + + + &reftitle.errors; diff --git a/reference/haru/harufont/getxheight.xml b/reference/haru/harufont/getxheight.xml index 67081dd22b..b72729efb3 100644 --- a/reference/haru/harufont/getxheight.xml +++ b/reference/haru/harufont/getxheight.xml @@ -1,5 +1,5 @@ - + HaruFont::getXHeight @@ -12,6 +12,18 @@ intHaruFont::getXHeight + + Gets the distance from the baseline of lowercase letters. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the distance from the baseline of lowercase letters. diff --git a/reference/haru/harufont/measuretext.xml b/reference/haru/harufont/measuretext.xml index e8e74359ab..ed5367f1bd 100644 --- a/reference/haru/harufont/measuretext.xml +++ b/reference/haru/harufont/measuretext.xml @@ -1,5 +1,5 @@ - + HaruFont::measureText @@ -18,7 +18,7 @@ boolword_wrap - Returns the number of characters which can be included within the + Calculate the number of characters which can be included within the specified width. @@ -80,6 +80,15 @@ + + + &reftitle.returnvalues; + + Returns the number of characters which can be included within the + specified width. + + + &reftitle.errors; diff --git a/reference/haru/haruimage/getbitspercomponent.xml b/reference/haru/haruimage/getbitspercomponent.xml index 512273f699..da837049c4 100644 --- a/reference/haru/haruimage/getbitspercomponent.xml +++ b/reference/haru/haruimage/getbitspercomponent.xml @@ -1,5 +1,5 @@ - + HaruImage::getBitsPerComponent @@ -12,6 +12,19 @@ intHaruImage::getBitsPerComponent + + Gets the number of bits used to describe each color component of the + image. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the number of bits used to describe each color component of the image. diff --git a/reference/haru/haruimage/getcolorspace.xml b/reference/haru/haruimage/getcolorspace.xml index 548ab52aca..2b4e59ed98 100644 --- a/reference/haru/haruimage/getcolorspace.xml +++ b/reference/haru/haruimage/getcolorspace.xml @@ -1,5 +1,5 @@ - + HaruImage::getColorSpace @@ -12,6 +12,18 @@ stringHaruImage::getColorSpace + + Get the name of the color space. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the name of the color space of the image. The name is one of the following values: diff --git a/reference/haru/haruimage/getheight.xml b/reference/haru/haruimage/getheight.xml index f87257573a..2a251b8796 100644 --- a/reference/haru/haruimage/getheight.xml +++ b/reference/haru/haruimage/getheight.xml @@ -1,5 +1,5 @@ - + HaruImage::getHeight @@ -12,6 +12,18 @@ intHaruImage::getHeight + + Get the height of the image. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the height of the image. diff --git a/reference/haru/haruimage/getsize.xml b/reference/haru/haruimage/getsize.xml index be8a56107d..07fb4ecdee 100644 --- a/reference/haru/haruimage/getsize.xml +++ b/reference/haru/haruimage/getsize.xml @@ -1,5 +1,5 @@ - + HaruImage::getSize @@ -12,6 +12,18 @@ arrayHaruImage::getSize + + Get the size of the image. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns an array with two elements: width and height, which contain appropriate dimensions of the image. diff --git a/reference/haru/haruimage/getwidth.xml b/reference/haru/haruimage/getwidth.xml index 27c7e7c940..af81bec16a 100644 --- a/reference/haru/haruimage/getwidth.xml +++ b/reference/haru/haruimage/getwidth.xml @@ -1,5 +1,5 @@ - + HaruImage::getWidth @@ -12,6 +12,18 @@ intHaruImage::getWidth + + Get the width of the image. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the width of the image. diff --git a/reference/haru/harupage/begintext.xml b/reference/haru/harupage/begintext.xml index f0cb648461..c393a3fea8 100644 --- a/reference/haru/harupage/begintext.xml +++ b/reference/haru/harupage/begintext.xml @@ -1,5 +1,5 @@ - + HaruPage::beginText @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/closepath.xml b/reference/haru/harupage/closepath.xml index 9b345f8692..6764715039 100644 --- a/reference/haru/harupage/closepath.xml +++ b/reference/haru/harupage/closepath.xml @@ -1,5 +1,5 @@ - + HaruPage::closePath @@ -18,6 +18,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/concat.xml b/reference/haru/harupage/concat.xml index e9f0d8f6bd..582f2852b4 100644 --- a/reference/haru/harupage/concat.xml +++ b/reference/haru/harupage/concat.xml @@ -1,5 +1,5 @@ - + HaruPage::concat @@ -23,7 +23,7 @@ - &reftitle.parameters; @@ -79,7 +79,6 @@ - --> &reftitle.returnvalues; diff --git a/reference/haru/harupage/createdestination.xml b/reference/haru/harupage/createdestination.xml index 55eff83cdd..6ce84f047c 100644 --- a/reference/haru/harupage/createdestination.xml +++ b/reference/haru/harupage/createdestination.xml @@ -1,5 +1,5 @@ - + HaruPage::createDestination @@ -13,7 +13,19 @@ - Creates and returns new HaruDestination instance. + Create a new HaruDestination instance. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a new HaruDestination instance. diff --git a/reference/haru/harupage/createlinkannotation.xml b/reference/haru/harupage/createlinkannotation.xml index 9b1834777b..842be94207 100644 --- a/reference/haru/harupage/createlinkannotation.xml +++ b/reference/haru/harupage/createlinkannotation.xml @@ -1,5 +1,5 @@ - + HaruPage::createLinkAnnotation @@ -14,7 +14,7 @@ objectdestination - Creates and returns new HaruAnnotation instance. + Creates a new HaruAnnotation instance. @@ -42,6 +42,13 @@ + + &reftitle.returnvalues; + + Returns a new HaruAnnotation instance. + + + &reftitle.errors; diff --git a/reference/haru/harupage/createtextannotation.xml b/reference/haru/harupage/createtextannotation.xml index 42c7d1b12f..a902114d8e 100644 --- a/reference/haru/harupage/createtextannotation.xml +++ b/reference/haru/harupage/createtextannotation.xml @@ -1,5 +1,5 @@ - + HaruPage::createTextAnnotation @@ -15,7 +15,7 @@ objectencoder - Creates and returns new HaruAnnotation instance. + Creates a new HaruAnnotation instance. @@ -50,6 +50,13 @@ + + + &reftitle.returnvalues; + + Returns a new HaruAnnotation instance. + + &reftitle.errors; diff --git a/reference/haru/harupage/createurlannotation.xml b/reference/haru/harupage/createurlannotation.xml index 3be36e71fa..4932118b2d 100644 --- a/reference/haru/harupage/createurlannotation.xml +++ b/reference/haru/harupage/createurlannotation.xml @@ -1,5 +1,5 @@ - + HaruPage::createURLAnnotation @@ -14,7 +14,7 @@ stringurl - Creates and returns new HaruAnnotation instance. + Creates a new HaruAnnotation instance. @@ -41,7 +41,14 @@ - + + + &reftitle.returnvalues; + + Returns a new HaruAnnotation instance. + + + &reftitle.errors; diff --git a/reference/haru/harupage/curveto.xml b/reference/haru/harupage/curveto.xml index f06d61eaa7..e11f9fe9d4 100644 --- a/reference/haru/harupage/curveto.xml +++ b/reference/haru/harupage/curveto.xml @@ -1,5 +1,5 @@ - + HaruPage::curveTo @@ -24,6 +24,62 @@ + + &reftitle.parameters; + + + + x1 + + + A Bezier curve control point. + + + + + y1 + + + A Bezier curve control point. + + + + + x2 + + + A Bezier curve control point. + + + + + y2 + + + A Bezier curve control point. + + + + + x3 + + + The current point moves here. + + + + + x3 + + + The current point moves here. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/curveto2.xml b/reference/haru/harupage/curveto2.xml index b87e7349c4..5564f908a3 100644 --- a/reference/haru/harupage/curveto2.xml +++ b/reference/haru/harupage/curveto2.xml @@ -1,5 +1,5 @@ - + HaruPage::curveTo2 @@ -22,6 +22,46 @@ + + &reftitle.parameters; + + + + x2 + + + A Bezier curve control point. + + + + + y2 + + + A Bezier curve control point. + + + + + x3 + + + The current point moves here. + + + + + x3 + + + The current point moves here. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/curveto3.xml b/reference/haru/harupage/curveto3.xml index 28e81351b8..fa81e781f0 100644 --- a/reference/haru/harupage/curveto3.xml +++ b/reference/haru/harupage/curveto3.xml @@ -1,5 +1,5 @@ - + HaruPage::curveTo3 @@ -22,6 +22,46 @@ + + &reftitle.parameters; + + + + x1 + + + A Bezier curve control point. + + + + + y1 + + + A Bezier curve control point. + + + + + x3 + + + The current point moves here. + + + + + x3 + + + The current point moves here. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/endpath.xml b/reference/haru/harupage/endpath.xml index 99d85c8572..016ab9984f 100644 --- a/reference/haru/harupage/endpath.xml +++ b/reference/haru/harupage/endpath.xml @@ -1,5 +1,5 @@ - + HaruPage::endPath @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/endtext.xml b/reference/haru/harupage/endtext.xml index fa91b03818..ead2e03aec 100644 --- a/reference/haru/harupage/endtext.xml +++ b/reference/haru/harupage/endtext.xml @@ -1,5 +1,5 @@ - + HaruPage::endText @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/eofill.xml b/reference/haru/harupage/eofill.xml index d17d7355c4..969cf3217b 100644 --- a/reference/haru/harupage/eofill.xml +++ b/reference/haru/harupage/eofill.xml @@ -1,5 +1,5 @@ - + HaruPage::eofill @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/fill.xml b/reference/haru/harupage/fill.xml index 054f473515..ddadd9185e 100644 --- a/reference/haru/harupage/fill.xml +++ b/reference/haru/harupage/fill.xml @@ -1,5 +1,5 @@ - + HaruPage::fill @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/getcharspace.xml b/reference/haru/harupage/getcharspace.xml index 2ed3fd016d..c995d8cb9d 100644 --- a/reference/haru/harupage/getcharspace.xml +++ b/reference/haru/harupage/getcharspace.xml @@ -1,5 +1,5 @@ - + HaruPage::getCharSpace @@ -12,6 +12,18 @@ floatHaruPage::getCharSpace + + Get the current value of character spacing. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current value of character spacing. diff --git a/reference/haru/harupage/getcmykfill.xml b/reference/haru/harupage/getcmykfill.xml index 89a92d4a75..38fbe0d760 100644 --- a/reference/haru/harupage/getcmykfill.xml +++ b/reference/haru/harupage/getcmykfill.xml @@ -1,5 +1,5 @@ - + HaruPage::getCMYKFill @@ -12,6 +12,18 @@ arrayHaruPage::getCMYKFill + + Returns the current filling color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current filling color as an array with 4 elements ("c", "m", "y" and "k"). diff --git a/reference/haru/harupage/getcmykstroke.xml b/reference/haru/harupage/getcmykstroke.xml index f0295245fc..456a291e16 100644 --- a/reference/haru/harupage/getcmykstroke.xml +++ b/reference/haru/harupage/getcmykstroke.xml @@ -1,5 +1,5 @@ - + HaruPage::getCMYKStroke @@ -12,6 +12,18 @@ arrayHaruPage::getCMYKStroke + + Get the current stroking color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current stroking color as an array with 4 elements ("c", "m", "y" and "k"). diff --git a/reference/haru/harupage/getcurrentfont.xml b/reference/haru/harupage/getcurrentfont.xml index d0ad56a3d7..b94f25c452 100644 --- a/reference/haru/harupage/getcurrentfont.xml +++ b/reference/haru/harupage/getcurrentfont.xml @@ -1,5 +1,5 @@ - + HaruPage::getCurrentFont @@ -13,7 +13,19 @@ - Returns the currently used font as an instance of HaruFont. + Get the currently used font. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the currently used font as an instance of HaruFont. diff --git a/reference/haru/harupage/getcurrentfontsize.xml b/reference/haru/harupage/getcurrentfontsize.xml index a2f488f785..38e09b62df 100644 --- a/reference/haru/harupage/getcurrentfontsize.xml +++ b/reference/haru/harupage/getcurrentfontsize.xml @@ -1,5 +1,5 @@ - + HaruPage::getCurrentFontSize @@ -12,6 +12,18 @@ floatHaruPage::getCurrentFontSize + + Get the current font size. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current font size. diff --git a/reference/haru/harupage/getcurrentpos.xml b/reference/haru/harupage/getcurrentpos.xml index a912670a08..0417d710df 100644 --- a/reference/haru/harupage/getcurrentpos.xml +++ b/reference/haru/harupage/getcurrentpos.xml @@ -1,5 +1,5 @@ - + HaruPage::getCurrentPos @@ -12,6 +12,18 @@ arrayHaruPage::getCurrentPos + + Get the current position for path painting. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current position for path painting as an array of with two elements - "x" and "y". diff --git a/reference/haru/harupage/getcurrenttextpos.xml b/reference/haru/harupage/getcurrenttextpos.xml index b60875e7cc..ad0548b247 100644 --- a/reference/haru/harupage/getcurrenttextpos.xml +++ b/reference/haru/harupage/getcurrenttextpos.xml @@ -1,5 +1,5 @@ - + HaruPage::getCurrentTextPos @@ -12,6 +12,18 @@ arrayHaruPage::getCurrentTextPos + + Get the current position for text printing. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current position for text printing as an array with 2 elements - "x" and "y". diff --git a/reference/haru/harupage/getdash.xml b/reference/haru/harupage/getdash.xml index eb3848f01a..b1f32896b3 100644 --- a/reference/haru/harupage/getdash.xml +++ b/reference/haru/harupage/getdash.xml @@ -1,5 +1,5 @@ - + HaruPage::getDash @@ -13,13 +13,25 @@ - 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 HaruPage::setDash for more information on dash patterns. + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the current dash pattern as an array of two elements - "pattern" + and "phase" or &false; if dash pattern was not set. + + + &reftitle.errors; diff --git a/reference/haru/harupage/getfillingcolorspace.xml b/reference/haru/harupage/getfillingcolorspace.xml index d84b03f6b0..956e5b56fc 100644 --- a/reference/haru/harupage/getfillingcolorspace.xml +++ b/reference/haru/harupage/getfillingcolorspace.xml @@ -1,5 +1,5 @@ - + HaruPage::getFillingColorSpace @@ -12,6 +12,18 @@ intHaruPage::getFillingColorSpace + + Get the current filling color space. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current filling color space. The result value is one of the following: diff --git a/reference/haru/harupage/getflatness.xml b/reference/haru/harupage/getflatness.xml index 4b547bf7ba..9ddfcddc43 100644 --- a/reference/haru/harupage/getflatness.xml +++ b/reference/haru/harupage/getflatness.xml @@ -1,5 +1,5 @@ - + HaruPage::getFlatness @@ -12,6 +12,18 @@ floatHaruPage::getFlatness + + Get the flatness of the page. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the flatness of the page. diff --git a/reference/haru/harupage/getgmode.xml b/reference/haru/harupage/getgmode.xml index 0b9585d99c..20d53a3bb8 100644 --- a/reference/haru/harupage/getgmode.xml +++ b/reference/haru/harupage/getgmode.xml @@ -1,5 +1,5 @@ - + HaruPage::getGMode @@ -12,8 +12,22 @@ intHaruPage::getGMode + + Get the current graphics mode. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current graphics mode. The result value is one of the following: + + HaruPage::GMODE_PAGE_DESCRIPTION diff --git a/reference/haru/harupage/getgrayfill.xml b/reference/haru/harupage/getgrayfill.xml index ef5c8bbcaf..9d32f3e709 100644 --- a/reference/haru/harupage/getgrayfill.xml +++ b/reference/haru/harupage/getgrayfill.xml @@ -1,5 +1,5 @@ - + HaruPage::getGrayFill @@ -12,6 +12,18 @@ floatHaruPage::getGrayFill + + Get the current filling color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current filling color. diff --git a/reference/haru/harupage/getgraystroke.xml b/reference/haru/harupage/getgraystroke.xml index 47d265df83..183f3e0a2a 100644 --- a/reference/haru/harupage/getgraystroke.xml +++ b/reference/haru/harupage/getgraystroke.xml @@ -1,5 +1,5 @@ - + HaruPage::getGrayStroke @@ -12,6 +12,18 @@ floatHaruPage::getGrayStroke + + Get the current stroking color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current stroking color. diff --git a/reference/haru/harupage/getheight.xml b/reference/haru/harupage/getheight.xml index b78ad42c04..6a0f7b5fda 100644 --- a/reference/haru/harupage/getheight.xml +++ b/reference/haru/harupage/getheight.xml @@ -1,5 +1,5 @@ - + HaruPage::getHeight @@ -12,6 +12,18 @@ floatHaruPage::getHeight + + Get the height of the page. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the height of the page. diff --git a/reference/haru/harupage/gethorizontalscaling.xml b/reference/haru/harupage/gethorizontalscaling.xml index 26a0ae5b35..4f9eade545 100644 --- a/reference/haru/harupage/gethorizontalscaling.xml +++ b/reference/haru/harupage/gethorizontalscaling.xml @@ -1,5 +1,5 @@ - + HaruPage::getHorizontalScaling @@ -12,6 +12,18 @@ floatHaruPage::getHorizontalScaling + + Get the current value of the horizontal scaling. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current value of horizontal scaling. diff --git a/reference/haru/harupage/getlinecap.xml b/reference/haru/harupage/getlinecap.xml index 5807397484..843064ea5e 100644 --- a/reference/haru/harupage/getlinecap.xml +++ b/reference/haru/harupage/getlinecap.xml @@ -1,5 +1,5 @@ - + HaruPage::getLineCap @@ -12,6 +12,18 @@ intHaruPage::getLineCap + + Get the current line cap style. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current line cap style. The result value is one of the following: diff --git a/reference/haru/harupage/getlinejoin.xml b/reference/haru/harupage/getlinejoin.xml index 735e04152d..3ca70deafd 100644 --- a/reference/haru/harupage/getlinejoin.xml +++ b/reference/haru/harupage/getlinejoin.xml @@ -1,5 +1,5 @@ - + HaruPage::getLineJoin @@ -12,6 +12,18 @@ intHaruPage::getLineJoin + + Get the current line join style. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current line join style. The result value is one of the following: diff --git a/reference/haru/harupage/getlinewidth.xml b/reference/haru/harupage/getlinewidth.xml index 5b93937a25..c73f50f22d 100644 --- a/reference/haru/harupage/getlinewidth.xml +++ b/reference/haru/harupage/getlinewidth.xml @@ -1,5 +1,5 @@ - + HaruPage::getLineWidth @@ -12,6 +12,18 @@ floatHaruPage::getLineWidth + + Get the current line width. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current line width. diff --git a/reference/haru/harupage/getmiterlimit.xml b/reference/haru/harupage/getmiterlimit.xml index 6539a4334b..bc11f6ed21 100644 --- a/reference/haru/harupage/getmiterlimit.xml +++ b/reference/haru/harupage/getmiterlimit.xml @@ -1,5 +1,5 @@ - + HaruPage::getMiterLimit @@ -13,7 +13,19 @@ - Returns the value of miter limit. + Get the value of the miter limit. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the value of the miter limit. diff --git a/reference/haru/harupage/getrgbfill.xml b/reference/haru/harupage/getrgbfill.xml index aaf2659c0f..ea3e8d4f12 100644 --- a/reference/haru/harupage/getrgbfill.xml +++ b/reference/haru/harupage/getrgbfill.xml @@ -1,5 +1,5 @@ - + HaruPage::getRGBFill @@ -12,6 +12,18 @@ arrayHaruPage::getRGBFill + + Get the current filling color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current filling color as an array with 3 elements: "r", "g" and "b". diff --git a/reference/haru/harupage/getrgbstroke.xml b/reference/haru/harupage/getrgbstroke.xml index c96d3fe491..2be2ee32dd 100644 --- a/reference/haru/harupage/getrgbstroke.xml +++ b/reference/haru/harupage/getrgbstroke.xml @@ -1,5 +1,5 @@ - + HaruPage::getRGBStroke @@ -12,6 +12,18 @@ arrayHaruPage::getRGBStroke + + Get the current stroking color. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current stroking color. diff --git a/reference/haru/harupage/getstrokingcolorspace.xml b/reference/haru/harupage/getstrokingcolorspace.xml index 4ce023ff6c..77a26ecc3a 100644 --- a/reference/haru/harupage/getstrokingcolorspace.xml +++ b/reference/haru/harupage/getstrokingcolorspace.xml @@ -1,5 +1,5 @@ - + HaruPage::getStrokingColorSpace @@ -12,6 +12,18 @@ intHaruPage::getStrokingColorSpace + + Get the current stroking color space. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current stroking color space. The list of return values is the same as for HaruPage::getFillingColorSpace. diff --git a/reference/haru/harupage/gettextleading.xml b/reference/haru/harupage/gettextleading.xml index 125647446c..e13a5f0e63 100644 --- a/reference/haru/harupage/gettextleading.xml +++ b/reference/haru/harupage/gettextleading.xml @@ -1,5 +1,5 @@ - + HaruPage::getTextLeading @@ -12,6 +12,18 @@ floatHaruPage::getTextLeading + + Get the current value of line spacing. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current value of line spacing. diff --git a/reference/haru/harupage/gettextmatrix.xml b/reference/haru/harupage/gettextmatrix.xml index 3f965cc3d8..2221b331b7 100644 --- a/reference/haru/harupage/gettextmatrix.xml +++ b/reference/haru/harupage/gettextmatrix.xml @@ -1,5 +1,5 @@ - + HaruPage::getTextMatrix @@ -12,6 +12,13 @@ arrayHaruPage::getTextMatrix + + Get the current text transformation matrix of the page. + + + + + &reftitle.returnvalues; Returns the current text transformation matrix of the page as an array of 6 elements: "a", "b", "c", "d", "x" and "y". diff --git a/reference/haru/harupage/gettextrenderingmode.xml b/reference/haru/harupage/gettextrenderingmode.xml index 7fb18845ee..6f568c3e90 100644 --- a/reference/haru/harupage/gettextrenderingmode.xml +++ b/reference/haru/harupage/gettextrenderingmode.xml @@ -1,5 +1,5 @@ - + HaruPage::getTextRenderingMode @@ -12,6 +12,18 @@ intHaruPage::getTextRenderingMode + + Get the current text rendering mode. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current text rendering mode. The result value is one of the following: diff --git a/reference/haru/harupage/gettextrise.xml b/reference/haru/harupage/gettextrise.xml index 2a5f77da34..d3764c488b 100644 --- a/reference/haru/harupage/gettextrise.xml +++ b/reference/haru/harupage/gettextrise.xml @@ -1,5 +1,5 @@ - + HaruPage::getTextRise @@ -12,6 +12,18 @@ floatHaruPage::getTextRise + + Get the current value of text rising. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current value of text rising. diff --git a/reference/haru/harupage/gettextwidth.xml b/reference/haru/harupage/gettextwidth.xml index 0f9e142bf5..bcb36550ff 100644 --- a/reference/haru/harupage/gettextwidth.xml +++ b/reference/haru/harupage/gettextwidth.xml @@ -1,5 +1,5 @@ - + HaruPage::getTextWidth @@ -13,7 +13,7 @@ stringtext - 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 @@ -33,6 +33,13 @@ + + &reftitle.returnvalues; + + Returns the width of the text using current fontsize, character spacing and word spacing. + + + &reftitle.errors; diff --git a/reference/haru/harupage/gettransmatrix.xml b/reference/haru/harupage/gettransmatrix.xml index 5ab46b7b81..fbd8215c8e 100644 --- a/reference/haru/harupage/gettransmatrix.xml +++ b/reference/haru/harupage/gettransmatrix.xml @@ -1,5 +1,5 @@ - + HaruPage::getTransMatrix @@ -12,6 +12,18 @@ arrayHaruPage::getTransMatrix + + Get the current transformation matrix of the page. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current transformation matrix of the page as an array of 6 elements: "a", "b", "c", "d", "x" and "y". diff --git a/reference/haru/harupage/getwidth.xml b/reference/haru/harupage/getwidth.xml index b84b433587..dc7d2a8343 100644 --- a/reference/haru/harupage/getwidth.xml +++ b/reference/haru/harupage/getwidth.xml @@ -1,5 +1,5 @@ - + HaruPage::getWidth @@ -12,6 +12,18 @@ floatHaruPage::getWidth + + Get the width of the page. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the width of the page. diff --git a/reference/haru/harupage/getwordspace.xml b/reference/haru/harupage/getwordspace.xml index 80c880fcbc..36ea748d77 100644 --- a/reference/haru/harupage/getwordspace.xml +++ b/reference/haru/harupage/getwordspace.xml @@ -1,5 +1,5 @@ - + HaruPage::getWordSpace @@ -12,6 +12,18 @@ floatHaruPage::getWordSpace + + Get the current value of word spacing. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; Returns the current value of word spacing. diff --git a/reference/haru/harupage/measuretext.xml b/reference/haru/harupage/measuretext.xml index da0e76c4a9..4cd92638fa 100644 --- a/reference/haru/harupage/measuretext.xml +++ b/reference/haru/harupage/measuretext.xml @@ -1,5 +1,5 @@ - + HaruPage::measureText @@ -15,7 +15,7 @@ boolwordwrap - 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. @@ -53,6 +53,13 @@ + + &reftitle.returnvalues; + + Returns the number of characters which can be included within the specified width. + + + &reftitle.errors; diff --git a/reference/haru/harupage/movetextpos.xml b/reference/haru/harupage/movetextpos.xml index e1e77e6cf2..c5ad67541a 100644 --- a/reference/haru/harupage/movetextpos.xml +++ b/reference/haru/harupage/movetextpos.xml @@ -1,5 +1,5 @@ - + HaruPage::moveTextPos @@ -17,9 +17,40 @@ 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 + x, - y1 + y). If optional parameter set_leading - is &true;, the function sets the text leading to -y. The default - value of set_leading is &false;. + y1 + y). + + + + + &reftitle.parameters; + + + + x + + + The specified text position offset. + + + + + y + + + The specified text position offset. + + + + + set_leading + + + If set to &true;, the function sets the text leading to -y. + The default value of set_leading is &false;. + + + + diff --git a/reference/haru/harupage/moveto.xml b/reference/haru/harupage/moveto.xml index 4734e75a66..3fea84e381 100644 --- a/reference/haru/harupage/moveto.xml +++ b/reference/haru/harupage/moveto.xml @@ -1,5 +1,5 @@ - + HaruPage::moveTo @@ -18,7 +18,6 @@ - &reftitle.returnvalues; diff --git a/reference/haru/harupage/movetonextline.xml b/reference/haru/harupage/movetonextline.xml index da3a162c29..6f0ad4f316 100644 --- a/reference/haru/harupage/movetonextline.xml +++ b/reference/haru/harupage/movetonextline.xml @@ -1,5 +1,5 @@ - + HaruPage::moveToNextLine @@ -17,6 +17,11 @@ + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/setcharspace.xml b/reference/haru/harupage/setcharspace.xml index 271bb63490..50edf9d381 100644 --- a/reference/haru/harupage/setcharspace.xml +++ b/reference/haru/harupage/setcharspace.xml @@ -1,5 +1,5 @@ - + HaruPage::setCharSpace @@ -17,6 +17,22 @@ + + &reftitle.parameters; + + + + char_space + + + The new character spacing for the page. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/setflatness.xml b/reference/haru/harupage/setflatness.xml index 0cc63e5002..75bea6fee1 100644 --- a/reference/haru/harupage/setflatness.xml +++ b/reference/haru/harupage/setflatness.xml @@ -1,5 +1,5 @@ - + HaruPage::setFlatness @@ -17,6 +17,22 @@ + + &reftitle.parameters; + + + + flatness + + + The defined flatness for the page. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/setheight.xml b/reference/haru/harupage/setheight.xml index fde7f81d61..39619ce737 100644 --- a/reference/haru/harupage/setheight.xml +++ b/reference/haru/harupage/setheight.xml @@ -1,5 +1,5 @@ - + HaruPage::setHeight @@ -17,6 +17,22 @@ + + &reftitle.parameters; + + + + height + + + The defined height for the page. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/sethorizontalscaling.xml b/reference/haru/harupage/sethorizontalscaling.xml index bc80031059..fc9e111994 100644 --- a/reference/haru/harupage/sethorizontalscaling.xml +++ b/reference/haru/harupage/sethorizontalscaling.xml @@ -1,5 +1,5 @@ - + HaruPage::setHorizontalScaling @@ -13,8 +13,24 @@ floatscaling - Defines horizontal scaling for text showing on the page. The initial value - is 100. + Set the horizontal scaling for the page. + + + + + &reftitle.parameters; + + + + scaling + + + The horizontal scaling for text showing on the page. + The initial value is 100. + + + + diff --git a/reference/haru/harupage/setlinewidth.xml b/reference/haru/harupage/setlinewidth.xml index e312e6e293..f4255254ea 100644 --- a/reference/haru/harupage/setlinewidth.xml +++ b/reference/haru/harupage/setlinewidth.xml @@ -1,5 +1,5 @@ - + HaruPage::setLineWidth @@ -17,6 +17,22 @@ + + &reftitle.parameters; + + + + width + + + The defined line width for the page. + + + + + + + &reftitle.returnvalues; diff --git a/reference/haru/harupage/setmiterlimit.xml b/reference/haru/harupage/setmiterlimit.xml index f7bccb7a55..ed35998d29 100644 --- a/reference/haru/harupage/setmiterlimit.xml +++ b/reference/haru/harupage/setmiterlimit.xml @@ -1,5 +1,5 @@ - + HaruPage::setMiterLimit @@ -13,7 +13,23 @@ floatlimit - Defines the current value of the miter limit of the page. + Set the current value of the miter limit of the page. + + + + + &reftitle.parameters; + + + + limit + + + Defines the current value of the miter limit of the page. + + + + diff --git a/reference/haru/harupage/settextleading.xml b/reference/haru/harupage/settextleading.xml index 260a621ebc..45ece4a62f 100644 --- a/reference/haru/harupage/settextleading.xml +++ b/reference/haru/harupage/settextleading.xml @@ -1,5 +1,5 @@ - + HaruPage::setTextLeading @@ -13,7 +13,23 @@ floattext_leading - Defines line spacing for the page. + Set the text leading (line spacing) for the page. + + + + + &reftitle.parameters; + + + + text_leading + + + Defines line spacing for the page. + + + + diff --git a/reference/haru/harupage/settextrise.xml b/reference/haru/harupage/settextrise.xml index cadb7ea339..a187aa43f6 100644 --- a/reference/haru/harupage/settextrise.xml +++ b/reference/haru/harupage/settextrise.xml @@ -1,5 +1,5 @@ - + HaruPage::setTextRise @@ -13,11 +13,10 @@ floatrise - Defines the current value of text rising. + Set the current value of text rising. - &reftitle.returnvalues; diff --git a/reference/haru/harupage/setwidth.xml b/reference/haru/harupage/setwidth.xml index d4201dbf36..0328ee03c5 100644 --- a/reference/haru/harupage/setwidth.xml +++ b/reference/haru/harupage/setwidth.xml @@ -1,5 +1,5 @@ - + HaruPage::setWidth @@ -13,7 +13,23 @@ floatwidth - Defines width of the page. + Set the width of the page. + + + + + &reftitle.parameters; + + + + width + + + Defines width of the page. + + + + diff --git a/reference/haru/harupage/setwordspace.xml b/reference/haru/harupage/setwordspace.xml index c8cf3bd7c0..636ea004d4 100644 --- a/reference/haru/harupage/setwordspace.xml +++ b/reference/haru/harupage/setwordspace.xml @@ -1,5 +1,5 @@ - + HaruPage::setWordSpace @@ -13,7 +13,23 @@ floatword_space - Defines word spacing for the page. + Set the word spacing for the page. + + + + + &reftitle.parameters; + + + + word_space + + + Defines word spacing for the page. + + + + diff --git a/reference/haru/harupage/textout.xml b/reference/haru/harupage/textout.xml index 357595b276..144f717c61 100644 --- a/reference/haru/harupage/textout.xml +++ b/reference/haru/harupage/textout.xml @@ -1,5 +1,5 @@ - + HaruPage::textOut @@ -19,7 +19,7 @@ - &reftitle.parameters; @@ -51,7 +51,6 @@ - --> &reftitle.returnvalues;