<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kio/kio: KIO::AuthInfo Class Reference (kio/kio)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../../..">API Reference</a>
/ <a href="../../html/index.html">kio</a> / <a href=".">kio</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKIO.html">KIO</a> </li>
<li class="navelem"><a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KIO::AuthInfo Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KIO::AuthInfo" -->
<p>This class is intended to make it easier to prompt for, cache and retrieve authorization information.
<a href="classKIO_1_1AuthInfo.html#details">More...</a></p>
<p><code>#include <<a class="el" href="authinfo_8h_source.html">authinfo.h</a>></code></p>
<p><a href="classKIO_1_1AuthInfo-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a8fb6e847dad254df1ac93a01cbe55822">AuthInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a399bfad68bc8a0eb46d776683521c029">AuthInfo</a> (const <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> &info)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a67e76c710309babdbc8aa12fe4cbd993">operator=</a> (const <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> &info)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a078e06e077555d8bf793643874bb05ec">isModified</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a8f5ae80652bc6eb863f7362eca391b5e">setModified</a> (bool flag)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KURL </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#ae39069d497447ad0ce8ba4a2c39f3d71">url</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#abc129ff4f95d42a753c227a8923e06fe">username</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#ade45f65432bbf8dca0806e5f01f1b5ca">password</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#ae134d552753248d04e090e342108c864">prompt</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#aaf1bf0b4eb67bb3c4ef7f7fb00fec72d">caption</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a9d0e642bed9175c9585fa63b27225eed">comment</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#ae2d3878a3063c70f92f22d53b617652c">commentLabel</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a237d12ada4232f65b33f9f998f57d4b2">realmValue</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a08acc7ae9fd6ede95007c10b3b9f6b52">digestInfo</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a6e9d0fa2455eb89bb8c688f93e4952c8">verifyPath</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#aa62c5130b18da47c069935f77a6d0576">readOnly</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIO_1_1AuthInfo.html#a812e6bd7383b0735d8ff557d2b90f2fd">keepPassword</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a988643e7bb9be9b9f218259d76bcd6"></a><!-- doxytag: member="KIO::AuthInfo::modified" ref="a6a988643e7bb9be9b9f218259d76bcd6" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>modified</b></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac84da9fa21ead2cb673fc30d21530971"></a><!-- doxytag: member="KIO::AuthInfo::operator<<" ref="ac84da9fa21ead2cb673fc30d21530971" args="(QDataStream &s, const AuthInfo &a)" -->
KIO_EXPORT friend <a class="elRef" href="qdatastream.html">QDataStream</a> & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (<a class="elRef" href="qdatastream.html">QDataStream</a> &s, const <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> &a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adffab0f8294f9cbb34cfe26f04c64d70"></a><!-- doxytag: member="KIO::AuthInfo::operator>>" ref="adffab0f8294f9cbb34cfe26f04c64d70" args="(QDataStream &s, AuthInfo &a)" -->
KIO_EXPORT friend <a class="elRef" href="qdatastream.html">QDataStream</a> & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (<a class="elRef" href="qdatastream.html">QDataStream</a> &s, <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> &a)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is intended to make it easier to prompt for, cache and retrieve authorization information. </p>
<p>When using this class to cache, retrieve or prompt authentication information, you only need to set the necessary attributes. For example, to check whether a password is already cached, the only required information is the URL of the resource and optionally whether or not a path match should be performed. Similarly, to prompt for password you only need to optionally set the prompt, username (if already supplied), comment and commentLabel fields.</p>
<p><em>SPECIAL NOTE:</em> If you extend this class to add additional parameters do not forget to overload the stream insertion and extraction operators ("<<" and ">>") so that the added data can be correctly serialzed.</p>
<p>A two way messaging class for passing authentication information. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Dawit Alemayehu <<a href="mailto:adawit@kde.org">adawit@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00051">51</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8fb6e847dad254df1ac93a01cbe55822"></a><!-- doxytag: member="KIO::AuthInfo::AuthInfo" ref="a8fb6e847dad254df1ac93a01cbe55822" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AuthInfo::AuthInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="authinfo_8cpp_source.html#l00044">44</a> of file <a class="el" href="authinfo_8cpp_source.html">authinfo.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a399bfad68bc8a0eb46d776683521c029"></a><!-- doxytag: member="KIO::AuthInfo::AuthInfo" ref="a399bfad68bc8a0eb46d776683521c029" args="(const AuthInfo &info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AuthInfo::AuthInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> & </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="authinfo_8cpp_source.html#l00052">52</a> of file <a class="el" href="authinfo_8cpp_source.html">authinfo.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a078e06e077555d8bf793643874bb05ec"></a><!-- doxytag: member="KIO::AuthInfo::isModified" ref="a078e06e077555d8bf793643874bb05ec" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KIO::AuthInfo::isModified </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this method to check if the object was modified. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the object has been modified </dd></dl>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00076">76</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a67e76c710309babdbc8aa12fe4cbd993"></a><!-- doxytag: member="KIO::AuthInfo::operator=" ref="a67e76c710309babdbc8aa12fe4cbd993" args="(const AuthInfo &info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> & AuthInfo::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKIO_1_1AuthInfo.html">AuthInfo</a> & </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Overloaded equal to operator. </p>
<p>Definition at line <a class="el" href="authinfo_8cpp_source.html#l00057">57</a> of file <a class="el" href="authinfo_8cpp_source.html">authinfo.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8f5ae80652bc6eb863f7362eca391b5e"></a><!-- doxytag: member="KIO::AuthInfo::setModified" ref="a8f5ae80652bc6eb863f7362eca391b5e" args="(bool flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KIO::AuthInfo::setModified </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>flag</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this method to indicate that this object has been modified. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>true to mark the object as modified, false to clear </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00082">82</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aaf1bf0b4eb67bb3c4ef7f7fb00fec72d"></a><!-- doxytag: member="KIO::AuthInfo::caption" ref="aaf1bf0b4eb67bb3c4ef7f7fb00fec72d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#aaf1bf0b4eb67bb3c4ef7f7fb00fec72d">KIO::AuthInfo::caption</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The text to displayed in the title bar of the password prompting dialog. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If this field is not set, the authentication dialog simply displays the preset default caption.</dd></dl>
<p>This setting is <em>optional</em> and empty by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00126">126</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9d0e642bed9175c9585fa63b27225eed"></a><!-- doxytag: member="KIO::AuthInfo::comment" ref="a9d0e642bed9175c9585fa63b27225eed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#a9d0e642bed9175c9585fa63b27225eed">KIO::AuthInfo::comment</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Additional comment to be displayed when prompting the user for authentication information. </p>
<p>This field allows you to display a short (no more than 80 characters) extra description in the password prompt dialog. For example, this field along with the commentLabel can be used to describe the server that requested the authentication:</p>
<div class="fragment"><pre class="fragment"> Server: Squid Proxy @ foo.com
</pre></div><p>where "Server:" is the commentLabel and the rest is the actual comment. Note that it is always better to use the <code>commentLabel</code> field as it will be placed properly in the dialog rather than to include it within the actual comment.</p>
<p>This setting is <em>optional</em> and empty by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00150">150</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae2d3878a3063c70f92f22d53b617652c"></a><!-- doxytag: member="KIO::AuthInfo::commentLabel" ref="ae2d3878a3063c70f92f22d53b617652c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#ae2d3878a3063c70f92f22d53b617652c">KIO::AuthInfo::commentLabel</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Descriptive label to be displayed in front of the comment when prompting the user for password. </p>
<p>This setting is <em>optional</em> and only applicable when the comment field is also set. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00159">159</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a08acc7ae9fd6ede95007c10b3b9f6b52"></a><!-- doxytag: member="KIO::AuthInfo::digestInfo" ref="a08acc7ae9fd6ede95007c10b3b9f6b52" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#a08acc7ae9fd6ede95007c10b3b9f6b52">KIO::AuthInfo::digestInfo</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Field to store any extra authentication information for protocols that need it (ex: http). </p>
<p>This setting is <em>optional</em> and mostly applicable for HTTP protocol. However, any protocol can make use of it to store extra info. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00187">187</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a812e6bd7383b0735d8ff557d2b90f2fd"></a><!-- doxytag: member="KIO::AuthInfo::keepPassword" ref="a812e6bd7383b0735d8ff557d2b90f2fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classKIO_1_1AuthInfo.html#a812e6bd7383b0735d8ff557d2b90f2fd">KIO::AuthInfo::keepPassword</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flag to indicate the persistence of the given password. </p>
<p>This is a two-way flag, when set before calling openPassDlg it makes the "keep Password" check box visible to the user. In return the flag will indicate the state of the check box. By default if the flag is checked the password will be cached for the entire life of the current KDE session otherwise the cached password is deleted right after the application using it has been closed. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00220">220</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="ade45f65432bbf8dca0806e5f01f1b5ca"></a><!-- doxytag: member="KIO::AuthInfo::password" ref="ade45f65432bbf8dca0806e5f01f1b5ca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#ade45f65432bbf8dca0806e5f01f1b5ca">KIO::AuthInfo::password</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is <em>required</em> for caching. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00104">104</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae134d552753248d04e090e342108c864"></a><!-- doxytag: member="KIO::AuthInfo::prompt" ref="ae134d552753248d04e090e342108c864" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#ae134d552753248d04e090e342108c864">KIO::AuthInfo::prompt</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Information to be displayed when prompting the user for authentication information. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If this field is not set, the authentication dialog simply displays the preset default prompt.</dd></dl>
<p>This setting is <em>optional</em> and empty by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00115">115</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa62c5130b18da47c069935f77a6d0576"></a><!-- doxytag: member="KIO::AuthInfo::readOnly" ref="aa62c5130b18da47c069935f77a6d0576" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classKIO_1_1AuthInfo.html#aa62c5130b18da47c069935f77a6d0576">KIO::AuthInfo::readOnly</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flag which if set forces the username field to be read-only. </p>
<p>This setting is <em>optional</em> and false by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00207">207</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a237d12ada4232f65b33f9f998f57d4b2"></a><!-- doxytag: member="KIO::AuthInfo::realmValue" ref="a237d12ada4232f65b33f9f998f57d4b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#a237d12ada4232f65b33f9f998f57d4b2">KIO::AuthInfo::realmValue</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A unique identifier that allows caching of multiple passwords for different resources in the same server. </p>
<p>Mostly this setting is applicable to the HTTP protocol whose authentication scheme explicitly defines the use of such a unique key. However, any protocol that can generate or supply a unique id can effectively use it to distinguish passwords.</p>
<p>(If you are instead interested in caching the authentication info for multiple users to the same server, refer to multipleUserCaching below)</p>
<p>This setting is <em>optional</em> and not set by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00177">177</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae39069d497447ad0ce8ba4a2c39f3d71"></a><!-- doxytag: member="KIO::AuthInfo::url" ref="ae39069d497447ad0ce8ba4a2c39f3d71" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KURL <a class="el" href="classKIO_1_1AuthInfo.html#ae39069d497447ad0ce8ba4a2c39f3d71">KIO::AuthInfo::url</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The URL for which authentication is to be stored. </p>
<p>This field is required when attempting to cache authorization and retrieve it. However, it is not needed when prompting the user for authorization info.</p>
<p>This setting is <em>required</em> except when prompting the user for password. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00094">94</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="abc129ff4f95d42a753c227a8923e06fe"></a><!-- doxytag: member="KIO::AuthInfo::username" ref="abc129ff4f95d42a753c227a8923e06fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKIO_1_1AuthInfo.html#abc129ff4f95d42a753c227a8923e06fe">KIO::AuthInfo::username</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is <em>required</em> for caching. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00099">99</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6e9d0fa2455eb89bb8c688f93e4952c8"></a><!-- doxytag: member="KIO::AuthInfo::verifyPath" ref="a6e9d0fa2455eb89bb8c688f93e4952c8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classKIO_1_1AuthInfo.html#a6e9d0fa2455eb89bb8c688f93e4952c8">KIO::AuthInfo::verifyPath</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flag that, if set, indicates whether a path match should be performed when requesting for cached authorization. </p>
<p>A path is deemed to be a match if it is equal to or is a subset of the cached path. For example, if stored path is "/foo/bar" and the request's path set to "/foo/bar/acme", then it is a match whereas it would not if the request's path was set to "/foo".</p>
<p>This setting is <em>optional</em> and false by default. </p>
<p>Definition at line <a class="el" href="authinfo_8h_source.html#l00200">200</a> of file <a class="el" href="authinfo_8h_source.html">authinfo.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="authinfo_8h_source.html">authinfo.h</a></li>
<li><a class="el" href="authinfo_8cpp_source.html">authinfo.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kio/kio</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKACL.html">kacl</option>, <option value="classKAr.html">kar</option>, <option value="classKArchive.html">karchive</option>, <option value="classKArchiveDirectory.html">karchivedirectory</option>, <option value="classKArchiveEntry.html">karchiveentry</option>, <option value="classKArchiveFile.html">karchivefile</option>, <option value="classKAutoMount.html">kautomount</option>, <option value="classKAutoUnmount.html">kautounmount</option>, <option value="classKDataTool.html">kdatatool</option>, <option value="classKDataToolAction.html">kdatatoolaction</option>, <option value="classKDataToolInfo.html">kdatatoolinfo</option>, <option value="classKDCOPServiceStarter.html">kdcopservicestarter</option>, <option value="classKDEDesktopMimeType.html">kdedesktopmimetype</option>, <option value="classKDirLister.html">kdirlister</option>, <option value="classKDirNotify.html">kdirnotify</option>, <option value="classKDirWatch.html">kdirwatch</option>, <option value="classKEMailSettings.html">kemailsettings</option>, <option value="classKExecMimeType.html">kexecmimetype</option>, <option value="classKFileFilter.html">kfilefilter</option>, <option value="classKFileItem.html">kfileitem</option>, <option value="classKFileMetaInfo.html">kfilemetainfo</option>, <option value="classKFileMetaInfoGroup.html">kfilemetainfogroup</option>, <option value="classKFileMetaInfoItem.html">kfilemetainfoitem</option>, <option value="classKFileMimeTypeInfo.html">kfilemimetypeinfo</option>, <option value="classKFileMimeTypeInfo_1_1GroupInfo.html">kfilemimetypeinfo::groupinfo</option>, <option value="classKFileMimeTypeInfo_1_1ItemInfo.html">kfilemimetypeinfo::iteminfo</option>, <option value="classKFilePlugin.html">kfileplugin</option>, <option value="classKFileShare.html">kfileshare</option>, <option value="classKFilterBase.html">kfilterbase</option>, <option value="classKFilterDev.html">kfilterdev</option>, <option value="classKFolderType.html">kfoldertype</option>, <option value="classKImageIO.html">kimageio</option>, <option value="classKIO_1_1AuthInfo.html">kio::authinfo</option>, <option value="classKIO_1_1ChmodJob.html">kio::chmodjob</option>, <option value="classKIO_1_1Connection.html">kio::connection</option>, <option value="classKIO_1_1CopyJob.html">kio::copyjob</option>, <option value="classKIO_1_1DataProtocol.html">kio::dataprotocol</option>, <option value="classKIO_1_1DataSlave.html">kio::dataslave</option>, <option value="classKIO_1_1DavJob.html">kio::davjob</option>, <option value="classKIO_1_1DeleteJob.html">kio::deletejob</option>, <option value="classKIO_1_1FileCopyJob.html">kio::filecopyjob</option>, <option value="classKIO_1_1ForwardingSlaveBase.html">kio::forwardingslavebase</option>, <option value="classKIO_1_1Job.html">kio::job</option>, <option value="classKIO_1_1ListJob.html">kio::listjob</option>, <option value="classKIO_1_1MetaData.html">kio::metadata</option>, <option value="classKIO_1_1MetaInfoJob.html">kio::metainfojob</option>, <option value="classKIO_1_1MimetypeJob.html">kio::mimetypejob</option>, <option value="classKIO_1_1MkdirJob.html">kio::mkdirjob</option>, <option value="classKIO_1_1MultiGetJob.html">kio::multigetjob</option>, <option value="classKIO_1_1NetAccess.html">kio::netaccess</option>, <option value="classKIO_1_1NetRC.html">kio::netrc</option>, <option value="classKIO_1_1PasswordDialog.html">kio::passworddialog</option>, <option value="classKIO_1_1PreviewJob.html">kio::previewjob</option>, <option value="classKIO_1_1ProgressBase.html">kio::progressbase</option>, <option value="classKIO_1_1RenameDlg.html">kio::renamedlg</option>, <option value="classKIO_1_1Scheduler.html">kio::scheduler</option>, <option value="classKIO_1_1SimpleJob.html">kio::simplejob</option>, <option value="classKIO_1_1Slave.html">kio::slave</option>, <option value="classKIO_1_1SlaveBase.html">kio::slavebase</option>, <option value="classKIO_1_1SlaveConfig.html">kio::slaveconfig</option>, <option value="classKIO_1_1SlaveInterface.html">kio::slaveinterface</option>, <option value="classKIO_1_1StatJob.html">kio::statjob</option>, <option value="classKIO_1_1StatusbarProgress.html">kio::statusbarprogress</option>, <option value="classKIO_1_1StoredTransferJob.html">kio::storedtransferjob</option>, <option value="classKIO_1_1TCPSlaveBase.html">kio::tcpslavebase</option>, <option value="classKIO_1_1TransferJob.html">kio::transferjob</option>, <option value="classKLimitedIODevice.html">klimitediodevice</option>, <option value="classKMimeMagic.html">kmimemagic</option>, <option value="classKMimeMagicResult.html">kmimemagicresult</option>, <option value="classKMimeType.html">kmimetype</option>, <option value="classKMimeTypeChooser.html">kmimetypechooser</option>, <option value="classKMimeTypeChooserDialog.html">kmimetypechooserdialog</option>, <option value="classKMimeTypeResolver.html">kmimetyperesolver</option>, <option value="classKNFSShare.html">knfsshare</option>, <option value="classKOCRDialog.html">kocrdialog</option>, <option value="classKOCRDialogFactory.html">kocrdialogfactory</option>, <option value="classKOpenWithHandler.html">kopenwithhandler</option>, <option value="classKProtocolInfo.html">kprotocolinfo</option>, <option value="classKProtocolManager.html">kprotocolmanager</option>, <option value="classKRemoteEncoding.html">kremoteencoding</option>, <option value="classKRun.html">krun</option>, <option value="classKSambaShare.html">ksambashare</option>, <option value="classKScanDialog.html">kscandialog</option>, <option value="classKScanDialogFactory.html">kscandialogfactory</option>, <option value="classKService.html">kservice</option>, <option value="classKServiceGroup.html">kservicegroup</option>, <option value="classKServiceOffer.html">kserviceoffer</option>, <option value="classKServiceType.html">kservicetype</option>, <option value="classKServiceTypeProfile.html">kservicetypeprofile</option>, <option value="classKShellCompletion.html">kshellcompletion</option>, <option value="classKShred.html">kshred</option>, <option value="classKSimpleFileFilter.html">ksimplefilefilter</option>, <option value="classKTar.html">ktar</option>, <option value="classKTrader.html">ktrader</option>, <option value="classKURIFilter.html">kurifilter</option>, <option value="classKURIFilterData.html">kurifilterdata</option>, <option value="classKURIFilterPlugin.html">kurifilterplugin</option>, <option value="classKURIFilterPluginList.html">kurifilterpluginlist</option>, <option value="classKURLCompletion.html">kurlcompletion</option>, <option value="classKURLPixmapProvider.html">kurlpixmapprovider</option>, <option value="classKZip.html">kzip</option>, <option value="classObserver.html">observer</option>, <option value="classRenameDlgPlugin.html">renamedlgplugin</option>, <option value="classThumbCreator.html">thumbcreator</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../arts/html/index.html">arts</a></li><li><a href="../../../dcop/html/index.html">dcop</a></li><li><a href="../../../dnssd/html/index.html">dnssd</a></li><li><a href="../../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kate/html/index.html">kate</a></li><li><a href="../../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../../kdecore/html/index.html">kdecore</a></li><li><a href="../../../kded/html/index.html">kded</a></li><li><a href="../../../kdefx/html/index.html">kdefx</a></li><li><a href="../../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../../kdesu/html/index.html">kdesu</a></li><li><a href="../../../kdeui/html/index.html">kdeui</a></li><li><a href="../../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../../khtml/html/index.html">khtml</a></li><li><a href="../../../kimgio/html/index.html">kimgio</a></li><li><a href="../../../kinit/html/index.html">kinit</a></li><li><a href="../../../kio/html/index.html">kio</a></li><li> <a href="../../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../../kio/kio/html/index.html">kio</a></li><li> <a href="../../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/http/html/index.html">http</a></li><li><a href="../../../kjs/html/index.html">kjs</a></li><li><a href="../../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../../kparts/html/index.html">kparts</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../kspell2/html/index.html">kspell2</a></li><li><a href="../../../kunittest/html/index.html">kunittest</a></li><li><a href="../../../kutils/html/index.html">kutils</a></li><li><a href="../../../kwallet/html/index.html">kwallet</a></li><li><a href="../../../libkmid/html/index.html">libkmid</a></li><li><a href="../../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
