widgets/ItemListbox.h

/************************************************************************
    filename:   CEGUIItemListbox.h
    created:    Tue Sep 27 2005
    author:     Tomas Lindquist Olsen
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIItemListbox_h_
#define _CEGUIItemListbox_h_

#include "./ScrolledItemListBase.h"

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

// begin CEGUI namespace
namespace CEGUI
{

class CEGUIEXPORT ItemListbox : public ScrolledItemListBase
{
public:
    static const String EventNamespace; 
    static const String WidgetTypeName; 

    /************************************************************************
        Constants
    *************************************************************************/
    static const String EventSelectionChanged;
    static const String EventMultiSelectModeChanged;

    /************************************************************************
        Accessors
    *************************************************************************/
    size_t getSelectedCount(void) const;

    ItemEntry* getLastSelectedItem(void) const      {return d_lastSelected;}

    ItemEntry* getFirstSelectedItem(size_t start_index=0) const;

    ItemEntry* getNextSelectedItem(void) const;

    ItemEntry* getNextSelectedItemAfter(const ItemEntry* start_item) const;

    bool isMultiSelectEnabled(void) const   {return d_multiSelect;}

    bool isItemSelected(size_t index) const;

    /************************************************************************
        Manipulators
    *************************************************************************/
    void setMultiSelectEnabled(bool state);

    void clearAllSelections(void);

    void selectRange(size_t a, size_t z);

    void selectAllItems(void);

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

    virtual ~ItemListbox(void) {}

    /************************************************************************
        Implementation functions
    ************************************************************************/
    virtual void layoutItemWidgets();

    virtual Sizef getContentSize() const;

    virtual void notifyItemClicked(ItemEntry* li);

    virtual void notifyItemSelectState(ItemEntry* li, bool state);

protected:
    /************************************************************************
        Protected implementation functions
    ************************************************************************/
    ItemEntry* findSelectedItem(size_t start_index) const;

    // overridden from ItemListBase
    bool handle_PaneChildRemoved(const EventArgs& e);

    /************************************************************************
        New event handlers
    ************************************************************************/
    virtual void onSelectionChanged(WindowEventArgs& e);
    virtual void onMultiSelectModeChanged(WindowEventArgs& e);

    /************************************************************************
        Overridden event handlers
    ************************************************************************/
    virtual void onKeyDown(KeyEventArgs& e);

    /************************************************************************
        Implementation data
    ************************************************************************/
    bool d_multiSelect; 
    ItemEntry* d_lastSelected; 
    mutable size_t d_nextSelectionIndex; 

private:
    void addItemListboxProperties(void);
};

} // end CEGUI namespace

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

#endif // end of guard _CEGUIItemListbox_h_