• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2016 Marshall A. Greenblatt. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //    * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //    * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
14 // Framework nor the names of its contributors may be used to endorse
15 // or promote products derived from this software without specific prior
16 // written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // ---------------------------------------------------------------------------
31 //
32 // The contents of this file must follow a specific format in order to
33 // support the CEF translator tool. See the translator.README.txt file in the
34 // tools directory for more information.
35 //
36 
37 #ifndef CEF_INCLUDE_VIEWS_CEF_MENU_BUTTON_H_
38 #define CEF_INCLUDE_VIEWS_CEF_MENU_BUTTON_H_
39 #pragma once
40 
41 #include "include/cef_menu_model.h"
42 #include "include/views/cef_label_button.h"
43 #include "include/views/cef_menu_button_delegate.h"
44 
45 ///
46 // MenuButton is a button with optional text, icon and/or menu marker that shows
47 // a menu when clicked with the left mouse button. All size and position values
48 // are in density independent pixels (DIP) unless otherwise indicated. Methods
49 // must be called on the browser process UI thread unless otherwise indicated.
50 ///
51 /*--cef(source=library)--*/
52 class CefMenuButton : public CefLabelButton {
53  public:
54   ///
55   // Create a new MenuButton. A |delegate| must be provided to call ShowMenu()
56   // when the button is clicked. |text| will be shown on the MenuButton and used
57   // as the default accessible name. If |with_frame| is true the button will
58   // have a visible frame at all times, center alignment, additional padding and
59   // a default minimum size of 70x33 DIP. If |with_frame| is false the button
60   // will only have a visible frame on hover/press, left alignment, less padding
61   // and no default minimum size.
62   ///
63   /*--cef(optional_param=text)--*/
64   static CefRefPtr<CefMenuButton> CreateMenuButton(
65       CefRefPtr<CefMenuButtonDelegate> delegate,
66       const CefString& text);
67 
68   ///
69   // Show a menu with contents |menu_model|. |screen_point| specifies the menu
70   // position in screen coordinates. |anchor_position| specifies how the menu
71   // will be anchored relative to |screen_point|. This method should be called
72   // from CefMenuButtonDelegate::OnMenuButtonPressed().
73   ///
74   /*--cef()--*/
75   virtual void ShowMenu(CefRefPtr<CefMenuModel> menu_model,
76                         const CefPoint& screen_point,
77                         cef_menu_anchor_position_t anchor_position) = 0;
78 
79   ///
80   // Show the menu for this button. Results in a call to
81   // CefMenuButtonDelegate::OnMenuButtonPressed().
82   ///
83   /*--cef()--*/
84   virtual void TriggerMenu() = 0;
85 };
86 
87 #endif  // CEF_INCLUDE_VIEWS_CEF_MENU_BUTTON_H_
88