ui/checkboxgroup.h

Go to the documentation of this file.

// -*- c++ -*-
//
// $Id: checkboxgroup.h 3342 2010-09-17 18:32:00Z java $
//
// Copyright (C) 2008-2010  Rafael Ostertag
//
// This file is part of YAPET.
//
// YAPET is free software: you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation, either version 3 of the License, or (at your option) any later
// version.
//
// YAPET 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 General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// YAPET.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef _CHECKBOXGROUP_H
#define _CHECKBOXGROUP_H

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

#ifdef HAVE_NCURSES_H
# include <ncurses.h>
#else // HAVE_NCURSES_H
# ifdef HAVE_CURSES_H
#  include <curses.h>
# else
#  error "Neither curses.h nor ncurses.h available"
# endif // HAVE_CURSES_H
#endif // HAVE_NCURSES_H
#include "curswa.h" // Leave this here. It depends on the above includes.

#ifdef HAVE_INTTYPES_H
# include <inttypes.h>
#endif

#ifdef HAVE_STRING
# include <string>
#endif

#ifdef HAVE_VECTOR
# include <vector>
#endif


#include "uiexception.h"

namespace YAPET {
    namespace UI {

        class CheckBoxGroup {
            private:
                enum {
                    BASE_HEIGHT = 2,
                    BASE_WIDTH = 8,
                    // ZERO BASED!
                    MAX_ITEMS = 15
                };

                WINDOW* window;

                std::string title;

                std::vector<std::string> items;
                // This holds the options (checked and unchecked items)
                uint16_t options;

                int start_x;
                int start_y;
                int width;
                int height;

                inline CheckBoxGroup (const CheckBoxGroup&) {}
                inline const CheckBoxGroup& operator= (const CheckBoxGroup&) {
                    return *this;
                }

                int ItemsUsableWidth() const ;
                int ItemsUsableHeight() const;
                int lastItemPos() const;
                void addCheckBox (int pos) throw (UIException);

                void setCheckMark (int pos, bool mark) throw (UIException);

                void setCheckMark (int pos) throw (UIException);

                void setCursor (int pos) throw (UIException);
                void displayItems() throw (UIException);

            protected:
                void createWindow() throw (UIException);

            public:
                CheckBoxGroup (std::string t,
                               const std::vector<std::string>& it,
                               uint16_t o,
                               int x,
                               int y,
                               int w,
                               int h)  throw (UIException);
                virtual ~CheckBoxGroup();

                void refresh() throw (UIException);

                int focus() throw (UIException);

                void resize (int sx, int sy, int w, int h) throw (UIException);

                inline int getHeight() const {
                    return BASE_HEIGHT + items.size();
                }

                inline uint16_t getOptions() const {
                    return options;
                }
        };
    }
}
#endif // _CHECKBOXGROUP_H