Software and Services, Portable Libraries
2019.Mar.01
A library for managing digital certificates
|
The base class for calendar objects. More...
#include </home/doug/src/SoftwareAndServices/libSaSiCalendar/iCalendar.hpp>
Public Member Functions | |
iCalendar () | |
iCalendar Constructor. More... | |
iCalendar (iCalendar *ExistingiCalendarObject) | |
iCalendar Constructor. More... | |
iCalendar (icalbody *ExistingVCalendarObject) | |
iCalendar Constructor. More... | |
virtual | ~iCalendar () |
iCalendar Destructor More... | |
bool | add (const iCalendar *anotheriCal) |
Add another iCalendar to this object. More... | |
bool | add (const icalbody *body) |
Add an icalbody to this iCalendar object. More... | |
bool | add (const component *comp) |
Add a component to this iCalendar object. More... | |
bool | add (const property *prop) |
Add a property to the iCalendar object. More... | |
virtual InstanceCount_t | decInstance () const |
Decrement the instance. More... | |
unsigned int | getBodyCount () const |
Get the number of icalbody objects in this object. More... | |
component * | getComponent (unsigned int nTh) const |
Return the nTh component. More... | |
component * | getComponent (Tokens_t typeToGet, unsigned int nTh) const |
Return the nTh component that is typeToGet. More... | |
unsigned int | getComponentCount () const |
Return the number of components in this object. More... | |
unsigned int | getComponentCount (Tokens_t typeToCount) const |
Return the number of components in this object of type typeToCount. More... | |
iCalendar * | getiCal (unsigned int nTh) const |
Get the nTh ical object. More... | |
icalbody * | getiCalBody (unsigned int nTh) const |
Get the nTh icalbody object. More... | |
unsigned int | getiCalCount () const |
Get the number of iCalender objects in this object. More... | |
virtual InstanceCount_t | getInstance () const |
property * | getProperty (unsigned int nTh) const |
Return the nTh property. More... | |
unsigned int | getPropertyCount () const |
Return the number of properties in this object. More... | |
void * | getUserData () const |
Return the data set by a call to setUserData(). More... | |
virtual InstanceCount_t | incInstance () const |
Increment the instance. More... | |
void | operator delete (void *ToFree) |
bool | parse (const char *in, component *errors) |
Parse a string of calendar data. More... | |
bool | parse (File *in, component *errors) |
Parse an open File. More... | |
bool | parse (Parse &in, component *errors) |
Parse the contents of a already initialized Parse() object that contains calendar data. More... | |
void | setUserData (const void *userData) |
User data associated with this object. More... | |
bool | sprint (String *Results) const |
Convert this object to an RFC-iCalendar formatted string. More... | |
bool | valid () const |
Do basic checking to determine if the data parsed looks like some kind of known iCalendar object. More... | |
Protected Attributes | |
icalbodyVec * | _bodyList |
componentVec * | _componentList |
iCalendarVec * | _icalList |
propertyVec * | _propertyList |
void * | _userData |
The base class for calendar objects.
Generally this would not be used by applications. Instead they would use libINET-iCalFile, libINET-iCalXML, and so on.
Definition at line 434 of file iCalendar.hpp.
SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar | ( | ) |
iCalendar Constructor.
SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar | ( | iCalendar * | ExistingiCalendarObject | ) |
iCalendar Constructor.
ExistingiCalendarObject | An existing VCALENDER/VCALSTORE object to be added to 'this' object. |
SoftwareAndServices::Library::iCalendar::iCalendar::iCalendar | ( | icalbody * | ExistingVCalendarObject | ) |
iCalendar Constructor.
ExistingVCalendarObject | An existing VCALENDER object to be added to 'this' object. |
|
virtual |
iCalendar Destructor
bool SoftwareAndServices::Library::iCalendar::iCalendar::add | ( | const iCalendar * | anotheriCal | ) |
bool SoftwareAndServices::Library::iCalendar::iCalendar::add | ( | const icalbody * | body | ) |
bool SoftwareAndServices::Library::iCalendar::iCalendar::add | ( | const component * | comp | ) |
Add a component to this iCalendar object.
comp | The component to add. |
bool SoftwareAndServices::Library::iCalendar::iCalendar::add | ( | const property * | prop | ) |
|
inlinevirtualinherited |
Decrement the instance.
Definition at line 129 of file instance.hpp.
unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getBodyCount | ( | ) | const |
Get the number of icalbody objects in this object.
component* SoftwareAndServices::Library::iCalendar::iCalendar::getComponent | ( | unsigned int | nTh | ) | const |
Return the nTh component.
nTh | nTh starts from zero. |
component* SoftwareAndServices::Library::iCalendar::iCalendar::getComponent | ( | Tokens_t | typeToGet, |
unsigned int | nTh | ||
) | const |
Return the nTh component that is typeToGet.
typeToGet | Get the nTh component of this type. |
nTh | nTh starts from zero. |
unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getComponentCount | ( | ) | const |
Return the number of components in this object.
unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getComponentCount | ( | Tokens_t | typeToCount | ) | const |
Return the number of components in this object of type typeToCount.
typeToCount | Only count this kind of components in the results. |
iCalendar* SoftwareAndServices::Library::iCalendar::iCalendar::getiCal | ( | unsigned int | nTh | ) | const |
Get the nTh ical object.
nTh | nTh starts at zero for the first object. |
icalbody* SoftwareAndServices::Library::iCalendar::iCalendar::getiCalBody | ( | unsigned int | nTh | ) | const |
Get the nTh icalbody object.
nTh | nTh starts at zero for the first object. |
unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getiCalCount | ( | ) | const |
Get the number of iCalender objects in this object.
|
inlinevirtualinherited |
Definition at line 118 of file instance.hpp.
property* SoftwareAndServices::Library::iCalendar::iCalendar::getProperty | ( | unsigned int | nTh | ) | const |
Return the nTh property.
nTh | nTh starts from zero. |
unsigned int SoftwareAndServices::Library::iCalendar::iCalendar::getPropertyCount | ( | ) | const |
Return the number of properties in this object.
void* SoftwareAndServices::Library::iCalendar::iCalendar::getUserData | ( | ) | const |
Return the data set by a call to setUserData().
|
inlinevirtualinherited |
Increment the instance.
Definition at line 109 of file instance.hpp.
bool SoftwareAndServices::Library::iCalendar::iCalendar::parse | ( | const char * | in, |
component * | errors | ||
) |
Parse a string of calendar data.
in | The already initialized Parse() object. |
errors | An iCalendar formatted list of errors. |
Parse an open File.
in | The already opened File that contains calendar data. |
errors | An iCalendar formatted list of errors. |
Parse the contents of a already initialized Parse() object that contains calendar data.
in | The already initialized Parse() object. |
errors | An iCalendar formatted list of errors. |
void SoftwareAndServices::Library::iCalendar::iCalendar::setUserData | ( | const void * | userData | ) |
User data associated with this object.
This is not iCal specific, it is to be used in any way needed by calling application.
userData | A pointer to any kind of data. |
bool SoftwareAndServices::Library::iCalendar::iCalendar::sprint | ( | String * | Results | ) | const |
Convert this object to an RFC-iCalendar formatted string.
Results | A pointer to a String where the results will be appended to. |
bool SoftwareAndServices::Library::iCalendar::iCalendar::valid | ( | ) | const |
Do basic checking to determine if the data parsed looks like some kind of known iCalendar object.