/* -*- 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_CSVRULER_HXX #define INCLUDED_SC_SOURCE_UI_INC_CSVRULER_HXX #include #include "csvcontrol.hxx" #include "csvsplits.hxx" #include "scdllapi.h" class ScAccessibleCsvControl; /** A ruler control for the CSV import dialog. Supports setting and moving splits (which divide lines of data into several columns). */ class SC_DLLPUBLIC ScCsvRuler : public ScCsvControl { private: ScopedVclPtrInstance maBackgrDev;/// Ruler background, scaling. ScopedVclPtrInstance maRulerDev; /// Ruler with splits and cursor. Color maBackColor; /// Background color. Color maActiveColor; /// Color for active part of ruler. Color maTextColor; /// Text and scale color. Color maSplitColor; /// Split area color. ScCsvSplits maSplits; /// Vector with split positions. ScCsvSplits maOldSplits; /// Old state for cancellation. sal_Int32 mnPosCursorLast; /// Last valid position of cursor. sal_Int32 mnPosMTStart; /// Start position of mouse tracking. sal_Int32 mnPosMTCurr; /// Current position of mouse tracking. bool mbPosMTMoved; /// Tracking: Anytime moved to another position? Size maWinSize; /// Size of the control. Rectangle maActiveRect; /// The active area of the ruler. sal_Int32 mnSplitSize; /// Size of a split circle. public: explicit ScCsvRuler( ScCsvControl& rParent ); virtual ~ScCsvRuler(); virtual void dispose() override; // common ruler handling -------------------------------------------------- public: /** Sets position and size of the ruler. The height is calculated internally. */ virtual void setPosSizePixel( long nX, long nY, long nWidth, long nHeight, PosSizeFlags nFlags = PosSizeFlags::All ) override; /** Apply current layout data to the ruler. */ void ApplyLayout( const ScCsvLayoutData& rOldData ); private: /** Reads colors from system settings. */ SAL_DLLPRIVATE void InitColors(); /** Initializes all data dependent from the control's size. */ SAL_DLLPRIVATE void InitSizeData(); /** Moves cursor to a new position. @param bScroll sal_True = The method may scroll the ruler. */ SAL_DLLPRIVATE void MoveCursor( sal_Int32 nPos, bool bScroll = true ); /** Moves cursor to the given direction. */ SAL_DLLPRIVATE void MoveCursorRel( ScMoveMode eDir ); /** Sets cursor to an existing split, according to eDir. */ SAL_DLLPRIVATE void MoveCursorToSplit( ScMoveMode eDir ); /** Scrolls data grid vertically. */ SAL_DLLPRIVATE void ScrollVertRel( ScMoveMode eDir ); // split handling --------------------------------------------------------- public: /** Returns the split array. */ inline const ScCsvSplits& GetSplits() const { return maSplits; } /** Returns the number of splits. */ inline sal_uInt32 GetSplitCount() const { return maSplits.Count(); } /** Returns the position of the specified split. */ inline sal_Int32 GetSplitPos( sal_uInt32 nIndex ) const { return maSplits[ nIndex ]; } /** Finds a position nearest to nPos which does not cause scrolling the visible area. */ sal_Int32 GetNoScrollPos( sal_Int32 nPos ) const; /** Returns true if at position nPos is a split. */ inline bool HasSplit( sal_Int32 nPos ) const { return maSplits.HasSplit( nPos ); } /** Inserts a split. */ void InsertSplit( sal_Int32 nPos ); /** Removes a split. */ void RemoveSplit( sal_Int32 nPos ); /** Moves a split from nPos to nNewPos. */ void MoveSplit( sal_Int32 nPos, sal_Int32 nNewPos ); /** Removes all splits of the ruler. */ void RemoveAllSplits(); private: /** Finds next position without a split. */ SAL_DLLPRIVATE sal_Int32 FindEmptyPos( sal_Int32 nPos, ScMoveMode eDir ) const; /** Moves split and cursor to nNewPos and commits event. */ SAL_DLLPRIVATE void MoveCurrSplit( sal_Int32 nNewPos ); /** Moves split and cursor to the given direction and commits event. */ SAL_DLLPRIVATE void MoveCurrSplitRel( ScMoveMode eDir ); // event handling --------------------------------------------------------- protected: virtual void Resize() override; virtual void GetFocus() override; virtual void LoseFocus() override; virtual void DataChanged( const DataChangedEvent& rDCEvt ) override; virtual void MouseButtonDown( const MouseEvent& rMEvt ) override; virtual void MouseMove( const MouseEvent& rMEvt ) override; virtual void Tracking( const TrackingEvent& rTEvt ) override; virtual void KeyInput( const KeyEvent& rKEvt ) override; private: /** Starts tracking at the specified position. */ SAL_DLLPRIVATE void StartMouseTracking( sal_Int32 nPos ); /** Moves tracking to a new position. */ SAL_DLLPRIVATE void MoveMouseTracking( sal_Int32 nPos ); /** Applies tracking action for the current tracking position. @param bApply sal_True = apply action, sal_False = cancel action. */ SAL_DLLPRIVATE void EndMouseTracking( bool bApply ); // painting --------------------------------------------------------------- protected: virtual void Paint( vcl::RenderContext& rRenderContext, const Rectangle& ) override; public: /** Redraws the entire ruler. */ void ImplRedraw(); private: /** Returns the width of the control. */ inline sal_Int32 GetWidth() const { return maWinSize.Width(); } /** Returns the height of the control. */ inline sal_Int32 GetHeight() const { return maWinSize.Height(); } /** Draws the background and active area to maBackgrDev (only the given X range). */ SAL_DLLPRIVATE void ImplDrawArea( sal_Int32 nPosX, sal_Int32 nWidth ); /** Draws the entire ruler background with scaling to maBackgrDev. */ SAL_DLLPRIVATE void ImplDrawBackgrDev(); /** Draws a split to maRulerDev. */ SAL_DLLPRIVATE void ImplDrawSplit( sal_Int32 nPos ); /** Erases a split from maRulerDev. */ SAL_DLLPRIVATE void ImplEraseSplit( sal_Int32 nPos ); /** Draws the ruler background, all splits and the cursor to maRulerDev. */ SAL_DLLPRIVATE void ImplDrawRulerDev(); /** Inverts the cursor bar at the specified position in maRulerDev. */ SAL_DLLPRIVATE void ImplInvertCursor( sal_Int32 nPos ); /** Draws directly tracking rectangle to the column with the specified index. */ SAL_DLLPRIVATE void ImplDrawTrackingRect(); /** Sets arrow or horizontal split pointer. */ SAL_DLLPRIVATE void ImplSetMousePointer( sal_Int32 nPos ); // accessibility ---------------------------------------------------------- protected: /** Creates a new accessible object. */ virtual rtl::Reference ImplCreateAccessible() override; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */