1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/interface/OptionControl.h hrev49977 10 * src/kits/interface/OptionControl.cpp hrev33756 11 */ 12 13 14///// TO THEY WHO DOCUMENT: it seems like the OptionControl.cpp file some docs already, so that's a good starting point ///// 15 16 17/*! 18 \file OptionControl.h 19 \ingroup interface 20 \brief Undocumented file. 21 22 \since Haiku R1 23*/ 24 25 26/*! 27 \class BOptionControl 28 \ingroup interface 29 \ingroup libbe 30 \brief Undocumented class. 31 32 \since Haiku R1 33*/ 34 35 36/*! 37 \fn BOptionControl::BOptionControl(BRect frame, const char *name, const char *label, BMessage *message, uint32 resizeMask=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) 38 \brief Undocumented public method 39 40 \param frame Undocumented 41 \param name Undocumented 42 \param label Undocumented 43 \param message Undocumented 44 \param resizeMask Undocumented 45 \param flags Undocumented 46 47 \return Undocumented 48 \retval <value> Undocumented 49 50 \since Haiku R1 51*/ 52 53 54/*! 55 \fn BOptionControl::BOptionControl(const char *name, const char *label, BMessage *message, uint32 flags=B_WILL_DRAW) 56 \brief Undocumented public method 57 58 \param name Undocumented 59 \param label Undocumented 60 \param message Undocumented 61 \param flags Undocumented 62 63 \return Undocumented 64 \retval <value> Undocumented 65 66 \since Haiku R1 67*/ 68 69 70/*! 71 \fn virtual virtual BOptionControl::~BOptionControl() 72 \brief Undocumented public method 73 74 \return Undocumented 75 \retval <value> Undocumented 76 77 \since Haiku R1 78*/ 79 80 81/*! 82 \fn virtual virtual void BOptionControl::MessageReceived(BMessage *message) 83 \brief Undocumented public method 84 85 \param message Undocumented 86 87 \since Haiku R1 88*/ 89 90 91/*! 92 \fn status_t BOptionControl::AddOption(const char *name, int32 value) 93 \brief Undocumented public method 94 95 \param name Undocumented 96 \param value Undocumented 97 98 \return Undocumented 99 \retval <value> Undocumented 100 101 \since Haiku R1 102*/ 103 104 105/*! 106 \fn virtual bool BOptionControl::GetOptionAt(int32 index, const char **_name, int32 *_value)=0 107 \brief Undocumented public method 108 109 \param index Undocumented 110 \param _name Undocumented 111 \param _value Undocumented 112 113 \return Undocumented 114 \retval <value> Undocumented 115 116 \since Haiku R1 117*/ 118 119 120/*! 121 \fn virtual void BOptionControl::RemoveOptionAt(int32 index)=0 122 \brief Undocumented public method 123 124 \param index Undocumented 125 126 \since Haiku R1 127*/ 128 129 130/*! 131 \fn virtual int32 BOptionControl::CountOptions() const =0 132 \brief Undocumented public method 133 134 \return Undocumented 135 \retval <value> Undocumented 136 137 \since Haiku R1 138*/ 139 140 141/*! 142 \fn virtual status_t BOptionControl::AddOptionAt(const char *name, int32 value, int32 index)=0 143 \brief Undocumented public method 144 145 \param name Undocumented 146 \param value Undocumented 147 \param index Undocumented 148 149 \return Undocumented 150 \retval <value> Undocumented 151 152 \since Haiku R1 153*/ 154 155 156/*! 157 \fn virtual int32 BOptionControl::SelectedOption(const char **name=NULL, int32 *outValue=NULL) const =0 158 \brief Undocumented public method 159 160 \param name Undocumented 161 \param outValue Undocumented 162 163 \return Undocumented 164 \retval <value> Undocumented 165 166 \since Haiku R1 167*/ 168 169 170/*! 171 \fn virtual virtual status_t BOptionControl::SelectOptionFor(int32 value) 172 \brief Undocumented public method 173 174 \param value Undocumented 175 176 \return Undocumented 177 \retval <value> Undocumented 178 179 \since Haiku R1 180*/ 181 182 183/*! 184 \fn virtual virtual status_t BOptionControl::SelectOptionFor(const char *name) 185 \brief Undocumented public method 186 187 \param name Undocumented 188 189 \return Undocumented 190 \retval <value> Undocumented 191 192 \since Haiku R1 193*/ 194 195 196/*! 197 \fn BMessage* BOptionControl::MakeValueMessage(int32 value) 198 \brief Undocumented protected method 199 200 \param value Undocumented 201 202 \return Undocumented 203 \retval <value> Undocumented 204 205 \since Haiku R1 206*/ 207 208 209/*! 210 \var B_OPTION_CONTROL_VALUE 211 \brief Undocumented enum value. 212 213 \since Haiku R1 214*/ 215