/***********************************************************************
    created:    Wed Jul 6 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   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 _FalMultiColumnList_h_
#define _FalMultiColumnList_h_

#include "CEGUI/WindowRendererSets/Core/Module.h"
#include "CEGUI/widgets/MultiColumnList.h"
#include "CEGUI/falagard/WidgetLookFeel.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    /*!
    \brief
        MultiColumnList class for the FalagardBase module.

        This class requires LookNFeel to be assigned.  The LookNFeel should provide the following:

        States:
            - Enabled
            - EnabledFocused
            - Disabled

        Named Areas:
            - ItemRenderingArea         - area where items will be drawn when no scrollbars are visible.
            - ItemRenderingAreaHScroll  - area where items will be drawn when the horizontal scrollbar is visible.
            - ItemRenderingAreaVScroll  - area where items will be drawn when the vertical scrollbar is visible.
            - ItemRenderingAreaHVScroll - area where items will be drawn when both scrollbars are visible.

        Child Widgets:
            Scrollbar based widget with name suffix "__auto_vscrollbar__"
            Scrollbar based widget with name suffix "__auto_hscrollbar__"
            ListHeader based widget with name suffix "__auto_listheader__"
    */
    class COREWRSET_API FalagardMultiColumnList : public MultiColumnListWindowRenderer
    {
    public:
        static const String TypeName;       //!< type name for this widget.

        //! Name of the optional property to access for the unselected text colour.
        static const String UnselectedTextColourPropertyName;
        //! Name of the optional property to access for the selected text colour.
        static const String SelectedTextColourPropertyName;
        //! Name of the optional property to access to obtain active selection rendering colour.
        static const String ActiveSelectionColourPropertyName;
        //! Name of the optional property to access to obtain inactive selection rendering colour.
        static const String InactiveSelectionColourPropertyName;

        /*!
        \brief
            Constructor
        */
        FalagardMultiColumnList(const String& type);

        /*!
        \brief
            Perform rendering of the widget control frame and other 'static'
            areas.  This method should not render the actual items.  Note that
            the items are typically rendered to layer 3, other layers can be
            used for rendering imagery behind and infront of the items.

        \return
            Nothing.
        */
        void cacheListboxBaseImagery();

        Rectf getListRenderArea(void) const override;
        void createRenderGeometry() override;
    };
} // End of  CEGUI namespace section


#endif  // end of guard _FalMultiColumnList_h_
