STK_PropertyDescriptor.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: 6 oct. 2009
 * Purpose:  declaration of the PropertyDescritpor class.
 * Author:   iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_PROPERTYDESCRIPTOR_H
#define STK_PROPERTYDESCRIPTOR_H

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

namespace STK
{

class PropertyDescriptor
{
  private:
    String id_;

    String display_;

    String category_;

    String description_;

    String helpId_;

  public:
    PropertyDescriptor( String const& id
                      , String const& displayName
                      , String const& category = STRING_NA
                      , String const& description = STRING_NA
                      , String const& helpId = STRING_NA
                      );

    virtual ~PropertyDescriptor();

    inline String const& category() const
    { return category_;}

    inline String const& getDescription() const
    { return description_;}

    inline String const& getDisplayName() const
    { return display_;}

    inline String const& getHelpContextId() const
    { return helpId_;}

    inline String const& getId() const
    { return id_;}

    inline void setCategory( String const& category)
    { category_ = category;}

    inline void setDescription(String const& description)
    { description_ = description;}

    inline void setHelpContextIds(String const& contextId)
    { helpId_ = contextId;}
};

}

#endif /* STK_PROPERTYDESCRIPTOR_H */