holidayregionselector.h

/*
  This file is part of the kholidays library.

  Copyright 2010 John Layt <john@layt.net>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  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 KHOLIDAYS_HOLIDAYREGIONSELECTOR_H
#define KHOLIDAYS_HOLIDAYREGIONSELECTOR_H

#include "kholidays_export.h"

#include <QTreeWidget>

class QString;
class QStringList;

namespace KHolidays {

class HolidayRegion;

class KHOLIDAYS_EXPORT HolidayRegionSelector : public QWidget
{
  Q_OBJECT
  Q_PROPERTY( QAbstractItemView::SelectionMode listSelectionMode
              READ selectionMode WRITE setSelectionMode )

  Q_PROPERTY( bool enableRegionUseFlags
              READ regionUseFlagsEnabled WRITE setRegionUseFlagsEnabled )

  Q_PROPERTY( bool hideSearch
              READ searchHidden WRITE setSearchHidden )

  Q_PROPERTY( bool hideDescription
              READ descriptionHidden WRITE setDescriptionHidden )

  Q_PROPERTY( bool hideLanguage
              READ languageHidden WRITE setLanguageHidden )

  Q_PROPERTY( QStringList languageFilter
              READ languageFilter WRITE setLanguageFilter )

  public:
    enum SelectionStatus {
      RegionHidden,             
      RegionDisabled,           
      RegionAvailable,          
      RegionSelected            
    };

    enum RegionUseFlag {
      NotUsed            = 0x00,    
      UseInformationOnly = 0x01,    
      UseDaysOff         = 0x02     
    };
    Q_DECLARE_FLAGS( RegionUseFlags, RegionUseFlag )

    
    explicit HolidayRegionSelector( QWidget *parent = 0 );

    virtual ~HolidayRegionSelector();

    QStringList holidayRegions() const;

    void setSelectionMode( QAbstractItemView::SelectionMode selectionMode );

    QAbstractItemView::SelectionMode selectionMode() const;

    void setRegionUseFlagsEnabled( bool enableRegionUseFlags );

    bool regionUseFlagsEnabled() const;

    void setSelectionStatus( const QString &holidayRegionCode,
                             HolidayRegionSelector::SelectionStatus status );

    HolidayRegionSelector::SelectionStatus selectionStatus(
      const QString &holidayRegionCode ) const;

    QHash<QString, HolidayRegionSelector::SelectionStatus> selectionStatus() const;

    QStringList selection( HolidayRegionSelector::SelectionStatus selectionStatus =
                           HolidayRegionSelector::RegionSelected ) const;

    QStringList selection( HolidayRegionSelector::RegionUseFlags regionUseFlags ) const;

    void clearSelection();

    void setRegionUseFlags( const QString &holidayRegionCode,
                            HolidayRegionSelector::RegionUseFlags regionUseFlags );

    HolidayRegionSelector::RegionUseFlags regionUseFlags( const QString &holidayRegionCode ) const;

    QHash<QString, HolidayRegionSelector::RegionUseFlags> regionUseFlags() const;

    void setLanguageFilter( const QStringList &languages );

    QStringList languageFilter() const;

    void setSearchHidden( bool hideSearch );

    bool searchHidden() const;

    void setLanguageHidden( bool hideLanguage );

    bool languageHidden() const;

    void setDescriptionHidden( bool hideDescription );

    bool descriptionHidden() const;

  private Q_SLOTS:
    void itemChanged( QTreeWidgetItem *item, int column );
    void itemChanged( int index );

  Q_SIGNALS:
    void selectionChanged();

  private:
    class Private;
    Private *const d;
};

} // namespace KHolidays

Q_DECLARE_OPERATORS_FOR_FLAGS( KHolidays::HolidayRegionSelector::RegionUseFlags )

#endif // KHOLIDAYS_HOLIDAYREGIONSELECTOR_H