widgets/ItemEntry.h

/***********************************************************************
        filename:       CEGUIItemEntry.h
        created:        31/3/2005
        author:         Tomas Lindquist Olsen (based on code by Paul D Turner)
        
        purpose:        Interface to base class for ItemEntry widget
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIItemEntry_h_
#define _CEGUIItemEntry_h_

#include "../Base.h"
#include "../Window.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT ItemEntryWindowRenderer : public WindowRenderer
{
public:
    ItemEntryWindowRenderer(const String& name);

    virtual Sizef getItemPixelSize(void) const = 0;
};

class CEGUIEXPORT ItemEntry : public Window
{
public:
    /*************************************************************************
        Constants
    *************************************************************************/
    static const String WidgetTypeName;             

    static const String EventSelectionChanged;

        /*************************************************************************
                Accessors
        *************************************************************************/
        Sizef getItemPixelSize(void) const;

    ItemListBase* getOwnerList(void) const  {return d_ownerList;}

    bool isSelected(void) const             {return d_selected;}

    bool isSelectable(void) const           {return d_selectable;}

    /*************************************************************************
                Set methods
        *************************************************************************/
    void setSelected(bool setting)  {setSelected_impl(setting, true);}
    
    void select(void)               {setSelected_impl(true, true);}

    void deselect(void)             {setSelected_impl(false, true);}

    void setSelected_impl(bool state, bool notify);

    void setSelectable(bool setting);

        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        ItemEntry(const String& type, const String& name);

        virtual ~ItemEntry(void) {}

protected:
    /*************************************************************************
        Abstract Implementation Functions
    *************************************************************************/
    //virtual Size getItemPixelSize_impl(void) const = 0;

        /*************************************************************************
                Implementation Functions
        *************************************************************************/
    // validate window renderer
    virtual bool validateWindowRenderer(const WindowRenderer* renderer) const;

    /*************************************************************************
        New Event Handlers
    *************************************************************************/
    virtual void onSelectionChanged(WindowEventArgs& e);

    /*************************************************************************
                Overridden Event Handlers
        *************************************************************************/
        virtual void onMouseClicked(MouseEventArgs& e);

    /*************************************************************************
        Implementation Data
    *************************************************************************/
    
    ItemListBase* d_ownerList;
    
    bool d_selected;

    bool d_selectable;
    
    // make the ItemListBase a friend
    friend class ItemListBase;

private:
    
    void addItemEntryProperties(void);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIItemEntry_h_