vcl/inc/salmenu.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_VCL_INC_SALMENU_HXX
  21 #define INCLUDED_VCL_INC_SALMENU_HXX
  22
  23 #include <utility>
  24 #include <vcl/menu.hxx>
  25 #include <vcl/image.hxx>
  26
  27 struct SystemMenuData;
  28 class FloatingWindow;
  29 class SalFrame;
  30
  31 struct SalItemParams
  32 {
  33     Image           aImage;                 // Image
  34     VclPtr<Menu>    pMenu;                  // Pointer to Menu
  35     OUString        aText;                  // Menu-Text
  36     MenuItemType    eType;                  // MenuItem-Type
  37     sal_uInt16      nId;                    // item Id
  38     MenuItemBits    nBits;                  // MenuItem-Bits
  39 };
  40
  41 struct SalMenuButtonItem
  42 {
  43     sal_uInt16          mnId;
  44     Image               maImage;
  45     OUString            maToolTipText;
  46
  47     SalMenuButtonItem() : mnId( 0 ) {}
  48     SalMenuButtonItem( sal_uInt16 i_nId, Image aImg, OUString  i_TTText )
  49     : mnId( i_nId ), maImage(std::move( aImg )), maToolTipText(std::move( i_TTText )) {}
  50 };
  51
  52 class VCL_PLUGIN_PUBLIC SalMenuItem
  53 {
  54 public:
  55     virtual ~SalMenuItem();
  56 };
  57
  58 class VCL_PLUGIN_PUBLIC SalMenu
  59 {
  60 public:
  61     virtual ~SalMenu();
  62
  63     /**
  64      * Return true, if the implementation supports a native menu bar
  65      * (or wants to suppress LO's menu bar, like on Mac).
  66      *
  67      * You might need to implement the matching SalFrame::SetMenu.
  68      **/
  69     virtual bool HasNativeMenuBar() = 0;
  70     /** Return the height of the native menu bar. Must return 0, if it's hidden. */
  71     virtual int GetMenuBarHeight() const;
  72     /** Change visibility of the native menu bar. */
  73     virtual void ShowMenuBar(bool);
  74
  75     virtual void InsertItem( SalMenuItem* pSalMenuItem, unsigned nPos ) = 0;
  76     virtual void RemoveItem( unsigned nPos ) = 0;
  77     virtual void SetSubMenu( SalMenuItem* pSalMenuItem, SalMenu* pSubMenu, unsigned nPos ) = 0;
  78     virtual void SetFrame( const SalFrame* pFrame ) = 0;
  79     virtual void SetItemBits( unsigned /*nPos*/, MenuItemBits /*nBits*/ ) {}
  80     virtual void CheckItem( unsigned nPos, bool bCheck ) = 0;
  81     virtual void EnableItem( unsigned nPos, bool bEnable ) = 0;
  82     virtual void SetItemText( unsigned nPos, SalMenuItem* pSalMenuItem, const OUString& rText )= 0;
  83     virtual void SetItemImage( unsigned nPos, SalMenuItem* pSalMenuItem, const Image& rImage ) = 0;
  84     virtual void SetAccelerator( unsigned nPos, SalMenuItem* pSalMenuItem, const vcl::KeyCode& rKeyCode, const OUString& rKeyName ) = 0;
  85     virtual void GetSystemMenuData( SystemMenuData* pData ) = 0;
  86     virtual bool ShowNativePopupMenu(FloatingWindow * pWin, const tools::Rectangle& rRect, FloatWinPopupFlags nFlags);
  87     virtual void ShowCloseButton(bool bShow);
  88     virtual bool AddMenuBarButton( const SalMenuButtonItem& ); // return false if not implemented or failure
  89     virtual void RemoveMenuBarButton( sal_uInt16 nId );
  90     virtual void Update() {}
  91
  92     virtual bool CanGetFocus() const { return false; }
  93     virtual bool TakeFocus() { return false; }
  94
  95     // TODO: implement show/hide for the Win/Mac VCL native backends
  96     virtual void ShowItem( unsigned nPos, bool bShow ) { EnableItem( nPos, bShow ); }
  97
  98     // return an empty rectangle if not implemented
  99     // return Rectangle( Point( -1, -1 ), Size( 1, 1 ) ) if menu bar buttons implemented
 100     // but rectangle cannot be determined
 101     virtual tools::Rectangle GetMenuBarButtonRectPixel( sal_uInt16 i_nItemId, SalFrame* i_pReferenceFrame );
 102
 103     virtual void ApplyPersona();
 104 };
 105
 106 #endif // INCLUDED_VCL_INC_SALMENU_HXX
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */