Button.hpp

00001 /*******************************************************************************
00002 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef BUTTON_HPP
00034 #define BUTTON_HPP
00035 
00036 #include <MaximInterfaceCore/Function.hpp>
00037 #include "Graphic.hpp"
00038 #include "Rectangle.hpp"
00039 #include "Text.hpp"
00040 
00041 /// Clickable button control with text label.
00042 class Button : public Graphic {
00043 public:
00044   typedef MaximInterfaceCore::Function<void(Button *)> EventHandler;
00045 
00046   Button();
00047 
00048   /// @name Text
00049   /// @brief Text label of the button.
00050   /// @{
00051 
00052   const std::string & text() const { return label.text(); }
00053   void setText(const std::string & text) { label.setText(text); }
00054 
00055   /// @}
00056 
00057   /// @name Word wrap
00058   /// @brief Enable or disable word wrapping on the label.
00059   /// @{
00060 
00061   bool wordWrap() const { return label.wordWrap(); }
00062   void setWordWrap(bool wordWrap) { label.setWordWrap(wordWrap); }
00063 
00064   /// @}
00065 
00066   /// @name Preferred width
00067   /// @note Depends on text and wordWrap properties. Call update to refresh.
00068   /// @{
00069 
00070   int preferredWidth() const;
00071   int preferredHeight() const;
00072 
00073   /// @}
00074 
00075   /// Set the event handler that is called when the button is clicked.
00076   void setClickedHandler(const EventHandler & clickedHandler) {
00077     this->clickedHandler = clickedHandler;
00078   }
00079 
00080 protected:
00081   virtual void focusChanged(bool focused);
00082   virtual void resized();
00083   virtual bool doProcessKey(Key key);
00084 
00085 private:
00086   Rectangle border;
00087   Text label;
00088   EventHandler clickedHandler;
00089 };
00090 
00091 #endif