KonsoleKalendarVariables Class Reference

#include <konsolekalendarvariables.h>

Public Member Functions
	KonsoleKalendarVariables ()
	~KonsoleKalendarVariables ()
bool	allowGui () const
Akonadi::Collection::Id	collectionId () const
bool	getAll () const
Akonadi::FetchJobCalendar::Ptr	getCalendar () const
QString	getCalendarFile () const
int	getDaysCount () const
QString	getDescription () const
QDateTime	getEndDateTime () const
QString	getExportFile () const
ExportType	getExportType () const
bool	getFloating () const
QString	getImportFile () const
QString	getLocation () const
QDateTime	getStartDateTime () const
QString	getSummary () const
QString	getUID () const
bool	getUseEvents () const
bool	getUseJournals () const
bool	getUseTodos () const
bool	isAll () const
bool	isDaysCount () const
bool	isDescription () const
bool	isDryRun () const
bool	isEndDateTime () const
bool	isExportFile () const
bool	isLocation () const
bool	isNext () const
bool	isStartDateTime () const
bool	isSummary () const
bool	isUID () const
bool	isVerbose () const
void	setAll (bool all)
void	setAllowGui (bool allow)
void	setCalendar (const Akonadi::FetchJobCalendar::Ptr &)
void	setCalendarFile (const QString &calendar)
void	setCollectionId (Akonadi::Collection::Id)
void	setDaysCount (int count)
void	setDescription (const QString &description)
void	setDryRun (bool dryrun)
void	setEndDateTime (const QDateTime &end)
void	setExportFile (const QString &export_file)
void	setExportType (ExportType exportType)
void	setFloating (bool floating)
void	setImportFile (const QString &calendar)
void	setLocation (const QString &location)
void	setNext (bool next)
void	setStartDateTime (const QDateTime &start)
void	setSummary (const QString &summary)
void	setUID (const QString &uid)
void	setUseEvents (bool useEvents)
void	setUseJournals (bool useJournals)
void	setUseTodos (bool useTodos)
void	setVerbose (bool verbose)

Detailed Description

This class provides all the variables for the program.

Author

Tuukka Pasanen

Allen Winter

Definition at line 73 of file konsolekalendarvariables.h.

Constructor & Destructor Documentation

KonsoleKalendarVariables::KonsoleKalendarVariables

(

)

Construct an empty KonsoleKalendarVariables object.

Definition at line 54 of file konsolekalendarvariables.cpp.

KonsoleKalendarVariables::~KonsoleKalendarVariables

(

)

Destructor.

Definition at line 78 of file konsolekalendarvariables.cpp.

Member Function Documentation

bool KonsoleKalendarVariables::allowGui

(

)

const

Returns whether to allow using resources with potential GUI dependencies.

Definition at line 350 of file konsolekalendarvariables.cpp.

Akonadi::Collection::Id KonsoleKalendarVariables::collectionId

(

)

const

Definition at line 345 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::getAll

(

)

const

Return all option.

Definition at line 256 of file konsolekalendarvariables.cpp.

Akonadi::FetchJobCalendar::Ptr KonsoleKalendarVariables::getCalendar

(

)

const

Get global calendar resources.

Definition at line 215 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getCalendarFile

(

)

const

Returns fullpath to calendar file.

Returns

calendar file.

Definition at line 195 of file konsolekalendarvariables.cpp.

int KonsoleKalendarVariables::getDaysCount

(

)

const

Get how many day should be seen.

Definition at line 325 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getDescription

(

)

const

Return description.

Returns

description of event.

Definition at line 267 of file konsolekalendarvariables.cpp.

QDateTime KonsoleKalendarVariables::getEndDateTime

(

)

const

Get end date.

Returns

end date.

Definition at line 120 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getExportFile

(

)

const

To what file we'll output.

Definition at line 241 of file konsolekalendarvariables.cpp.

ExportType KonsoleKalendarVariables::getExportType

(

)

const

What export type to use.

Definition at line 225 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::getFloating

(

)

const

Returns if Event is floating.

Definition at line 314 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getImportFile

(

)

const

Return import filename.

Returns

File that should be imported.

Definition at line 205 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getLocation

(

)

const

Return location information.

Returns

location where event is occurring.

Definition at line 283 of file konsolekalendarvariables.cpp.

QDateTime KonsoleKalendarVariables::getStartDateTime

(

)

const

Get start date.

Returns

start date.

Definition at line 104 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getSummary

(

)

const

Get summary.

Returns

summary.

Definition at line 299 of file konsolekalendarvariables.cpp.

QString KonsoleKalendarVariables::getUID

(

)

const

Get UID, the unique tag for VCard entry.

Returns

UID number.

Definition at line 88 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::getUseEvents

(

)

const

Get use Events switch.

Returns

true if operation using Events is specified.

Definition at line 165 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::getUseJournals

(

)

const

Get use Journals switch.

Returns

true if operation using Journals is specified.

Definition at line 185 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::getUseTodos

(

)

const

Get use Todos switch.

Returns

true if operation using Todos is specified.

Definition at line 175 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isAll

(

)

const

Is the all option set?

Definition at line 246 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isDaysCount

(

)

const

Is there some cound of days should be seen.

Definition at line 330 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isDescription

(

)

const

Is there an event description?

Returns

true is there is description false there isn't.

Definition at line 272 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isDryRun

(

)

const

Is this program only in testing mode?

Returns

true yes false no.

Definition at line 155 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isEndDateTime

(

)

const

Is there end date?

Returns

true if there is false is there isn't.

Definition at line 125 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isExportFile

(

)

const

Has an Export File been set?

Definition at line 236 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isLocation

(

)

const

Is there event location information available?

Returns

true is there is description false there isn't.

Definition at line 288 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isNext

(

)

const

Should we show only next activity and exit?

Definition at line 135 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isStartDateTime

(

)

const

Is there start date?

Returns

true if there is false is there isn't.

Definition at line 109 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isSummary

(

)

const

Is there an event summary?

Returns

true there is false there isn't.

Definition at line 304 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isUID

(

)

const

Is there UID set?

Returns

true there is UID false there isn't.

Definition at line 93 of file konsolekalendarvariables.cpp.

bool KonsoleKalendarVariables::isVerbose

(

)

const

Should program be more verbose?

Definition at line 145 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setAll

(

bool

all

)

View all option.

Parameters

all	flag to view all Events.

Definition at line 251 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setAllowGui

(

bool

allow

)

Sets whether to allow using resources with potential GUI dependencies.

Definition at line 335 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setCalendar

(

const Akonadi::FetchJobCalendar::Ptr &

resources

)

Sets the calendar resources for global use.

Parameters

resources

is a pointer to the calendar to use.

Definition at line 210 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setCalendarFile

(

const QString &

calendar

)

Set calendar file.

Parameters

calendar

Calendar files full path.

Definition at line 190 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setCollectionId

(

Akonadi::Collection::Id

id

)

Definition at line 340 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setDaysCount

(

int

count

)

Sets how many day should be seen.

Parameters

count

is the number of days to be shown.

Definition at line 319 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setDescription

(

const QString &

description

)

Add description.

Parameters

description

to event.

Definition at line 261 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setDryRun

(

bool

dryrun

)

Should we only try to run it and do nothing?

Parameters

dryrun

false no and true just test it.

Definition at line 150 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setEndDateTime

(

const QDateTime &

end

)

Sets end date.

Parameters

end	is the enddate.

Definition at line 114 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setExportFile

(

const QString &

export_file

)

Sets the output file name to export_file.

Parameters

export_file

is the name of the export file.

Definition at line 230 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setExportType

(

ExportType

exportType

)

Sets the ExportType to use.

Parameters

exportType

is the ExportType to use.

Definition at line 220 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setFloating

(

bool

floating

)

Set if Event is floating.

Parameters

floating

if true then the Event is floating.

Definition at line 309 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setImportFile

(

const QString &

calendar

)

Set file to import active calendar.

Parameters

calendar

Calendar file to import.

Definition at line 200 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setLocation

(

const QString &

location

)

Add location information.

Parameters

location

location where the event occurs.

Definition at line 277 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setNext

(

bool

next

)

Show only next activity and exit.

Parameters

next	true or false.

Definition at line 130 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setStartDateTime

(

const QDateTime &

start

)

Sets start date.

Parameters

start

is the start date.

Definition at line 98 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setSummary

(

const QString &

summary

)

Add summary.

Parameters

summary

event summary.

Definition at line 293 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setUID

(

const QString &

uid

)

Sets the UID, the unique tag for VCard entry.

Parameters

uid	unique tag for VCard entry.

Definition at line 82 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setUseEvents

(

bool

useEvents

)

Set switch to use Events.

Parameters

useEvents

if true, operation uses Events.

Definition at line 160 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setUseJournals

(

bool

useJournals

)

Set switch to use Journals.

Parameters

useJournals

if true, operation uses Journals.

Definition at line 180 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setUseTodos

(

bool

useTodos

)

Set switch to use Todos.

Parameters

useTodos

if true, operation uses Todos.

Definition at line 170 of file konsolekalendarvariables.cpp.

void KonsoleKalendarVariables::setVerbose

(

bool

verbose

)

Should program be more verbose?

Parameters

verbose

a flag to set verbosity.

Definition at line 140 of file konsolekalendarvariables.cpp.

---

The documentation for this class was generated from the following files:

• konsolekalendarvariables.h
• konsolekalendarvariables.cpp