CheckBoxHandle.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLQt/src/ICLQt/CheckBoxHandle.h                       **
** Module : ICLQt                                                  **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLQt/GUIHandle.h>
#include <string>
#include <vector>
#include <QtWidgets/QCheckBox>

namespace icl{
  namespace qt{

    class ICLQt_API CheckBoxHandle : public GUIHandle<QCheckBox>{
      public:

      CheckBoxHandle();

      CheckBoxHandle(QCheckBox *cb, GUIWidget *w, bool *stateRef);

      void check(bool execCallbacks=true);

      // unchecks this checkbox
      void uncheck(bool execCallbacks=true);

      inline void doCheck(bool on, bool execCallbacks=true){
        if(on) check(execCallbacks);
        else uncheck(execCallbacks);
      }

      // returns whether this the checkbox is currently checked
      bool isChecked() const;

      private:

      bool *m_stateRef;

    };
  } // namespace qt
}