csvgrid.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 <vcl/virdev.hxx>
#include <unotools/options.hxx>
 
#include <vector>
#include <memory>
#include <scdllapi.h>
#include <editutil.hxx>
#include "csvcontrol.hxx"
#include "csvsplits.hxx"
 
namespace svtools { class ColorConfig; }
class EditEngine;
class ScAsciiOptions;
class ScAccessibleCsvControl;
class ScCsvTableBox;
 
const sal_uInt32 CSV_COLUMN_INVALID = CSV_VEC_NOTFOUND;
 
struct ScCsvColState
{
    sal_Int32            mnType;             
    bool                 mbColumnSelected;
 
    explicit             ScCsvColState( sal_Int32 nType = CSV_TYPE_DEFAULT ) :
                                    mnType( nType ), mbColumnSelected( false ) {}
 
    bool                 IsSelected() const { return mbColumnSelected; }
    void                 Select( bool bSel ) { mbColumnSelected = bSel; }
};
 
typedef ::std::vector< ScCsvColState > ScCsvColStateVec;
 
class SC_DLLPUBLIC ScCsvGrid : public ScCsvControl, public utl::ConfigurationListener
{
private:
    ScCsvTableBox*              mpTableBox;         
    VclPtr<VirtualDevice>       mpBackgrDev;        
    VclPtr<VirtualDevice>       mpGridDev;          
    std::unique_ptr<weld::Menu> mxPopup;            
 
    ::svtools::ColorConfig*     mpColorConfig;      
    Color                       maBackColor;        
    Color                       maGridColor;        
    Color                       maGridPBColor;      
    Color                       maAppBackColor;     
    Color                       maTextColor;        
    Color                       maHeaderBackColor;  
    Color                       maHeaderGridColor;  
    Color                       maHeaderTextColor;  
    Color                       maSelectColor;      
 
    std::unique_ptr< ScEditEngineDefaulter >
                                mpEditEngine;       
    vcl::Font                   maHeaderFont;       
    vcl::Font                   maMonoFont;         
    Size                        maWinSize;          
    Size                        maEdEngSize;        
 
    ScCsvSplits                 maSplits;           
    ScCsvColStateVec            maColStates;        
    std::vector<OUString>       maTypeNames;        
    std::vector< std::vector<OUString> > maTexts;   
 
    sal_Int32                   mnFirstImpLine;     
    sal_uInt32                  mnRecentSelCol;     
    sal_uInt32                  mnMTCurrCol;        
    bool                        mbTracking;         
    bool                        mbMTSelecting;      
 
public:
    explicit ScCsvGrid(const ScCsvLayoutData& rData, std::unique_ptr<weld::Menu> xPopup, ScCsvTableBox* pTableBox);
    virtual void SetDrawingArea(weld::DrawingArea* pDrawingArea) override;
    ScCsvTableBox* GetTableBox() { return mpTableBox; }
    virtual ~ScCsvGrid() override;
 
    void Init();
 
    // common grid handling ---------------------------------------------------
public:
    void                        UpdateLayoutData();
    void                        UpdateOffsetX();
    void                        ApplyLayout( const ScCsvLayoutData& rOldData );
    void                        SetFirstImportedLine( sal_Int32 nLine );
 
    sal_Int32                   GetNoScrollCol( sal_Int32 nPos ) const;
 
private:
    SAL_DLLPRIVATE void                        InitColors();
    SAL_DLLPRIVATE void                        InitFonts();
    SAL_DLLPRIVATE void                        InitSizeData();
 
    // split handling ---------------------------------------------------------
public:
    void                        InsertSplit( sal_Int32 nPos );
    void                        RemoveSplit( sal_Int32 nPos );
    void                        MoveSplit( sal_Int32 nPos, sal_Int32 nNewPos );
    void                        RemoveAllSplits();
    void                        SetSplits( const ScCsvSplits& rSplits );
 
private:
    SAL_DLLPRIVATE bool                        ImplInsertSplit( sal_Int32 nPos );
    SAL_DLLPRIVATE bool                        ImplRemoveSplit( sal_Int32 nPos );
    SAL_DLLPRIVATE void                        ImplClearSplits();
 
    // columns/column types ---------------------------------------------------
public:
    sal_uInt32           GetColumnCount() const { return maColStates.size(); }
    sal_uInt32                  GetFirstVisColumn() const;
    sal_uInt32                  GetLastVisColumn() const;
 
    bool                        IsValidColumn( sal_uInt32 nColIndex ) const;
    bool                        IsVisibleColumn( sal_uInt32 nColIndex ) const;
 
    sal_Int32                   GetColumnX( sal_uInt32 nColIndex ) const;
    sal_uInt32                  GetColumnFromX( sal_Int32 nX ) const;
 
    sal_Int32            GetColumnPos( sal_uInt32 nColIndex ) const { return maSplits[ nColIndex ]; }
    sal_uInt32                  GetColumnFromPos( sal_Int32 nPos ) const;
    sal_Int32                   GetColumnWidth( sal_uInt32 nColIndex ) const;
 
    const ScCsvColStateVec& GetColumnStates() const { return maColStates; }
    void                        SetColumnStates( ScCsvColStateVec&& rColStates );
    sal_Int32                   GetSelColumnType() const;
    void                        SetSelColumnType( sal_Int32 nType );
    void                        SetTypeNames( std::vector<OUString>&& rTypeNames );
    OUString             GetColumnTypeName( sal_uInt32 nColIndex ) const;
 
    void                        FillColumnDataSep( ScAsciiOptions& rOptions ) const;
    void                        FillColumnDataFix( ScAsciiOptions& rOptions ) const;
 
private:
    SAL_DLLPRIVATE sal_Int32                   GetColumnType( sal_uInt32 nColIndex ) const;
    SAL_DLLPRIVATE void                        SetColumnType( sal_uInt32 nColIndex, sal_Int32 nColType );
 
    SAL_DLLPRIVATE void                        ScrollVertRel( ScMoveMode eDir );
    SAL_DLLPRIVATE void                        ExecutePopup( const Point& rPos );
 
    // selection handling -----------------------------------------------------
public:
    bool                        IsSelected( sal_uInt32 nColIndex ) const;
    sal_uInt32                  GetFirstSelected() const;
    sal_uInt32                  GetNextSelected( sal_uInt32 nFromIndex ) const;
    void                        Select( sal_uInt32 nColIndex, bool bSelect = true );
    void                        ToggleSelect( sal_uInt32 nColIndex );
    void                        SelectRange( sal_uInt32 nColIndex1, sal_uInt32 nColIndex2, bool bSelect = true );
    void                        SelectAll( bool bSelect = true );
 
    sal_uInt32           GetFocusColumn() const { return GetColumnFromPos( GetGridCursorPos() ); }
 
private:
    SAL_DLLPRIVATE void                        MoveCursor( sal_uInt32 nColIndex );
    SAL_DLLPRIVATE void                        MoveCursorRel( ScMoveMode eDir );
 
    SAL_DLLPRIVATE void                        ImplClearSelection();
 
    SAL_DLLPRIVATE void                        DoSelectAction( sal_uInt32 nColIndex, sal_uInt16 nModifier );
 
    // cell contents ----------------------------------------------------------
public:
    void                        ImplSetTextLineSep(
                                    sal_Int32 nLine, const OUString& rTextLine,
                                    const OUString& rSepChars, sal_Unicode cTextSep, bool bMergeSep, bool bRemoveSpace = false );
    void                        ImplSetTextLineFix( sal_Int32 nLine, const OUString& rTextLine );
 
    OUString             GetCellText( sal_uInt32 nColIndex, sal_Int32 nLine ) const;
 
    // event handling ---------------------------------------------------------
protected:
    virtual void                Resize() override;
    virtual void                GetFocus() override;
    virtual void                LoseFocus() override;
 
    virtual bool                MouseButtonDown( const MouseEvent& rMEvt ) override;
    virtual bool                MouseMove( const MouseEvent& rMEvt ) override;
    virtual bool                MouseButtonUp( const MouseEvent& rMEvt ) override;
    virtual bool                KeyInput( const KeyEvent& rKEvt ) override;
    virtual bool                Command( const CommandEvent& rCEvt ) override;
 
    virtual tools::Rectangle    GetFocusRect() override;
 
    virtual void                StyleUpdated() override;
 
    virtual void                ConfigurationChanged( ::utl::ConfigurationBroadcaster*, ConfigurationHints ) override;
 
    // painting ---------------------------------------------------------------
protected:
    virtual void                Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& ) override;
 
public:
    void                        ImplRedraw(vcl::RenderContext& rRenderContext);
    EditEngine*                 GetEditEngine();
 
private:
    sal_Int32            GetWidth() const { return maWinSize.Width(); }
    sal_Int32            GetHeight() const { return maWinSize.Height(); }
 
    SAL_DLLPRIVATE void                        ImplSetColumnClipRegion( OutputDevice& rOutDev, sal_uInt32 nColIndex );
    SAL_DLLPRIVATE void                        ImplDrawColumnHeader( OutputDevice& rOutDev, sal_uInt32 nColIndex, Color aFillColor );
 
    SAL_DLLPRIVATE void                        ImplDrawCellText( const Point& rPos, const OUString& rText );
    SAL_DLLPRIVATE void                        ImplDrawFirstLineSep( bool bSet );
    SAL_DLLPRIVATE void                        ImplDrawColumnBackgr( sal_uInt32 nColIndex );
    SAL_DLLPRIVATE void                        ImplDrawRowHeaders();
    SAL_DLLPRIVATE void                        ImplDrawBackgrDev();
 
    SAL_DLLPRIVATE void                        ImplDrawColumnSelection( sal_uInt32 nColIndex );
    SAL_DLLPRIVATE void                        ImplDrawGridDev();
 
    SAL_DLLPRIVATE void                        ImplDrawColumn( sal_uInt32 nColIndex );
 
    SAL_DLLPRIVATE void                        ImplDrawHorzScrolled( sal_Int32 nOldPos );
 
    SAL_DLLPRIVATE void                        ImplInvertCursor( sal_Int32 nPos );
 
    // accessibility ----------------------------------------------------------
protected:
    virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() override;
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */