NamedElement.h

/***********************************************************************
    filename:   CEGUI/NamedElement.h
    created:    30/10/2011
    author:     Martin Preisler

    purpose:    Adds naming and name path traversal to Element
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2011 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 _CEGUINamedElement_h_
#define _CEGUINamedElement_h_

#include "CEGUI/Element.h"

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT NamedElementEventArgs : public EventArgs
{
public:
    NamedElementEventArgs(NamedElement* element):
        element(element)
    {}

    NamedElement* element;
};

class CEGUIEXPORT NamedElement :
    public Element
{
public:
    static const String EventNamespace;

    // generated internally by NamedElement
    static const String EventNameChanged;

    NamedElement(const String& name = "");

    virtual ~NamedElement();

    virtual void setName(const String& name);

    inline const String& getName() const
    {
        return d_name;
    }

    String getNamePath() const;

    using Element::isChild;
    bool isChild(const String& name_path) const;

    bool isChildRecursive(const String& name) const;

    using Element::isAncestor;
    bool isAncestor(const String& name) const;

    NamedElement* getChildElement(const String& name_path) const;

    NamedElement* getChildElementRecursive(const String& name) const;

    using Element::removeChild;
    void removeChild(const String& name_path);

protected:
    virtual void addChild_impl(Element* element);

    virtual NamedElement* getChildByNamePath_impl(const String& name_path) const;

    virtual NamedElement* getChildByNameRecursive_impl(const String& name) const;

    void addNamedElementProperties();

    virtual void onNameChanged(NamedElementEventArgs& e);

    String d_name;

private:
    /*************************************************************************
        May not copy or assign Element objects
    *************************************************************************/
    NamedElement(const Element&) {}
    NamedElement& operator=(const NamedElement&) {return *this;}
};

} // End of  CEGUI namespace section


#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUINamedElement_h_