csvcontrol.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 .
 */

#ifndef INCLUDED_SC_SOURCE_UI_INC_CSVCONTROL_HXX
#define INCLUDED_SC_SOURCE_UI_INC_CSVCONTROL_HXX

#include <scdllapi.h>
#include <address.hxx>
#include "csvsplits.hxx"
#include <o3tl/typed_flags_set.hxx>
#include <rtl/ref.hxx>
#include <vcl/customweld.hxx>
#include "AccessibleCsvControl.hxx"

namespace com::sun::star::accessibility { class XAccessible; }

const sal_Int32 CSV_MINCOLWIDTH         = 8;
const sal_Int32 CSV_MAXSTRLEN          = 0x7FFF;
const sal_uInt16 CSV_HDR_TRANSPARENCY   = 85;
const sal_Int32 CSV_SCROLL_DIST         = 3;

const sal_Int32 CSV_PREVIEW_LINES       = 32; // maximum count of preview lines
const sal_Int32 CSV_MAXCOLCOUNT         = MAXCOLCOUNT;

const sal_Int32 CSV_TYPE_DEFAULT        = 0;
const sal_Int32 CSV_TYPE_MULTI          = -1;
const sal_Int32 CSV_TYPE_NOSELECTION    = -2;

// External used column types.
const sal_uInt8 SC_COL_STANDARD         = 1;
const sal_uInt8 SC_COL_TEXT             = 2;
const sal_uInt8 SC_COL_MDY              = 3;
const sal_uInt8 SC_COL_DMY              = 4;
const sal_uInt8 SC_COL_YMD              = 5;
const sal_uInt8 SC_COL_SKIP             = 9;
const sal_uInt8 SC_COL_ENGLISH          = 10;

struct ScCsvExpData
{
    sal_Int32                   mnIndex;        
    sal_uInt8                   mnType;         

    ScCsvExpData() : mnIndex( 0 ), mnType( SC_COL_STANDARD ) {}
    ScCsvExpData( sal_Int32 nIndex, sal_uInt8 nType ) :
                                    mnIndex( nIndex ), mnType( nType ) {}
};

typedef ::std::vector< ScCsvExpData > ScCsvExpDataVec;

enum ScMoveMode
{
    MOVE_NONE,                  
    MOVE_FIRST,                 
    MOVE_LAST,                  
    MOVE_PREV,                  
    MOVE_NEXT,                  
    MOVE_PREVPAGE,              
    MOVE_NEXTPAGE               
};

enum class ScCsvDiff : sal_uInt32 {
    Equal          = 0x0000,
    PosCount       = 0x0001,
    PosOffset      = 0x0002,
    HeaderWidth    = 0x0004,
    CharWidth      = 0x0008,
    LineCount      = 0x0010,
    LineOffset     = 0x0020,
    HeaderHeight   = 0x0040,
    LineHeight     = 0x0080,
    RulerCursor    = 0x0100,
    GridCursor     = 0x0200,

    HorizontalMask = PosCount | PosOffset | HeaderWidth | CharWidth,
    VerticalMask   = LineCount | LineOffset | HeaderHeight | LineHeight
};
namespace o3tl {
    template<> struct typed_flags<ScCsvDiff> : is_typed_flags<ScCsvDiff, 0x03ff> {};
}


struct ScCsvLayoutData
{
    // horizontal settings
    sal_Int32                   mnPosCount;         
    sal_Int32                   mnPosOffset;        

    sal_Int32                   mnWinWidth;         
    sal_Int32                   mnHdrWidth;         
    sal_Int32                   mnCharWidth;        

    // vertical settings
    sal_Int32                   mnLineCount;        
    sal_Int32                   mnLineOffset;       

    sal_Int32                   mnWinHeight;        
    sal_Int32                   mnHdrHeight;        
    sal_Int32                   mnLineHeight;       

    // cursor settings
    sal_Int32                   mnPosCursor;        
    sal_Int32                   mnColCursor;        

    mutable sal_Int32           mnNoRepaint;        
    bool                        mbAppRTL;           

    explicit                    ScCsvLayoutData();

    ScCsvDiff                   GetDiff( const ScCsvLayoutData& rData ) const;
};

inline bool operator==( const ScCsvLayoutData& rData1, const ScCsvLayoutData& rData2 )
{
    return rData1.GetDiff( rData2 ) == ScCsvDiff::Equal;
}

inline bool operator!=( const ScCsvLayoutData& rData1, const ScCsvLayoutData& rData2 )
{
    return !(rData1 == rData2);
}

enum ScCsvCmdType
{
    // misc
    CSVCMD_NONE,                
    CSVCMD_REPAINT,             

    // modify horizontal dimensions
    CSVCMD_SETPOSCOUNT,         
    CSVCMD_SETPOSOFFSET,        
    CSVCMD_SETHDRWIDTH,         
    CSVCMD_SETCHARWIDTH,        

    // modify vertical dimensions
    CSVCMD_SETLINECOUNT,        
    CSVCMD_SETLINEOFFSET,       
    CSVCMD_SETHDRHEIGHT,        
    CSVCMD_SETLINEHEIGHT,       

    // cursors/positions
    CSVCMD_MOVERULERCURSOR,     
    CSVCMD_MOVEGRIDCURSOR,      
    CSVCMD_MAKEPOSVISIBLE,      

    // table contents
    CSVCMD_NEWCELLTEXTS,        
    CSVCMD_UPDATECELLTEXTS,     
    CSVCMD_SETCOLUMNTYPE,       
    CSVCMD_EXPORTCOLUMNTYPE,    
    CSVCMD_SETFIRSTIMPORTLINE,  

    // splits
    CSVCMD_INSERTSPLIT,         
    CSVCMD_REMOVESPLIT,         
    CSVCMD_TOGGLESPLIT,         
    CSVCMD_MOVESPLIT,           
    CSVCMD_REMOVEALLSPLITS      
};

class ScCsvCmd
{
private:
    ScCsvCmdType                meType;         
    sal_Int32                   mnParam1;       
    sal_Int32                   mnParam2;       

public:
    explicit             ScCsvCmd() : meType( CSVCMD_NONE ),
                                    mnParam1( CSV_POS_INVALID ), mnParam2( CSV_POS_INVALID ) {}

    inline void                 Set( ScCsvCmdType eType, sal_Int32 nParam1, sal_Int32 nParam2 );

    ScCsvCmdType         GetType() const     { return meType; }
    sal_Int32            GetParam1() const   { return mnParam1; }
    sal_Int32            GetParam2() const   { return mnParam2; }
};

inline void ScCsvCmd::Set( ScCsvCmdType eType, sal_Int32 nParam1, sal_Int32 nParam2 )
{
    meType = eType; mnParam1 = nParam1; mnParam2 = nParam2;
}

class SC_DLLPUBLIC ScCsvControl : public weld::CustomWidgetController
{
private:
    Link<ScCsvControl&,void>    maCmdHdl;           
    ScCsvCmd                    maCmd;              
    const ScCsvLayoutData&      mrData;             

    bool                        mbValidGfx;         

protected:
    rtl::Reference<ScAccessibleCsvControl> mxAccessible; 

public:
    explicit                    ScCsvControl(const ScCsvLayoutData& rData);
    virtual                     ~ScCsvControl() override;

    // event handling ---------------------------------------------------------

    virtual void                GetFocus() override;
    virtual void                LoseFocus() override;

    void                        AccSendFocusEvent( bool bFocused );
    void                        AccSendCaretEvent();
    void                        AccSendVisibleEvent();
    void                        AccSendSelectionEvent();
    void                        AccSendTableUpdateEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn, bool bAllRows = true );
    void                        AccSendInsertColumnEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn );
    void                        AccSendRemoveColumnEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn );

    ScAccessibleCsvControl*     GetAccessible() { return mxAccessible.get(); }

    // repaint helpers --------------------------------------------------------

    void                 InvalidateGfx() { mbValidGfx = false; }
    void                 ValidateGfx() { mbValidGfx = true; }
    bool                 IsValidGfx() const { return mbValidGfx; }

    void                        Repaint( bool bInvalidate = false );
    void                        DisableRepaint();
    void                        EnableRepaint();
    bool                 IsNoRepaint() const { return mrData.mnNoRepaint > 0; }

    // command handling -------------------------------------------------------

    void                 SetCmdHdl( const Link<ScCsvControl&,void>& rHdl ) { maCmdHdl = rHdl; }
    const ScCsvCmd&      GetCmd() const { return maCmd; }

    void                        Execute(
                                    ScCsvCmdType eType,
                                    sal_Int32 nParam1 = CSV_POS_INVALID,
                                    sal_Int32 nParam2 = CSV_POS_INVALID );

    // layout helpers ---------------------------------------------------------

    const ScCsvLayoutData& GetLayoutData() const { return mrData; }
    bool                 IsRTL() const { return mrData.mbAppRTL; }

    sal_Int32            GetPosCount() const { return mrData.mnPosCount; }
    sal_Int32                   GetVisPosCount() const;
    sal_Int32            GetFirstVisPos() const { return mrData.mnPosOffset; }
    sal_Int32            GetLastVisPos() const { return GetFirstVisPos() + GetVisPosCount(); }
    sal_Int32                   GetMaxPosOffset() const;

    bool                        IsValidSplitPos( sal_Int32 nPos ) const;
    bool                        IsVisibleSplitPos( sal_Int32 nPos ) const;

    sal_Int32            GetHdrWidth() const { return mrData.mnHdrWidth; }
    sal_Int32            GetCharWidth() const { return mrData.mnCharWidth; }
    sal_Int32                   GetHdrX() const;
    sal_Int32                   GetFirstX() const;
    sal_Int32                   GetLastX() const;
    sal_Int32                   GetX( sal_Int32 nPos ) const;
    sal_Int32                   GetPosFromX( sal_Int32 nX ) const;

    sal_Int32            GetLineCount() const { return mrData.mnLineCount; }
    sal_Int32                   GetVisLineCount() const;
    sal_Int32            GetFirstVisLine() const { return mrData.mnLineOffset; }
    sal_Int32                   GetLastVisLine() const;
    sal_Int32                   GetMaxLineOffset() const;

    bool                        IsValidLine( sal_Int32 nLine ) const;
    bool                        IsVisibleLine( sal_Int32 nLine ) const;

    sal_Int32            GetHdrHeight() const { return mrData.mnHdrHeight; }
    sal_Int32            GetLineHeight() const { return mrData.mnLineHeight; }
    sal_Int32                   GetY( sal_Int32 nLine ) const;
    sal_Int32                   GetLineFromY( sal_Int32 nY ) const;

    sal_Int32            GetRulerCursorPos() const { return mrData.mnPosCursor; }
    sal_Int32            GetGridCursorPos() const { return mrData.mnColCursor; }

    // static helpers ---------------------------------------------------------

    static void                 ImplInvertRect( OutputDevice& rOutDev, const tools::Rectangle& rRect );

    static ScMoveMode           GetHorzDirection( sal_uInt16 nCode, bool bHomeEnd );
    static ScMoveMode           GetVertDirection( sal_uInt16 nCode, bool bHomeEnd );
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */