frmselimpl.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_SVX_SOURCE_INC_FRMSELIMPL_HXX
#define INCLUDED_SVX_SOURCE_INC_FRMSELIMPL_HXX

#include <vcl/virdev.hxx>
#include <vcl/image.hxx>
#include <svx/frmsel.hxx>
#include <svx/framelink.hxx>
#include <svx/framelinkarray.hxx>
#include <editeng/borderline.hxx>

namespace svx {

namespace a11y {
    class AccFrameSelector;
    class AccFrameSelectorChild;
}

class FrameBorder
{
public:
    explicit FrameBorder(FrameBorderType eType);
    static double GetDefaultPatternScale() { return 0.05; }

    FrameBorderType GetType() const
    {
        return meType;
    }

    bool IsEnabled() const
    {
        return mbEnabled;
    }
    void Enable(FrameSelFlags nFlags);

    FrameBorderState GetState() const
    {
        return meState;
    }
    void SetState(FrameBorderState eState);

    bool IsSelected() const { return mbSelected; }
    void Select( bool bSelect ) { mbSelected = bSelect; }

    const editeng::SvxBorderLine& GetCoreStyle() const { return maCoreStyle; }
    void SetCoreStyle( const editeng::SvxBorderLine* pStyle );

    void SetUIColorPrim( const Color& rColor ) {maUIStyle.SetColorPrim( rColor ); }
    void SetUIColorSecn( const Color& rColor ) {maUIStyle.SetColorSecn( rColor ); }
    const frame::Style& GetUIStyle() const { return maUIStyle; }

    void ClearFocusArea() { maFocusArea.Clear(); }
    void AddFocusPolygon( const tools::Polygon& rFocus );
    void MergeFocusToPolyPolygon( tools::PolyPolygon& rPPoly ) const;

    void ClearClickArea() { maClickArea.Clear(); }
    void AddClickRect( const tools::Rectangle& rRect );
    bool ContainsClickPoint( const Point& rPos ) const;
    tools::Rectangle GetClickBoundRect() const;

    void SetKeyboardNeighbors(FrameBorderType eLeft, FrameBorderType eRight,
                              FrameBorderType eTop, FrameBorderType eBottom);
    FrameBorderType GetKeyboardNeighbor( sal_uInt16 nKeyCode ) const;

private:
    const FrameBorderType meType; 
    FrameBorderState meState; 
    editeng::SvxBorderLine maCoreStyle; 
    frame::Style maUIStyle; 
    FrameBorderType meKeyLeft; 
    FrameBorderType meKeyRight; 
    FrameBorderType meKeyTop; 
    FrameBorderType meKeyBottom;    
    tools::PolyPolygon maFocusArea;    
    tools::PolyPolygon maClickArea;    
    bool mbEnabled : 1; 
    bool mbSelected : 1; 
};


typedef std::vector< FrameBorder* > FrameBorderPtrVec;

struct FrameSelectorImpl
{
    FrameSelector&      mrFrameSel;     
    ScopedVclPtr<VirtualDevice> mpVirDev; 
    std::vector<Image>  maArrows;       
    Color               maBackCol;      
    Color               maArrowCol;     
    Color               maMarkCol;      
    Color               maHCLineCol;    
    Point               maVirDevPos;    

    FrameBorder         maLeft;         
    FrameBorder         maRight;        
    FrameBorder         maTop;          
    FrameBorder         maBottom;       
    FrameBorder         maHor;          
    FrameBorder         maVer;          
    FrameBorder         maTLBR;         
    FrameBorder         maBLTR;         
    editeng::SvxBorderLine maCurrStyle;    
    frame::Array        maArray;        

    FrameSelFlags       mnFlags;        
    FrameBorderPtrVec   maAllBorders;   
    FrameBorderPtrVec   maEnabBorders;  
    Link<LinkParamNone*,void> maSelectHdl;    

    tools::Long                mnCtrlSize;     
    tools::Long                mnArrowSize;    
    tools::Long                mnLine1;        
    tools::Long                mnLine2;        
    tools::Long                mnLine3;        
    tools::Long                mnFocusOffs;    

    bool                mbHor;          
    bool                mbVer;          
    bool                mbTLBR;         
    bool                mbBLTR;         
    bool                mbFullRepaint;  
    bool                mbAutoSelect;   
    bool                mbHCMode;       

    std::vector<rtl::Reference<a11y::AccFrameSelectorChild>>
                        maChildVec;     
    explicit            FrameSelectorImpl( FrameSelector& rFrameSel );
                        ~FrameSelectorImpl();

    // initialization
    void                Initialize( FrameSelFlags nFlags );

    void                InitColors();
    void                InitArrowImageList();
    void                InitGlobalGeometry();
    void                InitBorderGeometry();
    void                InitVirtualDevice();
    void                sizeChanged();

    // frame border access
    const FrameBorder&  GetBorder( FrameBorderType eBorder ) const;
    FrameBorder&        GetBorderAccess( FrameBorderType eBorder );

    // drawing
    void                DrawBackground();

    void                DrawArrows( const FrameBorder& rBorder );

    Color               GetDrawLineColor( const Color& rColor ) const;
    void                DrawAllFrameBorders();

    void                DrawVirtualDevice();
    void                CopyVirDevToControl(vcl::RenderContext& rRenderContext);

    void                DrawAllTrackingRects(vcl::RenderContext& rRenderContext);

    Point               GetDevPosFromMousePos( const Point& rMousePos ) const;

    void                DoInvalidate( bool bFullRepaint );

    // frame border state and style
    void                SetBorderState( FrameBorder& rBorder, FrameBorderState eState );
    void                SetBorderCoreStyle( FrameBorder& rBorder, const editeng::SvxBorderLine* pStyle );

    void                ToggleBorderState( FrameBorder& rBorder );

    // frame border selection
    void                SelectBorder( FrameBorder& rBorder, bool bSelect );
    void                SilentGrabFocus();

    bool                SelectedBordersEqual() const;
};


struct FrameBorderDummy_Pred
{
    bool operator()( const FrameBorder* ) const { return true; }
};

struct FrameBorderVisible_Pred
{
    bool operator()( const FrameBorder* pBorder ) const { return pBorder->GetState() == FrameBorderState::Show; }
};

struct FrameBorderSelected_Pred
{
    bool operator()( const FrameBorder* pBorder ) const { return pBorder->IsSelected(); }
};

template< typename Cont, typename Iter, typename Pred >
class FrameBorderIterBase
{
public:
    typedef Cont container_type;
    typedef Iter iterator_type;
    typedef typename Cont::value_type value_type;
    typedef FrameBorderIterBase<Cont, Iter, Pred> this_type;

    explicit            FrameBorderIterBase( container_type& rCont );
    bool         Is() const { return maIt != maEnd; }
    this_type&          operator++();
    value_type   operator*() const { return *maIt; }

private:
    iterator_type       maIt;
    iterator_type       maEnd;
    Pred                maPred;
};

typedef FrameBorderIterBase< const FrameBorderPtrVec, FrameBorderPtrVec::const_iterator, FrameBorderDummy_Pred >
    FrameBorderCIter;

typedef FrameBorderIterBase< FrameBorderPtrVec, FrameBorderPtrVec::iterator, FrameBorderDummy_Pred >
    FrameBorderIter;

typedef FrameBorderIterBase< const FrameBorderPtrVec, FrameBorderPtrVec::const_iterator, FrameBorderVisible_Pred >
    VisFrameBorderCIter;

typedef FrameBorderIterBase< FrameBorderPtrVec, FrameBorderPtrVec::iterator, FrameBorderVisible_Pred >
    VisFrameBorderIter;

typedef FrameBorderIterBase< const FrameBorderPtrVec, FrameBorderPtrVec::const_iterator, FrameBorderSelected_Pred >
    SelFrameBorderCIter;

typedef FrameBorderIterBase< FrameBorderPtrVec, FrameBorderPtrVec::iterator, FrameBorderSelected_Pred >
    SelFrameBorderIter;

}

#endif

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