/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_VCL_INC_SALMENU_HXX
#define INCLUDED_VCL_INC_SALMENU_HXX

#include <utility>
#include <vcl/menu.hxx>
#include <vcl/image.hxx>

struct SystemMenuData;
class FloatingWindow;
class SalFrame;

struct SalItemParams
{
    Image           aImage;                 // Image
    VclPtr<Menu>    pMenu;                  // Pointer to Menu
    OUString        aText;                  // Menu-Text
    MenuItemType    eType;                  // MenuItem-Type
    sal_uInt16      nId;                    // item Id
    MenuItemBits    nBits;                  // MenuItem-Bits
};

struct SalMenuButtonItem
{
    sal_uInt16          mnId;
    Image               maImage;
    OUString            maToolTipText;

    SalMenuButtonItem() : mnId( 0 ) {}
    SalMenuButtonItem( sal_uInt16 i_nId, Image aImg, OUString  i_TTText )
    : mnId( i_nId ), maImage(std::move( aImg )), maToolTipText(std::move( i_TTText )) {}
};

class VCL_PLUGIN_PUBLIC SalMenuItem
{
public:
    virtual ~SalMenuItem();
};

class VCL_PLUGIN_PUBLIC SalMenu
{
public:
    virtual ~SalMenu();

    /**
     * Return true, if the implementation supports a native menu bar
     * (or wants to suppress LO's menu bar, like on Mac).
     *
     * You might need to implement the matching SalFrame::SetMenu.
     **/
    virtual bool HasNativeMenuBar() = 0;
    /** Return the height of the native menu bar. Must return 0, if it's hidden. */
    virtual int GetMenuBarHeight() const;
    /** Change visibility of the native menu bar. */
    virtual void ShowMenuBar(bool);

    virtual void InsertItem( SalMenuItem* pSalMenuItem, unsigned nPos ) = 0;
    virtual void RemoveItem( unsigned nPos ) = 0;
    virtual void SetSubMenu( SalMenuItem* pSalMenuItem, SalMenu* pSubMenu, unsigned nPos ) = 0;
    virtual void SetFrame( const SalFrame* pFrame ) = 0;
    virtual void SetItemBits( unsigned /*nPos*/, MenuItemBits /*nBits*/ ) {}
    virtual void CheckItem( unsigned nPos, bool bCheck ) = 0;
    virtual void EnableItem( unsigned nPos, bool bEnable ) = 0;
    virtual void SetItemText( unsigned nPos, SalMenuItem* pSalMenuItem, const OUString& rText )= 0;
    virtual void SetItemImage( unsigned nPos, SalMenuItem* pSalMenuItem, const Image& rImage ) = 0;
    virtual void SetAccelerator( unsigned nPos, SalMenuItem* pSalMenuItem, const vcl::KeyCode& rKeyCode, const OUString& rKeyName ) = 0;
    virtual void GetSystemMenuData( SystemMenuData* pData ) = 0;
    virtual bool ShowNativePopupMenu(FloatingWindow * pWin, const tools::Rectangle& rRect, FloatWinPopupFlags nFlags);
    virtual void ShowCloseButton(bool bShow);
    virtual bool AddMenuBarButton( const SalMenuButtonItem& ); // return false if not implemented or failure
    virtual void RemoveMenuBarButton( sal_uInt16 nId );
    virtual void Update() {}

    virtual bool CanGetFocus() const { return false; }
    virtual bool TakeFocus() { return false; }

    // TODO: implement show/hide for the Win/Mac VCL native backends
    virtual void ShowItem( unsigned nPos, bool bShow ) { EnableItem( nPos, bShow ); }

    // return an empty rectangle if not implemented
    // return Rectangle( Point( -1, -1 ), Size( 1, 1 ) ) if menu bar buttons implemented
    // but rectangle cannot be determined
    virtual tools::Rectangle GetMenuBarButtonRectPixel( sal_uInt16 i_nItemId, SalFrame* i_pReferenceFrame );

    virtual void ApplyPersona();
};

#endif // INCLUDED_VCL_INC_SALMENU_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */