<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-mateprintconfig">
  <refnamediv>
    <refname>mateprint.Config</refname>
    <refpurpose>Config object for MatePrint</refpurpose>
  </refnamediv>

<!-- ********************************** -->
<!-- BEGIN OF MATEPRINTCONFIG SYNOPSIS -->
<!-- ********************************** -->

<refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
    <ooclass><classname>mateprint.Config</classname></ooclass>
    <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
    
    <constructorsynopsis language="python">
	   <methodname><link linkend="constructor-mateprintconfig">mateprint.Config</link></methodname>
	   <methodparam><parameter role="keyword"></parameter></methodparam>
    </constructorsynopsis>
    
    <methodsynopsis language="python">
	    <methodname><link linkend="method-mateprintconfig--dup">dup</link></methodname>
	    <methodparam></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--get">get</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--set">set</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">value</parameter></methodparam>
    </methodsynopsis>    
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--get-boolean">get_boolean</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--get-int">get_int</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--get-double">get_double</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis> 
  
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--get-length">get_lenght</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
    </methodsynopsis> 

    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--set-boolean">set_boolean</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--set-int">set_int</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--set-double">set_double</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
    </methodsynopsis> 
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--set-length">set_lenght</link></methodname>
        <methodparam><parameter role="keyword">key</parameter></methodparam>
        <methodparam><parameter role="keyword">val</parameter></methodparam>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
    </methodsynopsis> 

    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig--dump">dump</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis> 

    <!-- 
    <methodsynopsis language="python">
        <methodname><link linkend="method-mateprintconfig-to-string">to_string</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis> 
    -->

  </classsynopsis>
</refsect1>

<!-- ********************************** -->
<!-- BEGIN OF MATEPRINTCONFIG ANCESTRY -->
<!-- ********************************** -->

<refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-mateprintconfig">mateprint.Config</link>
</synopsis>
</refsect1>

<!-- ************************************** -->
<!-- BEGIN OF MATEPRINTCONFIG DESCRIPTION -->
<!-- ************************************** -->

<refsect1 id="description-mateprintconfig">
    <title>Description</title>

<para>

</para>
</refsect1>

<!-- ************************************** -->
<!-- BEGIN OF MATEPRINTCONFIG CONSTRUCTOR -->
<!-- ************************************** -->

<refsect1 id="constructor-mateprintconfig">
  <title>Constructor</title>

  <programlisting><constructorsynopsis language="python">
	  <methodname>mateprint.Config</methodname>
	  <methodparam><parameter role="keyword"></parameter></methodparam>
  </constructorsynopsis></programlisting>
    
  <variablelist>

    <varlistentry>
	    <term><emphasis>Returns</emphasis>&nbsp;:</term>
	    <listitem><simpara>a new <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link>.
        </simpara></listitem>
    </varlistentry>
  </variablelist>

  <para>
    Creates a new <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object.
  </para>
</refsect1>

<!-- ********************************* -->
<!-- BEGIN OF MATEPRINTCONFIG METHODS -->
<!-- ********************************* -->

<refsect1>
    <title>Methods</title>

    <refsect2 id="method-mateprintconfig--dup">
        <title>mateprint.Config.dup</title>
            <programlisting><methodsynopsis language="python">
                <methodname>dup</methodname>
                    <methodparam></methodparam>
            </methodsynopsis></programlisting>
      
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>  a copy of config.</simpara></listitem>
                </varlistentry>
            </variablelist>

        <para>
            The <methodname>dup</methodname>() method does a deep copy of the config config.
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--get">
        <title>mateprint.Config.get</title>
            <programlisting><methodsynopsis language="python">
                <methodname>get</methodname>
                    <methodparam><parameter role="keyword">key</parameter></methodparam>
            </methodsynopsis></programlisting>

            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                    <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara> the value of the key, <literal>None</literal> indicates failure.</simpara></listitem>
                </varlistentry>
            </variablelist>

        <para>
            The <methodname>get</methodname>() method 
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--set">
        <title>mateprint.Config.set</title>
        <programlisting><methodsynopsis language="python">
                <methodname>set</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">value</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">value</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the value to set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>set</methodname>() method sets the value of string key in the MatePrintConfig object to value value
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--get-boolean">
        <title>mateprint.Config.get_boolean</title>
        <programlisting><methodsynopsis language="python">
                <methodname>get_boolean</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> a boolean variable to store the value in. Should initially be <literal>None</literal>.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>get_boolean</methodname>() method gets the value of key key from the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object. Converts values such as "true", "y", "yes", and their 
            opposites, to their boolean equivalent. The boolean value will be stored in the variable val.
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--get-int">
        <title>mateprint.Config.get_int</title>
        <programlisting><methodsynopsis language="python">
                <methodname>get_int</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> an integer variable to store the value in. Should initially be <literal>None</literal>.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>get_int</methodname>() method gets the value of key key from the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object. Converts values to their integer equivalent. The integer 
            value will be stored in the variable val.
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--get-double">
        <title>mateprint.Config.get_double</title>
        <programlisting><methodsynopsis language="python">
                <methodname>get_double</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> a double variable to store the value in. Should initially be <literal>None</literal>.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>get_double</methodname>() method gets the value of key key from the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object. Converts values to their double equivalent. The double 
            value will be stored in the variable val.
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--get-length">
        <title>mateprint.Config.get_length</title>
        <programlisting><methodsynopsis language="python">
                <methodname>get_length</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
                <methodparam><parameter role="keyword">unit</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> a double variable to store the value in. Should initially be <literal>None</literal>.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
                <listitem><simpara> pointer to an already allocated MatePrintUnit struct.<literal>None</literal>.</simpara></listitem>
            </varlistentry>

            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>get_length</methodname>() method gets the value of key key from the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object. Converts values to their double equivalent. The double 
            value will be stored in the variable val and the units will be stored in unit.
        </para>
    </refsect2>

    <refsect2 id="method-mateprintconfig--set-boolean">
        <title>mateprint.Config.set_boolean</title>
        <programlisting><methodsynopsis language="python">
                <methodname>set_boolean</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be obtained.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> boolean containing the value to set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>set_boolean</methodname>() method set a boolean value in the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object.
        </para>
    </refsect2>
    
    <refsect2 id="method-mateprintconfig--set-int">
        <title>mateprint.Config.set_int</title>
        <programlisting><methodsynopsis language="python">
                <methodname>set_int</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> integer containing the value to set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> if a value was retrieved, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>set_int</methodname>() method set an integer value in the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object.
        </para>
    </refsect2>
    
    <refsect2 id="method-mateprintconfig--set-double">
        <title>mateprint.Config.set_double</title>
        <programlisting><methodsynopsis language="python">
                <methodname>set_double</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> integer containing the value to set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>set_double</methodname>() method set an integer value in the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link> object.
        </para>
    </refsect2>
    
    <refsect2 id="method-mateprintconfig--set-length">
        <title>mateprint.Config.set_length</title>
        <programlisting><methodsynopsis language="python">
                <methodname>set_length</methodname>
                <methodparam><parameter role="keyword">key</parameter></methodparam>
                <methodparam><parameter role="keyword">val</parameter></methodparam>
                <methodparam><parameter role="keyword">unit</parameter></methodparam>
            </methodsynopsis></programlisting>
        
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">key</parameter>&nbsp;:</term>
                <listitem><simpara> string containing the path of key whose value is to be set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">val</parameter>&nbsp;:</term>
                <listitem><simpara> double containing the value to set.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
                <listitem><simpara> units to use when setting value.</simpara></listitem>
            </varlistentry>
            
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara> <literal>TRUE</literal> on success, <literal>FALSE</literal> on failure.</simpara></listitem>
            </varlistentry>
        </variablelist>
        
        <para>
            The <methodname>set_length</methodname>() method sets a double value and the units it is using. This should be used in conjunction with 
            <link linkend="method-mateprintconfig--get-length"><methodname>get_lenght</methodname></link> 
        </para>
    </refsect2>
    
    <refsect2 id="method-mateprintconfig--dump">
        <title>mateprint.Config.dump</title>
        <programlisting><methodsynopsis language="python">
                <methodname>dump</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
        
        <para>
            The <methodname>dump</methodname>() method print out the tree structure representing the 
            <link linkend="class-mateprintconfig"><classname>mateprint.Config</classname></link>. Output is to STDOUT and is limited to a depth of 20.
        </para>
    </refsect2>
  </refsect1>  
</refentry>
