Line data    Source code

       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 <tools/solar.h>
      24             : #include "vcl/dllapi.h"
      25             : #include <vcl/menu.hxx>
      26             : #include <vcl/keycod.hxx>
      27             : #include <vcl/image.hxx>
      28             : 
      29             : struct SystemMenuData;
      30             : class FloatingWindow;
      31             : class SalFrame;
      32             : 
      33           0 : struct SalItemParams
      34             : {
      35             :     sal_uInt16      nId;                    // item Id
      36             :     MenuItemType    eType;                  // MenuItem-Type
      37             :     MenuItemBits    nBits;                  // MenuItem-Bits
      38             :     Menu*           pMenu;                  // Pointer to Menu
      39             :     OUString   aText;                  // Menu-Text
      40             :     Image           aImage;                 // Image
      41             : };
      42             : 
      43           0 : struct SalMenuButtonItem
      44             : {
      45             :     sal_uInt16          mnId;
      46             :     Image               maImage;
      47             :     OUString       maToolTipText;
      48             : 
      49             :     SalMenuButtonItem() : mnId( 0 ) {}
      50           0 :     SalMenuButtonItem( sal_uInt16 i_nId, const Image& rImg, const OUString& i_rTTText = OUString() )
      51           0 :     : mnId( i_nId ), maImage( rImg ), maToolTipText( i_rTTText ) {}
      52             : };
      53             : 
      54             : class VCL_PLUGIN_PUBLIC SalMenuItem
      55             : {
      56             : public:
      57           0 :     SalMenuItem() {}
      58             :     virtual ~SalMenuItem();
      59             : };
      60             : 
      61             : class VCL_PLUGIN_PUBLIC SalMenu
      62             : {
      63             : public:
      64           0 :     SalMenu() {}
      65             :     virtual ~SalMenu();
      66             : 
      67             :     virtual bool VisibleMenuBar() = 0;  // must return true to actually DISPLAY native menu bars
      68             :                                             // otherwise only menu messages are processed (eg, OLE on Windows)
      69             : 
      70             :     virtual void InsertItem( SalMenuItem* pSalMenuItem, unsigned nPos ) = 0;
      71             :     virtual void RemoveItem( unsigned nPos ) = 0;
      72             :     virtual void SetSubMenu( SalMenuItem* pSalMenuItem, SalMenu* pSubMenu, unsigned nPos ) = 0;
      73             :     virtual void SetFrame( const SalFrame* pFrame ) = 0;
      74             :     virtual void CheckItem( unsigned nPos, bool bCheck ) = 0;
      75             :     virtual void EnableItem( unsigned nPos, bool bEnable ) = 0;
      76             :     virtual void SetItemText( unsigned nPos, SalMenuItem* pSalMenuItem, const OUString& rText )= 0;
      77             :     virtual void SetItemImage( unsigned nPos, SalMenuItem* pSalMenuItem, const Image& rImage ) = 0;
      78             :     virtual void SetAccelerator( unsigned nPos, SalMenuItem* pSalMenuItem, const KeyCode& rKeyCode, const OUString& rKeyName ) = 0;
      79             :     virtual void GetSystemMenuData( SystemMenuData* pData ) = 0;
      80             :     virtual bool ShowNativePopupMenu(FloatingWindow * pWin, const Rectangle& rRect, sal_uLong nFlags);
      81             :     virtual bool AddMenuBarButton( const SalMenuButtonItem& ); // return false if not implemented or failure
      82             :     virtual void RemoveMenuBarButton( sal_uInt16 nId );
      83             : 
      84             :     // TODO: implement show/hide for the Win/Mac VCL native backends
      85           0 :     virtual void ShowItem( unsigned nPos, bool bShow ) { EnableItem( nPos, bShow ); }
      86             : 
      87             :     // return an empty rectangle if not implemented
      88             :     // return Rectangle( Point( -1, -1 ), Size( 1, 1 ) ) if menu bar buttons implemented
      89             :     // but rectangle cannot be determined
      90             :     virtual Rectangle GetMenuBarButtonRectPixel( sal_uInt16 i_nItemId, SalFrame* i_pReferenceFrame );
      91             : };
      92             : 
      93             : #endif // INCLUDED_VCL_INC_SALMENU_HXX
      94             : 
      95             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */