Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 98d6b53e11e983e268c3e19f14e091a0 > files > 1406

kdepim-devel-doc-3.5.9-9mdv2008.1.x86_64.rpm

<?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: karm_part.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>karm_part.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _KARMPART_H_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _KARMPART_H_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;kparts/part.h&gt;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include "karmerrors.h"</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &lt;kparts/factory.h&gt;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &lt;karmdcopiface.h&gt;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include "reportcriteria.h"</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include &lt;qlistview.h&gt;</span>
<a name="l00010"></a>00010 
<a name="l00011"></a>00011 <span class="keyword">class </span>KAccel;
<a name="l00012"></a>00012 <span class="keyword">class </span><a class="code" href="classKAccelMenuWatch.html" title="Easy updating of menu accels when changing a KAccel object.">KAccelMenuWatch</a>;
<a name="l00013"></a>00013 <span class="keyword">class </span>KarmTray;
<a name="l00014"></a>00014 <span class="keyword">class </span>QWidget;
<a name="l00015"></a>00015 <span class="keyword">class </span>QPainter;
<a name="l00016"></a>00016 <span class="keyword">class </span>KURL;
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="keyword">class </span><a class="code" href="classPreferences.html" title="Provide an interface to the configuration options for the program.">Preferences</a>;
<a name="l00019"></a>00019 <span class="keyword">class </span><a class="code" href="classTask.html" title="A class representing a task.">Task</a>;
<a name="l00020"></a>00020 <span class="keyword">class </span><a class="code" href="classTaskView.html" title="Container and interface for the tasks.">TaskView</a>;
<a name="l00021"></a>00021 
<a name="l00030"></a><a class="code" href="classkarmPart.html">00030</a> <span class="keyword">class </span><a class="code" href="classkarmPart.html" title="This is a &amp;quot;Part&amp;quot;.">karmPart</a> : <span class="keyword">public</span> KParts::ReadWritePart, <span class="keyword">virtual</span> <span class="keyword">public</span> <a class="code" href="classKarmDCOPIface.html" title="Define DCOP interface to karm.">KarmDCOPIface</a>
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032   Q_OBJECT
<a name="l00033"></a>00033 
<a name="l00034"></a>00034   <span class="keyword">private</span>:
<a name="l00035"></a>00035     <span class="keywordtype">void</span>             makeMenus();
<a name="l00036"></a>00036     QString          _hastodo( <a class="code" href="classTask.html" title="A class representing a task.">Task</a>* task, <span class="keyword">const</span> QString &amp;taskname ) <span class="keyword">const</span>;
<a name="l00037"></a>00037     QString          _hasTask( <a class="code" href="classTask.html" title="A class representing a task.">Task</a>* task, <span class="keyword">const</span> QString &amp;taskname ) <span class="keyword">const</span>;
<a name="l00038"></a>00038     <a class="code" href="classTask.html" title="A class representing a task.">Task</a>*            _hasUid( <a class="code" href="classTask.html" title="A class representing a task.">Task</a>* task, <span class="keyword">const</span> QString &amp;uid ) <span class="keyword">const</span>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040     KAccel*          _accel;
<a name="l00041"></a>00041     <a class="code" href="classKAccelMenuWatch.html" title="Easy updating of menu accels when changing a KAccel object.">KAccelMenuWatch</a>* _watcher;
<a name="l00042"></a>00042     <a class="code" href="classTaskView.html" title="Container and interface for the tasks.">TaskView</a>*        _taskView;
<a name="l00043"></a>00043     <a class="code" href="classPreferences.html" title="Provide an interface to the configuration options for the program.">Preferences</a>*     _preferences;
<a name="l00044"></a>00044     KarmTray*        _tray;
<a name="l00045"></a>00045     KAction*         actionStart;
<a name="l00046"></a>00046     KAction*         actionStop;
<a name="l00047"></a>00047     KAction*         actionStopAll;
<a name="l00048"></a>00048     KAction*         actionDelete;
<a name="l00049"></a>00049     KAction*         actionEdit;
<a name="l00050"></a>00050 <span class="comment">//    KAction* actionAddComment;</span>
<a name="l00051"></a>00051     KAction*         actionMarkAsComplete;
<a name="l00052"></a>00052     KAction*         actionMarkAsIncomplete;
<a name="l00053"></a>00053     KAction*         actionPreferences;
<a name="l00054"></a>00054     KAction*         actionClipTotals;
<a name="l00055"></a>00055     KAction*         actionClipHistory;
<a name="l00056"></a>00056     QString          m_error[ KARM_MAX_ERROR_NO + 1 ];
<a name="l00057"></a>00057 
<a name="l00058"></a>00058     <span class="keyword">friend</span> <span class="keyword">class </span>KarmTray;
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="keyword">public</span>:
<a name="l00061"></a>00061     <a class="code" href="classkarmPart.html" title="This is a &amp;quot;Part&amp;quot;.">karmPart</a>(QWidget *parentWidget, <span class="keyword">const</span> <span class="keywordtype">char</span> *widgetName,
<a name="l00062"></a>00062              QObject *parent, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00063"></a>00063     <span class="comment">// DCOP</span>
<a name="l00064"></a>00064     <span class="keywordtype">void</span> <a class="code" href="classkarmPart.html#bc728d8da93ef069218ab4bcac1a59ec" title="Graceful shutdown.">quit</a>();
<a name="l00065"></a>00065     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classkarmPart.html#bb955c25e64cd8a0f2d7652331e6bf85" title="save your tasks">save</a>();
<a name="l00066"></a>00066     QString <a class="code" href="classkarmPart.html#d3353001fc9ae758b01f71df19813e64" title="Return karm version.">version</a>() <span class="keyword">const</span>;
<a name="l00067"></a>00067     QString <a class="code" href="classkarmPart.html#e80aa0a5f76f8b6b38712e4e3a4a4b26" title="Return id of task found, empty string if no match.">taskIdFromName</a>( <span class="keyword">const</span> QString &amp;taskName ) <span class="keyword">const</span>;
<a name="l00069"></a>00069     <span class="keywordtype">int</span> <a class="code" href="classkarmPart.html#c5712b371c7814dbe44d33c83b264806">addTask</a>( <span class="keyword">const</span> QString &amp;taskName );
<a name="l00071"></a>00071     QString <a class="code" href="classkarmPart.html#30de4080b1f8fa1f39d68124a92dfb1b">setPerCentComplete</a>( <span class="keyword">const</span> QString&amp; taskName, <span class="keywordtype">int</span> PerCent );
<a name="l00073"></a>00073     <span class="keywordtype">int</span> <a class="code" href="classkarmPart.html#d411815848abe3cd0bd03d7122796eb7">bookTime</a>( <span class="keyword">const</span> QString&amp; taskId, <span class="keyword">const</span> QString&amp; iso8601StartDateTime, <span class="keywordtype">long</span> durationInMinutes );
<a name="l00075"></a>00075     QString <a class="code" href="classkarmPart.html#60028d3e673f06157dae3e9b1b43eeb0">getError</a>( <span class="keywordtype">int</span> karmErrorNumber ) <span class="keyword">const</span>;
<a name="l00076"></a>00076     <span class="keywordtype">int</span> <a class="code" href="classkarmPart.html#9304cde9df11b2b5ff730ea444c75342" title="Total time currently associated with a task.">totalMinutesForTaskId</a>( <span class="keyword">const</span> QString&amp; taskId );
<a name="l00077"></a>00077     QString <a class="code" href="classkarmPart.html#01dc133af29a63197e96728ea79aee81" title="Start timer for all tasks with the summary taskname.">starttimerfor</a>( <span class="keyword">const</span> QString &amp;taskname );
<a name="l00078"></a>00078     QString <a class="code" href="classkarmPart.html#e86b5889eb7f48f828c3c742e8d18acc" title="Stop timer for all tasks with the summary taskname.">stoptimerfor</a>( <span class="keyword">const</span> QString &amp;taskname );
<a name="l00079"></a>00079     QString <a class="code" href="classkarmPart.html#45a9114bf4dbc1014f7cc4e416d3b260" title="delete the current item">deletetodo</a>();
<a name="l00080"></a>00080     <span class="keywordtype">bool</span>    <a class="code" href="classkarmPart.html#2b2a23c3309f738eafa8e8725856c183" title="get if prompted on deleting a task">getpromptdelete</a>();
<a name="l00081"></a>00081     QString <a class="code" href="classkarmPart.html#9881ea0826d978c55f2f814767e92223" title="set if prompted on deleting a task">setpromptdelete</a>( <span class="keywordtype">bool</span> prompt );
<a name="l00082"></a>00082     QString <a class="code" href="classkarmPart.html#a0f7264083449fffaf98c93ea836b4d4" 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">"r"</span>, QString quote=<span class="stringliteral">"q"</span> );
<a name="l00083"></a>00083     QString <a class="code" href="classkarmPart.html#f8ff5f5e881c86a4f938cce6676e1cff" title="import planner project file">importplannerfile</a>( QString filename );
<a name="l00084"></a>00084 
<a name="l00085"></a>00085     <span class="keyword">virtual</span> ~<a class="code" href="classkarmPart.html" title="This is a &amp;quot;Part&amp;quot;.">karmPart</a>();
<a name="l00086"></a>00086 
<a name="l00092"></a>00092     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classkarmPart.html#01791cf560e8f1eece1acb7ce2b127f6" title="This is a virtual function inherited from KParts::ReadWritePart.">setReadWrite</a>(<span class="keywordtype">bool</span> rw);
<a name="l00093"></a>00093 
<a name="l00097"></a>00097     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classkarmPart.html#1bac947eb5ba82d424999090ca9db7de" title="Reimplemented to disable and enable Save action.">setModified</a>(<span class="keywordtype">bool</span> modified);
<a name="l00098"></a>00098 
<a name="l00099"></a>00099 <span class="keyword">protected</span>:
<a name="l00103"></a>00103     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classkarmPart.html#f16dcf6b1dc200325feb9823915103b9" title="This must be implemented by each part.">openFile</a>();
<a name="l00104"></a>00104 
<a name="l00108"></a>00108     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classkarmPart.html#5284d929ced192174d47eaeaf0687acf" title="This must be implemented by each read-write part.">saveFile</a>();
<a name="l00109"></a>00109 
<a name="l00110"></a>00110 <span class="keyword">protected</span> slots:
<a name="l00111"></a>00111     <span class="keywordtype">void</span> contextMenuRequest( QListViewItem*, <span class="keyword">const</span> QPoint&amp; point, <span class="keywordtype">int</span> );
<a name="l00112"></a>00112     <span class="keywordtype">void</span> fileOpen();
<a name="l00113"></a>00113     <span class="keywordtype">void</span> fileSaveAs();
<a name="l00114"></a>00114     <span class="keywordtype">void</span> slotSelectionChanged();
<a name="l00115"></a>00115     <span class="keywordtype">void</span> startNewSession(); 
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="keyword">class </span>KInstance;
<a name="l00119"></a>00119 <span class="keyword">class </span>KAboutData;
<a name="l00120"></a>00120 
<a name="l00121"></a>00121 <span class="keyword">class </span>karmPartFactory : <span class="keyword">public</span> KParts::Factory
<a name="l00122"></a>00122 {
<a name="l00123"></a>00123     Q_OBJECT
<a name="l00124"></a>00124 <span class="keyword">public</span>:
<a name="l00125"></a>00125     karmPartFactory();
<a name="l00126"></a>00126     <span class="keyword">virtual</span> ~karmPartFactory();
<a name="l00127"></a>00127     <span class="keyword">virtual</span> KParts::Part* createPartObject( QWidget *parentWidget, <span class="keyword">const</span> <span class="keywordtype">char</span> *widgetName,
<a name="l00128"></a>00128                                             QObject *parent, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00129"></a>00129                                             <span class="keyword">const</span> <span class="keywordtype">char</span> *classname, <span class="keyword">const</span> QStringList &amp;args );
<a name="l00130"></a>00130     <span class="keyword">static</span> KInstance* instance();
<a name="l00131"></a>00131  
<a name="l00132"></a>00132 <span class="keyword">private</span>:
<a name="l00133"></a>00133     <span class="keyword">static</span> KInstance* s_instance;
<a name="l00134"></a>00134     <span class="keyword">static</span> KAboutData* s_about;
<a name="l00135"></a>00135 };
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="preprocessor">#endif // _KARMPART_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>&nbsp;&nbsp;<a href="../../akregator/src/html/index.html">src</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>