docs/user/support/TypeConstants.dox

   1 /*
   2  * Copyright 2007-2014 Haiku, Inc. All rights reserved.
   3  * Distributed under the terms of the MIT License.
   4  *
   5  * Authors:
   6  *              Niels Sascha Reedijk, niels.reedijk@gmail.com
   7  *              John Scipione, jscipione@gmail.com
   8  *
   9  * Corresponds to:
  10  *              headers/os/support/TypeConstants.h      rev 43506
  11  */
  12
  13
  14 /*!
  15         \file TypeConstants.h
  16         \ingroup support
  17         \ingroup libbe
  18         \brief Represents type codes that are used in various part of the Haiku API.
  19
  20         The type codes all refer to a specified type, except one. B_ANY_TYPE can
  21         refer to literally any type. This type could be used in case you send or receive
  22         data of which you don't know the type, but you want to send or receive it
  23         anyway.
  24 */
  25
  26
  27 /*!
  28         \var B_ANY_TYPE
  29         \brief General type when the exact contents is not yet known.
  30
  31         \since Haiku R1
  32 */
  33
  34
  35 /*!
  36         \var B_ATOM_TYPE
  37         \brief Reference to a BAtomic class that was going to be in BeOS R6.
  38
  39         Unused in Haiku.
  40
  41         \since Haiku R1
  42 */
  43
  44
  45 /*!
  46         \var B_ATOMREF_TYPE
  47         \brief Reference to a BAtomic class that was going to be in BeOS R6.
  48
  49         Unused in Haiku.
  50
  51         \since Haiku R1
  52 */
  53
  54
  55 /*!
  56         \var B_BOOL_TYPE
  57         \brief Boolean value.
  58
  59         \since Haiku R1
  60 */
  61
  62
  63 /*!
  64         \var B_CHAR_TYPE
  65         \brief Represents the \c char type.
  66
  67         \since Haiku R1
  68 */
  69
  70
  71 /*!
  72         \var B_COLOR_8_BIT_TYPE
  73         \brief Represents a one-byte color.
  74
  75         \since Haiku R1
  76 */
  77
  78
  79 /*!
  80         \var B_DOUBLE_TYPE
  81         \brief Represents the \c double type.
  82
  83         \since Haiku R1
  84 */
  85
  86
  87 /*!
  88         \var B_FLOAT_TYPE
  89         \brief Represents the \c float type.
  90
  91         \since Haiku R1
  92 */
  93
  94
  95 /*!
  96         \var B_GRAYSCALE_8_BIT_TYPE
  97         \brief Represents a byte-long grayscale value.
  98
  99         \since Haiku R1
 100 */
 101
 102
 103 /*!
 104         \var B_INT16_TYPE
 105         \brief Represents a \c short type.
 106
 107         \since Haiku R1
 108 */
 109
 110
 111 /*!
 112         \var B_INT32_TYPE
 113         \brief Represents a \c long type.
 114
 115         \since Haiku R1
 116 */
 117
 118
 119 /*!
 120         \var B_INT64_TYPE
 121         \brief Represents a \c long \c long type.
 122
 123         \since Haiku R1
 124 */
 125
 126
 127 /*!
 128         \var B_INT8_TYPE
 129         \brief Represents a \c char type used for integer storage.
 130
 131         \since Haiku R1
 132 */
 133
 134
 135 /*!
 136         \var B_LARGE_ICON_TYPE
 137         \brief Represents a large icon.
 138
 139         \since Haiku R1
 140 */
 141
 142
 143 /*!
 144         \var B_MEDIA_PARAMETER_GROUP_TYPE
 145         \brief Represents the BParameterGroup type from the media kit.
 146
 147         \since Haiku R1
 148 */
 149
 150
 151 /*!
 152         \var B_MEDIA_PARAMETER_TYPE
 153         \brief Represents the BParameter type from the media kit.
 154
 155         \since Haiku R1
 156 */
 157
 158
 159 /*!
 160         \var B_MEDIA_PARAMETER_WEB_TYPE
 161         \brief Represents the BParameterWeb type from the media kit.
 162
 163         \since Haiku R1
 164 */
 165
 166
 167 /*!
 168         \var B_MESSAGE_TYPE
 169         \brief Represents a BMessage type.
 170
 171         \since Haiku R1
 172 */
 173
 174
 175 /*!
 176         \var B_MESSENGER_TYPE
 177         \brief Represents a BMessenger type.
 178
 179         \since Haiku R1
 180 */
 181
 182
 183 // Todo: the rest of the types
 184
 185
 186 /*!
 187         \name System-wide MIME types for handling URLs
 188 */
 189
 190
 191 //! @{
 192
 193
 194 /*!
 195         \var B_URL_HTTP
 196         \brief application/x-vnd.Be.URL.http
 197
 198         \since Haiku R1
 199 */
 200
 201
 202 /*!
 203         \var B_URL_HTTPS
 204         \brief application/x-vnd.Be.URL.https
 205
 206         \since Haiku R1
 207 */
 208
 209
 210 /*!
 211         \var B_URL_FTP
 212         \brief application/x-vnd.Be.URL.ftp
 213
 214         \since Haiku R1
 215 */
 216
 217
 218 /*!
 219         \var B_URL_GOPHER
 220         \brief application/x-vnd.Be.URL.gopher
 221
 222         \since Haiku R1
 223 */
 224
 225
 226 /*!
 227         \var B_URL_MAILTO
 228         \brief application/x-vnd.Be.URL.mailto
 229
 230         \since Haiku R1
 231 */
 232
 233
 234 /*!
 235         \var B_URL_NEWS
 236         \brief application/x-vnd.Be.URL.news
 237
 238         \since Haiku R1
 239 */
 240
 241
 242 /*!
 243         \var B_URL_NNTP
 244         \brief application/x-vnd.Be.URL.nntp
 245
 246         \since Haiku R1
 247 */
 248
 249
 250 /*!
 251         \var B_URL_TELNET
 252         \brief application/x-vnd.Be.URL.telnet
 253
 254         \since Haiku R1
 255 */
 256
 257
 258 /*!
 259         \var B_URL_RLOGIN
 260         \brief application/x-vnd.Be.URL.rlogin
 261
 262         \since Haiku R1
 263 */
 264
 265
 266 /*!
 267         \var B_URL_TN3270
 268         \brief application/x-vnd.Be.URL.tn3270
 269
 270         \since Haiku R1
 271 */
 272
 273
 274 /*!
 275         \var B_URL_WAIS
 276         \brief application/x-vnd.Be.URL.wais
 277
 278         \since Haiku R1
 279 */
 280
 281
 282 /*!
 283         \var B_URL_FILE
 284         \brief application/x-vnd.Be.URL.file
 285
 286         \since Haiku R1
 287 */
 288
 289
 290 //! @}