diff options
author | Timothy Pearson <[email protected]> | 2011-11-06 15:56:40 -0600 |
---|---|---|
committer | Timothy Pearson <[email protected]> | 2011-11-06 15:56:40 -0600 |
commit | e16866e072f94410321d70daedbcb855ea878cac (patch) | |
tree | ee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdeui/ktimezonewidget.h | |
parent | a58c20c1a7593631a1b50213c805507ebc16adaf (diff) | |
download | tdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip |
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdeui/ktimezonewidget.h')
-rw-r--r-- | tdeui/ktimezonewidget.h | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/tdeui/ktimezonewidget.h b/tdeui/ktimezonewidget.h new file mode 100644 index 000000000..a09b1dd56 --- /dev/null +++ b/tdeui/ktimezonewidget.h @@ -0,0 +1,112 @@ +/* + Copyright (C) 2005, S.R.Haque <[email protected]>. + This file is part of the KDE project + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License version 2, as published by the Free Software Foundation. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef KTIMEZONEWIDGET_H +#define KTIMEZONEWIDGET_H + +#include <kdelibs_export.h> +#include <klistview.h> +#include <tqstring.h> + +class KTimezone; +class KTimezones; +class KTimezoneWidgetPrivate; + +/** + * @brief A timezone selection widget. + * + * \b Detail: + * + * This class provides for selection of one or more timezones. + * + * \b Example: + * + * To use the class to implement a system timezone selection feature: + * \code + * + * // This adds a timezone widget to a dialog. + * m_timezones = new KTimezoneWidget(this, "Timezones"); + * ... + * \endcode + * + * To use the class to implement a multiple-choice custom timezone selector: + * \code + * + * m_timezones = new KTimezoneWidget(this, "Timezones", vcalendarTimezones); + * m_timezones->setSelectionModeExt(KListView::Multi); + * ... + * \endcode + * + * @author S.R.Haque <[email protected]> + * @since 3.5 + */ +class KDEUI_EXPORT KTimezoneWidget : + public KListView +{ + Q_OBJECT + +public: + /** + * Constructs a timezone selection widget. + * + * @param parent The parent widget. + * @param name The name of this widget. + * @param db The timezone database to use. If 0, the system timezone + * database is used. + */ + KTimezoneWidget(TQWidget *parent = 0, const char *name = 0, KTimezones *db = 0); + + /** + * Destroys the timezone selection widget. + */ + virtual ~KTimezoneWidget(); + + /** + * Returns the currently selected timezones. See TQListView::selectionChanged(). + * + * @return a list of timezone names, in the format used by the database + * supplied to the {@link KTimezoneWidget() } constructor. + */ + TQStringList selection() const; + + /** + * Select/deselect the named timezone. + * + * @param zone The timezone name to be selected. Ignored if not recognised! + * @param selected The new selection state. + */ + void setSelected(const TQString &zone, bool selected); + + /** + * Format a timezone name in a standardised manner. The returned value is + * transformed via an i18n lookup, so the caller should previously have + * set the timezone catalogue: + * \code + * KGlobal::locale()->insertCatalogue("timezones"); + * \endcode + * + * @return formatted timezone name. + */ + static TQString displayName(const KTimezone *zone); + +private: + KTimezoneWidgetPrivate *d; +}; + +#endif |