1 ////////////////////////////////////////////////////////////////////////////// 2 // 3 // Copyright (c) 2004-2021 musikcube team 4 // 5 // All rights reserved. 6 // 7 // Redistribution and use in source and binary forms, with or without 8 // modification, are permitted provided that the following conditions are met: 9 // 10 // * Redistributions of source code must retain the above copyright notice, 11 // this list of conditions and the following disclaimer. 12 // 13 // * Redistributions in binary form must reproduce the above copyright 14 // notice, this list of conditions and the following disclaimer in the 15 // documentation and/or other materials provided with the distribution. 16 // 17 // * Neither the name of the author nor the names of other contributors may 18 // be used to endorse or promote products derived from this software 19 // without specific prior written permission. 20 // 21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 // POSSIBILITY OF SUCH DAMAGE. 32 // 33 ////////////////////////////////////////////////////////////////////////////// 34 35 #pragma once 36 37 #include <cursespp/IScrollable.h> 38 #include <cursespp/IScrollAdapter.h> 39 #include <cursespp/ScrollableWindow.h> 40 #include <sigslot/sigslot.h> 41 #include <functional> 42 43 namespace cursespp { 44 class ListWindow: public ScrollableWindow { 45 public: 46 static size_t NO_SELECTION; 47 48 using Decorator = std::function<void(ListWindow*)>; 49 50 sigslot::signal3<ListWindow*, size_t, size_t> SelectionChanged; 51 sigslot::signal2<ListWindow*, size_t> Invalidated; 52 sigslot::signal2<ListWindow*, size_t> EntryActivated; 53 sigslot::signal2<ListWindow*, size_t> EntryContextMenu; 54 55 ListWindow(std::shared_ptr<IScrollAdapter> adapter, IWindow *parent = nullptr); 56 ListWindow(IWindow *parent = nullptr); 57 58 virtual ~ListWindow(); 59 60 void ScrollToTop() override; 61 void ScrollToBottom() override; 62 void ScrollUp(int delta = 1) override; 63 void ScrollDown(int delta = 1) override; 64 void PageUp() override; 65 void PageDown() override; 66 67 void Invalidate() override; 68 void OnAdapterChanged() override; 69 70 const IScrollAdapter::ScrollPosition& GetScrollPosition() override; 71 72 bool KeyPress(const std::string& key) override; 73 bool MouseEvent(const IMouseHandler::Event& event) override; 74 75 void SetScrollbarVisible(bool visible); 76 void SetDecorator(Decorator decorator); 77 78 /* virtual methods we define */ 79 virtual void ScrollTo(size_t index); 80 virtual size_t GetSelectedIndex(); 81 virtual void SetSelectedIndex(size_t index); 82 virtual bool IsEntryVisible(size_t index); 83 84 protected: 85 void OnDimensionsChanged() override; 86 void DecorateFrame() override; 87 IScrollAdapter::ScrollPosition& GetMutableScrollPosition() override; 88 89 /* virtual methods we define */ 90 virtual void OnSelectionChanged(size_t newIndex, size_t oldIndex); 91 virtual bool OnEntryActivated(size_t index); 92 virtual bool OnEntryContextMenu(size_t index); 93 virtual void OnInvalidated(); 94 95 private: 96 bool IsSelectedItemCompletelyVisible(); 97 98 bool showScrollbar; 99 IScrollAdapter::ScrollPosition scrollPosition; 100 size_t selectedIndex; 101 Decorator decorator; 102 }; 103 } 104