charactertraits.h

//© Copyright 2010 - 2012 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/

#ifndef _uicharactertraits_h
#define _uicharactertraits_h

#include "colourvalue.h"
#include "countedptr.h"

namespace Mezzanine
{
    namespace UI
    {
        class FontData;

        /// @typedef CharacterStatus
        /// @brief An enum describing the status and boolean traits a Character can have.
        enum CharacterStatus
        {
            /// @todo When additional fonts are no longer needed for bold, italics, etc. style font and such, add those basic properties here.
            CS_Clickable    = 1
        };//CharacterStatus

        ///////////////////////////////////////////////////////////////////////////////
        /// @brief This class stores common data for determining the look of a Character.
        /// @details
        ///////////////////////////////////////
        class MEZZ_LIB CharacterTraits
        {
        public:
            /// @brief Blank Constructor.
            CharacterTraits();
            /// @brief Descriptive Constructor.
            /// @param Font A pointer to the font to be used.
            /// @param Character The colour to be given to the characters altered by this class.
            CharacterTraits(FontData* Font, const ColourValue& Character);
            /// @brief Class Destructor.
            virtual ~CharacterTraits();

            ///////////////////////////////////////////////////////////////////////////////
            // Public Data Members

            /// @brief The font this Character belongs to.
            FontData*        CharFont;
            /// @brief The colour to render this Character as.
            ColourValue      CharColour;

            ///////////////////////////////////////////////////////////////////////////////
            // Operator Methods

            /// @brief Assignment operator.
            /// @param Other The other CharacterTraits to copy from.
            /// @return Returns a reference to this.
            CharacterTraits& operator=(const CharacterTraits& Other);

            /// @brief Equality comparison operator.
            /// @param Other The other CharacterTraits to compare with.
            /// @return Returns true if the two CharacterTraits are equal, false otherwise.
            bool operator==(const CharacterTraits& Other) const;
            /// @brief Inequality comparison operator.
            /// @param Other The other CharacterTraits to compare with.
            /// @return Returns true if the two CharacterTraits are not equal, false otherwise.
            bool operator!=(const CharacterTraits& Other) const;

            ///////////////////////////////////////////////////////////////////////////////
            // Serialization

            /// @brief Convert this class to an XML::Node ready for serialization.
            /// @param ParentNode The point in the XML hierarchy that this renderable should be appended to.
            void ProtoSerialize(XML::Node& ParentNode) const;
            /// @brief Take the data stored in an XML Node and overwrite this object with it.
            /// @param SelfRoot An XML::Node containing the data to populate this class with.
            void ProtoDeSerialize(const XML::Node& SelfRoot);
            /// @brief Get the name of the the XML tag this class will leave behind as its instances are serialized.
            /// @return A string containing the name of this class.
            static String GetSerializableName();
        };//CharacterTraits

        /// @typedef CharacterTraitsPtr
        /// @brief Convenience typedef for counted pointers to CharacterTraits.
        typedef CountedPtr<CharacterTraits> CharacterTraitsPtr;
    }//UI
}//Mezzanine

#endif