Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 0c5b9dda82f313a591c2de51d3bb4975 > files > 122

libCEGUI-devel-0.6.2-3mdv2009.1.i586.rpm

/************************************************************************
	filename: 	CEGUIItemEntryProperties.h
	created:	Tue Mar 21 2006
	author:		Tomas Lindquist Olsen
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIItemEntryProperties_h_
#define _CEGUIItemEntryProperties_h_

#include "CEGUIProperty.h"

// Start of CEGUI namespace section
namespace CEGUI
{
// Start of ItemEntryProperties namespace section
/*!
\brief
    Namespace containing all classes that make up the properties interface for the ItemEntry class
*/
namespace ItemEntryProperties
{
    /*!
    \brief
	    Property to access the state of the selectable setting.

	    \par Usage:
		    - Name: Selectable
		    - Format: "[text]".

	    \par Where [text] is:
		    - "True" to indicate that the item is selectable.
		    - "False" to indicate that the item is not selectable.
    */
    class Selectable : public Property
    {
    public:
	    Selectable() : Property(
		    "Selectable",
		    "Property to get/set the state of the selectable setting for the ItemEntry.  Value is either \"True\" or \"False\".",
		    "False")
	    {}

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

    /*!
    \brief
	    Property to access the state of the selected setting.

	    \par Usage:
		    - Name: Selected
		    - Format: "[text]".

	    \par Where [text] is:
		    - "True" to indicate that the item is selectable.
		    - "False" to indicate that the item is not selectable.
    */
    class Selected : public Property
    {
    public:
	    Selected() : Property(
		    "Selected",
		    "Property to get/set the state of the selected setting for the ItemEntry.  Value is either \"True\" or \"False\".",
		    "False")
	    {}

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

} // End of  ItemEntryProperties namespace section
} // End of  CEGUI namespace section

#endif	// end of guard _CEGUIItemEntryProperties_h_