xrb_widgetskinhandler.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_widgetskinhandler.hpp by Victor Dods, created 2005/06/20
// ///////////////////////////////////////////////////////////////////////////
// Unless a different license was explicitly granted in writing by the
// copyright holder (Victor Dods), this software is freely distributable under
// the terms of the GNU General Public License, version 2.  Any works deriving
// from this work must also be released under the GNU GPL.  See the included
// file LICENSE for details.
// ///////////////////////////////////////////////////////////////////////////

#if !defined(_XRB_WIDGETSKINHANDLER_HPP_)
#define _XRB_WIDGETSKINHANDLER_HPP_

#include "xrb.hpp"

#include <vector>

#include "xrb_widgetskin.hpp"

namespace Xrb
{

class Widget;

class WidgetSkinHandler
{
public:

    WidgetSkinHandler ();
    virtual ~WidgetSkinHandler ();

    // ///////////////////////////////////////////////////////////////////////
    // accessors
    // ///////////////////////////////////////////////////////////////////////

    inline WidgetSkin const *GetWidgetSkin () const
    {
        return m_widget_skin;
    }
    inline WidgetBackground const *WidgetSkinWidgetBackground (
        WidgetSkin::WidgetBackgroundType const widget_background_type) const
    {
        return m_widget_skin->GetWidgetBackground(widget_background_type);
    }
    inline Resource<Font> const &WidgetSkinFont (
        WidgetSkin::FontType const font_type) const
    {
        return m_widget_skin->GetFont(font_type);
    }
    inline Resource<GLTexture> const &WidgetSkinTexture (
        WidgetSkin::TextureType const texture_type) const
    {
        return m_widget_skin->GetTexture(texture_type);
    }
    inline ScreenCoordVector2 const &WidgetSkinMargins (
        WidgetSkin::MarginsType const margins_type) const
    {
        return m_widget_skin->Margins(margins_type);
    }

    // ///////////////////////////////////////////////////////////////////////
    // modifiers
    // ///////////////////////////////////////////////////////////////////////

    void SetWidgetSkinWidgetBackground (
        WidgetSkin::WidgetBackgroundType widget_background_type,
        WidgetBackground const *widget_background);
    void SetWidgetSkinFont (
        WidgetSkin::FontType font_type,
        Resource<Font> const &font);
    void SetWidgetSkinFontFacePath (
        WidgetSkin::FontType font_type,
        std::string const &font_face_path);
    void SetWidgetSkinFontHeightRatio (
        WidgetSkin::FontType font_type,
        Float font_height_ratio);
    void SetWidgetSkinFontHeight (
        WidgetSkin::FontType font_type,
        ScreenCoord font_height);
    void SetWidgetSkinTexture (
        WidgetSkin::TextureType texture_type,
        Resource<GLTexture> const &texture);
    void SetWidgetSkinTexturePath (
        WidgetSkin::TextureType texture_type,
        std::string const &texture_path);
    void SetWidgetSkinMarginRatios (
        WidgetSkin::MarginsType margin_type,
        FloatVector2 const &margin_ratios);
    void SetWidgetSkinMargins (
        WidgetSkin::MarginsType margin_type,
        ScreenCoordVector2 const &margins);

protected:

    // ///////////////////////////////////////////////////////////////////////
    // abstract functions
    // ///////////////////////////////////////////////////////////////////////

    virtual Uint32 WidgetSkinHandlerChildCount () const = 0;
    virtual WidgetSkinHandler *WidgetSkinHandlerChild (Uint32 index) = 0;
    virtual WidgetSkinHandler *WidgetSkinHandlerParent () = 0;

    // ///////////////////////////////////////////////////////////////////////
    // WidgetSkin property change handlers
    // ///////////////////////////////////////////////////////////////////////

    virtual void HandleChangedWidgetSkinWidgetBackground (
        WidgetSkin::WidgetBackgroundType widget_background_type) { }
    virtual void HandleChangedWidgetSkinFont (
        WidgetSkin::FontType font_type) { }
    virtual void HandleChangedWidgetSkinTexture (
        WidgetSkin::TextureType texture_type) { }
    virtual void HandleChangedWidgetSkinMargins (
        WidgetSkin::MarginsType margins_type) { }

    WidgetSkin *m_widget_skin;

    bool m_delete_widget_skin;

private:

    // ///////////////////////////////////////////////////////////////////////
    // this function is used to generalize the redundant code in
    // all the SetBlahBlah functions
    // ///////////////////////////////////////////////////////////////////////

    template <typename PropertyType, typename DataType>
    void SetProperty (
        PropertyType const property,
        DataType const data,
        void (WidgetSkin::*SetWidgetSkinProperty)(PropertyType, DataType),
        void (WidgetSkinHandler::*PropagateChangedPropertyFunction)(PropertyType))
    {
        // make sure we go up to the top level parent before setting
        // the property and propagating the changes.
        if (WidgetSkinHandlerParent() != NULL)
        {
            WidgetSkinHandlerParent()->SetProperty<PropertyType, DataType>(
                property,
                data,
                SetWidgetSkinProperty,
                PropagateChangedPropertyFunction);
        }
        else
        {
            ASSERT1(m_widget_skin != NULL);
            // set the property on the widget skin
            (m_widget_skin->*SetWidgetSkinProperty)(property, data);
            // send property change notification down the widget hierarchy.
            (this->*PropagateChangedPropertyFunction)(property);
        }
    }

    // ///////////////////////////////////////////////////////////////////////
    // these functions propagate property changes to child widgets
    // ///////////////////////////////////////////////////////////////////////

    template <typename PropertyType>
    void PropagateChangedProperty (
        PropertyType const property,
        void (WidgetSkinHandler::*HandleChangedProperty)(PropertyType))
    {
        // call HandleChangedProperty on this WidgetSkinHandler
        (this->*HandleChangedProperty)(property);
        // call PropagateProperty on all child WidgetSkinHandlers
        for (Uint32 i = 0; i < WidgetSkinHandlerChildCount(); ++i)
        {
            WidgetSkinHandler *child = WidgetSkinHandlerChild(i);
            ASSERT1(child != NULL);
            child->PropagateChangedProperty<PropertyType>(
                property,
                HandleChangedProperty);
        }
    }

    void PropagateChangedWidgetBackground (
        WidgetSkin::WidgetBackgroundType widget_background_type);
    void PropagateChangedFont (
        WidgetSkin::FontType font_type);
    void PropagateChangedTexture (
        WidgetSkin::TextureType texture_type);
    void PropagateChangedMargins (
        WidgetSkin::MarginsType margins_type);
}; // end of class WidgetSkinHandler

} // end of namespace Xrb

#endif // !defined(_XRB_WIDGETSKINHANDLER_HPP_)

---