Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 192 insertions, 0 deletions

diff --git a/include/svx/frmsel.hxx b/include/svx/frmsel.hxx
new file mode 100644
index 000000000..f9a619525
--- /dev/null
+++ b/include/svx/frmsel.hxx
@@ -0,0 +1,192 @@
+/* -*- 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,
+    /** If set, the left frame border is enabled. */
+    Left            = 0x0001,
+    /** If set, the right frame border is enabled. */
+    Right           = 0x0002,
+    /** If set, the top frame border is enabled. */
+    Top             = 0x0004,
+    /** If set, the bottom frame border is enabled. */
+    Bottom          = 0x0008,
+    /** If set, the inner horizontal frame border is enabled. */
+    InnerHorizontal = 0x0010,
+    /** If set, the inner vertical frame border is enabled. */
+    InnerVertical   = 0x0020,
+    /** If set, the top-left to bottom-right diagonal frame border is enabled. */
+    DiagonalTLBR    = 0x0040,
+    /** If set, the bottom-left to top-right diagonal frame border is enabled. */
+    DiagonalBLTR    = 0x0080,
+
+    /** If set, all four outer frame borders are enabled. */
+    Outer           = Left | Right | Top | Bottom,
+
+    /** If set, all frame borders will support the don't care state. */
+    DontCare        = 0x0100
+};
+namespace o3tl
+{
+    template<> struct typed_flags<FrameSelFlags> : is_typed_flags<FrameSelFlags, 0x1ff> {};
+}
+
+namespace svx {
+
+struct FrameSelectorImpl;
+namespace a11y { class AccFrameSelectorChild; }
+
+/** All possible states of a frame border. */
+enum class FrameBorderState
+{
+    Show,        /// Frame border has a visible style.
+    Hide,        /// Frame border is hidden (off).
+    DontCare     /// Frame border is in don't care state (if enabled).
+};
+
+
+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;
+
+    /** Initializes the control, enables/disables frame borders according to flags. */
+    void                Initialize( FrameSelFlags nFlags );
+
+    // enabled frame borders
+
+    /** Returns true, if the specified frame border is enabled. */
+    bool                IsBorderEnabled( FrameBorderType eBorder ) const;
+    /** Returns the number of enabled frame borders. */
+    sal_Int32           GetEnabledBorderCount() const;
+    /** Returns the border type from the passed index (counts only enabled frame borders). */
+    FrameBorderType     GetEnabledBorderType( sal_Int32 nIndex ) const;
+
+    // frame border state and style
+
+    /** Returns true, if the control supports the "don't care" frame border state. */
+    bool                SupportsDontCareState() const;
+
+    /** Returns the state (visible/hidden/don't care) of the specified frame border. */
+    FrameBorderState    GetFrameBorderState( FrameBorderType eBorder ) const;
+    /** Returns the style of the specified frame border, if it is visible. */
+    const editeng::SvxBorderLine* GetFrameBorderStyle( FrameBorderType eBorder ) const;
+
+    /** Shows the specified frame border using the passed style, or hides it, if pStyle is 0. */
+    void                ShowBorder( FrameBorderType eBorder, const editeng::SvxBorderLine* pStyle );
+    /** Sets the specified frame border to "don't care" state. */
+    void                SetBorderDontCare( FrameBorderType eBorder );
+
+    /** Returns true, if any enabled frame border has a visible style (not "don't care"). */
+    bool                IsAnyBorderVisible() const;
+    /** Hides all enabled frame borders. */
+    void                HideAllBorders();
+
+    /** Returns true, if all visible frame borders have equal widths.
+        @descr  Ignores hidden and "don't care" frame borders. On success,
+        returns the width in the passed parameter. */
+    bool                GetVisibleWidth( long& rnWidth, SvxBorderLineStyle& rnStyle ) const;
+    /** Returns true, if all visible frame borders have equal color.
+        @descr  Ignores hidden and "don't care" frame borders. On success,
+        returns the color in the passed parameter. */
+    bool                GetVisibleColor( Color& rColor ) const;
+
+    // frame border selection
+
+    /** Returns the current selection handler. */
+    const Link<LinkParamNone*,void>&  GetSelectHdl() const;
+    /** Sets the passed handler that is called if the selection of the control changes. */
+    void                SetSelectHdl( const Link<LinkParamNone*,void>& rHdl );
+
+    /** Returns true, if the specified frame border is selected. */
+    bool                IsBorderSelected( FrameBorderType eBorder ) const;
+    /** Selects or deselects the specified frame border. */
+    void                SelectBorder( FrameBorderType eBorder );
+    /** Returns true, if any of the enabled frame borders is selected. */
+    bool                IsAnyBorderSelected() const;
+    /** Selects or deselects all frame borders. */
+    void                SelectAllBorders( bool bSelect );
+    /** Deselects all frame borders. */
+    void         DeselectAllBorders() { SelectAllBorders( false ); }
+
+    /** Selects or deselects all visible frame borders (ignores hidden and "don't care" borders). */
+    void                SelectAllVisibleBorders();
+
+    /** Sets the passed line widths to all selected frame borders (in twips). */
+    void                SetStyleToSelection( long nWidth, SvxBorderLineStyle nStyle );
+    /** Sets the passed color to all selected frame borders. */
+    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(); }
+
+    /** Returns the accessibility child object of the specified frame border (if enabled). */
+    rtl::Reference< a11y::AccFrameSelectorChild >
+                        GetChildAccessible( FrameBorderType eBorder );
+    /** Returns the accessibility child object with specified index (counts enabled frame borders only). */
+    css::uno::Reference< css::accessibility::XAccessible >
+                        GetChildAccessible( sal_Int32 nIndex );
+    /** Returns the accessibility child object at the specified position (relative to control). */
+    css::uno::Reference< css::accessibility::XAccessible >
+                        GetChildAccessible( const Point& rPos );
+
+    /** Returns the bounding rectangle of the specified frame border (if enabled). */
+    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;   /// Pointer to accessibility object of the control.
+    std::unique_ptr< FrameSelectorImpl > mxImpl;
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */