-rw-r--r-- | library/tzselect.cpp | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/library/tzselect.cpp b/library/tzselect.cpp index 335037e..4343eab 100644 --- a/library/tzselect.cpp +++ b/library/tzselect.cpp @@ -29,12 +29,20 @@ #include <stdlib.h> #include <qcopchannel_qws.h> #include <qpe/qpeapplication.h> #include <qmessagebox.h> +/*! + \class TimeZoneSelector + + \brief The TimeZoneSelector widget allows users to configure their time zone information. + + \ingroup qtopiaemb +*/ + class TimeZoneSelectorPrivate { public: TimeZoneSelectorPrivate() : includeLocal(FALSE) {} bool includeLocal; }; @@ -190,12 +198,16 @@ void TZCombo::handleSystemChannel(const QCString&msg, const QByteArray&) { if ( msg == "timeZoneListChange()" ) { updateZones(); } } +/*! + Creates a new TimeZoneSelector with parent \a p and name \a n. The combobox will be + populated with the available timezones. +*/ TimeZoneSelector::TimeZoneSelector(QWidget* p, const char* n) : QHBox(p,n) { d = new TimeZoneSelectorPrivate(); // build the combobox before we do any updates... @@ -210,12 +222,15 @@ TimeZoneSelector::TimeZoneSelector(QWidget* p, const char* n) : QObject::connect( cmbTz, SIGNAL( activated( int ) ), this, SLOT( slotTzActive( int ) ) ); QObject::connect( cmdTz, SIGNAL( clicked() ), this, SLOT( slotExecute() ) ); } +/*! + Destroys a TimeZoneSelector. +*/ TimeZoneSelector::~TimeZoneSelector() { } void TimeZoneSelector::setLocalIncluded(bool b) { @@ -225,22 +240,33 @@ void TimeZoneSelector::setLocalIncluded(bool b) bool TimeZoneSelector::localIncluded() const { return d->includeLocal; } - +/*! + Returns the currently selected timezone as a string in location format, e.g. + \code Australia/Brisbane \endcode +*/ QString TimeZoneSelector::currentZone() const { return cmbTz->currZone(); } +/*! + Sets the current timezone to \a id. +*/ void TimeZoneSelector::setCurrentZone( const QString& id ) { cmbTz->setCurrZone( id ); } +/*! \fn void TimeZoneSelector::signalNewTz( const QString& id ) + This signal is emitted when a timezone has been selected by the user. The id + is a \l QString in location format, eg \code Australia/Brisbane \endcode +*/ + void TimeZoneSelector::slotTzActive( int ) { emit signalNewTz( cmbTz->currZone() ); } |