datefacet.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) version 3, or any
   later version accepted by the membership of KDE e.V. (or its
   successor approved by the membership of KDE e.V.), which shall
   act as a proxy defined in Section 6 of version 3 of the license.

   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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _NEPOMUK_QUERY_DATE_FACET_H_
#define _NEPOMUK_QUERY_DATE_FACET_H_

#include "facet.h"

class DateRange;

namespace Nepomuk {
    namespace Utils {
        class DateFacet : public Facet
        {
            Q_OBJECT

        public:
            DateFacet( QObject* parent = 0 );

            virtual ~DateFacet();

            Query::Term queryTerm() const;

            SelectionMode selectionMode() const;

            int count() const;

            KGuiItem guiItem( int index ) const;
            bool isSelected( int index ) const;

            enum DateRangeCandidate {
                NoDateRange = 0x0,

                Anytime = 0x1,

                Today = 0x2,

                Yesterday = 0x4,

                ThisWeek = 0x8,

                LastWeek = 0x10,

                ThisMonth = 0x20,

                LastMonth = 0x40,

                ThisYear = 0x80,

                LastYear = 0x100,

                CustomDateRange = 0x10000,

                DefaultRanges = Anytime|Today|ThisWeek|ThisMonth|ThisYear|CustomDateRange
            };
            Q_DECLARE_FLAGS( DateRangeCandidates, DateRangeCandidate )

            
            void setDateRangeCandidates( DateRangeCandidates ranges );

            DateRangeCandidates dateRangeCandidates() const;

        public Q_SLOTS:
            void clearSelection();

            void setSelected( int index, bool selected = true );

            bool selectFromTerm( const Nepomuk::Query::Term& queryTerm );

        protected:
            virtual Query::Term createDateRangeTerm( const DateRange& range ) const;

            virtual DateRange extractDateRange( const Query::Term& queryTerm ) const;

            virtual DateRange getCustomRange( bool* ok = 0 ) const;

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

#endif