<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<refentry id="A11yProfileManagerProfile">
<refmeta>
<refentrytitle role="top_of_page" id="A11yProfileManagerProfile.top_of_page">A11yProfileManagerProfile</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>A11Y-PROFILE-MANAGER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>A11yProfileManagerProfile</refname>
<refpurpose>This object represents an accessibility profile.</refpurpose>
</refnamediv>

<refsect1 id="A11yProfileManagerProfile.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="A11Y-PROFILE-MANAGER-TYPE-PROFILE:CAPS">A11Y_PROFILE_MANAGER_TYPE_PROFILE</link></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-validate">a11y_profile_manager_profile_validate</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-set-settings">a11y_profile_manager_profile_set_settings</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-reset-settings">a11y_profile_manager_profile_reset_settings</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-write-dconf-file">a11y_profile_manager_profile_write_dconf_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="A11yProfileManagerProfile"><returnvalue>A11yProfileManagerProfile</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-new">a11y_profile_manager_profile_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-dir-name">a11y_profile_manager_profile_get_dir_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-name">a11y_profile_manager_profile_get_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-description">a11y_profile_manager_profile_get_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-monitor-schema">a11y_profile_manager_profile_get_monitor_schema</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-monitor-key">a11y_profile_manager_profile_get_monitor_key</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-at-command">a11y_profile_manager_profile_get_at_command</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="a11y-profile-manager-profile-get-valid">a11y_profile_manager_profile_get_valid</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="A11yProfileManagerProfile.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--at-command">at-command</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--description">description</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--dir-name">dir-name</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--monitor-key">monitor-key</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--monitor-schema">monitor-schema</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--name">name</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="A11yProfileManagerProfile--valid">valid</link></entry><entry role="property_flags">Read</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="A11yProfileManagerProfile.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="A11yProfileManagerProfile-struct">A11yProfileManagerProfile</link></entry></row>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="A11yProfileManagerProfileClass">A11yProfileManagerProfileClass</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="A11yProfileManagerProfileError">A11yProfileManagerProfileError</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="A11yProfileManagerProfile.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> A11yProfileManagerProfile
</screen>
</refsect1>


<refsect1 id="A11yProfileManagerProfile.description" role="desc">
<title role="desc.title">Description</title>
<para>An accessibility profile represents a group of settings that can be enabled to provide a better experience for a user with a disability. An accessibility profile can be associated with an assistive technology service such as the Orca Screen reader if desired.</para><para>Only one accessibility profile can be enabled at a time, as the same setting may be present in multiple profiles, and have multiple different values accross different profiles. The accessibility profile manager library currently only supports GSettings for profile configuration at this time.</para>

</refsect1>
<refsect1 id="A11yProfileManagerProfile.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="A11Y-PROFILE-MANAGER-TYPE-PROFILE:CAPS" role="macro">
<title>A11Y_PROFILE_MANAGER_TYPE_PROFILE</title>
<indexterm zone="A11Y-PROFILE-MANAGER-TYPE-PROFILE:CAPS"><primary>A11Y_PROFILE_MANAGER_TYPE_PROFILE</primary></indexterm>
<programlisting language="C">#define A11Y_PROFILE_MANAGER_TYPE_PROFILE (a11y_profile_manager_profile_get_type ())
</programlisting>
<para>The type for <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link>.</para>
</refsect2>
<refsect2 id="a11y-profile-manager-profile-validate" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_validate&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-validate" role="0.1"><primary>a11y_profile_manager_profile_validate</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
a11y_profile_manager_profile_validate (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>,
                                       <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Validates the profile manifest and gsettings files found in the profile directory given at object creation time. If required manifest data is not present, or the GSettings data is invalid, #error will be set to <link linkend="ProfileError"><type>ProfileError</type></link>.</para>
<para>The validity of the profile can be checked with #<link linkend="a11y-profile-manager-profile-get-valid"><function>a11y_profile_manager_profile_get_valid()</function></link>.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>location to store the error occuring, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-set-settings" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_set_settings&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-set-settings" role="0.1"><primary>a11y_profile_manager_profile_set_settings</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
a11y_profile_manager_profile_set_settings
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>,
                                <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Sets the settings as per the profile GSettings file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>location to store the error occuring, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-reset-settings" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_reset_settings&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-reset-settings" role="0.1"><primary>a11y_profile_manager_profile_reset_settings</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
a11y_profile_manager_profile_reset_settings
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>,
                                <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Resets the settings given in the profile GSettings file to defaults.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>location to store the error occuring, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-write-dconf-file" role="function" condition="since:0.1.2">
<title>a11y_profile_manager_profile_write_dconf_file&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-write-dconf-file" role="0.1.2"><primary>a11y_profile_manager_profile_write_dconf_file</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
a11y_profile_manager_profile_write_dconf_file
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>,
                                <parameter>const <link linkend="gchar"><type>gchar</type></link> *file</parameter>,
                                <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Writes the gsettings data in the profile to a format that is consumable by the dconf command-line utility. The file can be used with &apos;dconf compile&apos; to create a dconf database with profile settings.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>file</para></entry>
<entry role="parameter_description"><para> &nbsp;.  <para>A file to write the dconf data to. </para>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>location to store the error occuring, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.1.2">0.1.2</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-new" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_new&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-new" role="0.1"><primary>a11y_profile_manager_profile_new</primary></indexterm>
<programlisting language="C"><link linkend="A11yProfileManagerProfile"><returnvalue>A11yProfileManagerProfile</returnvalue></link>&#160;*
a11y_profile_manager_profile_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *profile_dir</parameter>);</programlisting>
<para>Creates a new accessibility profile object.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>profile_dir</para></entry>
<entry role="parameter_description"><para> &nbsp;.  <para>The profile directory name relative to the profiles directory. </para>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para>A new Profile </para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-dir-name" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_dir_name&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-dir-name" role="0.1"><primary>a11y_profile_manager_profile_get_dir_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_dir_name
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--dir-name"><type>"dir-name"</type></link> property.</para>
<para>The directory where the profile files are stored, relative to the profiles directory.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--dir-name"><type>"dir-name"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-name" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_name&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-name" role="0.1"><primary>a11y_profile_manager_profile_get_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_name (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--name"><type>"name"</type></link> property.</para>
<para>The name of the accessibility profile, as per the manifest file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--name"><type>"name"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-description" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_description&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-description" role="0.1"><primary>a11y_profile_manager_profile_get_description</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_description
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--description"><type>"description"</type></link> property.</para>
<para>The description of the accessibility profile, as per the manifest file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--description"><type>"description"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-monitor-schema" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_monitor_schema&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-monitor-schema" role="0.1"><primary>a11y_profile_manager_profile_get_monitor_schema</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_monitor_schema
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--monitor-schema"><type>"monitor-schema"</type></link> property.</para>
<para>The GSettings schema to subscribe to for change events, as per the manifest file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--monitor-schema"><type>"monitor-schema"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-monitor-key" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_monitor_key&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-monitor-key" role="0.1"><primary>a11y_profile_manager_profile_get_monitor_key</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_monitor_key
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--monitor-key"><type>"monitor-key"</type></link> property.</para>
<para>THe GSettings key associated with the GSettings schema to monitor, as per the manifest file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--monitor-key"><type>"monitor-key"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-at-command" role="function" condition="since:0.1.2">
<title>a11y_profile_manager_profile_get_at_command&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-at-command" role="0.1.2"><primary>a11y_profile_manager_profile_get_at_command</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
a11y_profile_manager_profile_get_at_command
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--at-command"><type>"at-command"</type></link> property.</para>
<para>The command to execute to run an assistive technology that best works with this profile.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--at-command"><type>"at-command"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1.2">0.1.2</link></para></refsect2>
<refsect2 id="a11y-profile-manager-profile-get-valid" role="function" condition="since:0.1">
<title>a11y_profile_manager_profile_get_valid&#160;()</title>
<indexterm zone="a11y-profile-manager-profile-get-valid" role="0.1"><primary>a11y_profile_manager_profile_get_valid</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
a11y_profile_manager_profile_get_valid
                               (<parameter><link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="A11yProfileManagerProfile--valid"><type>"valid"</type></link> property.</para>
<para>The validity of the accessibility profile, whether the GSettings exist, the manifest is valid, whether settings values are the correct value type, etc.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="A11yProfileManagerProfile"><type>A11yProfileManagerProfile</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="A11yProfileManagerProfile--valid"><type>"valid"</type></link> property</para>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>

</refsect1>
<refsect1 id="A11yProfileManagerProfile.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="A11yProfileManagerProfile-struct" role="struct">
<title>struct A11yProfileManagerProfile</title>
<indexterm zone="A11yProfileManagerProfile-struct" role="0.1"><primary>A11yProfileManagerProfile</primary></indexterm>
<programlisting language="C">struct A11yProfileManagerProfile;</programlisting>
<para>This object represents an accessibility profile.</para>
<para>An accessibility profile represents a group of settings that can be enabled to provide a better experience for a user with a disability. An accessibility profile can be associated with an assistive technology service such as the Orca Screen reader if desired.</para><para>Only one accessibility profile can be enabled at a time, as the same setting may be present in multiple profiles, and have multiple different values accross different profiles. The accessibility profile manager library currently only supports GSettings for profile configuration at this time.</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfileClass" role="struct">
<title>struct A11yProfileManagerProfileClass</title>
<indexterm zone="A11yProfileManagerProfileClass"><primary>A11yProfileManagerProfileClass</primary></indexterm>
<programlisting language="C">struct A11yProfileManagerProfileClass {
	GObjectClass parent_class;
};
</programlisting>
<para>The class structure for <link linkend="A11Y-PROFILE-MANAGER-TYPE-PROFILE:CAPS"><literal>A11Y_PROFILE_MANAGER_TYPE_PROFILE</literal></link>. All the fields in this structure are private and should never be accessed directly.</para>
<refsect3 role="struct_members">
<title>Members</title>
<informaltable role="struct_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="struct_members_name" colwidth="300px"/>
<colspec colname="struct_members_description"/>
<colspec colname="struct_members_annotations" colwidth="200px"/>
<tbody>
<row><entry role="struct_member_name"><para><link linkend="GObjectClass"><type>GObjectClass</type></link>&#160;<structfield id="A11yProfileManagerProfileClass.parent-class">parent_class</structfield>;</para></entry>
<entry role="struct_member_description"><para>the parent class structure</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3>
</refsect2>
<refsect2 id="A11yProfileManagerProfileError" role="enum" condition="since:0.1">
<title>enum A11yProfileManagerProfileError</title>
<indexterm zone="A11yProfileManagerProfileError" role="0.1"><primary>A11yProfileManagerProfileError</primary></indexterm>
<para>Errors which can be thrown when attempting to activate an accessibility profile.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-PROFILE-GROUP:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_PROFILE_GROUP</para></entry>
<entry role="enum_member_description"><para>No profile group in manifest file:</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-NAME-ENTRY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_NAME_ENTRY</para></entry>
<entry role="enum_member_description"><para>No name entry in profile group.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-DESCRIPTION-ENTRY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_DESCRIPTION_ENTRY</para></entry>
<entry role="enum_member_description"><para>No description entry in profile group.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-INVALID-ENTRY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_INVALID_ENTRY</para></entry>
<entry role="enum_member_description"><para>Invalid manifest entry.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-SUCH-MONITOR-SCHEMA:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_SUCH_MONITOR_SCHEMA</para></entry>
<entry role="enum_member_description"><para>No such assistive technology monitor schema.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-SCHEMA-WITHOUT-KEY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_SCHEMA_WITHOUT_KEY</para></entry>
<entry role="enum_member_description"><para>A schema was specified, but no key.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-SUCH-MONITOR-KEY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_SUCH_MONITOR_KEY</para></entry>
<entry role="enum_member_description"><para>No such assistive technology monitor key.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-SUCH-SCHEMA:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_SUCH_SCHEMA</para></entry>
<entry role="enum_member_description"><para>GSettings schema does not exist.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-SCHEMA-NOT-RELOCATABLE:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_SCHEMA_NOT_RELOCATABLE</para></entry>
<entry role="enum_member_description"><para>Schema is not relocatable.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-NO-SUCH-KEY:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_NO_SUCH_KEY</para></entry>
<entry role="enum_member_description"><para>Key does not exist in schema.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-INVALID-SCHEMA-PATH:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_INVALID_SCHEMA_PATH</para></entry>
<entry role="enum_member_description"><para>Invalid schema path.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="A11Y-PROFILE-MANAGER-PROFILE-ERROR-INVALID-KEY-TYPE:CAPS">A11Y_PROFILE_MANAGER_PROFILE_ERROR_INVALID_KEY_TYPE</para></entry>
<entry role="enum_member_description"><para>Invalid key type.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>

</refsect1>
<refsect1 id="A11yProfileManagerProfile.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="A11yProfileManagerProfile--at-command" role="property"><title>The <literal>“at-command”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--at-command" role="0.1.2"><primary>A11yProfileManagerProfile:at-command</primary></indexterm>
<programlisting>  “at-command”               <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The command to execute to run an assistive technology that best works with this profile.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1.2">0.1.2</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--description" role="property"><title>The <literal>“description”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--description" role="0.1"><primary>A11yProfileManagerProfile:description</primary></indexterm>
<programlisting>  “description”              <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The description of the accessibility profile, as per the manifest file.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--dir-name" role="property"><title>The <literal>“dir-name”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--dir-name" role="0.1"><primary>A11yProfileManagerProfile:dir-name</primary></indexterm>
<programlisting>  “dir-name”                 <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The directory where the profile files are stored, relative to the profiles directory.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--monitor-key" role="property"><title>The <literal>“monitor-key”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--monitor-key" role="0.1"><primary>A11yProfileManagerProfile:monitor-key</primary></indexterm>
<programlisting>  “monitor-key”              <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>THe GSettings key associated with the GSettings schema to monitor, as per the manifest file.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--monitor-schema" role="property"><title>The <literal>“monitor-schema”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--monitor-schema" role="0.1"><primary>A11yProfileManagerProfile:monitor-schema</primary></indexterm>
<programlisting>  “monitor-schema”           <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The GSettings schema to subscribe to for change events, as per the manifest file.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--name" role="property"><title>The <literal>“name”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--name" role="0.1"><primary>A11yProfileManagerProfile:name</primary></indexterm>
<programlisting>  “name”                     <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>The name of the accessibility profile, as per the manifest file.</para>
<para>Flags: Read</para>
<para>Default value: NULL</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>
<refsect2 id="A11yProfileManagerProfile--valid" role="property"><title>The <literal>“valid”</literal> property</title>
<indexterm zone="A11yProfileManagerProfile--valid" role="0.1"><primary>A11yProfileManagerProfile:valid</primary></indexterm>
<programlisting>  “valid”                    <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>The validity of the accessibility profile, whether the GSettings exist, the manifest is valid, whether settings values are the correct value type, etc.</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
<para role="since">Since: <link linkend="api-index-0.1">0.1</link></para></refsect2>

</refsect1>

</refentry>
