<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMAWifiDialog: libnma Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libnma Reference Manual">
<link rel="up" href="api-reference.html" title="libnma API reference">
<link rel="prev" href="NMAVpnPasswordDialog.html" title="NMAVpnPasswordDialog">
<link rel="next" href="NMACertChooser.html" title="NMACertChooser">
<meta name="generator" content="GTK-Doc V1.29.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#NMAWifiDialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#NMAWifiDialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="api-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="NMAVpnPasswordDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="NMACertChooser.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="NMAWifiDialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMAWifiDialog.top_of_page"></a>NMAWifiDialog</span></h2>
<p>NMAWifiDialog</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="NMAWifiDialog.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new" title="nma_wifi_dialog_new ()">nma_wifi_dialog_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new-for-secrets" title="nma_wifi_dialog_new_for_secrets ()">nma_wifi_dialog_new_for_secrets</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new-for-hidden" title="nma_wifi_dialog_new_for_hidden ()">nma_wifi_dialog_new_for_hidden</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new-for-create" title="nma_wifi_dialog_new_for_create ()">nma_wifi_dialog_new_for_create</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">NMConnection</span> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-get-connection" title="nma_wifi_dialog_get_connection ()">nma_wifi_dialog_get_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-nag-user" title="nma_wifi_dialog_nag_user ()">nma_wifi_dialog_nag_user</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-set-nag-ignored" title="nma_wifi_dialog_set_nag_ignored ()">nma_wifi_dialog_set_nag_ignored</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-get-nag-ignored" title="nma_wifi_dialog_get_nag_ignored ()">nma_wifi_dialog_get_nag_ignored</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new-for-other" title="nma_wifi_dialog_new_for_other ()">nma_wifi_dialog_new_for_other</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NMAWifiDialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk4/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk4/GtkBin.html#GtkBin-struct">GtkBin</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk4/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk4/GtkDialog.html#GtkDialog-struct">GtkDialog</a>
<span class="lineart">╰──</span> NMAWifiDialog
</pre>
</div>
<div class="refsect1">
<a name="NMAWifiDialog.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="NMAWifiDialog.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="nma-wifi-dialog-new"></a><h3>nma_wifi_dialog_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMClient.html#NMClient-struct"><span class="type">NMClient</span></a> *client</code></em>,
<em class="parameter"><code><span class="type">NMConnection</span> *connection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMDevice.html#NMDevice-struct"><span class="type">NMDevice</span></a> *device</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMAccessPoint.html#NMAccessPoint-struct"><span class="type">NMAccessPoint</span></a> *ap</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> secrets_only</code></em>);</pre>
<p>Creates a wifi connection dialog and populates it with settings from
<em class="parameter"><code>connection</code></em>
if given. If <em class="parameter"><code>device</code></em>
is not given a device selection combo box
will be included. If <em class="parameter"><code>connection</code></em>
is not given a connection selection combo
box will be included. If <em class="parameter"><code>secrets_only</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> a complete connection
creator/editor dialog is returned, otherwise only wifi security secrets
relevant to the security settings in <em class="parameter"><code>connection</code></em>
are going to be shown and
will be editable.</p>
<div class="refsect3">
<a name="nma-wifi-dialog-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client</p></td>
<td class="parameter_description"><p>client to retrieve list of devices or connections from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>connection to be shown/edited or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>device to check connection compatibility against</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ap</p></td>
<td class="parameter_description"><p>AP to check connection compatibility against</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secrets_only</p></td>
<td class="parameter_description"><p>whether to only ask for secrets for given connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nma-wifi-dialog-new.returns"></a><h4>Returns</h4>
<p> the dialog widget or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-new-for-secrets"></a><h3>nma_wifi_dialog_new_for_secrets ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_new_for_secrets (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMClient.html#NMClient-struct"><span class="type">NMClient</span></a> *client</code></em>,
<em class="parameter"><code><span class="type">NMConnection</span> *connection</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *secrets_setting_name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *const*secrets_hints</code></em>);</pre>
<p>Creates a wifi secrets dialog and populates it with setting values from
<em class="parameter"><code>connection</code></em>
. If <em class="parameter"><code>secrets_setting_name</code></em>
and <em class="parameter"><code>secrets_hints</code></em>
are not given
this function creates an identical dialog as <a class="link" href="NMAWifiDialog.html#nma-wifi-dialog-new" title="nma_wifi_dialog_new ()"><code class="function">nma_wifi_dialog_new()</code></a> would
create with the <em class="parameter"><code>secrets_only</code></em>
parameter <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. Otherwise
<em class="parameter"><code>secrets_setting_name</code></em>
and <em class="parameter"><code>secrets_hints</code></em>
determine the list of specific
secrets that are being requested from the user and no editable entries
are shown for any other settings.</p>
<p>Note: only a subset of all settings and setting keys is supported as
<em class="parameter"><code>secrets_setting_name</code></em>
and <em class="parameter"><code>secrets_hints</code></em>
.</p>
<div class="refsect3">
<a name="nma-wifi-dialog-new-for-secrets.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client</p></td>
<td class="parameter_description"><p>client to retrieve list of devices or connections from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>connection for which secrets are requested</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secrets_setting_name</p></td>
<td class="parameter_description"><p>setting name whose secrets are requested
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secrets_hints</p></td>
<td class="parameter_description"><p>array of setting key names within the setting given in
<em class="parameter"><code>secrets_setting_name</code></em>
which are requested or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nma-wifi-dialog-new-for-secrets.returns"></a><h4>Returns</h4>
<p> the dialog widget or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-new-for-hidden"></a><h3>nma_wifi_dialog_new_for_hidden ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_new_for_hidden (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMClient.html#NMClient-struct"><span class="type">NMClient</span></a> *client</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-new-for-create"></a><h3>nma_wifi_dialog_new_for_create ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_new_for_create (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMClient.html#NMClient-struct"><span class="type">NMClient</span></a> *client</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-get-connection"></a><h3>nma_wifi_dialog_get_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">NMConnection</span> *
nma_wifi_dialog_get_connection (<em class="parameter"><code><a class="link" href="NMAWifiDialog.html" title="NMAWifiDialog"><span class="type">NMAWifiDialog</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMDevice.html#NMDevice-struct"><span class="type">NMDevice</span></a> **device</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMAccessPoint.html#NMAccessPoint-struct"><span class="type">NMAccessPoint</span></a> **ap</code></em>);</pre>
<div class="refsect3">
<a name="nma-wifi-dialog-get-connection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>an <a class="link" href="NMAWifiDialog.html" title="NMAWifiDialog"><span class="type">NMAWifiDialog</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>ap</p></td>
<td class="parameter_description"><p>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nma-wifi-dialog-get-connection.returns"></a><h4>Returns</h4>
<p>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-nag-user"></a><h3>nma_wifi_dialog_nag_user ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_nag_user (<em class="parameter"><code><a class="link" href="NMAWifiDialog.html" title="NMAWifiDialog"><span class="type">NMAWifiDialog</span></a> *self</code></em>);</pre>
<div class="warning"><p><code class="literal">nma_wifi_dialog_nag_user</code> is deprecated and should not be used in newly-written code.</p></div>
<div class="refsect3">
<a name="nma-wifi-dialog-nag-user.returns"></a><h4>Returns</h4>
<p>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-set-nag-ignored"></a><h3>nma_wifi_dialog_set_nag_ignored ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nma_wifi_dialog_set_nag_ignored (<em class="parameter"><code><a class="link" href="NMAWifiDialog.html" title="NMAWifiDialog"><span class="type">NMAWifiDialog</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ignored</code></em>);</pre>
<div class="warning"><p><code class="literal">nma_wifi_dialog_set_nag_ignored</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-get-nag-ignored"></a><h3>nma_wifi_dialog_get_nag_ignored ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
nma_wifi_dialog_get_nag_ignored (<em class="parameter"><code><a class="link" href="NMAWifiDialog.html" title="NMAWifiDialog"><span class="type">NMAWifiDialog</span></a> *self</code></em>);</pre>
<div class="warning"><p><code class="literal">nma_wifi_dialog_get_nag_ignored</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="nma-wifi-dialog-new-for-other"></a><h3>nma_wifi_dialog_new_for_other ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk4/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
nma_wifi_dialog_new_for_other (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm/NMClient.html#NMClient-struct"><span class="type">NMClient</span></a> *client</code></em>);</pre>
<div class="warning"><p><code class="literal">nma_wifi_dialog_new_for_other</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
<div class="refsect1">
<a name="NMAWifiDialog.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29.1</div>
</body>
</html>