source/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28
  29 /** An abstract interface which represents a UI element that supports a table interface.
  30
  31     Examples of UI elements which typically support a table interface are lists, tables,
  32     and trees.
  33
  34     @tags{Accessibility}
  35 */
  36 class JUCE_API  AccessibilityTableInterface
  37 {
  38 public:
  39     /** Destructor. */
  40     virtual ~AccessibilityTableInterface() = default;
  41
  42     /** Returns the total number of rows in the table. */
  43     virtual int getNumRows() const = 0;
  44
  45     /** Returns the total number of columns in the table. */
  46     virtual int getNumColumns() const = 0;
  47
  48     /** Returns the AccessibilityHandler for one of the cells in the table, or
  49         nullptr if there is no cell at the specified position.
  50     */
  51     virtual const AccessibilityHandler* getCellHandler (int row, int column) const = 0;
  52 };
  53
  54 } // namespace juce