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_BUTTON_H_ 38 #define CEF_INCLUDE_VIEWS_CEF_BUTTON_H_ 39 #pragma once 40 41 #include "include/views/cef_view.h" 42 43 class CefLabelButton; 44 45 /// 46 // A View representing a button. Depending on the specific type, the button 47 // could be implemented by a native control or custom rendered. Methods must be 48 // called on the browser process UI thread unless otherwise indicated. 49 /// 50 /*--cef(source=library)--*/ 51 class CefButton : public CefView { 52 public: 53 /// 54 // Returns this Button as a LabelButton or NULL if this is not a LabelButton. 55 /// 56 /*--cef()--*/ 57 virtual CefRefPtr<CefLabelButton> AsLabelButton() = 0; 58 59 /// 60 // Sets the current display state of the Button. 61 /// 62 /*--cef()--*/ 63 virtual void SetState(cef_button_state_t state) = 0; 64 65 /// 66 // Returns the current display state of the Button. 67 /// 68 /*--cef(default_retval=CEF_BUTTON_STATE_NORMAL)--*/ 69 virtual cef_button_state_t GetState() = 0; 70 71 /// 72 // Sets the Button will use an ink drop effect for displaying state changes. 73 /// 74 /*--cef()--*/ 75 virtual void SetInkDropEnabled(bool enabled) = 0; 76 77 /// 78 // Sets the tooltip text that will be displayed when the user hovers the mouse 79 // cursor over the Button. 80 /// 81 /*--cef()--*/ 82 virtual void SetTooltipText(const CefString& tooltip_text) = 0; 83 84 /// 85 // Sets the accessible name that will be exposed to assistive technology (AT). 86 /// 87 /*--cef()--*/ 88 virtual void SetAccessibleName(const CefString& name) = 0; 89 }; 90 91 #endif // CEF_INCLUDE_VIEWS_CEF_BUTTON_H_ 92