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 *
19 * along with this program; if not, write to the Free Software *
20 * Foundation, Inc., 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 TQt, and distribute the resulting executable, *
24 * without including the source code for TQt in the source distribution. *
25 * *
26 ******************************************************************************/
27
28#ifndef _KONSOLEKALENDARVARIABLES_H_
29#define _KONSOLEKALENDARVARIABLES_H_
30
31#include <libkcal/calendarlocal.h>
32#include <libkcal/calendarresources.h>
33#include <libkcal/resourcelocal.h>
34#include <libkcal/resourcecalendar.h>
35#include <libkcal/event.h>
36
37#include <tqstring.h>
38#include <tqdatetime.h>
39
45namespace KCal
46{
51 {
70 };
71
78 {
79 public:
88
93 void setUseEvents( bool useEvents );
98 bool getUseEvents();
99
104 void setUseTodos( bool useTodos );
109 bool getUseTodos();
110
115 void setUseJournals( bool useJournals );
120 bool getUseJournals();
121
126 void setStartDateTime( TQDateTime start );
127
132 TQDateTime getStartDateTime();
133
138 bool isStartDateTime();
139
144 void setEndDateTime( TQDateTime end );
145
150 TQDateTime getEndDateTime();
151
156 bool isEndDateTime();
157
162 void setUID( TQString uid );
163
168 TQString getUID();
169
174 bool isUID();
175
180 void setNext( bool next );
181
185 bool isNext();
186
191 void setVerbose( bool verbose );
192
196 bool isVerbose();
197
202 void setDryRun( bool dryrun );
203
208 bool isDryRun();
209
214 void setCalendarFile( TQString calendar );
215
220 TQString getCalendarFile();
221
226 void setImportFile( TQString calendar );
227
232 TQString getImportFile();
233
238 void setDescription( TQString description );
239
244 TQString getDescription();
245
250 bool isDescription();
251
256 void setLocation( TQString location );
257
262 TQString getLocation();
263
268 bool isLocation();
269
274 void setSummary( TQString summary );
275
280 TQString getSummary();
281
286 bool isSummary();
287
292 void setAll( bool all );
296 bool getAll();
300 bool isAll();
301
306 void setFloating( bool floating );
310 bool getFloating();
311
316 void setCalendar( CalendarResources *resources );
317
322 CalendarResources *getCalendar();
323
327 void setExportFile( TQString export_file );
328
332 TQString getExportFile();
333
337 bool isExportFile();
338
342 void setExportType( ExportType exportType );
343
348
353 void setDaysCount( int count );
354
358 bool isDaysCount();
359
364 int getDaysCount();
365
366 private:
367 bool m_bIsUID;
368 TQString m_UID;
369 bool m_bIsStartDateTime;
370 TQDateTime m_startDateTime;
371 bool m_bIsEndDateTime;
372 TQDateTime m_endDateTime;
373 bool m_bNext;
374 bool m_bVerbose;
375 bool m_bDryRun;
376 bool m_bUseEvents;
377 bool m_bUseTodos;
378 bool m_bUseJournals;
379 TQString m_calendar;
380 TQString m_import;
381 ExportType m_exportType;
382 bool m_bIsExportFile;
383 TQString m_exportFile;
384 bool m_bAll;
385 bool m_bDescription;
386 TQString m_description;
387 bool m_bLocation;
388 TQString m_location;
389 bool m_bSummary;
390 TQString m_summary;
391 bool m_bFloating;
392 bool m_bDaysCount;
393 int m_daysCount;
394 CalendarResources *m_calendarResources;
395 };
396
397}
398
399#endif
This class provides all the variables for the program.
bool getFloating()
Return if Event is floating.
void setDescription(TQString description)
Add description.
void setCalendar(CalendarResources *resources)
Set calendar resources for global use.
bool isStartDateTime()
Is there start date?
bool getUseTodos()
Get use Todos switch.
bool getUseEvents()
Get use Events switch.
void setEndDateTime(TQDateTime end)
Sets end date.
bool isDryRun()
Is this program only in testing mode?
TQString getImportFile()
Return import filename.
void setStartDateTime(TQDateTime start)
Sets start date.
void setUID(TQString uid)
Sets the UID, the unique tag for VCard entry.
void setUseEvents(bool useEvents)
Set switch to use Events.
void setAll(bool all)
View all option.
void setNext(bool next)
Show only next activity and exit.
TQString getCalendarFile()
Returns fullpath to calendar file.
void setFloating(bool floating)
Set if Event is floating.
TQString getDescription()
Return description.
int getDaysCount()
Get how many day should be seen.
bool isDaysCount()
Is there some cound of days should be seen.
TQString getExportFile()
To what file we'll output.
void setExportType(ExportType exportType)
Set export type that'll we use.
bool isDescription()
Is there an event description?
void setCalendarFile(TQString calendar)
Set calendar file.
bool isVerbose()
Should program be more verbose?
KonsoleKalendarVariables()
Construct an empty KonsoleKalendarVariables object.
bool isNext()
Should we show only next activity and exit?
void setUseTodos(bool useTodos)
Set switch to use Todos.
void setVerbose(bool verbose)
Should program be more verbose?
TQDateTime getStartDateTime()
Get start date.
bool isLocation()
Is there event location information available?
bool getUseJournals()
Get use Journals switch.
void setDaysCount(int count)
Set how many day should be seen.
void setDryRun(bool dryrun)
Should we only try to run it and do nothing?
void setUseJournals(bool useJournals)
Set switch to use Journals.
TQString getLocation()
Return location information.
void setSummary(TQString summary)
Add summary.
ExportType getExportType()
What export type to use.
void setImportFile(TQString calendar)
Set file to import active calendar.
bool isExportFile()
Has an Export File been set?
bool isSummary()
Is there an event summary?
TQDateTime getEndDateTime()
Get end date.
TQString getUID()
Get UID, the unique tag for VCard entry.
void setLocation(TQString location)
Add location information.
void setExportFile(TQString export_file)
Set output file.
bool isAll()
Is the all option set?
CalendarResources * getCalendar()
Get global calendar resources.
ExportType
ExportType is the type of Export output.
@ ExportTypeCSV
Export Comma-Separated Values.
@ ExportTypeTextShort
Export as compact text.
@ ExportTypeNone
Export none.
@ ExportTypeText
Export as text (default)
@ ExportTypeXML
Export XML (NOT AVAILABLE YET)
@ ExportTypeMonthHTML
Export HTML for the time span on month boundaries.
@ ExportTypeXHTML
Export XHTML (NOT AVAILABLE YET)
@ ExportTypeHTML
Export HTML for the specified time span.
@ ExportTypeVCard
Export VCard (NOT AVAILABLE YET)