olinewin.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/window.hxx>
#include "viewdata.hxx"
 
class ScOutlineEntry;
class ScOutlineArray;
 
enum ScOutlineMode { SC_OUTLINE_HOR, SC_OUTLINE_VER };
 
class ScOutlineWindow : public vcl::Window
{
private:
    ScViewData&                 mrViewData;         
    ScSplitPos                  meWhich;            
    bool                        mbHoriz;            
    bool                        mbMirrorEntries;    
    bool                        mbMirrorLevels;     
 
    Color                       maLineColor;        
    tools::Long                        mnHeaderSize;       
    tools::Long                        mnHeaderPos;        
    tools::Long                        mnMainFirstPos;     
    tools::Long                        mnMainLastPos;      
 
    size_t                      mnMTLevel;          
    size_t                      mnMTEntry;          
    bool                        mbMTActive;         
    bool                        mbMTPressed;        
 
    tools::Rectangle                   maFocusRect;        
    size_t                      mnFocusLevel;       
    size_t                      mnFocusEntry;       
    bool                        mbDontDrawFocus;    
 
public:
                                ScOutlineWindow(
                                    vcl::Window* pParent,
                                    ScOutlineMode eMode,
                                    ScViewData* pViewData,
                                    ScSplitPos eWhich );
    virtual                     ~ScOutlineWindow() override;
    virtual void                dispose() override;
 
    void                        SetHeaderSize( tools::Long nNewSize );
    tools::Long                        GetDepthSize() const;
 
    void                        ScrollPixel( tools::Long nDiff );
 
    using Window::ShowFocus;
 
private:
    void                        InitSettings();
 
    ScDocument&          GetDoc() const { return mrViewData.GetDocument(); }
    SCTAB                GetTab() const { return mrViewData.GetTabNo(); }
    const ScOutlineArray*       GetOutlineArray() const;
    const ScOutlineEntry*       GetOutlineEntry( size_t nLevel, size_t nEntry ) const;
 
    bool                        IsHidden( SCCOLROW nColRowIndex ) const;
    bool                        IsFiltered( SCCOLROW nColRowIndex ) const;
    bool                        IsFirstVisible( SCCOLROW nColRowIndex ) const;
    void                        GetVisibleRange( SCCOLROW& rnColRowStart, SCCOLROW& rnColRowEnd ) const;
 
    Point                       GetPoint( tools::Long nLevelPos, tools::Long nEntryPos ) const;
    tools::Rectangle                   GetRectangle(
                                    tools::Long nLevelStart, tools::Long nEntryStart,
                                    tools::Long nLevelEnd, tools::Long nEntryEnd ) const;
 
    tools::Long                        GetOutputSizeLevel() const;
    tools::Long                        GetOutputSizeEntry() const;
 
    size_t                      GetLevelCount() const;
    tools::Long                        GetLevelPos( size_t nLevel ) const;
    size_t                      GetLevelFromPos( tools::Long nLevelPos ) const;
 
    tools::Long                        GetColRowPos( SCCOLROW nColRowIndex ) const;
    tools::Long                        GetHeaderEntryPos() const;
    bool                        GetEntryPos(
                                    size_t nLevel, size_t nEntry,
                                    tools::Long& rnStartPos, tools::Long& rnEndPos, tools::Long& rnImagePos ) const;
    bool                        GetImagePos( size_t nLevel, size_t nEntry, Point& rPos ) const;
    bool                        IsButtonVisible( size_t nLevel, size_t nEntry ) const;
 
    bool                        ItemHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry, bool& rbButton ) const;
    bool                        ButtonHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry ) const;
    bool                        LineHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry ) const;
 
    void                        DoFunction( size_t nLevel, size_t nEntry ) const;
    void                        DoExpand( size_t nLevel, size_t nEntry ) const;
    void                        DoCollapse( size_t nLevel, size_t nEntry ) const;
 
    bool                        IsFocusButtonVisible() const;
 
    bool                        ImplMoveFocusByEntry( bool bForward, bool bFindVisible );
    bool                        ImplMoveFocusByLevel( bool bForward );
    bool                        ImplMoveFocusByTabOrder( bool bForward );
 
    void                        ImplMoveFocusToVisible( bool bForward );
 
    void                        MoveFocusByEntry( bool bForward );
    void                        MoveFocusByLevel( bool bForward );
    void                        MoveFocusByTabOrder( bool bForward );
 
    void                        StartMouseTracking( size_t nLevel, size_t nEntry );
    bool                 IsMouseTracking() const { return mbMTActive; }
    void                        EndMouseTracking();
 
    void                        SetEntryAreaClipRegion();
    void                        DrawLineRel(
                                    tools::Long nLevelStart, tools::Long nEntryStart,
                                    tools::Long nLevelEnd, tools::Long nEntryEnd );
    void                        DrawRectRel(
                                    tools::Long nLevelStart, tools::Long nEntryStart,
                                    tools::Long nLevelEnd, tools::Long nEntryEnd );
    void                        DrawImageRel(tools::Long nLevelPos, tools::Long nEntryPos, const OUString& rId);
    void                        DrawBorderRel(size_t nLevel, size_t nEntry, bool bPressed);
 
    void                        ShowFocus();
    void                        HideFocus();
 
    void                        ScrollRel( tools::Long nEntryDiff, tools::Long nEntryStart, tools::Long nEntryEnd );
 
protected:
    virtual void                Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
 
    virtual void                Resize() override;
    virtual void                GetFocus() override;
    virtual void                LoseFocus() override;
 
    virtual void                MouseMove( const MouseEvent& rMEvt ) override;
    virtual void                MouseButtonUp( const MouseEvent& rMEvt ) override;
    virtual void                MouseButtonDown( const MouseEvent& rMEvt ) override;
 
    virtual void                KeyInput( const KeyEvent& rKEvt ) override;
 
public:
    virtual void                DataChanged( const DataChangedEvent& rDCEvt ) override;
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */