mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 10:52:49 +00:00
2916de09fb
there were some stale zone name comments marked for translation, the scopping script (probably purposely) did not remove such Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
138 lines
4 KiB
C++
138 lines
4 KiB
C++
/*
|
|
Copyright (C) 2005, S.R.Haque <srhaque@iee.org>.
|
|
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 <kdeui_export.h>
|
|
|
|
#include <QtGui/QTreeWidget>
|
|
|
|
class KTimeZone;
|
|
|
|
/**
|
|
* @brief A time zone selection widget.
|
|
*
|
|
* \b Detail:
|
|
*
|
|
* This class provides for selection of one or more time zones.
|
|
*
|
|
* \b Example:
|
|
*
|
|
* To use the class to implement a system timezone selection feature:
|
|
* \code
|
|
*
|
|
* // This adds a time zone widget to a dialog.
|
|
* m_timezones = new KTimeZoneWidget(this);
|
|
* ...
|
|
* \endcode
|
|
*
|
|
* To use the class to implement a multiple-choice custom time zone selector:
|
|
* \code
|
|
*
|
|
* m_timezones = new KTimeZoneWidget( this, "Time zones", vcalendarTimezones );
|
|
* m_timezones->setSelectionMode( QTreeView::MultiSelection );
|
|
* ...
|
|
* \endcode
|
|
*
|
|
* \image html ktimezonewidget.png "KDE Time Zone Widget"
|
|
*
|
|
* @author S.R.Haque <srhaque@iee.org>
|
|
*/
|
|
class KDEUI_EXPORT KTimeZoneWidget : public QTreeWidget
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(bool itemsCheckable READ itemsCheckable WRITE setItemsCheckable)
|
|
Q_PROPERTY(QAbstractItemView::SelectionMode selectionMode READ selectionMode WRITE setSelectionMode)
|
|
|
|
public:
|
|
/**
|
|
* Constructs a time zone selection widget.
|
|
*
|
|
* @param parent The parent widget.
|
|
*/
|
|
explicit KTimeZoneWidget( QWidget *parent = 0 );
|
|
|
|
/**
|
|
* Destroys the time zone selection widget.
|
|
*/
|
|
virtual ~KTimeZoneWidget();
|
|
|
|
/**
|
|
* Makes all items show a checkbox, so that the user can select multiple
|
|
* timezones by means of checking checkboxes, rather than via multi-selection.
|
|
*
|
|
* In "items checkable" mode, the selection(), setSelected() and clearSelection()
|
|
* methods work on the check states rather than on selecting/unselecting.
|
|
*
|
|
* @since 4.4
|
|
*/
|
|
void setItemsCheckable(bool enable);
|
|
/**
|
|
* @return true if setItemsCheckable(true) was called.
|
|
* @since 4.4
|
|
*/
|
|
bool itemsCheckable() const;
|
|
|
|
/**
|
|
* Allows to select multiple timezones. This is the same as
|
|
* setSelectionMode(KTimeZoneWidget::MultiSelection) normally,
|
|
* but in "items checkable" mode, this is rather about allowing to
|
|
* check multiple items. In that case, the actual QTreeWidget selection
|
|
* mode remains unchanged.
|
|
* @since 4.4
|
|
*/
|
|
void setSelectionMode(QAbstractItemView::SelectionMode mode);
|
|
|
|
/**
|
|
* @return the selection mode set by setSelectionMode().
|
|
* @since 4.4
|
|
*/
|
|
QAbstractItemView::SelectionMode selectionMode() const;
|
|
|
|
/**
|
|
* Returns the currently selected time zones. See QTreeView::selectionChanged().
|
|
*
|
|
* @return a list of time zone names, in the format used by the database
|
|
* supplied to the {@link KTimeZoneWidget() } constructor.
|
|
*/
|
|
QStringList selection() const;
|
|
|
|
/**
|
|
* Select/deselect the named time zone.
|
|
*
|
|
* @param zone The time zone name to be selected. Ignored if not recognized!
|
|
* @param selected The new selection state.
|
|
*/
|
|
void setSelected( const QString &zone, bool selected );
|
|
|
|
/**
|
|
* Unselect all timezones.
|
|
* This is the same as QTreeWidget::clearSelection, except in checkable items mode,
|
|
* where items are all unchecked.
|
|
* The overload is @since 4.4.
|
|
*/
|
|
void clearSelection();
|
|
|
|
private:
|
|
class Private;
|
|
Private* const d;
|
|
};
|
|
|
|
#endif
|