• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

KonsoleKalendar

  • sources
  • kde-4.12
  • kdepim
  • console
  • konsolekalendar
konsolekalendarvariables.h
Go to the documentation of this file.
1 /******************************************************************************
2  * konsolekalendarvariables.h *
3  * *
4  * KonsoleKalendar is a command line interface to KDE calendars *
5  * Copyright (C) 2002-2004 Tuukka Pasanen <illuusio@mailcity.com> *
6  * Copyright (C) 2003-2005 Allen Winter <winter@kde.org> *
7  * *
8  * This program is free software; you can redistribute it and/or modify *
9  * it under the terms of the GNU General Public License as published by *
10  * the Free Software Foundation; either version 2 of the License, or *
11  * (at your option) any later version. *
12  * *
13  * This program is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16  * GNU General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU General Public License along *
19  * with this program; if not, write to the Free Software Foundation, Inc., *
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
21  * *
22  * As a special exception, permission is given to link this program *
23  * with any edition of Qt, and distribute the resulting executable, *
24  * without including the source code for Qt in the source distribution. *
25  * *
26  *****************************************************************************/
27 
28 #ifndef KONSOLEKALENDARVARIABLES_H
29 #define KONSOLEKALENDARVARIABLES_H
30 
31 #include <KCalCore/Event>
32 #include <Akonadi/Calendar/FetchJobCalendar>
33 #include <Akonadi/Collection>
34 
35 #include <QtCore/QString>
36 #include <QtCore/QDateTime>
37 
46 enum ExportType {
48  ExportTypeNone,
50  ExportTypeText,
52  ExportTypeTextShort,
54  ExportTypeHTML,
56  ExportTypeMonthHTML,
58  ExportTypeXHTML,
60  ExportTypeXML,
62  ExportTypeCSV,
64  ExportTypeVCard
65 };
66 
73 class KonsoleKalendarVariables
74 {
75  public:
79  KonsoleKalendarVariables();
83  ~KonsoleKalendarVariables();
84 
89  void setUseEvents( bool useEvents );
94  bool getUseEvents() const;
95 
100  void setUseTodos( bool useTodos );
105  bool getUseTodos() const;
106 
111  void setUseJournals( bool useJournals );
116  bool getUseJournals() const;
117 
122  void setStartDateTime( const QDateTime &start );
123 
128  QDateTime getStartDateTime() const;
129 
134  bool isStartDateTime() const;
135 
140  void setEndDateTime( const QDateTime &end );
141 
146  QDateTime getEndDateTime() const;
147 
152  bool isEndDateTime() const;
153 
158  void setUID( const QString &uid );
159 
164  QString getUID() const;
165 
170  bool isUID() const;
171 
176  void setNext( bool next );
177 
181  bool isNext() const;
182 
187  void setVerbose( bool verbose );
188 
192  bool isVerbose() const;
193 
198  void setDryRun( bool dryrun );
199 
204  bool isDryRun() const;
205 
210  void setCalendarFile( const QString &calendar );
211 
216  QString getCalendarFile() const;
217 
222  void setImportFile( const QString &calendar );
223 
228  QString getImportFile() const;
229 
234  void setDescription( const QString &description );
235 
240  QString getDescription() const;
241 
246  bool isDescription() const;
247 
252  void setLocation( const QString &location );
253 
258  QString getLocation() const;
259 
264  bool isLocation() const;
265 
270  void setSummary( const QString &summary );
271 
276  QString getSummary() const;
277 
282  bool isSummary() const;
283 
288  void setAll( bool all );
292  bool getAll() const;
296  bool isAll() const;
297 
302  void setFloating( bool floating );
303 
307  bool getFloating() const;
308 
314  void setCalendar( const Akonadi::FetchJobCalendar::Ptr & );
315 
319  Akonadi::FetchJobCalendar::Ptr getCalendar() const;
320 
326  void setExportFile( const QString &export_file );
327 
331  QString getExportFile() const;
332 
336  bool isExportFile() const;
337 
343  void setExportType( ExportType exportType );
344 
348  ExportType getExportType() const;
349 
355  void setDaysCount( int count );
356 
360  bool isDaysCount() const;
361 
365  int getDaysCount() const;
366 
370  void setAllowGui( bool allow );
371 
372  void setCollectionId(Akonadi::Collection::Id);
373  Akonadi::Collection::Id collectionId() const;
374 
378  bool allowGui() const;
379 
380  private:
381  //@cond PRIVATE
382  bool m_bIsUID;
383  QString m_UID;
384  bool m_bIsStartDateTime;
385  QDateTime m_startDateTime;
386  bool m_bIsEndDateTime;
387  QDateTime m_endDateTime;
388  bool m_bNext;
389  bool m_bVerbose;
390  bool m_bDryRun;
391  bool m_bUseEvents;
392  bool m_bUseTodos;
393  bool m_bUseJournals;
394  QString m_calendarFile;
395  QString m_import;
396  ExportType m_exportType;
397  bool m_bIsExportFile;
398  QString m_exportFile;
399  bool m_bAll;
400  bool m_bDescription;
401  QString m_description;
402  bool m_bLocation;
403  QString m_location;
404  bool m_bSummary;
405  QString m_summary;
406  bool m_bFloating;
407  bool m_bDaysCount;
408  int m_daysCount;
409  bool m_bAllowGui;
410  Akonadi::Collection::Id m_collectionId;
411  Akonadi::FetchJobCalendar::Ptr m_calendar;
412  //@endcond
413 };
414 
415 #endif
ExportTypeMonthHTML
Export HTML for the time span on month boundaries.
Definition: konsolekalendarvariables.h:56
KonsoleKalendarVariables::KonsoleKalendarVariables
KonsoleKalendarVariables()
Construct an empty KonsoleKalendarVariables object.
Definition: konsolekalendarvariables.cpp:54
KonsoleKalendarVariables::getExportType
ExportType getExportType() const
What export type to use.
Definition: konsolekalendarvariables.cpp:225
KonsoleKalendarVariables::setAll
void setAll(bool all)
View all option.
Definition: konsolekalendarvariables.cpp:251
ExportTypeNone
Export none.
Definition: konsolekalendarvariables.h:48
KonsoleKalendarVariables::getCalendarFile
QString getCalendarFile() const
Returns fullpath to calendar file.
Definition: konsolekalendarvariables.cpp:195
KonsoleKalendarVariables::getUseTodos
bool getUseTodos() const
Get use Todos switch.
Definition: konsolekalendarvariables.cpp:175
KonsoleKalendarVariables::setDescription
void setDescription(const QString &description)
Add description.
Definition: konsolekalendarvariables.cpp:261
KonsoleKalendarVariables::getStartDateTime
QDateTime getStartDateTime() const
Get start date.
Definition: konsolekalendarvariables.cpp:104
KonsoleKalendarVariables::isDaysCount
bool isDaysCount() const
Is there some cound of days should be seen.
Definition: konsolekalendarvariables.cpp:330
KonsoleKalendarVariables::setUseJournals
void setUseJournals(bool useJournals)
Set switch to use Journals.
Definition: konsolekalendarvariables.cpp:180
KonsoleKalendarVariables::setDaysCount
void setDaysCount(int count)
Sets how many day should be seen.
Definition: konsolekalendarvariables.cpp:319
KonsoleKalendarVariables::setAllowGui
void setAllowGui(bool allow)
Sets whether to allow using resources with potential GUI dependencies.
Definition: konsolekalendarvariables.cpp:335
KonsoleKalendarVariables::setStartDateTime
void setStartDateTime(const QDateTime &start)
Sets start date.
Definition: konsolekalendarvariables.cpp:98
KonsoleKalendarVariables::getExportFile
QString getExportFile() const
To what file we'll output.
Definition: konsolekalendarvariables.cpp:241
KonsoleKalendarVariables::collectionId
Akonadi::Collection::Id collectionId() const
Definition: konsolekalendarvariables.cpp:345
KonsoleKalendarVariables::getSummary
QString getSummary() const
Get summary.
Definition: konsolekalendarvariables.cpp:299
ExportTypeTextShort
Export as compact text.
Definition: konsolekalendarvariables.h:52
KonsoleKalendarVariables::setVerbose
void setVerbose(bool verbose)
Should program be more verbose?
Definition: konsolekalendarvariables.cpp:140
KonsoleKalendarVariables
This class provides all the variables for the program.
Definition: konsolekalendarvariables.h:73
KonsoleKalendarVariables::isUID
bool isUID() const
Is there UID set?
Definition: konsolekalendarvariables.cpp:93
KonsoleKalendarVariables::isEndDateTime
bool isEndDateTime() const
Is there end date?
Definition: konsolekalendarvariables.cpp:125
KonsoleKalendarVariables::isAll
bool isAll() const
Is the all option set?
Definition: konsolekalendarvariables.cpp:246
KonsoleKalendarVariables::getDescription
QString getDescription() const
Return description.
Definition: konsolekalendarvariables.cpp:267
KonsoleKalendarVariables::getUseJournals
bool getUseJournals() const
Get use Journals switch.
Definition: konsolekalendarvariables.cpp:185
KonsoleKalendarVariables::setLocation
void setLocation(const QString &location)
Add location information.
Definition: konsolekalendarvariables.cpp:277
KonsoleKalendarVariables::allowGui
bool allowGui() const
Returns whether to allow using resources with potential GUI dependencies.
Definition: konsolekalendarvariables.cpp:350
KonsoleKalendarVariables::getEndDateTime
QDateTime getEndDateTime() const
Get end date.
Definition: konsolekalendarvariables.cpp:120
KonsoleKalendarVariables::setNext
void setNext(bool next)
Show only next activity and exit.
Definition: konsolekalendarvariables.cpp:130
KonsoleKalendarVariables::setCollectionId
void setCollectionId(Akonadi::Collection::Id)
Definition: konsolekalendarvariables.cpp:340
KonsoleKalendarVariables::~KonsoleKalendarVariables
~KonsoleKalendarVariables()
Destructor.
Definition: konsolekalendarvariables.cpp:78
KonsoleKalendarVariables::setExportFile
void setExportFile(const QString &export_file)
Sets the output file name to export_file.
Definition: konsolekalendarvariables.cpp:230
KonsoleKalendarVariables::setSummary
void setSummary(const QString &summary)
Add summary.
Definition: konsolekalendarvariables.cpp:293
KonsoleKalendarVariables::isSummary
bool isSummary() const
Is there an event summary?
Definition: konsolekalendarvariables.cpp:304
KonsoleKalendarVariables::getFloating
bool getFloating() const
Returns if Event is floating.
Definition: konsolekalendarvariables.cpp:314
KonsoleKalendarVariables::getImportFile
QString getImportFile() const
Return import filename.
Definition: konsolekalendarvariables.cpp:205
KonsoleKalendarVariables::setUID
void setUID(const QString &uid)
Sets the UID, the unique tag for VCard entry.
Definition: konsolekalendarvariables.cpp:82
KonsoleKalendarVariables::isExportFile
bool isExportFile() const
Has an Export File been set?
Definition: konsolekalendarvariables.cpp:236
KonsoleKalendarVariables::setUseEvents
void setUseEvents(bool useEvents)
Set switch to use Events.
Definition: konsolekalendarvariables.cpp:160
ExportType
ExportType
ExportType is the type of Export output.
Definition: konsolekalendarvariables.h:46
KonsoleKalendarVariables::setDryRun
void setDryRun(bool dryrun)
Should we only try to run it and do nothing?
Definition: konsolekalendarvariables.cpp:150
KonsoleKalendarVariables::isNext
bool isNext() const
Should we show only next activity and exit?
Definition: konsolekalendarvariables.cpp:135
ExportTypeHTML
Export HTML for the specified time span.
Definition: konsolekalendarvariables.h:54
ExportTypeXHTML
Export XHTML (NOT AVAILABLE YET)
Definition: konsolekalendarvariables.h:58
KonsoleKalendarVariables::setImportFile
void setImportFile(const QString &calendar)
Set file to import active calendar.
Definition: konsolekalendarvariables.cpp:200
KonsoleKalendarVariables::isDescription
bool isDescription() const
Is there an event description?
Definition: konsolekalendarvariables.cpp:272
KonsoleKalendarVariables::isStartDateTime
bool isStartDateTime() const
Is there start date?
Definition: konsolekalendarvariables.cpp:109
KonsoleKalendarVariables::getUID
QString getUID() const
Get UID, the unique tag for VCard entry.
Definition: konsolekalendarvariables.cpp:88
KonsoleKalendarVariables::setFloating
void setFloating(bool floating)
Set if Event is floating.
Definition: konsolekalendarvariables.cpp:309
KonsoleKalendarVariables::getUseEvents
bool getUseEvents() const
Get use Events switch.
Definition: konsolekalendarvariables.cpp:165
KonsoleKalendarVariables::setEndDateTime
void setEndDateTime(const QDateTime &end)
Sets end date.
Definition: konsolekalendarvariables.cpp:114
KonsoleKalendarVariables::getDaysCount
int getDaysCount() const
Get how many day should be seen.
Definition: konsolekalendarvariables.cpp:325
KonsoleKalendarVariables::setExportType
void setExportType(ExportType exportType)
Sets the ExportType to use.
Definition: konsolekalendarvariables.cpp:220
KonsoleKalendarVariables::getAll
bool getAll() const
Return all option.
Definition: konsolekalendarvariables.cpp:256
KonsoleKalendarVariables::setCalendar
void setCalendar(const Akonadi::FetchJobCalendar::Ptr &)
Sets the calendar resources for global use.
Definition: konsolekalendarvariables.cpp:210
KonsoleKalendarVariables::getLocation
QString getLocation() const
Return location information.
Definition: konsolekalendarvariables.cpp:283
ExportTypeXML
Export XML (NOT AVAILABLE YET)
Definition: konsolekalendarvariables.h:60
KonsoleKalendarVariables::getCalendar
Akonadi::FetchJobCalendar::Ptr getCalendar() const
Get global calendar resources.
Definition: konsolekalendarvariables.cpp:215
ExportTypeVCard
Export VCard (NOT AVAILABLE YET)
Definition: konsolekalendarvariables.h:64
KonsoleKalendarVariables::isLocation
bool isLocation() const
Is there event location information available?
Definition: konsolekalendarvariables.cpp:288
ExportTypeCSV
Export Comma-Separated Values.
Definition: konsolekalendarvariables.h:62
KonsoleKalendarVariables::isDryRun
bool isDryRun() const
Is this program only in testing mode?
Definition: konsolekalendarvariables.cpp:155
KonsoleKalendarVariables::setUseTodos
void setUseTodos(bool useTodos)
Set switch to use Todos.
Definition: konsolekalendarvariables.cpp:170
KonsoleKalendarVariables::setCalendarFile
void setCalendarFile(const QString &calendar)
Set calendar file.
Definition: konsolekalendarvariables.cpp:190
KonsoleKalendarVariables::isVerbose
bool isVerbose() const
Should program be more verbose?
Definition: konsolekalendarvariables.cpp:145
ExportTypeText
Export as text (default)
Definition: konsolekalendarvariables.h:50
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:04 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KonsoleKalendar

Skip menu "KonsoleKalendar"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal