listbox.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
 *
 *
 * Per Larsson a.k.a finalman
 * Olof Naessén a.k.a jansem/yakslem
 *
 * Visit: http://guichan.sourceforge.net
 *
 * License: (BSD)
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Guichan nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef GUI_WIDGETS_LISTBOX_H
#define GUI_WIDGETS_LISTBOX_H
 
#include "gui/widgets/widget.h"
 
#include "listeners/keylistener.h"
#include "listeners/mouselistener.h"
 
#include "localconsts.h"
 
class Skin;
class KeyEvent;
class ListModel;
class MouseEvent;
class SelectionListener;
class Widget2;
 
class ListBox notfinal : public Widget,
                         public MouseListener,
                         public KeyListener
{
    public:
        ListBox(const Widget2 *const widget,
                ListModel *const listModel,
                const std::string &skin);
 
        A_DELETE_COPY(ListBox)
 
        ~ListBox() override;
 
        void postInit() override;
 
        void draw(Graphics *const graphics) override A_NONNULL(2);
 
        void safeDraw(Graphics *const graphics) override A_NONNULL(2);
 
        void updateAlpha();
 
        // Inherited from KeyListener
 
        void keyPressed(KeyEvent& event) override final;
 
        // Inherited from MouseListener
 
        void mouseWheelMovedUp(MouseEvent& event) override final;
 
        void mouseWheelMovedDown(MouseEvent& event) override final;
 
        void mousePressed(MouseEvent &event) override;
 
        void mouseReleased(MouseEvent &event) override;
 
        void mouseReleased1(const MouseEvent &event);
 
        void mouseDragged(MouseEvent &event) override;
 
        void refocus();
 
        void setDistributeMousePressed(const bool b) noexcept2
        { mDistributeMousePressed = b; }
 
        virtual void adjustSize();
 
        void logic() override final;
 
        virtual int getSelectionByMouse(const int y) const;
 
        void setCenter(const bool b) noexcept2
        { mCenterText = b; }
 
        int getPressedIndex() const noexcept2 A_WARN_UNUSED
        { return mPressedIndex; }
 
        virtual unsigned int getRowHeight() const A_WARN_UNUSED
        { return mRowHeight; }
 
        void setRowHeight(unsigned int n) noexcept2
        { mRowHeight = n; }
 
        int getSelected() const noexcept2 A_WARN_UNUSED
        { return mSelected; }
 
        void setSelected(const int selected);
 
        void setListModel(ListModel *listModel);
 
        ListModel *getListModel() const noexcept2 A_WARN_UNUSED
        { return mListModel; }
 
        bool isWrappingEnabled() const noexcept2 A_WARN_UNUSED
        { return mWrappingEnabled; }
 
        void setWrappingEnabled(const bool wrappingEnabled) noexcept2
        { mWrappingEnabled = wrappingEnabled; }
 
        void addSelectionListener(SelectionListener *const selectionListener);
 
        void removeSelectionListener(SelectionListener *const
                                     selectionListener);
 
        void distributeValueChangedEvent();
 
    protected:
        int mSelected;
 
        ListModel *mListModel;
 
        bool mWrappingEnabled;
 
        typedef std::list<SelectionListener*> SelectionListenerList;
 
        SelectionListenerList mSelectionListeners;
 
        typedef SelectionListenerList::iterator SelectionListenerIterator;
 
        Color mHighlightColor;
        Color mForegroundSelectedColor;
        Color mForegroundSelectedColor2;
        int mOldSelected;
        int mPadding;
        int mPressedIndex;
        unsigned int mRowHeight;
        int mItemPadding;
        Skin *mSkin;
        static float mAlpha;
        bool mDistributeMousePressed;
        bool mCenterText;
};
 
#endif  // GUI_WIDGETS_LISTBOX_H