<?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>karm: karmdcopiface.h Source File (karm)</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=".">karm</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>karm</h2> <!-- Generated by Doxygen 1.5.5 --> <h1>karmdcopiface.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 only:</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2004 Mark Bucciarelli <mark@hubcapconsulting.com></span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span> <a name="l00006"></a>00006 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00007"></a>00007 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span> <a name="l00008"></a>00008 <span class="comment"> * (at your option) any later version.</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * This program is distributed in the hope that it will be useful,</span> <a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00013"></a>00013 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00014"></a>00014 <span class="comment"> *</span> <a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License along</span> <a name="l00016"></a>00016 <span class="comment"> * with this program; if not, write to the</span> <a name="l00017"></a>00017 <span class="comment"> * Free Software Foundation, Inc.</span> <a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor</span> <a name="l00019"></a>00019 <span class="comment"> * Boston, MA 02110-1301 USA.</span> <a name="l00020"></a>00020 <span class="comment"> */</span> <a name="l00021"></a>00021 <span class="preprocessor">#ifndef KARM_DCOP_IFAC_H</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define KARM_DCOP_IFAC_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <dcopobject.h></span> <a name="l00025"></a>00025 <a name="l00027"></a><a class="code" href="classKarmDCOPIface.html">00027</a> <span class="keyword">class </span><a class="code" href="classKarmDCOPIface.html" title="Define DCOP interface to karm.">KarmDCOPIface</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> DCOPObject <a name="l00028"></a>00028 { <a name="l00029"></a>00029 K_DCOP <a name="l00030"></a>00030 k_dcop: <a name="l00031"></a>00031 <a name="l00033"></a>00033 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#9be11598b71744731e3e39342c4b21bb" title="Return karm version.">version</a>() <span class="keyword">const</span> = 0; <a name="l00034"></a>00034 <a name="l00036"></a>00036 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#f172ea6335f5381b9dcc3a26b89d3de5" title="Return id of task found, empty string if no match.">taskIdFromName</a>( <span class="keyword">const</span> QString& taskName ) <span class="keyword">const</span> = 0; <a name="l00037"></a>00037 <a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKarmDCOPIface.html#f0707d43497a01215b29cf796f7ef9a6" title="Add a new top-level task.">addTask</a>( <span class="keyword">const</span> QString& taskName ) = 0; <a name="l00048"></a>00048 <a name="l00057"></a>00057 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#97525787cb8318fb06ab32d688d7256e" title="Set percent complete to a task.">setPerCentComplete</a>( <span class="keyword">const</span> QString& taskName, <span class="keywordtype">int</span> perCent ) = 0; <a name="l00058"></a>00058 <a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKarmDCOPIface.html#4ca56cbfb2cde550aa400093c2c5d749" title="Add time to a task.">bookTime</a>( <span class="keyword">const</span> QString& taskId, <span class="keyword">const</span> QString& iso8601StartDateTime, <a name="l00078"></a>00078 <span class="keywordtype">long</span> durationInMinutes ) = 0; <a name="l00079"></a>00079 <a name="l00090"></a>00090 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#9ac6c63251cf61abd90dd3ecc2ad7e77" title="Return error string associated with karm error number.">getError</a>( <span class="keywordtype">int</span> karmErrorNumber ) <span class="keyword">const</span> = 0; <a name="l00091"></a>00091 <a name="l00100"></a>00100 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKarmDCOPIface.html#f1d71ccd7ed2f59e89830d6e8d3017c9" title="Total time currently associated with a task.">totalMinutesForTaskId</a>( <span class="keyword">const</span> QString& taskId ) = 0; <a name="l00101"></a>00101 <a name="l00103"></a>00103 <span class="comment">// may conflict with unitaskmode</span> <a name="l00104"></a>00104 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#4800d14b4ea9480f1b279f490e165c53" title="Start timer for all tasks with the summary taskname.">starttimerfor</a>( <span class="keyword">const</span> QString& taskname ) = 0; <a name="l00105"></a>00105 <a name="l00107"></a>00107 <span class="comment">// may conflict with unitaskmode</span> <a name="l00108"></a>00108 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#0ce08b3c6fe18d2a078777b59bc44f99" title="Stop timer for all tasks with the summary taskname.">stoptimerfor</a>( <span class="keyword">const</span> QString& taskname ) = 0; <a name="l00109"></a>00109 <a name="l00111"></a>00111 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#c811a7ebfee69237d61b257ce57e5231" title="delete the current item">deletetodo</a>() = 0; <a name="l00112"></a>00112 <a name="l00114"></a>00114 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#d3320d4153e7e2f8f8111cdda6bc10d0" title="set if prompted on deleting a task">setpromptdelete</a>( <span class="keywordtype">bool</span> prompt ) = 0; <a name="l00115"></a>00115 <a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKarmDCOPIface.html#4ae54e1e6345c30842591cf56ab59b1b" title="get if prompted on deleting a task">getpromptdelete</a>() = 0; <a name="l00118"></a>00118 <a name="l00120"></a>00120 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#f44678e6863850aefbfea94c4096e16c" title="export csv history or totals file">exportcsvfile</a>( QString filename, QString from, QString to, <span class="keywordtype">int</span> type = 0, <span class="keywordtype">bool</span> decimalMinutes=<span class="keyword">true</span>, <span class="keywordtype">bool</span> allTasks=<span class="keyword">true</span>, QString delimiter=<span class="stringliteral">";"</span>, QString quote=<span class="stringliteral">"'"</span> ) = 0; <a name="l00121"></a>00121 <a name="l00123"></a>00123 <span class="keyword">virtual</span> QString <a class="code" href="classKarmDCOPIface.html#dc015ea1f2e8a3b5b7d74bc4b328bbe0" title="import planner project file">importplannerfile</a>( QString filename ) = 0; <a name="l00124"></a>00124 <a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKarmDCOPIface.html#a2947b2710b3c19fc18ebda73d23e004" title="save your tasks">save</a>() = 0; <a name="l00127"></a>00127 <a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKarmDCOPIface.html#605188ba11e7124a68d3fdd5386afc73" title="Graceful shutdown.">quit</a>() = 0; <a name="l00130"></a>00130 }; <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="preprocessor">#endif // KARM_DCOP_IFAC_H</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>karm</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</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="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="classDesktopTracker.html">desktoptracker</option>, <option value="classEditTaskDialog.html">edittaskdialog</option>, <option value="classHistoryEvent.html">historyevent</option>, <option value="classIdleTimeDetector.html">idletimedetector</option>, <option value="classKAccelMenuWatch.html">kaccelmenuwatch</option>, <option value="classKarmDCOPIface.html">karmdcopiface</option>, <option value="classKarmStorage.html">karmstorage</option>, <option value="classKArmTimeWidget.html">karmtimewidget</option>, <option value="classMainWindow.html">mainwindow</option>, <option value="classMyPrinter.html">myprinter</option>, <option value="classPlannerParser.html">plannerparser</option>, <option value="classPreferences.html">preferences</option>, <option value="classReportCriteria.html">reportcriteria</option>, <option value="classTask.html">task</option>, <option value="classTaskView.html">taskview</option>, <option value="classTaskViewWhatsThis.html">taskviewwhatsthis</option>, <option value="classTimeKard.html">timekard</option>, <option value="classWeek.html">week</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>