mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
2c21f12e07
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321707 c90b9560-bf6c-de11-be94-00142212c4b1
407 lines
14 KiB
XML
407 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<phpdoc:classref xml:id="class.cairostatus" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<title>The CairoStatus class</title>
|
|
<titleabbrev>CairoStatus</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ CairoStatus intro -->
|
|
<section xml:id="cairostatus.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
<classname>CairoStatus</classname> is used to indicate errors that can occur when using Cairo.
|
|
In some cases it is returned directly by functions. but when using <classname>CairoContext</classname>,
|
|
the last error, if any, is stored in the object and can be retrieved with <methodname>CairoContext::status</methodname>
|
|
or <function>cairo_status</function>. New entries may be added in future versions.
|
|
</para>
|
|
<para>Use <methodname>Cairo::statusToString</methodname> or <function>cairo_status_to_string</function> to get a
|
|
human-readable representation of an error message.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="cairostatus.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass><classname>CairoStatus</classname></ooclass>
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<classname>CairoStatus</classname>
|
|
</ooclass>
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.success">CairoStatus::SUCCESS</varname>
|
|
<initializer>0</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.no-memory">CairoStatus::NO_MEMORY</varname>
|
|
<initializer>1</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-restore">CairoStatus::INVALID_RESTORE</varname>
|
|
<initializer>2</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-pop-group">CairoStatus::INVALID_POP_GROUP</varname>
|
|
<initializer>3</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.no-current-point">CairoStatus::NO_CURRENT_POINT</varname>
|
|
<initializer>4</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-matrix">CairoStatus::INVALID_MATRIX</varname>
|
|
<initializer>5</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-status">CairoStatus::INVALID_STATUS</varname>
|
|
<initializer>6</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.null-pointer">CairoStatus::NULL_POINTER</varname>
|
|
<initializer>7</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-string">CairoStatus::INVALID_STRING</varname>
|
|
<initializer>8</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-path-data">CairoStatus::INVALID_PATH_DATA</varname>
|
|
<initializer>9</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.read-error">CairoStatus::READ_ERROR</varname>
|
|
<initializer>10</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.write-error">CairoStatus::WRITE_ERROR</varname>
|
|
<initializer>11</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.surface-finished">CairoStatus::SURFACE_FINISHED</varname>
|
|
<initializer>12</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.surface-type-mismatch">CairoStatus::SURFACE_TYPE_MISMATCH</varname>
|
|
<initializer>13</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.pattern-type-mismatch">CairoStatus::PATTERN_TYPE_MISMATCH</varname>
|
|
<initializer>14</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-content">CairoStatus::INVALID_CONTENT</varname>
|
|
<initializer>15</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-format">CairoStatus::INVALID_FORMAT</varname>
|
|
<initializer>16</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-visual">CairoStatus::INVALID_VISUAL</varname>
|
|
<initializer>17</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.file-not-found">CairoStatus::FILE_NOT_FOUND</varname>
|
|
<initializer>18</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-dash">CairoStatus::INVALID_DASH</varname>
|
|
<initializer>19</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-dsc-comment">CairoStatus::INVALID_DSC_COMMENT</varname>
|
|
<initializer>20</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-index">CairoStatus::INVALID_INDEX</varname>
|
|
<initializer>21</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.clip-not-representable">CairoStatus::CLIP_NOT_REPRESENTABLE</varname>
|
|
<initializer>22</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.temp-file-error">CairoStatus::TEMP_FILE_ERROR</varname>
|
|
<initializer>23</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="cairostatus.constants.invalid-stride">CairoStatus::INVALID_STRIDE</varname>
|
|
<initializer>24</initializer>
|
|
</fieldsynopsis>
|
|
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
<!-- {{{ CairoStatus constants -->
|
|
<section xml:id="cairostatus.constants">
|
|
&reftitle.constants;
|
|
<variablelist>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.success">
|
|
<term><constant>CairoStatus::SUCCESS</constant></term>
|
|
<listitem>
|
|
<para>No error has occurred </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.no-memory">
|
|
<term><constant>CairoStatus::NO_MEMORY</constant></term>
|
|
<listitem>
|
|
<para>Out of memory</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-restore">
|
|
<term><constant>CairoStatus::INVALID_RESTORE</constant></term>
|
|
<listitem>
|
|
<para><function>cairo_restore</function> called without matching <function>cairo_save</function></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-pop-group">
|
|
<term><constant>CairoStatus::INVALID_POP_GROUP</constant></term>
|
|
<listitem>
|
|
<para>No saved group to pop </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.no-current-point">
|
|
<term><constant>CairoStatus::NO_CURRENT_POINT</constant></term>
|
|
<listitem>
|
|
<para>No current point defined </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-matrix">
|
|
<term><constant>CairoStatus::INVALID_MATRIX</constant></term>
|
|
<listitem>
|
|
<para>Invalid matrix (not invertible) </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-status">
|
|
<term><constant>CairoStatus::INVALID_STATUS</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for an input CairoStatus></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.null-pointer">
|
|
<term><constant>CairoStatus::NULL_POINTER</constant></term>
|
|
<listitem>
|
|
<para>Null pointer</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-string">
|
|
<term><constant>CairoStatus::INVALID_STRING</constant></term>
|
|
<listitem>
|
|
<para>Input string not valid UTF-8 string</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-path-data">
|
|
<term><constant>CairoStatus::INVALID_PATH_DATA</constant></term>
|
|
<listitem>
|
|
<para>Input path data not valid </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.read-error">
|
|
<term><constant>CairoStatus::READ_ERROR</constant></term>
|
|
<listitem>
|
|
<para>Error while reading from input stream </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.write-error">
|
|
<term><constant>CairoStatus::WRITE_ERROR</constant></term>
|
|
<listitem>
|
|
<para>Error while writing to output stream </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.surface-finished">
|
|
<term><constant>CairoStatus::SURFACE_FINISHED</constant></term>
|
|
<listitem>
|
|
<para>Target surface has been finished</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.surface-type-mismatch">
|
|
<term><constant>CairoStatus::SURFACE_TYPE_MISMATCH</constant></term>
|
|
<listitem>
|
|
<para>The surface type is not appropriate for the operation </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.pattern-type-mismatch">
|
|
<term><constant>CairoStatus::PATTERN_TYPE_MISMATCH</constant></term>
|
|
<listitem>
|
|
<para>The pattern type is not appropriate for the operation </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-content">
|
|
<term><constant>CairoStatus::INVALID_CONTENT</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for an input <classname>CairoContent</classname></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-format">
|
|
<term><constant>CairoStatus::INVALID_FORMAT</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for an input <classname>CairoFormat</classname></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-visual">
|
|
<term><constant>CairoStatus::INVALID_VISUAL</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for an input Visual</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.file-not-found">
|
|
<term><constant>CairoStatus::FILE_NOT_FOUND</constant></term>
|
|
<listitem>
|
|
<para>File not found</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-dash">
|
|
<term><constant>CairoStatus::INVALID_DASH</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for a dash setting </para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-dsc-comment">
|
|
<term><constant>CairoStatus::INVALID_DSC_COMMENT</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for a DSC comment</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-index">
|
|
<term><constant>CairoStatus::INVALID_INDEX</constant></term>
|
|
<listitem>
|
|
<para>Invalid index passed to getter</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.clip-not-representable">
|
|
<term><constant>CairoStatus::CLIP_NOT_REPRESENTABLE</constant></term>
|
|
<listitem>
|
|
<para>Clip region not representable in desired format</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.temp-file-error">
|
|
<term><constant>CairoStatus::TEMP_FILE_ERROR</constant></term>
|
|
<listitem>
|
|
<para>Error creating or writing to a temporary file</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry xml:id="cairostatus.constants.invalid-stride">
|
|
<term><constant>CairoStatus::INVALID_STRIDE</constant></term>
|
|
<listitem>
|
|
<para>Invalid value for <classname>CairoStride</classname></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
|
|
</partintro>
|
|
|
|
|
|
|
|
</phpdoc:classref>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|