Imported Upstream version 0.8.1 upstream/0.8.1

author: Michael Biebl <biebl@debian.org> 2010-11-29 00:47:11 +0100
committer: Michael Biebl <biebl@debian.org> 2010-11-29 00:47:11 +0100
commit: 9fae01fa351805b2903e535736e06971bc0b925e (patch)
tree: c19bccf84c9f894e50fae678ba6ee2b2044e2d30 /docs/libnm-util/html/NMSettingCdma.html
1 files changed, 322 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html
new file mode 100644
index 00000000..878660d4
--- /dev/null
+++ b/docs/libnm-util/html/NMSettingCdma.html
@@ -0,0 +1,322 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>NMSettingCdma</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="libnm-util Reference Manual">
+<link rel="up" href="ch01.html" title="libnm-util API Reference">
+<link rel="prev" href="NMSettingSerial.html" title="NMSettingSerial">
+<link rel="next" href="NMSettingGsm.html" title="NMSettingGsm">
+<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="NMSettingSerial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch01.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">libnm-util Reference Manual</th>
+<td><a accesskey="n" href="NMSettingGsm.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#NMSettingCdma.synopsis" class="shortcut">Top</a>
+                   | 
+                  <a href="#NMSettingCdma.description" class="shortcut">Description</a>
+                   | 
+                  <a href="#NMSettingCdma.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   | 
+                  <a href="#NMSettingCdma.properties" class="shortcut">Properties</a>
+</td></tr>
+</table>
+<div class="refentry" title="NMSettingCdma">
+<a name="NMSettingCdma"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="NMSettingCdma.top_of_page"></a>NMSettingCdma</span></h2>
+<p>NMSettingCdma — Describes CDMA-based mobile broadband properties</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv" title="Synopsis">
+<a name="NMSettingCdma.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;nm-setting-cdma.h&gt;
+
+#define             <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-SETTING-NAME:CAPS" title="NM_SETTING_CDMA_SETTING_NAME">NM_SETTING_CDMA_SETTING_NAME</a>
+enum                <a class="link" href="NMSettingCdma.html#NMSettingCdmaError" title="enum NMSettingCdmaError">NMSettingCdmaError</a>;
+#define             <a class="link" href="NMSettingCdma.html#NM-TYPE-SETTING-CDMA-ERROR:CAPS" title="NM_TYPE_SETTING_CDMA_ERROR">NM_TYPE_SETTING_CDMA_ERROR</a>
+#define             <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-ERROR:CAPS" title="NM_SETTING_CDMA_ERROR">NM_SETTING_CDMA_ERROR</a>
+<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="NMSettingCdma.html#nm-setting-cdma-error-quark" title="nm_setting_cdma_error_quark ()">nm_setting_cdma_error_quark</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
+#define             <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-NUMBER:CAPS" title="NM_SETTING_CDMA_NUMBER">NM_SETTING_CDMA_NUMBER</a>
+#define             <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-USERNAME:CAPS" title="NM_SETTING_CDMA_USERNAME">NM_SETTING_CDMA_USERNAME</a>
+#define             <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-PASSWORD:CAPS" title="NM_SETTING_CDMA_PASSWORD">NM_SETTING_CDMA_PASSWORD</a>
+                    <a class="link" href="NMSettingCdma.html#NMSettingCdma-struct" title="NMSettingCdma">NMSettingCdma</a>;
+                    <a class="link" href="NMSettingCdma.html#NMSettingCdmaClass" title="NMSettingCdmaClass">NMSettingCdmaClass</a>;
+<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-type" title="nm_setting_cdma_get_type ()">nm_setting_cdma_get_type</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
+<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> *         <a class="link" href="NMSettingCdma.html#nm-setting-cdma-new" title="nm_setting_cdma_new ()">nm_setting_cdma_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
+const <span class="returnvalue">char</span> *        <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-number" title="nm_setting_cdma_get_number ()">nm_setting_cdma_get_number</a>          (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);
+const <span class="returnvalue">char</span> *        <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-username" title="nm_setting_cdma_get_username ()">nm_setting_cdma_get_username</a>        (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);
+const <span class="returnvalue">char</span> *        <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-password" title="nm_setting_cdma_get_password ()">nm_setting_cdma_get_password</a>        (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);
+</pre>
+</div>
+<div class="refsect1" title="Object Hierarchy">
+<a name="NMSettingCdma.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+   +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a>
+         +----NMSettingCdma
+</pre>
+</div>
+<div class="refsect1" title="Properties">
+<a name="NMSettingCdma.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="NMSettingCdma.html#NMSettingCdma--number" title='The "number" property'>number</a>"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
+  "<a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title='The "password" property'>password</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
+  "<a class="link" href="NMSettingCdma.html#NMSettingCdma--username" title='The "username" property'>username</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
+</pre>
+</div>
+<div class="refsect1" title="Description">
+<a name="NMSettingCdma.description"></a><h2>Description</h2>
+<p>
+The <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
+properties that allow connections to IS-95-based mobile broadband
+networks, including those using CDMA2000/EVDO technology.
+</p>
+</div>
+<div class="refsect1" title="Details">
+<a name="NMSettingCdma.details"></a><h2>Details</h2>
+<div class="refsect2" title="NM_SETTING_CDMA_SETTING_NAME">
+<a name="NM-SETTING-CDMA-SETTING-NAME:CAPS"></a><h3>NM_SETTING_CDMA_SETTING_NAME</h3>
+<pre class="programlisting">#define NM_SETTING_CDMA_SETTING_NAME "cdma"
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="enum NMSettingCdmaError">
+<a name="NMSettingCdmaError"></a><h3>enum NMSettingCdmaError</h3>
+<pre class="programlisting">typedef enum
+{
+	NM_SETTING_CDMA_ERROR_UNKNOWN = 0,
+	NM_SETTING_CDMA_ERROR_INVALID_PROPERTY,
+	NM_SETTING_CDMA_ERROR_MISSING_PROPERTY,
+	NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING
+} NMSettingCdmaError;
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NM_TYPE_SETTING_CDMA_ERROR">
+<a name="NM-TYPE-SETTING-CDMA-ERROR:CAPS"></a><h3>NM_TYPE_SETTING_CDMA_ERROR</h3>
+<pre class="programlisting">#define NM_TYPE_SETTING_CDMA_ERROR (nm_setting_cdma_error_get_type ()) 
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NM_SETTING_CDMA_ERROR">
+<a name="NM-SETTING-CDMA-ERROR:CAPS"></a><h3>NM_SETTING_CDMA_ERROR</h3>
+<pre class="programlisting">#define NM_SETTING_CDMA_ERROR nm_setting_cdma_error_quark ()
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_error_quark ()">
+<a name="nm-setting-cdma-error-quark"></a><h3>nm_setting_cdma_error_quark ()</h3>
+<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              nm_setting_cdma_error_quark         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Registers an error quark for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> if necessary.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the error quark used for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> errors.
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="NM_SETTING_CDMA_NUMBER">
+<a name="NM-SETTING-CDMA-NUMBER:CAPS"></a><h3>NM_SETTING_CDMA_NUMBER</h3>
+<pre class="programlisting">#define NM_SETTING_CDMA_NUMBER       "number"
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NM_SETTING_CDMA_USERNAME">
+<a name="NM-SETTING-CDMA-USERNAME:CAPS"></a><h3>NM_SETTING_CDMA_USERNAME</h3>
+<pre class="programlisting">#define NM_SETTING_CDMA_USERNAME     "username"
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NM_SETTING_CDMA_PASSWORD">
+<a name="NM-SETTING-CDMA-PASSWORD:CAPS"></a><h3>NM_SETTING_CDMA_PASSWORD</h3>
+<pre class="programlisting">#define NM_SETTING_CDMA_PASSWORD     "password"
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NMSettingCdma">
+<a name="NMSettingCdma-struct"></a><h3>NMSettingCdma</h3>
+<pre class="programlisting">typedef struct _NMSettingCdma NMSettingCdma;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="NMSettingCdmaClass">
+<a name="NMSettingCdmaClass"></a><h3>NMSettingCdmaClass</h3>
+<pre class="programlisting">typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingCdmaClass;
+</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_get_type ()">
+<a name="nm-setting-cdma-get-type"></a><h3>nm_setting_cdma_get_type ()</h3>
+<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               nm_setting_cdma_get_type            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_new ()">
+<a name="nm-setting-cdma-new"></a><h3>nm_setting_cdma_new ()</h3>
+<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> *         nm_setting_cdma_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Creates a new <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object with default values.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the new empty <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_get_number ()">
+<a name="nm-setting-cdma-get-number"></a><h3>nm_setting_cdma_get_number ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *        nm_setting_cdma_get_number          (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
+<td>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--number" title='The "number" property'><span class="type">"number"</span></a> property of the setting
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_get_username ()">
+<a name="nm-setting-cdma-get-username"></a><h3>nm_setting_cdma_get_username ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *        nm_setting_cdma_get_username        (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
+<td>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--username" title='The "username" property'><span class="type">"username"</span></a> property of the setting
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2" title="nm_setting_cdma_get_password ()">
+<a name="nm-setting-cdma-get-password"></a><h3>nm_setting_cdma_get_password ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *        nm_setting_cdma_get_password        (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
+<td>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title='The "password" property'><span class="type">"password"</span></a> property of the setting
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<div class="refsect1" title="Property Details">
+<a name="NMSettingCdma.property-details"></a><h2>Property Details</h2>
+<div class="refsect2" title='The "number" property'>
+<a name="NMSettingCdma--number"></a><h3>The <code class="literal">"number"</code> property</h3>
+<pre class="programlisting">  "number"                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
+<p>
+The number to dial to establish the connection to the CDMA-based mobile
+broadband network, if any.  If not specified, the default number (<span class="type">777</span>)
+is used when required.
+</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2" title='The "password" property'>
+<a name="NMSettingCdma--password"></a><h3>The <code class="literal">"password"</code> property</h3>
+<pre class="programlisting">  "password"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
+<p>
+The password used to authenticate with the network, if required.  Many
+providers do not require a password, or accept any password.  But if a
+password is required, it is specified here.
+</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2" title='The "username" property'>
+<a name="NMSettingCdma--username"></a><h3>The <code class="literal">"username"</code> property</h3>
+<pre class="programlisting">  "username"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
+<p>
+The username used to authenticate with the network, if required.  Many
+providers do not require a username, or accept any username.  But if a
+username is required, it is specified here.
+</p>
+<p>Default value: NULL</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.14</div>
+</body>
+</html>
\ No newline at end of file
author	Michael Biebl <biebl@debian.org>	2010-11-29 00:47:11 +0100
committer	Michael Biebl <biebl@debian.org>	2010-11-29 00:47:11 +0100
commit	9fae01fa351805b2903e535736e06971bc0b925e (patch)
tree	c19bccf84c9f894e50fae678ba6ee2b2044e2d30 /docs/libnm-util/html/NMSettingCdma.html