STK_Category.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

 This program 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 of the
 License, or (at your option) any later version.

 This program 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 program; if not, write to the
 Free Software Foundation, Inc.,
 59 Temple Place,
 Suite 330,
 Boston, MA 02111-1307
 USA

 Contact : Serge.Iovleff@stkpp.org
 */

/*
 * Project:  stkpp::gui::model
 * created on: 7 nov. 2009
 * Purpose:  .
 * Author:   iovleff, serge.iovleff@stkpp.org
 **/

#ifndef CATEGORY_H
#define CATEGORY_H

#include "../../../projects/STKernel/include/STK_String.h"
#include "../../../projects/STKernel/include/STK_List1D.h"

#include "STK_Tool.h"

namespace STK
{

class Category
{
  public:
    enum Type
    {
      Default,  
      Scratchpad
    };

  public:
    Category( String const& aname = String(), Type atype = Default);
   virtual ~Category();
    inline String const& name() const
    { return name_;}
    inline void setName( String const& aname)
    { name_ = aname;}
    inline int toolCount() const
    { return tool_list_.size();}
    inline Tool tool( int idx) const
    { return tool_list_.elt(idx);}
    inline void removeTool( int idx)
    { tool_list_.erase(idx);}
    inline void addTool( const Tool &atool)
    { tool_list_.push_back(atool);}
    inline Type type() const
    { return type_;}
    inline void setType( Type atype)
    { type_ = atype;}
    inline bool isNull() const
    { return name_.empty();}

  private:
    String name_;
    Type type_;
    List1D<Tool> tool_list_;

};

} // namespace STK

#endif /* CATEGORY_H */