tablecontrolinterface.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 <sal/types.h>
#include <vcl/seleng.hxx>
#include <vcl/window.hxx>
 
#include <controls/table/tabletypes.hxx>
#include <controls/table/tablemodel.hxx>
 
namespace svt::table
{
    //= TableControlAction
    enum TableControlAction
    {
        cursorUp,
        cursorDown,
        cursorLeft,
        cursorRight,
        cursorToLineStart,
        cursorToLineEnd,
        cursorToFirstLine,
        cursorToLastLine,
        cursorPageUp,
        cursorPageDown,
        cursorTopLeft,
        cursorBottomRight,
        cursorSelectRow,
        cursorSelectRowUp,
        cursorSelectRowDown,
        cursorSelectRowAreaTop,
        cursorSelectRowAreaBottom,
 
        invalidTableControlAction
    };
 
 
    //= TableCellArea
 
    enum TableCellArea
    {
        CellContent,
        ColumnDivider
    };
 
 
    //= TableCell
 
    struct TableCell
    {
        ColPos          nColumn;
        RowPos          nRow;
        TableCellArea   eArea;
 
        TableCell( ColPos const i_column, RowPos const i_row )
            :nColumn( i_column )
            ,nRow( i_row )
            ,eArea( CellContent )
        {
        }
    };
 
 
    //= ColumnMetrics
 
    struct ColumnMetrics
    {
        tools::Long    nStartPixel;
 
        tools::Long    nEndPixel;
 
        ColumnMetrics()
            :nStartPixel(0)
            ,nEndPixel(0)
        {
        }
 
        ColumnMetrics( tools::Long const i_start, tools::Long const i_end )
            :nStartPixel( i_start )
            ,nEndPixel( i_end )
        {
        }
    };
 
 
    //= TableArea
 
    enum class TableArea
    {
        ColumnHeaders,
        RowHeaders,
        All
    };
 
 
    //= ITableControl
 
    class SAL_NO_VTABLE ITableControl
    {
    public:
        virtual void    hideCursor() = 0;
 
        virtual void    showCursor() = 0;
 
        virtual bool    dispatchAction( TableControlAction _eAction ) = 0;
 
        virtual SelectionEngine* getSelEngine() = 0;
 
        virtual PTableModel getModel() const = 0;
 
        virtual ColPos  getCurrentColumn() const = 0;
 
        virtual RowPos  getCurrentRow() const = 0;
 
        virtual void    activateCell( ColPos const i_col, RowPos const i_row ) = 0;
 
        virtual ::Size  getTableSizePixel() const = 0;
 
        virtual void    setPointer( PointerStyle i_pointer ) = 0;
 
        virtual void    captureMouse() = 0;
 
        virtual void    releaseMouse() = 0;
 
        virtual void    invalidate( TableArea const i_what ) = 0;
 
        virtual tools::Long    pixelWidthToAppFont( tools::Long const i_pixels ) const = 0;
 
        virtual void    showTracking( tools::Rectangle const & i_location, ShowTrackFlags const i_flags ) = 0;
 
        virtual void    hideTracking() = 0;
 
        virtual TableCell       hitTest( const Point& rPoint ) const = 0;
 
        virtual ColumnMetrics   getColumnMetrics( ColPos const i_column ) const = 0;
 
        virtual bool isRowSelected( RowPos _nRow ) const = 0;
 
        virtual ~ITableControl() {};
    };
 
} // namespace svt::table
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */