frmsel.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_FRMSEL_HXX
#define INCLUDED_SVX_FRMSEL_HXX

#include <memory>
#include <vcl/customweld.hxx>
#include <editeng/borderline.hxx>
#include <svx/framebordertype.hxx>
#include <svx/svxdllapi.h>
#include <o3tl/typed_flags_set.hxx>

class Color;

enum class FrameSelFlags
{
    NONE            = 0x0000,
    Left            = 0x0001,
    Right           = 0x0002,
    Top             = 0x0004,
    Bottom          = 0x0008,
    InnerHorizontal = 0x0010,
    InnerVertical   = 0x0020,
    DiagonalTLBR    = 0x0040,
    DiagonalBLTR    = 0x0080,

    Outer           = Left | Right | Top | Bottom,

    DontCare        = 0x0100
};
namespace o3tl
{
    template<> struct typed_flags<FrameSelFlags> : is_typed_flags<FrameSelFlags, 0x1ff> {};
}

namespace svx {

struct FrameSelectorImpl;
namespace a11y { class AccFrameSelectorChild; }

enum class FrameBorderState
{
    Show,        
    Hide,        
    DontCare     
};


namespace a11y
{
    class AccFrameSelector;
}

class SAL_WARN_UNUSED SVX_DLLPUBLIC FrameSelector final : public weld::CustomWidgetController
{
public:
    FrameSelector();
    virtual void SetDrawingArea(weld::DrawingArea* pDrawingArea) override;
    virtual ~FrameSelector() override;

    void                Initialize( FrameSelFlags nFlags );

    // enabled frame borders

    bool                IsBorderEnabled( FrameBorderType eBorder ) const;
    sal_Int32           GetEnabledBorderCount() const;
    FrameBorderType     GetEnabledBorderType( sal_Int32 nIndex ) const;

    // frame border state and style

    bool                SupportsDontCareState() const;

    FrameBorderState    GetFrameBorderState( FrameBorderType eBorder ) const;
    const editeng::SvxBorderLine* GetFrameBorderStyle( FrameBorderType eBorder ) const;

    void                ShowBorder( FrameBorderType eBorder, const editeng::SvxBorderLine* pStyle );
    void                SetBorderDontCare( FrameBorderType eBorder );

    bool                IsAnyBorderVisible() const;
    void                HideAllBorders();

    bool                GetVisibleWidth( long& rnWidth, SvxBorderLineStyle& rnStyle ) const;
    bool                GetVisibleColor( Color& rColor ) const;

    // frame border selection

    const Link<LinkParamNone*,void>&  GetSelectHdl() const;
    void                SetSelectHdl( const Link<LinkParamNone*,void>& rHdl );

    bool                IsBorderSelected( FrameBorderType eBorder ) const;
    void                SelectBorder( FrameBorderType eBorder );
    bool                IsAnyBorderSelected() const;
    void                SelectAllBorders( bool bSelect );
    void         DeselectAllBorders() { SelectAllBorders( false ); }

    void                SelectAllVisibleBorders();

    void                SetStyleToSelection( long nWidth, SvxBorderLineStyle nStyle );
    void                SetColorToSelection( const Color& rColor );

    // accessibility

    css::uno::Reference<css::accessibility::XAccessible> getAccessibleParent() const { return GetDrawingArea()->get_accessible_parent(); }
    virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() override;
    a11yrelationset get_accessible_relation_set() const { return GetDrawingArea()->get_accessible_relation_set(); }

    rtl::Reference< a11y::AccFrameSelectorChild >
                        GetChildAccessible( FrameBorderType eBorder );
    css::uno::Reference< css::accessibility::XAccessible >
                        GetChildAccessible( sal_Int32 nIndex );
    css::uno::Reference< css::accessibility::XAccessible >
                        GetChildAccessible( const Point& rPos );

    tools::Rectangle           GetClickBoundRect( FrameBorderType eBorder ) const;

private:
    virtual void        Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
    virtual bool        MouseButtonDown( const MouseEvent& rMEvt ) override;
    virtual bool        KeyInput( const KeyEvent& rKEvt ) override;
    virtual void        GetFocus() override;
    virtual void        LoseFocus() override;
    virtual void        StyleUpdated() override;
    virtual void        Resize() override;

    rtl::Reference<a11y::AccFrameSelector> mxAccess;   
    std::unique_ptr< FrameSelectorImpl > mxImpl;
};

}

#endif

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