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, 320 insertions, 0 deletions

diff --git a/include/vcl/headbar.hxx b/include/vcl/headbar.hxx
new file mode 100644
index 000000000..12d5c5941
--- /dev/null
+++ b/include/vcl/headbar.hxx
@@ -0,0 +1,320 @@
+/* -*- 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_VCL_HEADBAR_HXX
+#define INCLUDED_VCL_HEADBAR_HXX
+
+#include <vcl/dllapi.h>
+#include <tools/link.hxx>
+#include <vcl/window.hxx>
+#include <o3tl/typed_flags_set.hxx>
+#include <memory>
+
+/*************************************************************************
+
+Description
+============
+
+class HeaderBar
+
+This class serves for displaying a header bar. A header bar can display
+texts, images or both of them. The items can be changed in size, dragged or
+clicked at. In many cases, it makes, for example, sense to use this control
+in combination with a SvTabListBox.
+
+--------------------------------------------------------------------------
+
+WinBits
+
+WB_BORDER           a border is drawn in the top and in the bottom
+WB_BOTTOMBORDER     a border is drawn in the bottom
+WB_BUTTONSTYLE      The items look like buttons, otherwise they are flat.
+WB_3DLOOK           3D look
+WB_DRAG             items can be dragged
+WB_STDHEADERBAR     WB_BUTTONSTYLE | WB_BOTTOMBORDER
+
+--------------------------------------------------------------------------
+
+ItemBits
+
+HeaderBarItemBits::LEFT            content is displayed in the item left-justified
+HeaderBarItemBits::CENTER          content is displayed in the item centred
+HeaderBarItemBits::RIGHT           content is displayed in the item right-justified
+HeaderBarItemBits::TOP             content is displayed in the item at the upper border
+HeaderBarItemBits::VCENTER         content is displayed in the item vertically centred
+HeaderBarItemBits::BOTTOM          content is displayed in the item at the bottom border
+HeaderBarItemBits::LEFTIMAGE       in case of text and image, the image is displayed left of the text
+HeaderBarItemBits::RIGHTIMAGE      in case of text and image, the image is displayed right of the text
+HeaderBarItemBits::FIXED           item cannot be changed in size
+HeaderBarItemBits::FIXEDPOS        item cannot be moved
+HeaderBarItemBits::CLICKABLE       item is clickable
+                    (select handler is only called on MouseButtonUp)
+HeaderBarItemBits::FLAT            item is displayed in a flat way, even if WB_BUTTONSTYLE is set
+HeaderBarItemBits::DOWNARROW       An arrow pointing downwards is displayed behind the text,
+                    which should, for example, be shown, when after this item,
+                    a corresponding list is sorted in descending order.
+                    The status of the arrow can be set/reset with SetItemBits().
+HeaderBarItemBits::UPARROW         An arrow pointing upwards is displayed behind the text,
+                    which should, for example, be shown, when after this item,
+                    a corresponding list is sorted in ascending order.
+                    The status of the arrow can be set/reset with SetItemBits().
+HeaderBarItemBits::USERDRAW        For this item, the UserDraw handler is called as well.
+HeaderBarItemBits::STDSTYLE        (HeaderBarItemBits::LEFT | HeaderBarItemBits::LEFTIMAGE | HeaderBarItemBits::CLICKABLE)
+
+--------------------------------------------------------------------------
+
+Handler
+
+Select()            Is called, when the item is clicked. If HeaderBarItemBits::CLICKABLE
+                    is set in the item and not HeaderBarItemBits::FLAT, the handler is only
+                    called in the MouseButtonUp handler, when the mouse has been
+                    released over the item. In this case, the Select handler
+                    behaves like it does with a ToolBox button.
+DoubleClick()       This handler is called, when an item is double-clicked.
+                    Whether the item or the separator has been clicked, can
+                    be determined by IsItemMode(). Normally, when a separator
+                    is double-clicked, the optimal column width should be
+                    calculated and should be set.
+StartDrag()         This handler is called, when dragging is started resp.
+                    an item has been clicked. At the latest in this handler,
+                    the size of the size-line should be set with
+                    SetDragSize(), if IsItemMode() returns false.
+Drag()              This handler is called, when dragging is taking place.
+                    If no size is set with SetDragSize(), this handler can
+                    be used to draw the line in the neighbouring window by
+                    oneself. The current dragging position can be requested
+                    with GetDragPos(). In every case, IsItemMode()
+                    should be checked to find out whether a separator is
+                    dragged as well.
+EndDrag()           This handler is called, when a dragging process has been
+                    stopped. If GetCurItemId() returns 0 in the EndDrag handler,
+                    the drag process was aborted. If this is not the case and
+                    IsItemMode() returns false, the new size of the dragged
+                    item should be requested using GetItemSize() and it
+                    should be taken over in the corresponding control.
+                    If IsItemMode() returns true, GetCurItemId()
+                    returns an Id and IsItemDrag() returns true, this
+                    item has been dragged. In this case, the new position
+                    should be requested using  GetItemPos() and the data
+                    in the corresponding control should be adapted.
+                    Otherwise, the position to which the item has been dragged
+                    could also be requested with GetItemDragPos().
+
+Further methods that are important for the handler.
+
+GetCurItemId()      Returns the id of the item, for which the handler has
+                    currently been called. Only returns a valid id in the
+                    handlers Select(), DoubleClick(), StartDrag(),
+                    Drag() and EndDrag(). In the EndDrag handler,
+                    this method returns the id of the dragged item or 0,
+                    if the drag process has been aborted.
+GetItemDragPos()    Returns the position, at which an item has been moved.
+                    HEADERBAR_ITEM_NOTFOUND is returned, if the process
+                    has been aborted or no ItemDrag is active.
+IsItemMode()        This method can be used to determine whether the
+                    handler has been called for an item or a separator.
+                    true    - handler was called for the item
+                    false   - handler was called for the separator
+IsItemDrag()        This method can be used to determine whether an item
+                    has been dragged or selected.
+                    true    - item is dragged
+                    false   - item is selected
+SetDragSize()       This method is used to set the size of the separating
+                    line that is drawn by the control. It should be
+                    equivalent to the height of the neighbouring window.
+                    The height of the HeaderBar is added automatically.
+
+--------------------------------------------------------------------------
+
+Further methods
+
+SetOffset()             This method sets the offset, from which on the
+                        items are shown. This is needed when the
+                        corresponding window is scrolled.
+CalcWindowSizePixel()   This method can be used to calculate the height
+                        of the window, so that the content of the item
+                        can be displayed.
+
+--------------------------------------------------------------------------
+
+Tips and tricks:
+
+1) ContextMenu
+If a context sensitive PopupMenu should be shown, the command
+handler must be overlaid. Using GetItemId() and when passing the
+mouse position, it can be determined whether the mouse click has been
+carried out over an item resp. over which item the mouse click has been
+carried out.
+
+2) last item
+If ButtonStyle has been set, it looks better, if an empty item is
+set at the end which takes up the remaining space.
+In order to do that, you can insert an item with an empty string and
+pass HEADERBAR_FULLSIZE as size. For such an item, you should not set
+HeaderBarItemBits::CLICKABLE, but HeaderBarItemBits::FIXEDPOS.
+
+*************************************************************************/
+
+class ImplHeadItem;
+
+#define WB_BOTTOMBORDER         (WinBits(0x0400))
+#define WB_BUTTONSTYLE          (WinBits(0x0800))
+#define WB_STDHEADERBAR         (WB_BUTTONSTYLE | WB_BOTTOMBORDER)
+
+enum class HeaderBarItemBits
+{
+    NONE                = 0x0000,
+    LEFT                = 0x0001,
+    CENTER              = 0x0002,
+    RIGHT               = 0x0004,
+    LEFTIMAGE           = 0x0010,
+    RIGHTIMAGE          = 0x0020,
+    CLICKABLE           = 0x0400,
+    FLAT                = 0x0800,
+    DOWNARROW           = 0x1000,
+    UPARROW             = 0x2000,
+    STDSTYLE            = LEFT | LEFTIMAGE | CLICKABLE,
+};
+
+namespace o3tl
+{
+    template<> struct typed_flags<HeaderBarItemBits> : is_typed_flags<HeaderBarItemBits, 0x3c37> {};
+}
+
+#define HEADERBAR_APPEND            (sal_uInt16(0xFFFF))
+#define HEADERBAR_ITEM_NOTFOUND     (sal_uInt16(0xFFFF))
+#define HEADERBAR_FULLSIZE          (long(1000000000))
+
+class VCL_DLLPUBLIC HeaderBar : public vcl::Window
+{
+private:
+    std::vector<std::unique_ptr<ImplHeadItem>> mvItemList;
+    long                mnBorderOff1;
+    long                mnBorderOff2;
+    long                mnOffset;
+    long                mnDX;
+    long                mnDY;
+    long                mnDragSize;
+    long                mnStartPos;
+    long                mnDragPos;
+    long                mnMouseOff;
+    sal_uInt16          mnCurItemId;
+    sal_uInt16          mnItemDragPos;
+    bool                mbDragable;
+    bool                mbDrag;
+    bool                mbItemDrag;
+    bool                mbOutDrag;
+    bool                mbButtonStyle;
+    bool                mbItemMode;
+    Link<HeaderBar*,void> maStartDragHdl;
+    Link<HeaderBar*,void> maEndDragHdl;
+    Link<HeaderBar*,void> maSelectHdl;
+    Link<HeaderBar*,void> maCreateAccessibleHdl;
+
+    css::uno::Reference< css::accessibility::XAccessible >
+                          mxAccessible;
+
+    using Window::ImplInit;
+    VCL_DLLPRIVATE void             ImplInit( WinBits nWinStyle );
+    VCL_DLLPRIVATE void             ImplInitSettings( bool bFont, bool bForeground, bool bBackground );
+    VCL_DLLPRIVATE long             ImplGetItemPos( sal_uInt16 nPos ) const;
+    VCL_DLLPRIVATE tools::Rectangle ImplGetItemRect( sal_uInt16 nPos ) const;
+    using Window::ImplHitTest;
+    VCL_DLLPRIVATE sal_uInt16       ImplHitTest( const Point& rPos, long& nMouseOff, sal_uInt16& nPos ) const;
+    VCL_DLLPRIVATE void             ImplInvertDrag( sal_uInt16 nStartPos, sal_uInt16 nEndPos );
+    VCL_DLLPRIVATE void             ImplDrawItem(vcl::RenderContext& rRenderContext, sal_uInt16 nPos, bool bHigh,
+                                                 const tools::Rectangle& rItemRect, const tools::Rectangle* pRect);
+    VCL_DLLPRIVATE void             ImplDrawItem(vcl::RenderContext& rRenderContext, sal_uInt16 nPos, bool bHigh,
+                                                 const tools::Rectangle* pRect);
+    VCL_DLLPRIVATE void             ImplUpdate( sal_uInt16 nPos,
+                                       bool bEnd = false );
+    VCL_DLLPRIVATE void             ImplStartDrag( const Point& rPos, bool bCommand );
+    VCL_DLLPRIVATE void             ImplDrag( const Point& rPos );
+    VCL_DLLPRIVATE void             ImplEndDrag( bool bCancel );
+
+    virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
+
+public:
+    HeaderBar( vcl::Window* pParent, WinBits nWinBits );
+    virtual ~HeaderBar() override;
+
+    virtual void        MouseButtonDown( const MouseEvent& rMEvt ) override;
+    virtual void        MouseMove( const MouseEvent& rMEvt ) override;
+    virtual void        Tracking( const TrackingEvent& rTEvt ) override;
+    virtual void        Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
+    virtual void        Draw( OutputDevice* pDev, const Point& rPos, DrawFlags nFlags ) override;
+    virtual void        Resize() override;
+    virtual void        Command( const CommandEvent& rCEvt ) override;
+    virtual void        RequestHelp( const HelpEvent& rHEvt ) override;
+    virtual void        StateChanged( StateChangedType nStateChange ) override;
+    virtual void        DataChanged( const DataChangedEvent& rDCEvt ) override;
+
+    virtual Size        GetOptimalSize() const override;
+
+    virtual void        EndDrag();
+    virtual void        Select();
+    virtual void        DoubleClick();
+
+    void                InsertItem( sal_uInt16 nItemId, const OUString& rText,
+                                    long nSize, HeaderBarItemBits nBits = HeaderBarItemBits::STDSTYLE,
+                                    sal_uInt16 nPos = HEADERBAR_APPEND );
+    void                RemoveItem( sal_uInt16 nItemId );
+    void                MoveItem( sal_uInt16 nItemId, sal_uInt16 nNewPos );
+    void                Clear();
+
+    void                SetOffset( long nNewOffset );
+    void         SetDragSize( long nNewSize ) { mnDragSize = nNewSize; }
+
+    sal_uInt16          GetItemCount() const;
+    sal_uInt16          GetItemPos( sal_uInt16 nItemId ) const;
+    sal_uInt16          GetItemId( sal_uInt16 nPos ) const;
+    sal_uInt16          GetItemId( const Point& rPos ) const;
+    tools::Rectangle           GetItemRect( sal_uInt16 nItemId ) const;
+    sal_uInt16          GetCurItemId() const { return mnCurItemId; }
+    bool                IsItemMode() const { return mbItemMode; }
+
+    void                SetItemSize( sal_uInt16 nItemId, long nNewSize );
+    long                GetItemSize( sal_uInt16 nItemId ) const;
+    void                SetItemBits( sal_uInt16 nItemId, HeaderBarItemBits nNewBits );
+    HeaderBarItemBits   GetItemBits( sal_uInt16 nItemId ) const;
+
+    void                SetItemText( sal_uInt16 nItemId, const OUString& rText );
+    OUString            GetItemText( sal_uInt16 nItemId ) const;
+
+    OUString            GetHelpText( sal_uInt16 nItemId ) const;
+
+    Size                CalcWindowSizePixel() const;
+
+    using Window::SetHelpId;
+
+    void         SetStartDragHdl( const Link<HeaderBar*,void>& rLink )      { maStartDragHdl = rLink; }
+    void         SetEndDragHdl( const Link<HeaderBar*,void>& rLink )        { maEndDragHdl = rLink; }
+    void         SetSelectHdl( const Link<HeaderBar*,void>& rLink )         { maSelectHdl = rLink; }
+    void         SetCreateAccessibleHdl( const Link<HeaderBar*,void>& rLink ) { maCreateAccessibleHdl = rLink; }
+
+    bool         IsDragable() const                          { return mbDragable; }
+
+    /** Creates and returns the accessible object of the header bar. */
+    virtual css::uno::Reference< css::accessibility::XAccessible >  CreateAccessible() override;
+    void SetAccessible( const css::uno::Reference< css::accessibility::XAccessible >& );
+};
+
+#endif // INCLUDED_VCL_HEADBAR_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */