From 612dc509723bafbc28e09e1489fa21e06688be27 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Tue, 15 Jul 2014 09:29:28 -0600 Subject: NxWidgets::CStickyImage: New image class --- NxWidgets/libnxwidgets/include/cstickyimage.hxx | 190 ++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 NxWidgets/libnxwidgets/include/cstickyimage.hxx (limited to 'NxWidgets/libnxwidgets/include/cstickyimage.hxx') diff --git a/NxWidgets/libnxwidgets/include/cstickyimage.hxx b/NxWidgets/libnxwidgets/include/cstickyimage.hxx new file mode 100644 index 000000000..d89069453 --- /dev/null +++ b/NxWidgets/libnxwidgets/include/cstickyimage.hxx @@ -0,0 +1,190 @@ +/**************************************************************************** + * NxWidgets/libnxwidgets/include/cimagebutton.hxx + * + * Copyright (C) 2014 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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_CSTICKIMAGE_HXX +#define __INCLUDE_CSTICKIMAGE_HXX + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include + +#include +#include + +#include + +#include "cimage.hxx" +#include "cwidgetstyle.hxx" + +/**************************************************************************** + * Pre-Processor Definitions + ****************************************************************************/ + +/**************************************************************************** + * Implementation Classes + ****************************************************************************/ + +#if defined(__cplusplus) + +namespace NXWidgets +{ + class CWidgetControl; + + /** + * CImage that sticks in the selected selected state when clicked. + */ + + class CStickyImage : public CImage + { + protected: + bool m_stuckSelection; /**< True if the image is stuck in the selected */ + + /** + * 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 click events. The image state is completely controlled + * by the m_stuckSelection 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 release events. The image state is completely controlled + * by the m_stuckSelection 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 release events. The image state is completely controlled + * by the m_stuckSelection 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. + */ + + inline CStickyImage(const CStickyImage &button) : CImage(button) { } + + public: + + /** + * Constructor for an image. + * + * @param pWidgetControl The controlling widget for the display + * @param x The x coordinate of the image box, relative to its parent. + * @param y The y coordinate of the image box, relative to its parent. + * @param width The width of the image box. + * @param height The height of the image box. + * @param bitmap The source bitmap image. + * @param style The style that the widget should use. If this is not + * specified, the button will use the global default widget + * style. + */ + + CStickyImage(CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, + nxgl_coord_t width, nxgl_coord_t height, FAR IBitmap *bitmap, + CWidgetStyle *style = (CWidgetStyle *)NULL); + + /** + * Destructor. + */ + + virtual inline ~CStickyImage(void) { } + + /** + * Sets the image's stuck selection state. + * + * @param selection The new stuck selection state. + */ + + void setStuckSelection(bool selection); + + /** + * Toggles the images stuck selection state. + */ + + inline void toggleStuckSelection(void) + { + setStuckSelection(!m_stuckSelection); + } + + /** + * Returns the stuck selection state. + * + * @return True is the button is in the stuck selection state. + */ + + inline const bool isStuckSelection(void) const + { + return m_stuckSelection; + } + }; +} + +#endif // __cplusplus + +#endif // __INCLUDE_CSTICKIMAGE_HXX -- cgit v1.2.3