diff options
Diffstat (limited to 'NxWidgets/libnxwidgets/include/cstickybuttonarray.hxx')
| -rw-r--r-- | NxWidgets/libnxwidgets/include/cstickybuttonarray.hxx | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/NxWidgets/libnxwidgets/include/cstickybuttonarray.hxx b/NxWidgets/libnxwidgets/include/cstickybuttonarray.hxx new file mode 100644 index 000000000..5854c51f0 --- /dev/null +++ b/NxWidgets/libnxwidgets/include/cstickybuttonarray.hxx @@ -0,0 +1,174 @@ +/**************************************************************************** + * NxWidgets/libnxwidgets/include/cstickybuttonarray.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. + * + ****************************************************************************/ + +#ifndef __INCLUDE_CSTICKYBUTTONARRAY_HXX +#define __INCLUDE_CSTICKYBUTTONARRAY_HXX + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <stdbool.h> + +#include <nuttx/nx/nxglib.h> + +#include "cbuttonarray.hxx" +#include "cwidgetstyle.hxx" + +/**************************************************************************** + * Pre-Processor Definitions + ****************************************************************************/ + +/**************************************************************************** + * Implementation Classes + ****************************************************************************/ + +#if defined(__cplusplus) + +namespace NXWidgets +{ + /** + * Forward references + */ + + class CWidgetControl; + class CNxString; + + /** + * Manages a two-dimensional array of buttons as one widget. A two- + * dimensional array of buttons might also be called a "keyboard". + */ + + class CStickyButtonArray : public CButtonArray + { + protected: + bool m_isStuckDown; /**< True if one key in the array stuck down */ + bool m_stickDown; /**< True there is a change in a sticky button state */ + uint8_t m_stickyRow; /**< The row index of the stuck button */ + uint8_t m_stickyColumn; /**< The column index of the stuck button */ + + /** + * 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); + + /** + * Copy constructor is protected to prevent usage. + */ + + inline CStickyButtonArray(const CStickyButtonArray &button) : CButtonArray(button) { } + + public: + + /** + * Constructor for an array of sticky buttons. + * + * @param pWidgetControl The widget control for the display. + * @param x The x coordinate of the button array, relative to its parent. + * @param y The y coordinate of the button array, relative to its parent. + * @param buttonColumns The number of buttons in one row of the button array + * @param buttonRows The number of buttons in one column of the button array + * @param buttonWidth The width of one button + * @param buttonHeight The height of one button + * @param style The style that the button should use. If this is not + * specified, the button will use the global default widget + * style. + */ + + CStickyButtonArray(CWidgetControl *pWidgetControl, + nxgl_coord_t x, nxgl_coord_t y, + uint8_t buttonColumns, uint8_t buttonRows, + nxgl_coord_t buttonWidth, nxgl_coord_t buttonHeight, + CWidgetStyle *style = (CWidgetStyle *)NULL); + + /** + * CStickyButtonArray Destructor. + */ + + virtual inline ~CStickyButtonArray(void) { } + + /** + * Return the position of the last stuck down button (0,0 will be returned + * the no button has every been stuck down). The button at this position + * is currently stuck down then, in addition, return true. + * + * @param column The location to return the column index of the button + * of interest + * @param row The location to return the row index of the button of + * interest + * @return True if a button in the array is clicked + */ + + virtual bool isAnyButtonStuckDown(int &column, int &row) const; + + /** + * Check if this specific button in the array is stuck down + * + * @param column The column of the button to check. + * @param row The row of the button to check. + * @return True if this button is stuck down + */ + + virtual bool isThisButtonStuckDown(int column, int row) const; + + /** + * Force the button at this position into the stuck down state + * + * @param column The column containing the button to stick down + * @param row The rowtcontaining the button to stick down + * @return False(0) is returned if the indices are out of range. + */ + + virtual bool stickDown(int column, int row); + + /** + * Unstick all buttons + */ + + virtual void unstick(void); + }; +} + +#endif // __cplusplus + +#endif // __INCLUDE_CSTICKYBUTTONARRAY_HXX |