238 lines
8.3 KiB
C++
238 lines
8.3 KiB
C++
|
/****************************************************************************
|
||
|
|
* NxWidgets/libnxwidgets/include/cstickybutton.hxx
|
||
|
|
*
|
||
|
|
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
|
||
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions
|
||
|
|
* are met:
|
||
|
|
*
|
||
|
|
* 1. Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in
|
||
|
|
* the documentation and/or other materials provided with the
|
||
|
|
* distribution.
|
||
|
|
* 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
|
||
|
|
* me be used to endorse or promote products derived from this software
|
||
|
|
* without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*
|
||
|
|
****************************************************************************
|
||
|
|
*
|
||
|
|
* Portions of this package derive from Woopsi (http://woopsi.org/) and
|
||
|
|
* portions are original efforts. It is difficult to determine at this
|
||
|
|
* point what parts are original efforts and which parts derive from Woopsi.
|
||
|
|
* However, in any event, the work of Antony Dzeryn will be acknowledged
|
||
|
|
* in most NxWidget files. Thanks Antony!
|
||
|
|
*
|
||
|
|
* Copyright (c) 2007-2011, Antony Dzeryn
|
||
|
|
* All rights reserved.
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions are met:
|
||
|
|
*
|
||
|
|
* * Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
* * Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in the
|
||
|
|
* documentation and/or other materials provided with the distribution.
|
||
|
|
* * Neither the names "Woopsi", "Simian Zombie" nor the
|
||
|
|
* names of its contributors may be used to endorse or promote products
|
||
|
|
* derived from this software without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
|
||
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
|
|
* DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
|
||
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifndef __INCLUDE_CSTICKYBUTTON_HXX
|
||
|
|
#define __INCLUDE_CSTICKYBUTTON_HXX
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Included Files
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#include <nuttx/config.h>
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include <stdbool.h>
|
||
|
|
|
||
|
|
#include <nuttx/nx/nxglib.h>
|
||
|
|
|
||
|
|
#include "cbutton.hxx"
|
||
|
|
#include "cwidgetstyle.hxx"
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Pre-Processor Definitions
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Implementation Classes
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
|
||
|
|
namespace NXWidgets
|
||
|
|
{
|
||
|
|
class CWidgetControl;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* CButton that sticks down when clicked.
|
||
|
|
*/
|
||
|
|
|
||
|
|
class CStickyButton : public CButton
|
||
|
|
{
|
||
|
|
protected:
|
||
|
|
bool m_isStuckDown; /**< True if the key is stuck down */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Draws the outline of the button.
|
||
|
|
*
|
||
|
|
* @param port Graphics port to draw to.
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void drawOutline(CGraphicsPort *port);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Draw the area of this widget that falls within the clipping region.
|
||
|
|
* Called by the redraw() function to draw all visible regions.
|
||
|
|
*
|
||
|
|
* @param port The CGraphicsPort to draw to.
|
||
|
|
* @see redraw()
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void drawContents(CGraphicsPort *port);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Draw the area of this widget that falls within the clipping region.
|
||
|
|
* Called by the redraw() function to draw all visible regions.
|
||
|
|
*
|
||
|
|
* @param port The CGraphicsPort to draw to.
|
||
|
|
* @see redraw()
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void drawBorder(CGraphicsPort *port);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Don't redraw on button press events. The button display is
|
||
|
|
* completely controlled by the externally controlled stuck state.
|
||
|
|
*
|
||
|
|
* @param x The x coordinate of the click.
|
||
|
|
* @param y The y coordinate of the click.
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void onClick(nxgl_coord_t x, nxgl_coord_t y) {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Don't redraw on button release events. The button display is
|
||
|
|
* completely controlled by the externally controlled stuck state.
|
||
|
|
*
|
||
|
|
* @param x The x coordinate of the mouse.
|
||
|
|
* @param y The y coordinate of the mouse.
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void onRelease(nxgl_coord_t x, nxgl_coord_t y) { }
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Don't redraw on button release events. The button display is
|
||
|
|
* completely controlled by the externally controlled stuck state.
|
||
|
|
*
|
||
|
|
* @param x The x coordinate of the mouse.
|
||
|
|
* @param y The y coordinate of the mouse.
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual void onReleaseOutside(nxgl_coord_t x, nxgl_coord_t y) { }
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Copy constructor is protected to prevent usage. The button display is
|
||
|
|
* completely controlled by the externally controlled stuck state.
|
||
|
|
*/
|
||
|
|
|
||
|
|
inline CStickyButton(const CStickyButton &button) : CButton(button) { }
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor for buttons that display a string.
|
||
|
|
*
|
||
|
|
* @param pWidgetControl The controlling widget for the display.
|
||
|
|
* @param x The x coordinate of the button, relative to its parent.
|
||
|
|
* @param y The y coordinate of the button, relative to its parent.
|
||
|
|
* @param width The width of the button.
|
||
|
|
* @param height The height of the button.
|
||
|
|
* @param text The text for the button to display.
|
||
|
|
* @param style The style that the button should use. If this is not
|
||
|
|
* specified, the button will use the global default widget
|
||
|
|
* style.
|
||
|
|
*/
|
||
|
|
|
||
|
|
CStickyButton(CWidgetControl *pWidgetControl,
|
||
|
|
nxgl_coord_t x, nxgl_coord_t y,
|
||
|
|
nxgl_coord_t width, nxgl_coord_t height,
|
||
|
|
const CNxString &text,
|
||
|
|
CWidgetStyle *style = (CWidgetStyle *)NULL);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Destructor.
|
||
|
|
*/
|
||
|
|
|
||
|
|
virtual inline ~CStickyButton(void) { }
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the key's stuck down state. If this is true, the key has a
|
||
|
|
* inwards-bevelled border when drawn. If it is false, the key has
|
||
|
|
* an outwards-bevelled border.
|
||
|
|
*
|
||
|
|
* @param stuckDown The new stuck down state.
|
||
|
|
*/
|
||
|
|
|
||
|
|
void setStuckDown(bool stuckDown);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Toggles the key's stuck down state.
|
||
|
|
*/
|
||
|
|
|
||
|
|
inline void toggleStuckDown(void)
|
||
|
|
{
|
||
|
|
setStuckDown(!m_isStuckDown);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the stuck down state.
|
||
|
|
*
|
||
|
|
* @return True is the button is in the stuck down state.
|
||
|
|
*/
|
||
|
|
|
||
|
|
inline const bool isStuckDown(void) const
|
||
|
|
{
|
||
|
|
return m_isStuckDown;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif // __cplusplus
|
||
|
|
|
||
|
|
#endif // __INCLUDE_CSTICKYBUTTON_HXX
|