tablemodel.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <toolkit/dllapi.h>
#include <controls/table/tabletypes.hxx>
#include <controls/table/tablerenderer.hxx>
#include <controls/table/tableinputhandler.hxx>
 
#include <com/sun/star/style/VerticalAlignment.hpp>
#include <com/sun/star/style/HorizontalAlignment.hpp>
 
#include <sal/types.h>
 
#include <optional>
#include <memory>
#include <vector>
#include <o3tl/typed_flags_set.hxx>
 
namespace svt::table { class ITableDataSort; }
 
class Color;
 
enum class ColumnAttributeGroup
{
    NONE          = 0x00,
    WIDTH         = 0x01,
    APPEARANCE    = 0x02,
    ALL           = 0x03,
};
namespace o3tl
{
    template<> struct typed_flags<ColumnAttributeGroup> : is_typed_flags<ColumnAttributeGroup, 0x03> {};
}
 
 
namespace svt::table
{
    //= ScrollbarVisibility
    enum ScrollbarVisibility
    {
        ScrollbarShowNever,
        ScrollbarShowSmart,
        ScrollbarShowAlways
    };
 
 
    //= ITableModelListener
 
    class SAL_NO_VTABLE ITableModelListener : public std::enable_shared_from_this< ITableModelListener >
    {
    public:
        virtual void    rowsInserted( RowPos first, RowPos last ) = 0;
 
        virtual void    rowsRemoved( RowPos first, RowPos last ) = 0;
 
        virtual void    columnInserted() = 0;
 
        virtual void    columnRemoved() = 0;
 
        virtual void    allColumnsRemoved() = 0;
 
        virtual void    cellsUpdated( RowPos const i_firstRow, RowPos const i_lastRow ) = 0;
 
        virtual void    columnChanged( ColPos const i_column, ColumnAttributeGroup const i_attributeGroup ) = 0;
 
        virtual void    tableMetricsChanged() = 0;
 
        virtual ~ITableModelListener(){};
    };
    typedef std::shared_ptr< ITableModelListener > PTableModelListener;
 
 
    //= IColumnModel
 
    class SAL_NO_VTABLE IColumnModel
    {
    public:
        virtual OUString      getName() const = 0;
 
        virtual OUString      getHelpText() const = 0;
 
        virtual bool        isResizable() const = 0;
 
        virtual sal_Int32   getFlexibility() const = 0;
 
        virtual TableMetrics    getWidth() const = 0;
 
        virtual void            setWidth( TableMetrics _nWidth ) = 0;
 
        virtual TableMetrics    getMinWidth() const = 0;
 
        virtual TableMetrics    getMaxWidth() const = 0;
 
        virtual css::style::HorizontalAlignment getHorizontalAlign() = 0;
 
        virtual ~IColumnModel() { }
    };
    typedef std::shared_ptr< IColumnModel > PColumnModel;
 
 
    //= ITableModel
 
    class SAL_NO_VTABLE TOOLKIT_DLLPUBLIC ITableModel
    {
    public:
        virtual TableSize   getColumnCount() const = 0;
 
        virtual TableSize   getRowCount() const = 0;
 
        virtual bool        hasColumnHeaders() const = 0;
 
        virtual bool        hasRowHeaders() const = 0;
 
        virtual PColumnModel    getColumnModel( ColPos column ) = 0;
 
        virtual PTableRenderer  getRenderer() const = 0;
 
        virtual PTableInputHandler  getInputHandler() const = 0;
 
        virtual TableMetrics    getRowHeight() const = 0;
 
        virtual TableMetrics    getColumnHeaderHeight() const = 0;
 
        virtual TableMetrics    getRowHeaderWidth() const = 0;
 
        virtual ScrollbarVisibility getVerticalScrollbarVisibility() const = 0;
 
        virtual ScrollbarVisibility getHorizontalScrollbarVisibility() const = 0;
 
        virtual void addTableModelListener( const PTableModelListener& i_listener ) = 0;
 
        virtual void removeTableModelListener( const PTableModelListener& i_listener ) = 0;
 
        virtual void getCellContent( ColPos const i_col, RowPos const i_row, css::uno::Any& o_cellContent ) = 0;
 
        virtual void getCellToolTip( ColPos const i_col, RowPos const i_row, css::uno::Any & o_cellToolTip ) = 0;
 
        virtual css::uno::Any      getRowHeading( RowPos const i_rowPos ) const = 0;
 
        virtual ::std::optional< ::Color >    getLineColor() const = 0;
 
        virtual ::std::optional< ::Color >    getHeaderBackgroundColor() const = 0;
 
        virtual ::std::optional< ::Color >    getHeaderTextColor() const = 0;
 
        virtual ::std::optional< ::Color >    getActiveSelectionBackColor() const = 0;
 
        virtual ::std::optional< ::Color >    getInactiveSelectionBackColor() const = 0;
 
        virtual ::std::optional< ::Color >    getActiveSelectionTextColor() const = 0;
 
        virtual ::std::optional< ::Color >    getInactiveSelectionTextColor() const = 0;
 
        virtual ::std::optional< ::Color >    getTextColor() const = 0;
 
        virtual ::std::optional< ::Color >    getTextLineColor() const = 0;
 
        virtual ::std::optional< ::std::vector< ::Color > >
                                                getRowBackgroundColors() const = 0;
 
        virtual css::style::VerticalAlignment getVerticalAlign() const = 0;
 
        virtual ITableDataSort* getSortAdapter() = 0;
 
        virtual bool isEnabled() const = 0;
 
        virtual ~ITableModel() { }
    };
    typedef std::shared_ptr< ITableModel > PTableModel;
 
 
} // namespace svt::table
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */