123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345 |
- /****************************************************************************
- * apps/include/graphics/nxwidgets/clistdata.hxx
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership. The
- * ASF licenses this file to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance with the
- * License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations
- * under the License.
- *
- ****************************************************************************/
- /****************************************************************************
- *
- * 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 __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CLISTDATA_HXX
- #define __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CLISTDATA_HXX
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <cstdint>
- #include <cstdbool>
- #include <nuttx/nx/nxglib.h>
- #include "graphics/nxwidgets/tnxarray.hxx"
- #include "graphics/nxwidgets/ilistdataeventhandler.hxx"
- #include "graphics/nxwidgets/clistdataitem.hxx"
- #include "graphics/nxwidgets/cnxstring.hxx"
- /****************************************************************************
- * Pre-Processor Definitions
- ****************************************************************************/
- /****************************************************************************
- * Implementation Classes
- ****************************************************************************/
- #if defined(__cplusplus)
- namespace NXWidgets
- {
- /**
- * Class representing a list of items. Designed to be used by the
- * CListBox class, etc, to store its data. Fires events to notify
- * listeners when the list changes or a new selection is made.
- */
- class CListData
- {
- protected:
- TNxArray<CListDataItem*> m_items; /**< Collection of list data items. */
- TNxArray<IListDataEventHandler*> m_listDataEventhandlers; /**< Collection of event handlers. */
- bool m_allowMultipleSelections; /**< If true, multiple options can
- be selected. */
- bool m_sortInsertedItems; /**< Automatically sorts items on
- insertion if true. */
- /**
- * Quick sort the items using their compareTo() methods.
- *
- * @param start The index to start sorting at.
- * @param end The index to stop sorting at.
- */
- virtual void quickSort(const int start, const int end);
- /**
- * Swap the locations of two items in the array.
- *
- * @param index1 The index of the first item to swap.
- * @param index2 The index of the second item to swap.
- */
- virtual void swapItems(const int index1, const int index2);
- /**
- * Return the index that an item should be inserted at to maintain a sorted list of data.
- *
- * @param item The item to insert.
- * @return The index that the item should be imserted into at.
- */
- const int getSortedInsertionIndex(const CListDataItem *item) const;
- /**
- * Raise a data changed event.
- */
- void raiseDataChangedEvent(void);
- /**
- * Raise a selection changed event.
- */
- void raiseSelectionChangedEvent(void);
- public:
- /**
- * Constructor.
- */
- CListData(void);
- /**
- * Destructor.
- */
- virtual ~CListData(void);
- /**
- * Add a new item.
- *
- * @param text Text to show in the option.
- * @param value The value of the option.
- */
- virtual void addItem(const CNxString &text, const uint32_t value);
- /**
- * Add an existing item. CListData becomes the owner of the option and will delete it
- * when the list is deleted.
- *
- * @param item The item to add.
- */
- virtual void addItem(CListDataItem *item);
- /**
- * Remove an item by its index.
- *
- * @param index The index of the option to remove.
- */
- virtual void removeItem(const int index);
- /**
- * Select an item by its index.
- *
- * @param index The index of the item to select.
- */
- virtual void selectItem(const int index);
- /**
- * Deselect an item by its index.
- *
- * @param index The index of the item to select.
- */
- virtual void deselectItem(const int index);
- /**
- * Remove all items.
- */
- virtual void removeAllItems(void);
- /**
- * Get the selected index. Returns -1 if nothing is selected. If more than one
- * item is selected, the index of the first selected item is returned.
- *
- * @return The selected index.
- */
- virtual const int getSelectedIndex(void) const;
- /**
- * Sets the selected index. Specify -1 to select nothing. Resets any
- * other selected items to deselected.
- *
- * @param index The selected index.
- */
- virtual void setSelectedIndex(const int index);
- /**
- * Get the selected item. Returns NULL if nothing is selected.
- *
- * @return The selected option.
- */
- virtual const CListDataItem *getSelectedItem(void) const;
- /**
- * Sets whether multiple selections are possible or not.
- *
- * @param allowMultipleSelections True to allow multiple selections.
- */
- virtual inline void
- setAllowMultipleSelections(const bool allowMultipleSelections)
- {
- m_allowMultipleSelections = allowMultipleSelections;
- }
- /**
- * Get the specified item.
- *
- * @return The specified item.
- */
- virtual inline const CListDataItem *getItem(const int index) const
- {
- if (index < 0 || index >= m_items.size())
- {
- return (const CListDataItem *)0;
- }
- else
- {
- return m_items[index];
- }
- }
- /**
- * Sort the items using their compareTo() methods.
- */
- virtual void sort(void);
- /**
- * Get the total number of items.
- *
- * @return The number of items.
- */
- virtual inline const int getItemCount(void) const
- {
- return m_items.size();
- }
- /**
- * Select all items. Does nothing if the list does not allow
- * multiple selections.
- */
- virtual void selectAllItems(void);
- /**
- * Deselect all items.
- */
- virtual void deselectAllItems(void);
- /**
- * Select or deselect an item by its index. Does not deselect any
- * other selected items. Set index to -1 to select nothing.
- *
- * @param index The index of the item to select.
- * @param selected True to select the item, false to deselect it.
- */
- virtual void setItemSelected(const int index, const bool selected);
- /**
- * Returns whether multiple selections are possible or not.
- *
- * @return True if multiple selections are allowed.
- */
- virtual inline const bool allowsMultipleSelections(void) const
- {
- return m_allowMultipleSelections;
- }
- /**
- * Sets whether or not items added to the list are automatically
- * sorted on insert or not.
- *
- * @param sortInsertedItems True to enable sort on insertion.
- */
- virtual inline void setSortInsertedItems(const bool sortInsertedItems)
- {
- m_sortInsertedItems = sortInsertedItems;
- }
- /**
- * Add an event handler.
- *
- * @param eventHandler The event handler to add.
- */
- inline void addListDataEventHandler(IListDataEventHandler *eventHandler)
- {
- m_listDataEventhandlers.push_back(eventHandler);
- }
- /**
- * Remove an event handler.
- *
- * @param eventHandler The event handler to remove.
- */
- void removeListDataEventHandler(IListDataEventHandler *eventHandler);
- };
- }
- #endif // __cplusplus
- #endif // __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CLISTDATA_HXX
|