/* Copyright (C) 2013
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_INPUT_KEYBOARDKEYLIST_H
#define BLACKMISC_INPUT_KEYBOARDKEYLIST_H

#include "blackmisc/blackmiscexport.h"
#include "blackmisc/collection.h"
#include "blackmisc/input/keyboardkey.h"
#include "blackmisc/sequence.h"
#include "blackmisc/variant.h"

#include <QMetaType>
#include <initializer_list>
#include <tuple>

namespace BlackMisc
{
    namespace Input
    {
        //! Value object encapsulating a list of keyboard keys.
        class BLACKMISC_EXPORT CKeyboardKeyList :
            public CSequence<CKeyboardKey>,
            public BlackMisc::Mixin::MetaType<CKeyboardKeyList>
        {
        public:
            BLACKMISC_DECLARE_USING_MIXIN_METATYPE(CKeyboardKeyList)

            //! Default constructor
            CKeyboardKeyList();

            //! Init by single key
            CKeyboardKeyList(CKeyboardKey key);

            //! Construct from a base class object.
            CKeyboardKeyList(const CSequence<CKeyboardKey> &baseClass);

            //! Initializer list constructor.
            CKeyboardKeyList(std::initializer_list<CKeyboardKey> il) : CSequence<CKeyboardKey>(il) {}

            //! Get all supported keys
            static const CKeyboardKeyList &allSupportedKeys();
        };
    } //namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Input::CKeyboardKeyList)
Q_DECLARE_METATYPE(BlackMisc::CCollection<BlackMisc::Input::CKeyboardKey>)
Q_DECLARE_METATYPE(BlackMisc::CSequence<BlackMisc::Input::CKeyboardKey>)

#endif //guard