<?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>kandy: atcommand.h Source File (kandy)</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" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</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>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM 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_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">kandy</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;">
<h2><a name="content"></a>kandy</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>atcommand.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> This file is part of Kandy.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> As a special exception, permission is given to link this program</span>
<a name="l00021"></a>00021 <span class="comment"> with any edition of Qt, and distribute the resulting executable,</span>
<a name="l00022"></a>00022 <span class="comment"> without including the source code for Qt in the source distribution.</span>
<a name="l00023"></a>00023 <span class="comment">*/</span>
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef ATCOMMAND_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define ATCOMMAND_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <qstring.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <qstringlist.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <qptrlist.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">class </span>ATParameter {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00033"></a>00033 ATParameter();
<a name="l00034"></a>00034 ATParameter(<span class="keyword">const</span> QString &value,<span class="keyword">const</span> QString &name=<span class="stringliteral">""</span>,
<a name="l00035"></a>00035 <span class="keywordtype">bool</span> userInput=<span class="keyword">false</span>);
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keywordtype">void</span> setName(<span class="keyword">const</span> QString &name) { mName = name; }
<a name="l00038"></a>00038 QString name()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mName; }
<a name="l00039"></a>00039 <span class="keywordtype">void</span> setValue(<span class="keyword">const</span> QString &value) { mValue = value; }
<a name="l00040"></a>00040 QString value()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mValue; }
<a name="l00041"></a>00041 <span class="keywordtype">void</span> setUserInput(<span class="keywordtype">bool</span> userInput) { mUserInput = userInput; }
<a name="l00042"></a>00042 <span class="keywordtype">bool</span> userInput()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUserInput; }
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">private</span>:
<a name="l00045"></a>00045 QString mName;
<a name="l00046"></a>00046 QString mValue;
<a name="l00047"></a>00047 <span class="keywordtype">bool</span> mUserInput;
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00053"></a>00053 <span class="comment">// TODO: emit a signal, when the command was executed.</span>
<a name="l00054"></a><a class="code" href="classATCommand.html">00054</a> <span class="keyword">class </span><a class="code" href="classATCommand.html" title="This class provides an abstraction of an AT command.">ATCommand</a> {
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056 <a class="code" href="classATCommand.html" title="This class provides an abstraction of an AT command.">ATCommand</a>();
<a name="l00057"></a>00057 <a class="code" href="classATCommand.html" title="This class provides an abstraction of an AT command.">ATCommand</a>(<span class="keyword">const</span> QString &cmdString);
<a name="l00058"></a>00058 <a class="code" href="classATCommand.html" title="This class provides an abstraction of an AT command.">ATCommand</a>(<span class="keyword">const</span> QString &cmdName,<span class="keyword">const</span> QString &cmdString,
<a name="l00059"></a>00059 <span class="keywordtype">bool</span> hexOutput=<span class="keyword">false</span>);
<a name="l00060"></a>00060 <span class="keyword">virtual</span> ~<a class="code" href="classATCommand.html" title="This class provides an abstraction of an AT command.">ATCommand</a>();
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">void</span> setCmdName(<span class="keyword">const</span> QString &);
<a name="l00063"></a>00063 QString cmdName();
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">void</span> setCmdString(<span class="keyword">const</span> QString &);
<a name="l00066"></a>00066 QString cmdString();
<a name="l00067"></a>00067
<a name="l00068"></a>00068 QString cmd();
<a name="l00069"></a>00069
<a name="l00070"></a>00070 QString id();
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordtype">void</span> setHexOutput(<span class="keywordtype">bool</span>);
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> hexOutput();
<a name="l00074"></a>00074
<a name="l00075"></a>00075 QString processOutput(<span class="keyword">const</span> QString &);
<a name="l00076"></a>00076 QString processOutput();
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">void</span> setResultString(<span class="keyword">const</span> QString &);
<a name="l00079"></a>00079 QString resultString();
<a name="l00080"></a>00080 QString resultField(<span class="keywordtype">int</span> index);
<a name="l00081"></a>00081 QPtrList<QStringList> *resultFields();
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">void</span> addParameter(ATParameter *);
<a name="l00084"></a>00084 <span class="keywordtype">void</span> clearParameters();
<a name="l00085"></a>00085 QPtrList<ATParameter> parameters();
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordtype">void</span> setParameter(<span class="keywordtype">int</span> index,<span class="keyword">const</span> QString &value);
<a name="l00088"></a>00088 <span class="keywordtype">void</span> setParameter(<span class="keywordtype">int</span> index,<span class="keywordtype">int</span> value);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">void</span> setAutoDelete(<span class="keywordtype">bool</span> autoDelete) { mAutoDelete = autoDelete; }
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> autoDelete() { <span class="keywordflow">return</span> mAutoDelete; }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">private</span>:
<a name="l00094"></a>00094 <span class="keywordtype">void</span> construct();
<a name="l00095"></a>00095 <span class="keywordtype">void</span> setResultFields(QString fieldsString);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> extractParameters();
<a name="l00097"></a>00097
<a name="l00098"></a>00098 QString mCmdName;
<a name="l00099"></a>00099 QString mCmdString;
<a name="l00100"></a>00100 QString mId;
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> mHexOutput;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 QString mResultString;
<a name="l00104"></a>00104 QPtrList<QStringList> mResultFieldsList;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 QPtrList<ATParameter> mParameters;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keywordtype">bool</span> mAutoDelete;
<a name="l00109"></a>00109 };
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kandy</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</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="functions.html">Class Members</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="classATCommand.html">atcommand</option>, <option value="classCommandItem.html">commanditem</option>, <option value="classCommandSet.html">commandset</option>, <option value="classKandy.html">kandy</option>, <option value="classKandyPrefsDialog.html">kandyprefsdialog</option>, <option value="classKandyView.html">kandyview</option>, <option value="classMobileMain.html">mobilemain</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</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>
