ui.draw.color.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.ui-draw-color" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>Color Representation</title>
 <titleabbrev>UI\Draw\Color</titleabbrev>

 <partintro>

<!-- {{{ UI\Draw\Color intro -->
  <section xml:id="ui-draw-color.intro">
   &reftitle.intro;
   <para>
    Represents RGBA colours, individual channels are accessible via public properties.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="ui-draw-color.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>UI\Draw\Color</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>UI\Draw\Color</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-draw-color.constants.red">UI\Draw\Color::Red</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-draw-color.constants.green">UI\Draw\Color::Green</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-draw-color.constants.blue">UI\Draw\Color::Blue</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-draw-color.constants.alpha">UI\Draw\Color::Alpha</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="ui-draw-color.props.r">r</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="ui-draw-color.props.g">g</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="ui-draw-color.props.b">b</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="ui-draw-color.props.a">a</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">Constructor</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-draw-color')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-draw-color')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>


<!-- {{{ UI\Draw\Color properties -->
  <section xml:id="ui-draw-color.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="ui-draw-color.props.r">
     <term><varname>r</varname></term>
     <listitem>
      <para>Provides access to the red channel</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ui-draw-color.props.g">
     <term><varname>g</varname></term>
     <listitem>
      <para>Provides access to the green channel</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ui-draw-color.props.b">
     <term><varname>b</varname></term>
     <listitem>
      <para>Provides access to the blue channel</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ui-draw-color.props.a">
     <term><varname>a</varname></term>
     <listitem>
      <para>Provides access to the alpha channel</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


<!-- {{{ UI\Draw\Color constants -->
  <section xml:id="ui-draw-color.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="ui-draw-color.constants.red">
     <term><constant>UI\Draw\Color::Red</constant></term>
     <listitem>
      <para>Identifies the red channel</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-draw-color.constants.green">
     <term><constant>UI\Draw\Color::Green</constant></term>
     <listitem>
      <para>Identifies the green channel</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-draw-color.constants.blue">
     <term><constant>UI\Draw\Color::Blue</constant></term>
     <listitem>
      <para>Identifies the blue channel</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-draw-color.constants.alpha">
     <term><constant>UI\Draw\Color::Alpha</constant></term>
     <listitem>
      <para>Identifies the alpha channel</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.ui.ui.draw.entities.color;

</reference>

<!-- 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
-->