<?xml version="1.0"?>
<!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="gnome-desktop3-gnome-rr-screen">
<refmeta>
<refentrytitle role="top_of_page" id="gnome-desktop3-gnome-rr-screen.top_of_page">gnome-rr-screen</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GNOME-DESKTOP3 Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gnome-rr-screen</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="gnome-desktop3-gnome-rr-screen.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#include &lt;libgnomeui/gnome-rr.h&gt;

typedef             <link linkend="GnomeRRScreen">GnomeRRScreen</link>;
<link linkend="void"><returnvalue>void</returnvalue></link>                (<link linkend="GnomeRRScreenChanged">*GnomeRRScreenChanged</link>)             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
<link linkend="GnomeRRScreen"><returnvalue>GnomeRRScreen</returnvalue></link> *     <link linkend="gnome-rr-screen-new">gnome_rr_screen_new</link>                 (<parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GnomeRRScreenChanged"><type>GnomeRRScreenChanged</type></link> callback</parameter>,
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-rr-screen-destroy">gnome_rr_screen_destroy</link>             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="gnome-rr-screen-refresh">gnome_rr_screen_refresh</link>             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
<link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> **    <link linkend="gnome-rr-screen-list-outputs">gnome_rr_screen_list_outputs</link>        (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);
<link linkend="GnomeRRCrtc"><returnvalue>GnomeRRCrtc</returnvalue></link> **      <link linkend="gnome-rr-screen-list-crtcs">gnome_rr_screen_list_crtcs</link>          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);
<link linkend="GnomeRRMode"><returnvalue>GnomeRRMode</returnvalue></link> **      <link linkend="gnome-rr-screen-list-modes">gnome_rr_screen_list_modes</link>          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);
<link linkend="GnomeRRMode"><returnvalue>GnomeRRMode</returnvalue></link> **      <link linkend="gnome-rr-screen-list-clone-modes">gnome_rr_screen_list_clone_modes</link>    (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-rr-screen-set-size">gnome_rr_screen_set_size</link>            (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> mm_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> mm_height</parameter>);
<link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> *     <link linkend="gnome-rr-screen-get-output-by-id">gnome_rr_screen_get_output_by_id</link>    (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> id</parameter>);
<link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> *     <link linkend="gnome-rr-screen-get-output-by-name">gnome_rr_screen_get_output_by_name</link>  (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);
<link linkend="GnomeRRCrtc"><returnvalue>GnomeRRCrtc</returnvalue></link> *       <link linkend="gnome-rr-screen-get-crtc-by-id">gnome_rr_screen_get_crtc_by_id</link>      (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> id</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-rr-screen-get-ranges">gnome_rr_screen_get_ranges</link>          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *min_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *max_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *min_height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *max_height</parameter>);
</synopsis>
</refsynopsisdiv>

<refsect1 id="gnome-desktop3-gnome-rr-screen.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="gnome-desktop3-gnome-rr-screen.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GnomeRRScreen" role="typedef">
<title>GnomeRRScreen</title>
<indexterm zone="GnomeRRScreen"><primary>GnomeRRScreen</primary></indexterm>
<programlisting>typedef struct GnomeRRScreen GnomeRRScreen;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="GnomeRRScreenChanged" role="function">
<title>GnomeRRScreenChanged ()</title>
<indexterm zone="GnomeRRScreenChanged"><primary>GnomeRRScreenChanged</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                (*GnomeRRScreenChanged)             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-new" role="function">
<title>gnome_rr_screen_new ()</title>
<indexterm zone="gnome-rr-screen-new"><primary>gnome_rr_screen_new</primary></indexterm>
<programlisting><link linkend="GnomeRRScreen"><returnvalue>GnomeRRScreen</returnvalue></link> *     gnome_rr_screen_new                 (<parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GnomeRRScreenChanged"><type>GnomeRRScreenChanged</type></link> callback</parameter>,
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-destroy" role="function">
<title>gnome_rr_screen_destroy ()</title>
<indexterm zone="gnome-rr-screen-destroy"><primary>gnome_rr_screen_destroy</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_rr_screen_destroy             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-refresh" role="function">
<title>gnome_rr_screen_refresh ()</title>
<indexterm zone="gnome-rr-screen-refresh"><primary>gnome_rr_screen_refresh</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            gnome_rr_screen_refresh             (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>
Refreshes the screen configuration, and calls the screen's callback if it
exists and if the screen's configuration changed.
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&#160;:</term>
<listitem><simpara>location to store error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the screen's configuration changed; otherwise, the
function returns FALSE and a NULL error if the configuration didn't change,
or FALSE and a non-NULL error if there was an error while refreshing the
configuration.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-list-outputs" role="function">
<title>gnome_rr_screen_list_outputs ()</title>
<indexterm zone="gnome-rr-screen-list-outputs"><primary>gnome_rr_screen_list_outputs</primary></indexterm>
<programlisting><link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> **    gnome_rr_screen_list_outputs        (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-list-crtcs" role="function">
<title>gnome_rr_screen_list_crtcs ()</title>
<indexterm zone="gnome-rr-screen-list-crtcs"><primary>gnome_rr_screen_list_crtcs</primary></indexterm>
<programlisting><link linkend="GnomeRRCrtc"><returnvalue>GnomeRRCrtc</returnvalue></link> **      gnome_rr_screen_list_crtcs          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-list-modes" role="function">
<title>gnome_rr_screen_list_modes ()</title>
<indexterm zone="gnome-rr-screen-list-modes"><primary>gnome_rr_screen_list_modes</primary></indexterm>
<programlisting><link linkend="GnomeRRMode"><returnvalue>GnomeRRMode</returnvalue></link> **      gnome_rr_screen_list_modes          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-list-clone-modes" role="function">
<title>gnome_rr_screen_list_clone_modes ()</title>
<indexterm zone="gnome-rr-screen-list-clone-modes"><primary>gnome_rr_screen_list_clone_modes</primary></indexterm>
<programlisting><link linkend="GnomeRRMode"><returnvalue>GnomeRRMode</returnvalue></link> **      gnome_rr_screen_list_clone_modes    (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-set-size" role="function">
<title>gnome_rr_screen_set_size ()</title>
<indexterm zone="gnome-rr-screen-set-size"><primary>gnome_rr_screen_set_size</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_rr_screen_set_size            (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> mm_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> mm_height</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mm_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mm_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-get-output-by-id" role="function">
<title>gnome_rr_screen_get_output_by_id ()</title>
<indexterm zone="gnome-rr-screen-get-output-by-id"><primary>gnome_rr_screen_get_output_by_id</primary></indexterm>
<programlisting><link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> *     gnome_rr_screen_get_output_by_id    (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> id</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-get-output-by-name" role="function">
<title>gnome_rr_screen_get_output_by_name ()</title>
<indexterm zone="gnome-rr-screen-get-output-by-name"><primary>gnome_rr_screen_get_output_by_name</primary></indexterm>
<programlisting><link linkend="GnomeRROutput"><returnvalue>GnomeRROutput</returnvalue></link> *     gnome_rr_screen_get_output_by_name  (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-get-crtc-by-id" role="function">
<title>gnome_rr_screen_get_crtc_by_id ()</title>
<indexterm zone="gnome-rr-screen-get-crtc-by-id"><primary>gnome_rr_screen_get_crtc_by_id</primary></indexterm>
<programlisting><link linkend="GnomeRRCrtc"><returnvalue>GnomeRRCrtc</returnvalue></link> *       gnome_rr_screen_get_crtc_by_id      (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> id</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-rr-screen-get-ranges" role="function">
<title>gnome_rr_screen_get_ranges ()</title>
<indexterm zone="gnome-rr-screen-get-ranges"><primary>gnome_rr_screen_get_ranges</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_rr_screen_get_ranges          (<parameter><link linkend="GnomeRRScreen"><type>GnomeRRScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *min_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *max_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *min_height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *max_height</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

</refentry>
