STK_Tool.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
 */
/*--------------------------------------------------------------------*/
/* $Id: STK_Tool.h,v 1.1 2010/02/22 14:31:37 siovleff Exp $
 *
 * Project:  stkpp::gui::model
 * created on: 7 nov. 2009
 * Purpose:  .
 * Author:   iovleff, serge.iovleff@stkpp.org
 *
 * $Log: STK_Tool.h,v $
 * Revision 1.1  2010/02/22 14:31:37  siovleff
 * Adding Tool and Category class to the model
 *
 **/
/*--------------------------------------------------------------------*/
#ifndef STK_TOOL_H_
#define STK_TOOL_H_

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

namespace STK
{

class Tool
{
  public:
    enum Type
    {
      Default,
      Custom 
    };

  private:
    String name_;
    String xml_;
    String icon_name_;
    Type type_;

  public:
    Tool( String const& aname = String(),
          String const& xml = String(),
          String const& icon_name = String(),
          Type atype = Default);

    virtual ~Tool();

    inline String const& name() const
    { return name_;}

    inline void setName( String const& aname)
    { name_ = aname;}

    inline String const& getDomXml() const
    { return xml_;}

    inline void setDomXml( String const& xml)
    { xml_ = xml;}

    inline String const& getIconName() const
    { return icon_name_;}

    inline void setIconName( String const& icon_name)
    { icon_name_ = icon_name;}

    inline Type type() const
    { return type_;}

    inline void setType( Type atype)
    { type_ = atype;}

    inline bool isNull() const
    { return name_.empty();}
};

}

#endif /* STK_TOOL_H_ */