Avoid potential negative array index access to cached text.
[LibreOffice.git] / vcl / inc / salmenu.hxx
blob975df9391eaed591dd10dfa67ae775d30ca37b6c
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_VCL_INC_SALMENU_HXX
21 #define INCLUDED_VCL_INC_SALMENU_HXX
23 #include <utility>
24 #include <vcl/menu.hxx>
25 #include <vcl/image.hxx>
27 struct SystemMenuData;
28 class FloatingWindow;
29 class SalFrame;
31 struct SalItemParams
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
41 struct SalMenuButtonItem
43 sal_uInt16 mnId;
44 Image maImage;
45 OUString maToolTipText;
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 )) {}
52 class VCL_PLUGIN_PUBLIC SalMenuItem
54 public:
55 virtual ~SalMenuItem();
58 class VCL_PLUGIN_PUBLIC SalMenu
60 public:
61 virtual ~SalMenu();
63 virtual bool VisibleMenuBar() = 0; // must return true to actually DISPLAY native menu bars
64 // otherwise only menu messages are processed (eg, OLE on Windows)
65 virtual void ShowMenuBar( bool ) {}
66 virtual void InsertItem( SalMenuItem* pSalMenuItem, unsigned nPos ) = 0;
67 virtual void RemoveItem( unsigned nPos ) = 0;
68 virtual void SetSubMenu( SalMenuItem* pSalMenuItem, SalMenu* pSubMenu, unsigned nPos ) = 0;
69 virtual void SetFrame( const SalFrame* pFrame ) = 0;
70 virtual void SetItemBits( unsigned /*nPos*/, MenuItemBits /*nBits*/ ) {}
71 virtual void CheckItem( unsigned nPos, bool bCheck ) = 0;
72 virtual void EnableItem( unsigned nPos, bool bEnable ) = 0;
73 virtual void SetItemText( unsigned nPos, SalMenuItem* pSalMenuItem, const OUString& rText )= 0;
74 virtual void SetItemImage( unsigned nPos, SalMenuItem* pSalMenuItem, const Image& rImage ) = 0;
75 virtual void SetAccelerator( unsigned nPos, SalMenuItem* pSalMenuItem, const vcl::KeyCode& rKeyCode, const OUString& rKeyName ) = 0;
76 virtual void GetSystemMenuData( SystemMenuData* pData ) = 0;
77 virtual bool ShowNativePopupMenu(FloatingWindow * pWin, const tools::Rectangle& rRect, FloatWinPopupFlags nFlags);
78 virtual void ShowCloseButton(bool bShow);
79 virtual bool AddMenuBarButton( const SalMenuButtonItem& ); // return false if not implemented or failure
80 virtual void RemoveMenuBarButton( sal_uInt16 nId );
81 virtual void Update() {}
83 virtual bool CanGetFocus() const { return false; }
84 virtual bool TakeFocus() { return false; }
86 // TODO: implement show/hide for the Win/Mac VCL native backends
87 virtual void ShowItem( unsigned nPos, bool bShow ) { EnableItem( nPos, bShow ); }
89 // return an empty rectangle if not implemented
90 // return Rectangle( Point( -1, -1 ), Size( 1, 1 ) ) if menu bar buttons implemented
91 // but rectangle cannot be determined
92 virtual tools::Rectangle GetMenuBarButtonRectPixel( sal_uInt16 i_nItemId, SalFrame* i_pReferenceFrame );
94 virtual int GetMenuBarHeight() const;
96 virtual void ApplyPersona();
99 #endif // INCLUDED_VCL_INC_SALMENU_HXX
101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */