source-git / gcr

Clone
Source Code
GIT

Files

  1.   b00eeb04ed99e7486f76dabe082c410d0627c81e
  2.   docs
  3.   reference
  4.   gcr
  5.   html
  6.   GcrPrompt.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrPrompt: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="prompts.html" title="Part IV. Prompting">
<link rel="prev" href="prompts.html" title="Part IV. Prompting">
<link rel="next" href="GcrPromptDialog.html" title="GcrPromptDialog">
<meta name="generator" content="GTK-Doc V1.27.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="#GcrPrompt.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GcrPrompt.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#GcrPrompt.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#GcrPrompt.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GcrPrompt.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GcrPrompt.signals" class="shortcut">Signals</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="prompts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="prompts.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GcrPromptDialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GcrPrompt"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GcrPrompt.top_of_page"></a>GcrPrompt</span></h2>
<p>GcrPrompt — a user prompt</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GcrPrompt.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">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-password" title="gcr_prompt_password ()">gcr_prompt_password</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="GcrPrompt.html#gcr-prompt-password-async" title="gcr_prompt_password_async ()">gcr_prompt_password_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-password-finish" title="gcr_prompt_password_finish ()">gcr_prompt_password_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-password-run" title="gcr_prompt_password_run ()">gcr_prompt_password_run</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-confirm" title="gcr_prompt_confirm ()">gcr_prompt_confirm</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="GcrPrompt.html#gcr-prompt-confirm-async" title="gcr_prompt_confirm_async ()">gcr_prompt_confirm_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-confirm-finish" title="gcr_prompt_confirm_finish ()">gcr_prompt_confirm_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-confirm-run" title="gcr_prompt_confirm_run ()">gcr_prompt_confirm_run</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="GcrPrompt.html#gcr-prompt-reset" title="gcr_prompt_reset ()">gcr_prompt_reset</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="GcrPrompt.html#gcr-prompt-close" title="gcr_prompt_close ()">gcr_prompt_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-title" title="gcr_prompt_get_title ()">gcr_prompt_get_title</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="GcrPrompt.html#gcr-prompt-set-title" title="gcr_prompt_set_title ()">gcr_prompt_set_title</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-message" title="gcr_prompt_get_message ()">gcr_prompt_get_message</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="GcrPrompt.html#gcr-prompt-set-message" title="gcr_prompt_set_message ()">gcr_prompt_set_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-description" title="gcr_prompt_get_description ()">gcr_prompt_get_description</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="GcrPrompt.html#gcr-prompt-set-description" title="gcr_prompt_set_description ()">gcr_prompt_set_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-warning" title="gcr_prompt_get_warning ()">gcr_prompt_get_warning</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="GcrPrompt.html#gcr-prompt-set-warning" title="gcr_prompt_set_warning ()">gcr_prompt_set_warning</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-continue-label" title="gcr_prompt_get_continue_label ()">gcr_prompt_get_continue_label</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="GcrPrompt.html#gcr-prompt-set-continue-label" title="gcr_prompt_set_continue_label ()">gcr_prompt_set_continue_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-cancel-label" title="gcr_prompt_get_cancel_label ()">gcr_prompt_get_cancel_label</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="GcrPrompt.html#gcr-prompt-set-cancel-label" title="gcr_prompt_set_cancel_label ()">gcr_prompt_set_cancel_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-choice-label" title="gcr_prompt_get_choice_label ()">gcr_prompt_get_choice_label</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="GcrPrompt.html#gcr-prompt-set-choice-label" title="gcr_prompt_set_choice_label ()">gcr_prompt_set_choice_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-choice-chosen" title="gcr_prompt_get_choice_chosen ()">gcr_prompt_get_choice_chosen</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="GcrPrompt.html#gcr-prompt-set-choice-chosen" title="gcr_prompt_set_choice_chosen ()">gcr_prompt_set_choice_chosen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-password-new" title="gcr_prompt_get_password_new ()">gcr_prompt_get_password_new</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="GcrPrompt.html#gcr-prompt-set-password-new" title="gcr_prompt_set_password_new ()">gcr_prompt_set_password_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-password-strength" title="gcr_prompt_get_password_strength ()">gcr_prompt_get_password_strength</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPrompt.html#gcr-prompt-get-caller-window" title="gcr_prompt_get_caller_window ()">gcr_prompt_get_caller_window</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="GcrPrompt.html#gcr-prompt-set-caller-window" title="gcr_prompt_set_caller_window ()">gcr_prompt_set_caller_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPrompt.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--caller-window" title="The “caller-window” property">caller-window</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--cancel-label" title="The “cancel-label” property">cancel-label</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--choice-chosen" title="The “choice-chosen” property">choice-chosen</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--choice-label" title="The “choice-label” property">choice-label</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--continue-label" title="The “continue-label” property">continue-label</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--description" title="The “description” property">description</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--message" title="The “message” property">message</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--password-new" title="The “password-new” property">password-new</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--password-strength" title="The “password-strength” property">password-strength</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--title" title="The “title” property">title</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GcrPrompt.html#GcrPrompt--warning" title="The “warning” property">warning</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPrompt.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GcrPrompt.html#GcrPrompt-prompt-close" title="The “prompt-close” signal">prompt-close</a></td>
<td class="signal_flags">Run First</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPrompt.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GcrPrompt.html#GcrPrompt-struct" title="GcrPrompt">GcrPrompt</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrPrompt.html#GcrPromptIface" title="struct GcrPromptIface">GcrPromptIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply">GcrPromptReply</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPrompt.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/home/dueno/jhbuild/install/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
    <span class="lineart">╰──</span> GcrPrompt
</pre>
</div>
<div class="refsect1">
<a name="GcrPrompt.prerequisites"></a><h2>Prerequisites</h2>
<p>
GcrPrompt requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="GcrPrompt.implementations"></a><h2>Known Implementations</h2>
<p>
GcrPrompt is implemented by
 <a class="link" href="GcrPromptDialog.html" title="GcrPromptDialog">GcrPromptDialog</a> and  <a class="link" href="GcrSystemPrompt.html" title="GcrSystemPrompt">GcrSystemPrompt</a>.</p>
</div>
<div class="refsect1">
<a name="GcrPrompt.description"></a><h2>Description</h2>
<p>A <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> represents a prompt displayed to the user. It is an interface
with various implementations.</p>
<p>Various properties are set on the prompt, and then the prompt is displayed
the various prompt methods like <a class="link" href="GcrPrompt.html#gcr-prompt-password-run" title="gcr_prompt_password_run ()"><code class="function">gcr_prompt_password_run()</code></a>.</p>
<p>A <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> may be used to display multiple related prompts. Most
implemantions do not hide the window between display of multiple related
prompts, and the <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> must be closed or destroyed in order to make
it go away. This allows the user to see that the prompts are related.</p>
<p>Use <a class="link" href="GcrPromptDialog.html" title="GcrPromptDialog"><span class="type">GcrPromptDialog</span></a> to create an in-process GTK+ dialog prompt. Use
<a class="link" href="GcrSystemPrompt.html" title="GcrSystemPrompt"><span class="type">GcrSystemPrompt</span></a> to create a system prompt in a prompter process.</p>
<p>The prompt implementation will always display the GcrPrompt:message property,
but may choose not to display the GcrPrompt:description or GcrPrompt:title
properties.</p>
</div>
<div class="refsect1">
<a name="GcrPrompt.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-prompt-password"></a><h3>gcr_prompt_password ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gcr_prompt_password (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                     <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                     <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Prompts for password. Set the various properties on the prompt before calling
this method to explain which password should be entered.</p>
<p>This method will block until the a response is returned from the prompter.</p>
<p>A password will be returned if the user enters a password successfully.
The returned password is valid until the next time a method is called
to display another prompt.</p>
<p><code class="literal">NULL</code> will be returned if the user cancels or if an error occurs. Check the
<em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-password.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-password.returns"></a><h4>Returns</h4>
<p> the password owned by the prompt, or <code class="literal">NULL</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-password-async"></a><h3>gcr_prompt_password_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_password_async (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                           <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                           <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                           <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Prompts for password. Set the various properties on the prompt before calling
this method to explain which password should be entered.</p>
<p>This method will return immediately and complete asynchronously.</p>
<div class="refsect3">
<a name="gcr-prompt-password-async.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-password-finish"></a><h3>gcr_prompt_password_finish ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gcr_prompt_password_finish (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                            <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                            <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Complete an operation to prompt for a password.</p>
<p>A password will be returned if the user enters a password successfully.
The returned password is valid until the next time a method is called
to display another prompt.</p>
<p><code class="literal">NULL</code> will be returned if the user cancels or if an error occurs. Check the
<em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-password-finish.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>asynchronous result passed to callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-password-finish.returns"></a><h4>Returns</h4>
<p> the password owned by the prompt, or <code class="literal">NULL</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-password-run"></a><h3>gcr_prompt_password_run ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gcr_prompt_password_run (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Prompts for password. Set the various properties on the prompt before calling
this method to explain which password should be entered.</p>
<p>This method will block until the a response is returned from the prompter
and will run a main loop similar to a <code class="function">gtk_dialog_run()</code>. The application
will remain responsive but care must be taken to handle reentrancy issues.</p>
<p>A password will be returned if the user enters a password successfully.
The returned password is valid until the next time a method is called
to display another prompt.</p>
<p><code class="literal">NULL</code> will be returned if the user cancels or if an error occurs. Check the
<em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-password-run.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-password-run.returns"></a><h4>Returns</h4>
<p> the password owned by the prompt, or <code class="literal">NULL</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-confirm"></a><h3>gcr_prompt_confirm ()</h3>
<pre class="programlisting"><a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
gcr_prompt_confirm (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                    <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                    <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Prompts for confirmation asking a cancel/continue style question.
Set the various properties on the prompt before calling this function to
represent the question correctly.</p>
<p>This method will block until the a response is returned from the prompter.</p>
<p><a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CONTINUE:CAPS"><code class="literal">GCR_PROMPT_REPLY_CONTINUE</code></a> will be returned if the user confirms the prompt. The
return value will also be <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CANCEL:CAPS"><code class="literal">GCR_PROMPT_REPLY_CANCEL</code></a> if the user cancels or if
an error occurs. Check the <em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-confirm.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-confirm.returns"></a><h4>Returns</h4>
<p> the reply from the prompt</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-confirm-async"></a><h3>gcr_prompt_confirm_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_confirm_async (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                          <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                          <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Prompts for confirmation asking a cancel/continue style question.
Set the various properties on the prompt before calling this method to
represent the question correctly.</p>
<p>This method will return immediately and complete asynchronously.</p>
<div class="refsect3">
<a name="gcr-prompt-confirm-async.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-confirm-finish"></a><h3>gcr_prompt_confirm_finish ()</h3>
<pre class="programlisting"><a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
gcr_prompt_confirm_finish (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                           <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                           <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Complete an operation to prompt for confirmation.</p>
<p><a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CONTINUE:CAPS"><code class="literal">GCR_PROMPT_REPLY_CONTINUE</code></a> will be returned if the user confirms the prompt. The
return value will also be <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CANCEL:CAPS"><code class="literal">GCR_PROMPT_REPLY_CANCEL</code></a> if the user cancels or if
an error occurs. Check the <em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-confirm-finish.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>asynchronous result passed to callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-confirm-finish.returns"></a><h4>Returns</h4>
<p> the reply from the prompt</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-confirm-run"></a><h3>gcr_prompt_confirm_run ()</h3>
<pre class="programlisting"><a class="link" href="GcrPrompt.html#GcrPromptReply" title="enum GcrPromptReply"><span class="returnvalue">GcrPromptReply</span></a>
gcr_prompt_confirm_run (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                        <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                        <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Prompts for confirmation asking a cancel/continue style question.
Set the various properties on the prompt before calling this function to
represent the question correctly.</p>
<p>This method will block until the a response is returned from the prompter
and will run a main loop similar to a <code class="function">gtk_dialog_run()</code>. The application
will remain responsive but care must be taken to handle reentrancy issues.</p>
<p><a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CONTINUE:CAPS"><code class="literal">GCR_PROMPT_REPLY_CONTINUE</code></a> will be returned if the user confirms the prompt. The
return value will also be <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CANCEL:CAPS"><code class="literal">GCR_PROMPT_REPLY_CANCEL</code></a> if the user cancels or if
an error occurs. Check the <em class="parameter"><code>error</code></em>
 argument to tell the difference.</p>
<div class="refsect3">
<a name="gcr-prompt-confirm-run.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional cancellation object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to place error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-confirm-run.returns"></a><h4>Returns</h4>
<p> the reply from the prompt</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-reset"></a><h3>gcr_prompt_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_reset (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Reset the contents and properties of the prompt.</p>
<div class="refsect3">
<a name="gcr-prompt-reset.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-close"></a><h3>gcr_prompt_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_close (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Closes the prompt so that in can no longer be used to prompt. The various
prompt methods will return results as if the user dismissed the prompt.</p>
<p>The prompt may also be closed by the implementor of the <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> object.</p>
<p>This emits the GcrPrompt::prompt-close signal on the prompt object.</p>
<div class="refsect3">
<a name="gcr-prompt-close.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>prompt</p></td>
<td class="parameter_description"><p>a prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-title"></a><h3>gcr_prompt_get_title ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_title (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Gets the title of the prompt.</p>
<p>A prompt implementation may choose not to display the prompt title. The
prompt message should contain relevant information.</p>
<div class="refsect3">
<a name="gcr-prompt-get-title.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-title.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the prompt
title. </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="gcr-prompt-set-title"></a><h3>gcr_prompt_set_title ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_title (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                      <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
<p>Sets the title of the prompt.</p>
<p>A prompt implementation may choose not to display the prompt title. The
prompt message should contain relevant information.</p>
<div class="refsect3">
<a name="gcr-prompt-set-title.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>the prompt title</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-message"></a><h3>gcr_prompt_get_message ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_message (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Gets the prompt message for the user.</p>
<p>A prompt implementation should always display this message.</p>
<div class="refsect3">
<a name="gcr-prompt-get-message.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-message.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the detailed
description of the prompt. </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="gcr-prompt-set-message"></a><h3>gcr_prompt_set_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_message (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>Sets the prompt message for the user.</p>
<p>A prompt implementation should always display this message.</p>
<div class="refsect3">
<a name="gcr-prompt-set-message.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>the prompt message</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-description"></a><h3>gcr_prompt_get_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_description (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get the detailed description of the prompt.</p>
<p>A prompt implementation may choose not to display this detailed description.
The prompt message should contain relevant information.</p>
<div class="refsect3">
<a name="gcr-prompt-get-description.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-description.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the detailed
description of the prompt. </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="gcr-prompt-set-description"></a><h3>gcr_prompt_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_description (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                            <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);</pre>
<p>Set the detailed description of the prompt.</p>
<p>A prompt implementation may choose not to display this detailed description.
Use <a class="link" href="GcrPrompt.html#gcr-prompt-set-message" title="gcr_prompt_set_message ()"><code class="function">gcr_prompt_set_message()</code></a> to set a general message containing relevant
information.</p>
<div class="refsect3">
<a name="gcr-prompt-set-description.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>description</p></td>
<td class="parameter_description"><p>the detailed description</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-warning"></a><h3>gcr_prompt_get_warning ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_warning (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get a prompt warning displayed on the prompt.</p>
<p>This is a warning like "The password is incorrect." usually displayed to the
user about a previous 'unsuccessful' prompt.</p>
<p>If this string is <code class="literal">NULL</code> then no warning is displayed.</p>
<div class="refsect3">
<a name="gcr-prompt-get-warning.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-warning.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the prompt
warning, or <code class="literal">NULL</code> if no warning. </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="gcr-prompt-set-warning"></a><h3>gcr_prompt_set_warning ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_warning (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *warning</code></em>);</pre>
<p>Set a prompt warning displayed on the prompt.</p>
<p>This is a warning like "The password is incorrect." usually displayed to the
user about a previous 'unsuccessful' prompt.</p>
<p>If this string is <code class="literal">NULL</code> then no warning is displayed.</p>
<div class="refsect3">
<a name="gcr-prompt-set-warning.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>warning</p></td>
<td class="parameter_description"><p>the warning or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-continue-label"></a><h3>gcr_prompt_get_continue_label ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_continue_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get the label for the continue button.</p>
<p>This is the button that results in a <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CONTINUE:CAPS"><code class="literal">GCR_PROMPT_REPLY_CONTINUE</code></a> reply
from the prompt.</p>
<div class="refsect3">
<a name="gcr-prompt-get-continue-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-continue-label.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the label. </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="gcr-prompt-set-continue-label"></a><h3>gcr_prompt_set_continue_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_continue_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                               <em class="parameter"><code>const <span class="type">gchar</span> *continue_label</code></em>);</pre>
<p>Set the label for the continue button.</p>
<p>This is the button that results in a <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CONTINUE:CAPS"><code class="literal">GCR_PROMPT_REPLY_CONTINUE</code></a> reply
from the prompt.</p>
<div class="refsect3">
<a name="gcr-prompt-set-continue-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>continue_label</p></td>
<td class="parameter_description"><p>the label</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-cancel-label"></a><h3>gcr_prompt_get_cancel_label ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_cancel_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get the label for the cancel button.</p>
<p>This is the button that results in a <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CANCEL:CAPS"><code class="literal">GCR_PROMPT_REPLY_CANCEL</code></a> reply
from the prompt.</p>
<div class="refsect3">
<a name="gcr-prompt-get-cancel-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-cancel-label.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the label. </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="gcr-prompt-set-cancel-label"></a><h3>gcr_prompt_set_cancel_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_cancel_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                             <em class="parameter"><code>const <span class="type">gchar</span> *cancel_label</code></em>);</pre>
<p>Set the label for the continue button.</p>
<p>This is the button that results in a <a class="link" href="GcrPrompt.html#GCR-PROMPT-REPLY-CANCEL:CAPS"><code class="literal">GCR_PROMPT_REPLY_CANCEL</code></a> reply
from the prompt.</p>
<div class="refsect3">
<a name="gcr-prompt-set-cancel-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancel_label</p></td>
<td class="parameter_description"><p>the label</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-choice-label"></a><h3>gcr_prompt_get_choice_label ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_choice_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get the label for the additional choice.</p>
<p>This will be <code class="literal">NULL</code> if no additional choice is being displayed.</p>
<div class="refsect3">
<a name="gcr-prompt-get-choice-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-choice-label.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the additional
choice or <code class="literal">NULL</code>. </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="gcr-prompt-set-choice-label"></a><h3>gcr_prompt_set_choice_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_choice_label (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                             <em class="parameter"><code>const <span class="type">gchar</span> *choice_label</code></em>);</pre>
<p>Set the label for the additional choice.</p>
<p>If this is a non-<code class="literal">NULL</code> value then an additional boolean choice will be
displayed by the prompt allowing the user to select or deselect it.</p>
<p>The initial value of the choice can be set with the
<a class="link" href="GcrPrompt.html#gcr-prompt-set-choice-label" title="gcr_prompt_set_choice_label ()"><code class="function">gcr_prompt_set_choice_label()</code></a> method.</p>
<p>If this is <code class="literal">NULL</code>, then no additional choice is being displayed.</p>
<div class="refsect3">
<a name="gcr-prompt-set-choice-label.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>choice_label</p></td>
<td class="parameter_description"><p>the additional choice or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-choice-chosen"></a><h3>gcr_prompt_get_choice_chosen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gcr_prompt_get_choice_chosen (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get whether the additional choice was chosen or not.</p>
<p>The additional choice would have been setup using
<a class="link" href="GcrPrompt.html#gcr-prompt-set-choice-label" title="gcr_prompt_set_choice_label ()"><code class="function">gcr_prompt_set_choice_label()</code></a>.</p>
<div class="refsect3">
<a name="gcr-prompt-get-choice-chosen.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-choice-chosen.returns"></a><h4>Returns</h4>
<p> whether chosen</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-set-choice-chosen"></a><h3>gcr_prompt_set_choice_chosen ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_choice_chosen (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                              <em class="parameter"><code><span class="type">gboolean</span> chosen</code></em>);</pre>
<p>Set whether the additional choice is chosen or not.</p>
<p>The additional choice should be set up using <a class="link" href="GcrPrompt.html#gcr-prompt-set-choice-label" title="gcr_prompt_set_choice_label ()"><code class="function">gcr_prompt_set_choice_label()</code></a>.</p>
<div class="refsect3">
<a name="gcr-prompt-set-choice-chosen.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chosen</p></td>
<td class="parameter_description"><p>whether chosen</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-password-new"></a><h3>gcr_prompt_get_password_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gcr_prompt_get_password_new (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get whether the prompt will prompt for a new password.</p>
<p>This will cause the prompt implementation to ask the user to confirm the
password and/or display other relevant user interface for creating a new
password.</p>
<div class="refsect3">
<a name="gcr-prompt-get-password-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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-password-new.returns"></a><h4>Returns</h4>
<p> whether in new password mode or not</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-set-password-new"></a><h3>gcr_prompt_set_password_new ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_password_new (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                             <em class="parameter"><code><span class="type">gboolean</span> new_password</code></em>);</pre>
<p>Set whether the prompt will prompt for a new password.</p>
<p>This will cause the prompt implementation to ask the user to confirm the
password and/or display other relevant user interface for creating a new
password.</p>
<div class="refsect3">
<a name="gcr-prompt-set-password-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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_password</p></td>
<td class="parameter_description"><p>whether in new password mode or not</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-password-strength"></a><h3>gcr_prompt_get_password_strength ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gcr_prompt_get_password_strength (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get indication of the password strength.</p>
<p>Prompts will return a zero value if the password is empty, and a value
greater than zero if the password has any characters.</p>
<p>This is only valid after a successful prompt for a password.</p>
<div class="refsect3">
<a name="gcr-prompt-get-password-strength.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-password-strength.returns"></a><h4>Returns</h4>
<p> zero if the password is empty, greater than zero if not</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-prompt-get-caller-window"></a><h3>gcr_prompt_get_caller_window ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gcr_prompt_get_caller_window (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>);</pre>
<p>Get the string handle of the caller's window.</p>
<p>The caller window indicates to the prompt which window is prompting the
user. The prompt may choose to ignore this information or use it in whatever
way it sees fit.</p>
<div class="refsect3">
<a name="gcr-prompt-get-caller-window.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-prompt-get-caller-window.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the string
handle of the window. </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="gcr-prompt-set-caller-window"></a><h3>gcr_prompt_set_caller_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_prompt_set_caller_window (<em class="parameter"><code><a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *prompt</code></em>,
                              <em class="parameter"><code>const <span class="type">gchar</span> *window_id</code></em>);</pre>
<p>Set the string handle of the caller's window.</p>
<p>The caller window indicates to the prompt which window is prompting the
user. The prompt may choose to ignore this information or use it in whatever
way it sees fit.</p>
<div class="refsect3">
<a name="gcr-prompt-set-caller-window.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>prompt</p></td>
<td class="parameter_description"><p>the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window_id</p></td>
<td class="parameter_description"><p>the window id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrPrompt.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrPrompt-struct"></a><h3>GcrPrompt</h3>
<pre class="programlisting">typedef struct _GcrPrompt GcrPrompt;</pre>
<p>Represents a <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> displayed to the user.</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPromptIface"></a><h3>struct GcrPromptIface</h3>
<pre class="programlisting">struct GcrPromptIface {
	GTypeInterface parent_iface;

	void               (* prompt_password_async)    (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	const gchar *      (* prompt_password_finish)   (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_confirm_async)     (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	GcrPromptReply     (* prompt_confirm_finish)    (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_close)             (GcrPrompt *prompt);
};
</pre>
<p>The interface for implementing <a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a>.</p>
<div class="refsect3">
<a name="GcrPromptIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="GcrPromptIface.parent-iface"></a>parent_iface</code></em>;</p></td>
<td class="struct_member_description"><p>parent interface</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GcrPromptIface.prompt-password-async"></a>prompt_password_async</code></em> ()</p></td>
<td class="struct_member_description"><p>begin a password prompt</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GcrPromptIface.prompt-password-finish"></a>prompt_password_finish</code></em> ()</p></td>
<td class="struct_member_description"><p>complete a password prompt</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GcrPromptIface.prompt-confirm-async"></a>prompt_confirm_async</code></em> ()</p></td>
<td class="struct_member_description"><p>begin a confirm prompt</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GcrPromptIface.prompt-confirm-finish"></a>prompt_confirm_finish</code></em> ()</p></td>
<td class="struct_member_description"><p>complete a confirm prompt</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GcrPromptIface.prompt-close"></a>prompt_close</code></em> ()</p></td>
<td class="struct_member_description"><p>close a prompt</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GcrPromptReply"></a><h3>enum GcrPromptReply</h3>
<p>Various replies returned by <a class="link" href="GcrPrompt.html#gcr-prompt-confirm" title="gcr_prompt_confirm ()"><code class="function">gcr_prompt_confirm()</code></a> and friends.</p>
<div class="refsect3">
<a name="GcrPromptReply.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GCR-PROMPT-REPLY-CANCEL:CAPS"></a>GCR_PROMPT_REPLY_CANCEL</p></td>
<td class="enum_member_description">
<p>the prompt was cancelled</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCR-PROMPT-REPLY-CONTINUE:CAPS"></a>GCR_PROMPT_REPLY_CONTINUE</p></td>
<td class="enum_member_description">
<p>the user replied with 'ok'</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrPrompt.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GcrPrompt--caller-window"></a><h3>The <code class="literal">“caller-window”</code> property</h3>
<pre class="programlisting">  “caller-window”            <span class="type">gchar</span> *</pre>
<p>The string handle of the caller's window.</p>
<p>The caller window indicates to the prompt which window is prompting the
user. The prompt may choose to ignore this information or use it in whatever
way it sees fit.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--cancel-label"></a><h3>The <code class="literal">“cancel-label”</code> property</h3>
<pre class="programlisting">  “cancel-label”             <span class="type">gchar</span> *</pre>
<p>The label for the cancel button in the prompt.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Cancel"</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--choice-chosen"></a><h3>The <code class="literal">“choice-chosen”</code> property</h3>
<pre class="programlisting">  “choice-chosen”            <span class="type">gboolean</span></pre>
<p>Whether the additional choice is chosen or not.</p>
<p>The additional choice would have been setup using <a class="link" href="GcrPrompt.html#GcrPrompt--choice-label" title="The “choice-label” property"><span class="type">“choice-label”</span></a>.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--choice-label"></a><h3>The <code class="literal">“choice-label”</code> property</h3>
<pre class="programlisting">  “choice-label”             <span class="type">gchar</span> *</pre>
<p>The label for the additional choice.</p>
<p>If this is a non-<code class="literal">NULL</code> value then an additional boolean choice will be
displayed by the prompt allowing the user to select or deselect it.</p>
<p>If <code class="literal">NULL</code>, then no additional choice is displayed.</p>
<p>The initial value of the choice can be set with <a class="link" href="GcrPrompt.html#GcrPrompt--choice-chosen" title="The “choice-chosen” property"><span class="type">“choice-chosen”</span></a>.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--continue-label"></a><h3>The <code class="literal">“continue-label”</code> property</h3>
<pre class="programlisting">  “continue-label”           <span class="type">gchar</span> *</pre>
<p>The label for the continue button in the prompt.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: "Continue"</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--description"></a><h3>The <code class="literal">“description”</code> property</h3>
<pre class="programlisting">  “description”              <span class="type">gchar</span> *</pre>
<p>The detailed description of the prompt.</p>
<p>A prompt implementation may choose not to display this detailed description.
The prompt message should contain relevant information.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--message"></a><h3>The <code class="literal">“message”</code> property</h3>
<pre class="programlisting">  “message”                  <span class="type">gchar</span> *</pre>
<p>The prompt message for the user.</p>
<p>A prompt implementation should always display this message.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--password-new"></a><h3>The <code class="literal">“password-new”</code> property</h3>
<pre class="programlisting">  “password-new”             <span class="type">gboolean</span></pre>
<p>Whether the prompt will prompt for a new password.</p>
<p>This will cause the prompt implementation to ask the user to confirm the
password and/or display other relevant user interface for creating a new
password.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--password-strength"></a><h3>The <code class="literal">“password-strength”</code> property</h3>
<pre class="programlisting">  “password-strength”        <span class="type">gint</span></pre>
<p>Indication of the password strength.</p>
<p>Prompts will return a zero value if the password is empty, and a value
greater than zero if the password has any characters.</p>
<p>This is only valid after a successful prompt for a password.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--title"></a><h3>The <code class="literal">“title”</code> property</h3>
<pre class="programlisting">  “title”                    <span class="type">gchar</span> *</pre>
<p>The title of the prompt.</p>
<p>A prompt implementation may choose not to display the prompt title. The
<a class="link" href="GcrPrompt.html#GcrPrompt--message" title="The “message” property"><span class="type">“message”</span></a> should contain relevant information.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPrompt--warning"></a><h3>The <code class="literal">“warning”</code> property</h3>
<pre class="programlisting">  “warning”                  <span class="type">gchar</span> *</pre>
<p>A prompt warning displayed on the prompt, or <code class="literal">NULL</code> for no warning.</p>
<p>This is a warning like "The password is incorrect." usually displayed to the
user about a previous 'unsuccessful' prompt.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GcrPrompt.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GcrPrompt-prompt-close"></a><h3>The <code class="literal">“prompt-close”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GcrPrompt.html" title="GcrPrompt"><span class="type">GcrPrompt</span></a> *gcrprompt,
               <span class="type">gpointer</span>   user_data)</pre>
<p>Action signal fired when the prompt is to be closed. After the default
handler has run, the prompt is closed. The various prompting methods
will return results as if the user dismissed the prompt.</p>
<p>You can use the <a class="link" href="GcrPrompt.html#gcr-prompt-close" title="gcr_prompt_close ()"><code class="function">gcr_prompt_close()</code></a> method to emit this signal.</p>
<div class="refsect3">
<a name="GcrPrompt-prompt-close.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>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation