source: GTP/trunk/App/Demos/Geom/OgreStuff/include/CEGUI/elements/CEGUIListHeaderSegmentProperties.h @ 1812

/************************************************************************
        filename:       CEGUIListHeaderSegmentProperties.h
        created:        11/7/2004
        author:         Paul D Turner
        
        purpose:        Interface to properties for ListHeaderSegment class
*************************************************************************/
/*************************************************************************
    Crazy Eddie's GUI System (http://www.cegui.org.uk)
    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)

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

    This library 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 library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*************************************************************************/
#ifndef _CEGUIListHeaderSegmentProperties_h_
#define _CEGUIListHeaderSegmentProperties_h_

#include "CEGUIProperty.h"


// Start of CEGUI namespace section
namespace CEGUI
{

// Start of ListHeaderSegmentProperties namespace section
/*!
\brief
        Namespace containing all classes that make up the properties interface for the ListHeaderSegment class
*/
namespace ListHeaderSegmentProperties
{
/*!
\brief
        Property to access the sizable setting of the header segment.

        \par Usage:
                - Name: Sizable
                - Format: "[text]"

        \par Where [Text] is:
                - "True" to indicate the segment can be sized by the user.
                - "False" to indicate the segment can not be sized by the user.
*/
class Sizable : public Property
{
public:
        Sizable() : Property(
                "Sizable",
                "Property to get/set the sizable setting of the header segment.  Value is either \"True\" or \"False\".",
                "True")
        {}

        String  get(const PropertyReceiver* receiver) const;
        void    set(PropertyReceiver* receiver, const String& value);
};


/*!
\brief
        Property to access the click-able setting of the header segment.

        \par Usage:
                - Name: Clickable
                - Format: "[text]"

        \par Where [Text] is:
                - "True" to indicate the segment can be clicked by the user.
                - "False" to indicate the segment can not be clicked by the user.
*/
class Clickable : public Property
{
public:
        Clickable() : Property(
                "Clickable",
                "Property to get/set the click-able setting of the header segment.  Value is either \"True\" or \"False\".",
                "True")
        {}

        String  get(const PropertyReceiver* receiver) const;
        void    set(PropertyReceiver* receiver, const String& value);
};


/*!
\brief
        Property to access the drag-able setting of the header segment.

        \par Usage:
                - Name: Dragable
                - Format: "[text]"

        \par Where [Text] is:
                - "True" to indicate the segment can be dragged by the user.
                - "False" to indicate the segment can not be dragged by the user.
*/
class Dragable : public Property
{
public:
        Dragable() : Property(
                "Dragable",
                "Property to get/set the drag-able setting of the header segment.  Value is either \"True\" or \"False\".",
                "True")
        {}

        String  get(const PropertyReceiver* receiver) const;
        void    set(PropertyReceiver* receiver, const String& value);
};


/*!
\brief
        Property to access the sort direction setting of the header segment.

        \par Usage:
                - Name: SortDirection
                - Format: "[text]"

        \par Where [Text] is one of:
                - "Ascending"
                - "Descending"
                - "None"
*/
class SortDirection : public Property
{
public:
        SortDirection() : Property(
                "SortDirection",
                "Property to get/set the sort direction setting of the header segment.  Value is the text of one of the SortDirection enumerated value names.",
                "None")
        {}

        String  get(const PropertyReceiver* receiver) const;
        void    set(PropertyReceiver* receiver, const String& value);
};

} // End of  ListHeaderSegmentProperties namespace section

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIListHeaderSegmentProperties_h_