CEGUIListHeaderProperties.h

00001 /***********************************************************************
00002         filename:       CEGUIListHeaderProperties.h
00003         created:        11/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface to the properties for the ListHeader class.
00007 *************************************************************************/
00008 /***************************************************************************
00009  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00010  *
00011  *   Permission is hereby granted, free of charge, to any person obtaining
00012  *   a copy of this software and associated documentation files (the
00013  *   "Software"), to deal in the Software without restriction, including
00014  *   without limitation the rights to use, copy, modify, merge, publish,
00015  *   distribute, sublicense, and/or sell copies of the Software, and to
00016  *   permit persons to whom the Software is furnished to do so, subject to
00017  *   the following conditions:
00018  *
00019  *   The above copyright notice and this permission notice shall be
00020  *   included in all copies or substantial portions of the Software.
00021  *
00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00028  *   OTHER DEALINGS IN THE SOFTWARE.
00029  ***************************************************************************/
00030 #ifndef _CEGUIListHeaderProperties_h_
00031 #define _CEGUIListHeaderProperties_h_
00032 
00033 #include "CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of ListHeaderProperties namespace section
00045 namespace ListHeaderProperties
00046 {
00059 class ColumnsSizable : public Property
00060 {
00061 public:
00062         ColumnsSizable() : Property(
00063                 "ColumnsSizable",
00064                 "Property to get/set the setting for user sizing of the column headers.  Value is either \"True\" or \"False\".",
00065                 "True")
00066         {}
00067 
00068         String  get(const PropertyReceiver* receiver) const;
00069         void    set(PropertyReceiver* receiver, const String& value);
00070 };
00071 
00072 
00085 class ColumnsMovable : public Property
00086 {
00087 public:
00088         ColumnsMovable() : Property(
00089                 "ColumnsMovable",
00090                 "Property to get/set the setting for user moving of the column headers.  Value is either \"True\" or \"False\".",
00091                 "True")
00092         {}
00093 
00094         String  get(const PropertyReceiver* receiver) const;
00095         void    set(PropertyReceiver* receiver, const String& value);
00096 };
00097 
00098 
00111 class SortSettingEnabled : public Property
00112 {
00113 public:
00114         SortSettingEnabled() : Property(
00115                 "SortSettingEnabled",
00116                 "Property to get/set the setting for for user modification of the sort column & direction.  Value is either \"True\" or \"False\".",
00117                 "True")
00118         {}
00119 
00120         String  get(const PropertyReceiver* receiver) const;
00121         void    set(PropertyReceiver* receiver, const String& value);
00122 };
00123 
00124 
00138 class SortDirection : public Property
00139 {
00140 public:
00141         SortDirection() : Property(
00142                 "SortDirection",
00143                 "Property to get/set the sort direction setting of the header.  Value is the text of one of the SortDirection enumerated value names.",
00144                 "None")
00145         {}
00146 
00147         String  get(const PropertyReceiver* receiver) const;
00148         void    set(PropertyReceiver* receiver, const String& value);
00149 };
00150 
00151 
00163 class SortColumnID : public Property
00164 {
00165 public:
00166         SortColumnID() : Property(
00167                 "SortColumnID",
00168                 "Property to get/set the current sort column (via ID code).  Value is an unsigned integer number.",
00169                 "0")
00170         {}
00171 
00172         String  get(const PropertyReceiver* receiver) const;
00173         void    set(PropertyReceiver* receiver, const String& value);
00174 };
00175 
00176 } // End of  ListHeaderProperties namespace section
00177 
00178 } // End of  CEGUI namespace section
00179 
00180 
00181 #endif  // end of guard _CEGUIListHeaderProperties_h_

Generated on Sat Jun 28 14:35:44 2008 for Crazy Eddies GUI System by  doxygen 1.5.4