diff options
author | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2012-03-22 21:22:59 +0000 |
---|---|---|
committer | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2012-03-22 21:22:59 +0000 |
commit | 4dedf494c242b2c4b52707441eefe2a36fbacf0f (patch) | |
tree | 36728130c995053f18637c019829f492f0c3b3fe /NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx | |
parent | af2319a52f4b11df952a5a1060c76cc0cdff0b98 (diff) | |
download | nuttx-4dedf494c242b2c4b52707441eefe2a36fbacf0f.tar.gz nuttx-4dedf494c242b2c4b52707441eefe2a36fbacf0f.tar.bz2 nuttx-4dedf494c242b2c4b52707441eefe2a36fbacf0f.zip |
First check-in of NxWidgets
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4505 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx')
-rw-r--r-- | NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx | 293 |
1 files changed, 293 insertions, 0 deletions
diff --git a/NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx b/NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx new file mode 100644 index 000000000..20ba149fa --- /dev/null +++ b/NxWidgets/libnxwidgets/include/cscrollbarhorizontal.hxx @@ -0,0 +1,293 @@ +/**************************************************************************** + * NxWidgets/libnxwidgets/include/cscrollbarhorizontal.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_CSCROLLBARHORIZONTAL_HXX +#define __INCLUDE_CSCROLLBARHORIZONTAL_HXX + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <stdbool.h> + +#include <nuttx/nx/nxglib.h> + +#include "cnxwidget.hxx" +#include "cwidgeteventhandler.hxx" +#include "cwidgetstyle.hxx" +#include "islider.hxx" + +/**************************************************************************** + * Pre-Processor Definitions + ****************************************************************************/ + +/**************************************************************************** + * Implementation Classes + ****************************************************************************/ + +#if defined(__cplusplus) + +namespace NXWidgets +{ + class CSliderHorizontal; + class CGlyphButton; + class CNxTimer; + + /** + * Container class that holds a slider widget and two arrow buttons. + * The interface is presents is virtually identical to the CSliderHorizontal + * widget, which means the two are easily interchangeable. All events + * raised by the internal slider widget are re-raised by this widget + * to this widget's event handler, meaning its events are also identical + * to the CSliderHorizontal's. + */ + + class CScrollbarHorizontal : public ISlider, public CNxWidget, public CWidgetEventHandler + { + protected: + CSliderHorizontal *m_slider; /**< Pointer to the slider widget */ + CGlyphButton *m_leftButton; /**< Pointer to the left button */ + CGlyphButton *m_rightButton; /**< Pointer to the right button */ + nxgl_coord_t m_buttonWidth; /**< Width of the buttons */ + uint8_t m_scrollTimeout; /**< Time until a button triggers + another grip movement */ + CNxTimer *m_timer; /**< Controls slider button repeats */ + + /** + * Resize the scrollbar to the new dimensions. + * + * @param width The new width. + * @param height The new height. + */ + + virtual void onResize(nxgl_coord_t width, nxgl_coord_t height); + + /** + * Copy constructor is protected to prevent usage. + */ + + inline CScrollbarHorizontal(const CScrollbarHorizontal &scrollbarHorizontal) + : CNxWidget(scrollbarHorizontal) { } + + public: + + /** + * Constructor. + * + * @param pWidgetControl The widget control instance for the window. + * @param x The x coordinate of the slider, relative to its parent. + * @param y The y coordinate of the slider, relative to its parent. + * @param width The width of the slider. + * @param height The height of the slider. + * @param style The style that the widget should use. If this is not + * specified, the widget will use the values stored in the global + * g_defaultWidgetStyle object. The widget will copy the properties of + * the style into its own internal style object. + */ + + CScrollbarHorizontal(CWidgetControl *pWidgetControl, + nxgl_coord_t x, nxgl_coord_t y, + nxgl_coord_t width, nxgl_coord_t height, + CWidgetStyle *style = (CWidgetStyle *)NULL); + + /** + * Destructor. + */ + + virtual inline ~CScrollbarHorizontal(void) { } + + /** + * Get the smallest value that the slider can represent. + * + * @return The smallest value. + */ + + const nxgl_coord_t getMinimumValue(void) const; + + /** + * Get the largest value that the slider can represent. + * + * @return The largest value. + */ + + const nxgl_coord_t getMaximumValue(void) const; + + /** + * Get the current value of the slider. + * + * @return The current slider value. + */ + + const nxgl_coord_t getValue(void) const; + + /** + * Get the value represented by the height of the grip. + * For sliders, this would typically be 1 (so each new + * grip position is worth 1). For scrollbars, this + * would be the height of the scrolling widget. + * + * @return The page size. + */ + + const nxgl_coord_t getPageSize(void) const; + + /** + * Set the smallest value that the slider can represent. + * + * @param value The smallest value. + */ + + void setMinimumValue(const nxgl_coord_t value); + + /** + * Set the largest value that the slider can represent. + * + * @param value The largest value. + */ + + void setMaximumValue(const nxgl_coord_t value); + + /** + * Set the value that of the slider. This will reposition + * and redraw the grip. + * + * @param value The new value. + */ + + void setValue(const nxgl_coord_t value); + + /** + * Set the value that of the slider. This will reposition and redraw + * the grip. The supplied value should be bitshifted left 16 places. + * This ensures greater accuracy than the standard setValue() method if + * the slider is being used as a scrollbar. + * + * @param value The new value. + */ + + void setValueWithBitshift(const int32_t value); + + /** + * Set the page size represented by the grip. + * + * @param pageSize The page size. + * @see getPageSize(). + */ + + void setPageSize(const nxgl_coord_t pageSize); + + /** + * Process events fired by the grip. + * + * @param e The event details. + */ + + virtual void handleActionEvent(const CWidgetEventArgs &e); + + /** + * Process events fired by the grip. + * + * @param e The event details. + */ + + virtual void handleClickEvent(const CWidgetEventArgs &e); + + /** + * Process events fired by the grip. + * + * @param e The event details. + */ + + virtual void handleReleaseEvent(const CWidgetEventArgs &e); + + /** + * Process events fired by the grip. + * + * @param e The event details. + */ + + virtual void handleReleaseOutsideEvent(const CWidgetEventArgs &e); + + /** + * Process events fired by the grip. + * + * @param e The event details. + */ + + virtual void handleValueChangeEvent(const CWidgetEventArgs &e); + }; +} + +#endif // __cplusplus + +#endif // __INCLUDE_CSCROLLBARHORIZONTAL_HXX + |