diff options
Diffstat (limited to 'NxWidgets/libnxwidgets/include/clatchbuttonarray.hxx')
| -rw-r--r-- | NxWidgets/libnxwidgets/include/clatchbuttonarray.hxx | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/NxWidgets/libnxwidgets/include/clatchbuttonarray.hxx b/NxWidgets/libnxwidgets/include/clatchbuttonarray.hxx new file mode 100644 index 000000000..bffeb58a1 --- /dev/null +++ b/NxWidgets/libnxwidgets/include/clatchbuttonarray.hxx @@ -0,0 +1,170 @@ +/**************************************************************************** + * include/clatchbuttonarray.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_CLATCHBUTTONARRAY_HXX +#define __INCLUDE_CLATCHBUTTONARRAY_HXX + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <stdbool.h> + +#include <nuttx/nx/nxglib.h> + +#include "cstickybuttonarray.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. When a button + * is clicked is latches (i.e., it stays pushed after the press is released. + * The behavior is then like radio buttons: Pressing each each button in + * the array unlatches the previous button and latches the new button. + * + * Unlike CLatchButton, pressing the same button more than once has no + * effect. + */ + + class CLatchButtonArray : public CStickyButtonArray + { + protected: + /** + * Handles button click events + * + * @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); + + /** + * Redraws the button. + * + * @param x The x coordinate of the mouse. + * @param y The y coordinate of the mouse. + */ + + /** + * Copy constructor is protected to prevent usage. + */ + + inline CLatchButtonArray(const CLatchButtonArray &button) : CStickyButtonArray(button) { } + + public: + + /** + * Constructor for an array of latch 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. + */ + + CLatchButtonArray(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); + + /** + * CLatchButtonArray Destructor. + */ + + virtual inline ~CLatchButtonArray(void) { } + + /** + * Return the position of the last latched button (0,0 will be returned + * the no button has every been latched). The button at this position + * is currently latched 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 latched + */ + + inline const bool isAnyButtonLatched(int &column, int &row) const + { + return isAnyButtonStuckDown(column, row); + } + + /** + * Check if this specific button in the array is latched + * + * @param column The column of the button to check. + * @param row The row of the button to check. + * @return True if this button is clicked + */ + + inline const bool isThisButtonLatched(int column, int row) const + { + return isThisButtonStuckDown(column, row); + } + }; +} + +#endif // __cplusplus + +#endif // __INCLUDE_CLATCHBUTTONARRAY_HXX |