diff options
Diffstat (limited to 'NxWidgets/libnxwidgets/include/cprogressbar.hxx')
| -rw-r--r-- | NxWidgets/libnxwidgets/include/cprogressbar.hxx | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/NxWidgets/libnxwidgets/include/cprogressbar.hxx b/NxWidgets/libnxwidgets/include/cprogressbar.hxx new file mode 100644 index 000000000..c75d1eee6 --- /dev/null +++ b/NxWidgets/libnxwidgets/include/cprogressbar.hxx @@ -0,0 +1,251 @@ +/**************************************************************************** + * NxWidgets/libnxwidgets/include/cprogressbar.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_CPROGRESSBAR_HXX +#define __INCLUDE_CPROGRESSBAR_HXX + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <stdbool.h> + +#include <nuttx/nx/nxglib.h> + +#include "cnxwidget.hxx" + +/**************************************************************************** + * Pre-Processor Definitions + ****************************************************************************/ + +/**************************************************************************** + * Implementation Classes + ****************************************************************************/ + +#if defined(__cplusplus) + +namespace NXWidgets +{ + /** + * Forward references + */ + + class CWidgetControl; + + /** + * Widget providing a horizontal progress bar. + */ + + class CProgressBar : public CNxWidget + { + protected: + int16_t m_minimumValue; /**< Minimum value that the grip can represent. */ + int16_t m_maximumValue; /**< Maximum value that the grip can represent. */ + int16_t m_value; /**< Value of the progress bar. */ + bool m_showPercentageText; /**< If true, completion percentage is drawn + over the bar. */ + + /** + * 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); + + /** + * Copy constructor is protected to prevent usage. + */ + + inline CProgressBar(const CProgressBar &progressBar) : CNxWidget(progressBar) { } + + public: + + /** + * Constructor. + * + * @param pWidgetControl The widget control for the display. + * @param x The x coordinate of the progress bar, relative to its parent. + * @param y The y coordinate of the progress bar, relative to its parent. + * @param width The width of the progress bar. + * @param height The height of the progress bar. + */ + + CProgressBar(CWidgetControl *pWidgetControl, + nxgl_coord_t x, nxgl_coord_t y, + nxgl_coord_t width, nxgl_coord_t height); + + /** + * Destructor. + */ + + virtual inline ~CProgressBar(void) { } + + /** + * Get the smallest value that the progress bar can represent. + * + * @return The smallest value. + */ + + inline const int16_t getMinimumValue(void) const + { + return m_minimumValue; + } + + /** + * Get the largest value that the progress bar can represent. + * + * @return The largest value. + */ + + inline const int16_t getMaximumValue(void) const + { + return m_maximumValue; + } + + /** + * Get the current value of the progress bar. + * return The current progress bar value. + */ + + inline const int16_t getValue(void) const + { + return m_value; + } + + /** + * Set the smallest value that the progress bar can represent. + * + * @param value The smallest value. + */ + + inline void setMinimumValue(const int16_t value) + { + m_minimumValue = value; + } + + /** + * Set the largest value that the progress bar can represent. + * + * @param value The largest value. + */ + + inline void setMaximumValue(const int16_t value) + { + m_maximumValue = value; + } + + /** + * Set the value that of the progress bar. + * + * @param value The new value. + */ + + void setValue(const int16_t value); + + /** + * Shows the percentage text over the bar. + */ + + inline void showPercentageText(void) + { + m_showPercentageText = true; + redraw(); + } + + /** + * Hides the percentage text over the bar. + */ + + inline void hidePercentageText(void) + { + m_showPercentageText = false; + redraw(); + } + }; +} + +#endif // __cplusplus + +#endif // __INCLUDE_CPROGRESSBAR_HXX |