LibreOffice Module vcl (master)  1
menufloatingwindow.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #pragma once
21 
22 #include "menuwindow.hxx"
23 
24 #include <vcl/toolkit/floatwin.hxx>
25 #include <vcl/menu.hxx>
26 
27 #define EXTRASPACEY 2
28 #define GUTTERBORDER 8
29 
33 {
34  friend void Menu::ImplFillLayoutData() const;
35  friend void Menu::dispose();
36 
37 private:
44  sal_uInt16 nHighlightedItem; // highlighted/selected Item
45  sal_uInt16 nMBDownPos;
46  sal_uInt16 nScrollerHeight;
47  sal_uInt16 nFirstEntry;
48  sal_uInt16 nPosInParent;
49 
50  bool bInExecute : 1;
51  bool bScrollMenu : 1;
52  bool bScrollUp : 1;
53  bool bScrollDown : 1;
54  bool bIgnoreFirstMove : 1;
55  bool bKeyInput : 1;
56 
57  DECL_LINK( PopupEnd, FloatingWindow*, void );
58  DECL_LINK( HighlightChanged, Timer*, void );
59  DECL_LINK( SubmenuClose, Timer *, void );
60  DECL_LINK( AutoScroll, Timer *, void );
61  DECL_LINK( ShowHideListener, VclWindowEvent&, void );
62 
63  virtual void StateChanged( StateChangedType nType ) override;
64  virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
65 
66  void InitMenuClipRegion(vcl::RenderContext& rRenderContext);
67 
68  void Start();
69  void End();
70 
71 protected:
73  void ImplDrawScroller(vcl::RenderContext& rRenderContext, bool bUp);
74  using Window::ImplScroll;
75  void ImplScroll( const Point& rMousePos );
76  void ImplScroll( bool bUp );
77  void ImplCursorUpDown( bool bUp, bool bHomeEnd = false );
78  void ImplHighlightItem( const MouseEvent& rMEvt, bool bMBDown );
79  tools::Long ImplGetStartY() const;
80  tools::Rectangle ImplGetItemRect( sal_uInt16 nPos );
81  void RenderHighlightItem( vcl::RenderContext& rRenderContext, sal_uInt16 nPos );
82  tools::Long GetInitialItemY( tools::Long *pOptStartY = nullptr ) const;
83  void InvalidateItem( sal_uInt16 nPos );
84 
85 public:
86  MenuFloatingWindow(Menu* pMenu, vcl::Window* pParent, WinBits nStyle);
87  virtual ~MenuFloatingWindow() override;
88 
89  virtual void dispose() override;
90  void doShutdown();
91 
92  virtual void MouseMove(const MouseEvent& rMEvt) override;
93  virtual void MouseButtonDown(const MouseEvent& rMEvt) override;
94  virtual void MouseButtonUp(const MouseEvent& rMEvt) override;
95  virtual void KeyInput(const KeyEvent& rKEvent) override;
96  virtual void Command(const CommandEvent& rCEvt) override;
97  virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
98  virtual void RequestHelp( const HelpEvent& rHEvt ) override;
99  virtual void Resize() override;
100 
101  virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
102 
103  void SetFocusId( const VclPtr<vcl::Window>& xId ) { xSaveFocusId = xId; }
104  const VclPtr<vcl::Window>& GetFocusId() const { return xSaveFocusId; }
105 
106  void EnableScrollMenu( bool b );
107  bool IsScrollMenu() const { return bScrollMenu; }
108  sal_uInt16 GetScrollerHeight() const { return nScrollerHeight; }
109 
110  void Execute();
111  void StopExecute();
112  void EndExecute();
113  void EndExecute( sal_uInt16 nSelectId );
114 
115  PopupMenu* GetActivePopup() const { return pActivePopup; }
116  void KillActivePopup( PopupMenu* pThisOnly = nullptr );
117 
118  void ChangeHighlightItem(sal_uInt16 n, bool bStartPopupTimer);
119  sal_uInt16 GetHighlightedItem() const { return nHighlightedItem; }
120 
121  void SetPosInParent( sal_uInt16 nPos ) { nPosInParent = nPos; }
122 
123  bool MenuInHierarchyHasFocus() const;
124 
125  virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() override;
126 };
127 
128 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void StateChanged(StateChangedType nType) override
VclPtr< vcl::Window > xSaveFocusId
void RenderHighlightItem(vcl::RenderContext &rRenderContext, sal_uInt16 nPos)
void ImplHighlightItem(const MouseEvent &rMEvt, bool bMBDown)
void InvalidateItem(sal_uInt16 nPos)
Emit an Invalidate just for this item's area.
tools::Rectangle ImplGetItemRect(sal_uInt16 nPos)
void ChangeHighlightItem(sal_uInt16 n, bool bStartPopupTimer)
VclPtr< PopupMenu > pActivePopup
DECL_LINK(PopupEnd, FloatingWindow *, void)
long Long
PopupMenu * GetActivePopup() const
virtual void Resize() override
MenuFloatingWindow(Menu *pMenu, vcl::Window *pParent, WinBits nStyle)
StateChangedType
Definition: window.hxx:289
bool MenuInHierarchyHasFocus() const
sal_Int64 WinBits
Class that implements the actual window of the floating menu.
void KillActivePopup(PopupMenu *pThisOnly=nullptr)
sal_uInt16 GetHighlightedItem() const
tools::Long ImplGetStartY() const
Get a negative pixel offset for an offset menu.
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible() override
const VclPtr< vcl::Window > & GetFocusId() const
void InitMenuClipRegion(vcl::RenderContext &rRenderContext)
virtual void MouseButtonUp(const MouseEvent &rMEvt) override
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:303
sal_uInt16 GetScrollerHeight() const
void ImplScroll(const Point &rMousePos)
void ImplDrawScroller(vcl::RenderContext &rRenderContext, bool bUp)
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
vcl::Region ImplCalcClipRegion() const
Common ancestor for MenuFloatingWindow and MenuBarWindow.
Definition: menuwindow.hxx:48
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects...
virtual void RequestHelp(const HelpEvent &rHEvt) override
virtual ~MenuFloatingWindow() override
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override
void SetPosInParent(sal_uInt16 nPos)
void ImplCursorUpDown(bool bUp, bool bHomeEnd=false)
Definition: menu.hxx:123
virtual void DataChanged(const DataChangedEvent &rDCEvt) override
void SetFocusId(const VclPtr< vcl::Window > &xId)
SAL_DLLPRIVATE void ImplFillLayoutData() const
Definition: menu.cxx:2228
virtual void Command(const CommandEvent &rCEvt) override
Definition: timer.hxx:26
virtual void MouseButtonDown(const MouseEvent &rMEvt) override
virtual void KeyInput(const KeyEvent &rKEvent) override
virtual void dispose() override
Definition: menu.cxx:181
virtual void MouseMove(const MouseEvent &rMEvt) override
tools::Long GetInitialItemY(tools::Long *pOptStartY=nullptr) const
Calculate the initial vertical pixel offset of the first item.