summaryrefslogtreecommitdiffstats
path: root/vcl/source/window/menufloatingwindow.hxx
blob: c091b46add4f6830ffdad50a5abcbda44f9ed521 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* -*- 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_SOURCE_WINDOW_MENUFLOATINGWINDOW_HXX
#define INCLUDED_VCL_SOURCE_WINDOW_MENUFLOATINGWINDOW_HXX

#include "menuwindow.hxx"

#include <vcl/floatwin.hxx>
#include <vcl/menu.hxx>

#define EXTRASPACEY         2
#define GUTTERBORDER        8

/** Class that implements the actual window of the floating menu.
*/
class MenuFloatingWindow : public FloatingWindow, public MenuWindow
{
    friend void Menu::ImplFillLayoutData() const;
    friend void Menu::dispose();

private:
    VclPtr<Menu> pMenu;
    VclPtr<PopupMenu> pActivePopup;
    Timer aHighlightChangedTimer;
    Timer aSubmenuCloseTimer;
    Timer aScrollTimer;
    VclPtr<vcl::Window> xSaveFocusId;
    sal_uInt16 nHighlightedItem; // highlighted/selected Item
    sal_uInt16 nMBDownPos;
    sal_uInt16 nScrollerHeight;
    sal_uInt16 nFirstEntry;
    sal_uInt16 nPosInParent;

    bool bInExecute : 1;
    bool bScrollMenu : 1;
    bool bScrollUp : 1;
    bool bScrollDown : 1;
    bool bIgnoreFirstMove : 1;
    bool bKeyInput : 1;

    DECL_LINK( PopupEnd, FloatingWindow*, void );
    DECL_LINK( HighlightChanged, Timer*, void );
    DECL_LINK( SubmenuClose, Timer *, void );
    DECL_LINK( AutoScroll, Timer *, void );
    DECL_LINK( ShowHideListener, VclWindowEvent&, void );

    virtual void StateChanged( StateChangedType nType ) override;
    virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;

    void InitMenuClipRegion(vcl::RenderContext& rRenderContext);

    void Start();
    void End();

protected:
    vcl::Region ImplCalcClipRegion() const;
    void ImplDrawScroller(vcl::RenderContext& rRenderContext, bool bUp);
    using Window::ImplScroll;
    void ImplScroll( const Point& rMousePos );
    void ImplScroll( bool bUp );
    void ImplCursorUpDown( bool bUp, bool bHomeEnd = false );
    void ImplHighlightItem( const MouseEvent& rMEvt, bool bMBDown );
    long ImplGetStartY() const;
    tools::Rectangle ImplGetItemRect( sal_uInt16 nPos );
    void RenderHighlightItem( vcl::RenderContext& rRenderContext, sal_uInt16 nPos );
    long GetInitialItemY( long *pOptStartY = nullptr ) const;
    void InvalidateItem( sal_uInt16 nPos );

public:
    MenuFloatingWindow(Menu* pMenu, vcl::Window* pParent, WinBits nStyle);
    virtual ~MenuFloatingWindow() override;

    virtual void dispose() override;
    void doShutdown();

    virtual void MouseMove(const MouseEvent& rMEvt) override;
    virtual void MouseButtonDown(const MouseEvent& rMEvt) override;
    virtual void MouseButtonUp(const MouseEvent& rMEvt) override;
    virtual void KeyInput(const KeyEvent& rKEvent) override;
    virtual void Command(const CommandEvent& rCEvt) override;
    virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
    virtual void RequestHelp( const HelpEvent& rHEvt ) override;
    virtual void Resize() override;

    virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;

    void SetFocusId( const VclPtr<vcl::Window>& xId ) { xSaveFocusId = xId; }
    const VclPtr<vcl::Window>& GetFocusId() const      { return xSaveFocusId; }

    void EnableScrollMenu( bool b );
    bool IsScrollMenu() const        { return bScrollMenu; }
    sal_uInt16 GetScrollerHeight() const   { return nScrollerHeight; }

    void Execute();
    void StopExecute();
    void EndExecute();
    void EndExecute( sal_uInt16 nSelectId );

    PopupMenu* GetActivePopup() const  { return pActivePopup; }
    void KillActivePopup( PopupMenu* pThisOnly = nullptr );

    void ChangeHighlightItem(sal_uInt16 n, bool bStartPopupTimer);
    sal_uInt16 GetHighlightedItem() const { return nHighlightedItem; }

    void SetPosInParent( sal_uInt16 nPos ) { nPosInParent = nPos; }

    bool MenuInHierarchyHasFocus() const;

    virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() override;
};

#endif // INCLUDED_VCL_SOURCE_WINDOW_MENUFLOATINGWINDOW_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */