|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeMultiScreen</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="application-mgmt.html" title="Application management">
<link rel="prev" href="GnomeAbout.html" title="GnomeAbout">
<link rel="next" href="libgnomeui-GnomeAuthentication.html" title="GnomeAuthentication">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GnomeAbout.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="application-mgmt.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-GnomeAuthentication.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2964433" class="shortcut">Top</a>
 | 
<a href="#id2964698" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgnomeui-GnomeMultiScreen"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2964433"></a><span class="refentrytitle">GnomeMultiScreen</span>
</h2>
<p>GnomeMultiScreen — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnomeui-GnomeMultiScreen.html#gnome-url-show-on-screen">gnome_url_show_on_screen</a> (const char *url,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnomeui-GnomeMultiScreen.html#gnome-help-display-on-screen">gnome_help_display_on_screen</a> (const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnomeui-GnomeMultiScreen.html#gnome-help-display-with-doc-id-on-screen">gnome_help_display_with_doc_id_on_screen</a>
(<a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeProgram"
>GnomeProgram</a> *program,
const char *doc_id,
const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnomeui-GnomeMultiScreen.html#gnome-help-display-desktop-on-screen">gnome_help_display_desktop_on_screen</a>
(<a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeProgram"
>GnomeProgram</a> *program,
const char *doc_id,
const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgnomeui-GnomeMultiScreen.html#gnome-help-display-uri-on-screen">gnome_help_display_uri_on_screen</a>
(const char *help_uri,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2964698"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2964712"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2964722"></a><h3>
<a name="gnome-url-show-on-screen"></a>gnome_url_show_on_screen ()</h3>
<a class="indexterm" name="id2964738"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_url_show_on_screen (const char *url,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-url.html#gnome-url-show"
><code class="function">gnome_url_show()</code></a>, but ensures that the viewer application
appears on <em class="parameter"><code>screen</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>url</code></em> :</span></td>
<td> The url to display. Should begin with the protocol to use (e.g.
"http:", "ghelp:", etc)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if everything went fine, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case
<em class="parameter"><code>error</code></em> will contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964906"></a><h3>
<a name="gnome-help-display-on-screen"></a>gnome_help_display_on_screen ()</h3>
<a class="indexterm" name="id2964922"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_help_display_on_screen (const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-help.html#gnome-help-display"
><code class="function">gnome_help_display()</code></a>, but ensures that the help viewer
application appears on <em class="parameter"><code>screen</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2965135"></a><h3>
<a name="gnome-help-display-with-doc-id-on-screen"></a>gnome_help_display_with_doc_id_on_screen ()</h3>
<a class="indexterm" name="id2965152"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_help_display_with_doc_id_on_screen
(<a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeProgram"
>GnomeProgram</a> *program,
const char *doc_id,
const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-help.html#gnome-help-display-with-doc-id"
><code class="function">gnome_help_display_with_doc_id()</code></a>, but ensures that the help
viewer application appears on <em class="parameter"><code>screen</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
<td> The current application object, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> for the default one.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
<td> The document identifier, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to default to the application ID
(app_id) of the specified <em class="parameter"><code>program</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2965438"></a><h3>
<a name="gnome-help-display-desktop-on-screen"></a>gnome_help_display_desktop_on_screen ()</h3>
<a class="indexterm" name="id2965455"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_help_display_desktop_on_screen
(<a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeProgram"
>GnomeProgram</a> *program,
const char *doc_id,
const char *file_name,
const char *link_id,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-help.html#gnome-help-display-desktop"
><code class="function">gnome_help_display_desktop()</code></a>, but ensures that the help
viewer application appears on <em class="parameter"><code>screen</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
<td> The current application object, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> for the default one.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
<td> The name of the help file relative to the system's help domain
(<a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"
><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2965734"></a><h3>
<a name="gnome-help-display-uri-on-screen"></a>gnome_help_display_uri_on_screen ()</h3>
<a class="indexterm" name="id2965750"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gnome_help_display_uri_on_screen
(const char *help_uri,
<a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
>GdkScreen</a> *screen,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-help.html#gnome-help-display-uri"
><code class="function">gnome_help_display_uri()</code></a>, but ensures that the help viewer
application appears on <em class="parameter"><code>screen</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_uri</code></em> :</span></td>
<td> The URI to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="/usr/share/gtk-doc/html/gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
</div>
</div>
</body>
</html>