NXWidgets: clistdataitem.hxx Source File

NXWidgets 1.19

clistdataitem.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/clistdataitem.hxx
3 *
4 * Copyright (C) 2012, 2016 Gregory Nutt. All rights reserved.
5 * Author: Gregory Nutt <gnutt@nuttx.org>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
18 * me be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************
35 *
36 * Portions of this package derive from Woopsi (http://woopsi.org/) and
37 * portions are original efforts. It is difficult to determine at this
38 * point what parts are original efforts and which parts derive from Woopsi.
39 * However, in any event, the work of Antony Dzeryn will be acknowledged
40 * in most NxWidget files. Thanks Antony!
41 *
42 * Copyright (c) 2007-2011, Antony Dzeryn
43 * All rights reserved.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions are met:
47 *
48 * * Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
50 * * Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 * * Neither the names "Woopsi", "Simian Zombie" nor the
54 * names of its contributors may be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
58 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
59 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
60 * DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
61 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
62 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
64 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
66 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 *
68 ****************************************************************************/
69
70 #ifndef __INCLUDE_CLISTDATAITEM_HXX
71 #define __INCLUDE_CLISTDATAITEM_HXX
72
73 /****************************************************************************
74 * Included Files
75 ****************************************************************************/
76
77 #include <nuttx/config.h>
78
79 #include <stdint.h>
80 #include <stdbool.h>
81
82 #include <nuttx/nx/nxglib.h>
83
84 #include "cnxstring.hxx"
85
86 /****************************************************************************
87 * Pre-Processor Definitions
88 ****************************************************************************/
89
90 /****************************************************************************
91 * Implementation Classes
92 ****************************************************************************/
93
94 #if defined(__cplusplus)
95
96 namespace NXWidgets
97 {
98 /**
99 * Class representing a data item within a list. Intended for use within
100 * the CListData class.
101 */
102
103 class CListDataItem
104 {
105 protected:
106 CNxString m_text; /**< Text to display for option. */
107 uint32_t m_value; /**< Option value. */
108 bool m_isSelected; /**< True if the option is selected. */
109
110 public:
111
112 /**
113 * Constructor.
114 *
115 * @param text The text to display in the item.
116 * @param value The value of the item.
117 */
118
119 CListDataItem(const CNxString &text, const uint32_t value);
120
121 /**
122 * Destructor.
123 */
124
125 virtual ~CListDataItem(void);
126
127 /**
128 * Get the item's text.
129 *
130 * @return The item's text.
131 */
132
133 inline const CNxString &getText(void) const
134 {
135 return m_text;
136 }
137
138 /**
139 * Get the item's value.
140 *
141 * @return The item's value.
142 */
143
144 inline const uint32_t getValue(void) const
145 {
146 return m_value;
147 }
148
149 /**
150 * Get the item's selection state.
151 *
152 * @return True if the item is selected; false if not.
153 */
154
155 inline const bool isSelected(void) const
156 {
157 return m_isSelected;
158 }
159
160 /**
161 * Set the item's selection state.
162 *
163 * @param selected True to select the item; false to deselect it.
164 */
165
166 inline void setSelected(bool selected)
167 {
168 m_isSelected = selected;
169 }
170
171 /**
172 * Compare the item with another. Comparison is based on the text of
173 * the item. Returns 0 if the text in the two items is the same,
174 * a value less than 0 if this item is less than the argument, and
175 * a value greater than 0 if this item is greater than the argument.
176 *
177 * @param item An item to compare this object with.
178 * @return 0 if the text in the two items is the same,
179 * a value less than 0 if this item is less than the argument, and
180 * a value greater than 0 if this item is greater than the argument.
181 */
182
183 virtual int compareTo(const CListDataItem *item) const;
184 };
185 }
186
187 #endif // __cplusplus
188
189 #endif // __INCLUDE_CLISTDATAITEM_HXX
NXWidgets::CListDataItem::isSelected
const bool isSelected(void) const
Definition: clistdataitem.hxx:155
NXWidgets::CListDataItem
Definition: clistdataitem.hxx:103
NXWidgets::CListDataItem::CListDataItem
CListDataItem(const CNxString &text, const uint32_t value)
Definition: clistdataitem.cxx:98
NXWidgets::CListDataItem::getValue
const uint32_t getValue(void) const
Definition: clistdataitem.hxx:144
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::CListDataItem::m_value
uint32_t m_value
Definition: clistdataitem.hxx:107
NXWidgets::CListDataItem::compareTo
virtual int compareTo(const CListDataItem *item) const
Definition: clistdataitem.cxx:125
NXWidgets::CListDataItem::m_isSelected
bool m_isSelected
Definition: clistdataitem.hxx:108
NXWidgets::CListDataItem::~CListDataItem
virtual ~CListDataItem(void)
Definition: clistdataitem.cxx:109
NXWidgets::CListDataItem::m_text
CNxString m_text
Definition: clistdataitem.hxx:106
NXWidgets::CListDataItem::getText
const CNxString & getText(void) const
Definition: clistdataitem.hxx:133
NXWidgets::CNxString
Definition: cnxstring.hxx:121
NXWidgets::CListDataItem::setSelected
void setSelected(bool selected)
Definition: clistdataitem.hxx:166
cnxstring.hxx