juce_TableListBox.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  TableListBoxModel
{
public:
    //==============================================================================
    TableListBoxModel() = default;

    virtual ~TableListBoxModel() = default;
 
    //==============================================================================
    virtual int getNumRows() = 0;

    virtual void paintRowBackground (Graphics&,
                                     int rowNumber,
                                     int width, int height,
                                     bool rowIsSelected) = 0;

    virtual void paintCell (Graphics&,
                            int rowNumber,
                            int columnId,
                            int width, int height,
                            bool rowIsSelected) = 0;
 
    //==============================================================================
    virtual Component* refreshComponentForCell (int rowNumber, int columnId, bool isRowSelected,
                                                Component* existingComponentToUpdate);
 
    //==============================================================================
    virtual void cellClicked (int rowNumber, int columnId, const MouseEvent&);

    virtual void cellDoubleClicked (int rowNumber, int columnId, const MouseEvent&);

    virtual void backgroundClicked (const MouseEvent&);
 
    //==============================================================================
    virtual void sortOrderChanged (int newSortColumnId, bool isForwards);
 
    //==============================================================================
    virtual int getColumnAutoSizeWidth (int columnId);

    virtual String getCellTooltip (int rowNumber, int columnId);
 
    //==============================================================================
    virtual void selectedRowsChanged (int lastRowSelected);

    virtual void deleteKeyPressed (int lastRowSelected);

    virtual void returnKeyPressed (int lastRowSelected);

    virtual void listWasScrolled();

    virtual var getDragSourceDescription (const SparseSet<int>& currentlySelectedRows);
};
 
 
//==============================================================================
class JUCE_API  TableListBox   : public ListBox,
                                 private ListBoxModel,
                                 private TableHeaderComponent::Listener
{
public:
    //==============================================================================
    TableListBox (const String& componentName = String(),
                  TableListBoxModel* model = nullptr);

    ~TableListBox() override;
 
    //==============================================================================
    void setModel (TableListBoxModel* newModel);

    TableListBoxModel* getModel() const noexcept                    { return model; }
 
    //==============================================================================
    TableHeaderComponent& getHeader() const noexcept                { return *header; }

    void setHeader (std::unique_ptr<TableHeaderComponent> newHeader);

    void setHeaderHeight (int newHeight);

    int getHeaderHeight() const noexcept;
 
    //==============================================================================
    void autoSizeColumn (int columnId);

    void autoSizeAllColumns();

    void setAutoSizeMenuOptionShown (bool shouldBeShown) noexcept;

    bool isAutoSizeMenuOptionShown() const noexcept                 { return autoSizeOptionsShown; }

    Rectangle<int> getCellPosition (int columnId, int rowNumber,
                                    bool relativeToComponentTopLeft) const;

    Component* getCellComponent (int columnId, int rowNumber) const;

    void scrollToEnsureColumnIsOnscreen (int columnId);
 
    //==============================================================================
    int getNumRows() override;
    void paintListBoxItem (int, Graphics&, int, int, bool) override;
    Component* refreshComponentForRow (int rowNumber, bool isRowSelected, Component* existingComponentToUpdate) override;
    void selectedRowsChanged (int row) override;
    void deleteKeyPressed (int currentSelectedRow) override;
    void returnKeyPressed (int currentSelectedRow) override;
    void backgroundClicked (const MouseEvent&) override;
    void listWasScrolled() override;
    void tableColumnsChanged (TableHeaderComponent*) override;
    void tableColumnsResized (TableHeaderComponent*) override;
    void tableSortOrderChanged (TableHeaderComponent*) override;
    void tableColumnDraggingChanged (TableHeaderComponent*, int) override;
    void resized() override;
 
private:
    //==============================================================================
    class Header;
    class RowComp;
 
    TableHeaderComponent* header = nullptr;
    TableListBoxModel* model;
    int columnIdNowBeingDragged = 0;
    bool autoSizeOptionsShown = true;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void updateColumnComponents() const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TableListBox)
};
 
} // namespace juce