include/svtools/toolbarmenu.hxx

   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 #ifndef INCLUDED_SVTOOLS_TOOLBARMENU_HXX
  21 #define INCLUDED_SVTOOLS_TOOLBARMENU_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24
  25 #include <memory>
  26
  27 #include <rtl/ref.hxx>
  28 #include <vcl/dockwin.hxx>
  29
  30 namespace com :: sun :: star :: frame { class XFrame; }
  31 namespace com :: sun :: star :: frame { struct FeatureStateEvent; }
  32 namespace svt { class FrameStatusListener; }
  33
  34 class Control;
  35 class ValueSet;
  36
  37 namespace svtools {
  38
  39 class ToolbarMenuEntry;
  40 struct ToolbarMenu_Impl;
  41
  42 class SVT_DLLPUBLIC ToolbarPopupBase
  43 {
  44     friend class ToolbarPopupStatusListener;
  45 public:
  46     ToolbarPopupBase(const css::uno::Reference<css::frame::XFrame>& rFrame);
  47     virtual ~ToolbarPopupBase();
  48
  49 protected:
  50     void AddStatusListener( const OUString& rCommandURL );
  51
  52     // Forwarded from XStatusListener (subclasses must override this one to get the status updates):
  53     /// @throws css::uno::RuntimeException
  54     virtual void statusChanged(const css::frame::FeatureStateEvent& Event );
  55
  56     css::uno::Reference<css::frame::XFrame>  mxFrame;
  57     rtl::Reference<svt::FrameStatusListener> mxStatusListener;
  58 };
  59
  60 class SVT_DLLPUBLIC ToolbarPopup : public DockingWindow, public ToolbarPopupBase
  61 {
  62 public:
  63     ToolbarPopup(const css::uno::Reference<css::frame::XFrame>& rFrame,
  64                  vcl::Window* pParentWindow,
  65                  WinBits nBits );
  66     ToolbarPopup(const css::uno::Reference<css::frame::XFrame>& rFrame,
  67                  vcl::Window* pParentWindow,
  68                  const OString& rID, const OUString& rUIXMLDescription );
  69     virtual ~ToolbarPopup() override;
  70     virtual void dispose() override;
  71
  72 protected:
  73     bool IsInPopupMode();
  74     void EndPopupMode();
  75
  76 private:
  77     void init();
  78 };
  79
  80 class SVT_DLLPUBLIC ToolbarMenu : public ToolbarPopup
  81 {
  82     friend struct ToolbarMenu_Impl;
  83 public:
  84     ToolbarMenu(const css::uno::Reference<css::frame::XFrame>& rFrame,
  85                 vcl::Window* pParentWindow,
  86                 WinBits nBits );
  87
  88     virtual ~ToolbarMenu() override;
  89     virtual void dispose() override;
  90
  91     virtual void    MouseMove( const MouseEvent& rMEvt ) override;
  92     virtual void    MouseButtonDown( const MouseEvent& rMEvt ) override;
  93     virtual void    MouseButtonUp( const MouseEvent& rMEvt ) override;
  94     virtual void    KeyInput( const KeyEvent& rKEvent ) override;
  95     virtual void    Command( const CommandEvent& rCEvt ) override;
  96     virtual void    Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
  97     virtual void    GetFocus() override;
  98     virtual void    LoseFocus() override;
  99
 100     void            appendEntry( int nEntryId, const OUString& rStr, MenuItemBits nItemBits = MenuItemBits::NONE );
 101     void            appendEntry( int nEntryId, const OUString& rStr, const Image& rImage );
 102     void            appendEntry( int nEntryId, Control* pControl );
 103     void            appendSeparator();
 104
 105     /** creates an empty ValueSet that is initialized and can be inserted with appendEntry. */
 106     VclPtr<ValueSet> createEmptyValueSetControl();
 107
 108     void            checkEntry( int nEntryId, bool bCheck );
 109
 110     void            enableEntry( int nEntryId, bool bEnable );
 111
 112     void            setEntryText( int nEntryId, const OUString& rStr );
 113
 114     void            setEntryImage( int nEntryId, const Image& rImage );
 115
 116     const Size&     getMenuSize() const;
 117
 118     void            SetSelectHdl( const Link<ToolbarMenu*,void>& rLink );
 119
 120     int             getSelectedEntryId() const;
 121     int             getHighlightedEntryId() const;
 122
 123 protected:
 124     virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() override;
 125
 126     void            StateChanged( StateChangedType nType ) override;
 127     void            DataChanged( const DataChangedEvent& rDCEvt ) override;
 128
 129 private:
 130     DECL_LINK( HighlightHdl, ValueSet*, void );
 131
 132     void            initWindow();
 133
 134     Size            implCalcSize();
 135
 136     void            appendEntry(std::unique_ptr<ToolbarMenuEntry> pEntry);
 137
 138     void            implPaint(vcl::RenderContext& rRenderContext, ToolbarMenuEntry const * pThisOnly = nullptr, bool bHighlight = false);
 139
 140     void            implHighlightEntry(vcl::RenderContext& rRenderContext, int nHighlightEntry);
 141     void            implHighlightAtPosition(const MouseEvent& rMEvt);
 142
 143     void            implChangeHighlightEntry( int nEntry );
 144     void            implSelectEntry( int nSelectedEntry );
 145
 146     ToolbarMenuEntry*   implCursorUpDown( bool bUp, bool bHomeEnd );
 147     ToolbarMenuEntry*   implGetEntry( int nEntry ) const;
 148     ToolbarMenuEntry*   implSearchEntry( int nEntryId ) const;
 149
 150     std::unique_ptr<ToolbarMenu_Impl>   mpImpl;
 151 };
 152
 153 } // namespace svtools
 154
 155 #endif
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */