1/* 2 * Copyright 2011, Haiku inc. 3 * Distributed under the terms of the MIT Licence. 4 * 5 * Documentation by: 6 * Adrien Destugues <pulkomandy@pulkomandy.ath.cx> 7 * John Scipione <jscipione@gmail.com> 8 * Oliver Tappe <zooey@hirschkaefer.de> 9 * Corresponds to: 10 * /trunk/headers/os/locale/TimeZone.h rev 42274 11 * /trunk/src/kits/locale/TimeZone.cpp rev 42274 12 */ 13 14 15/*! 16 \file TimeZone.h 17 \brief Provides for the BTimeZone class. 18*/ 19 20 21/*! 22 \class BTimeZone 23 \ingroup locale 24 \brief Provides information about time zones. 25*/ 26 27 28/*! 29 \fn BTimeZone::BTimeZone(const char* zoneID, const BLanguage* language) 30 \brief Construct a timezone from its \a zoneID and \a language. 31 32 The constructor only allows you to construct a timezone if you already 33 know its code. If you don't know the code, you can instead go through the 34 BCountry class which can enumerate all timezones in a country, or use the 35 BLocaleRoster, which knows the timezone selected by the user. 36*/ 37 38 39/*! 40 \fn BTimeZone::BTimeZone(const BTimeZone& other) 41*/ 42 43 44/*! 45 \fn BTimeZone& BTimeZone::operator=(const BTimeZone& source) 46*/ 47 48 49/*! 50 \fn const BString& BTimeZone::ID() const 51 \brief Returns the ID of the time zone. 52*/ 53 54 55/*! 56 \fn const BString& BTimeZone::Name() const 57 \brief Returns the localized name of the time zone. 58 59 Use this method to display the time zone's name to the user. 60*/ 61 62 63/*! 64 \fn const BString& BTimeZone::DaylightSavingName() const 65 \brief Returns the name of the daylight savings rules used in this timezone. 66*/ 67 68 69/*! 70 \fn const BString& BTimeZone::ShortName() const 71 \brief Returns the short name of the timezone, in the user's locale. 72*/ 73 74 75/*! 76 \fn const BString& BTimeZone::ShortDaylightSavingName() const 77 \brief Returns the short name of the daylight savings rules used in this 78 timezone. 79*/ 80 81 82/*! 83 \fn int BTimeZone::OffsetFromGMT() const 84 \brief Return the offset from GMT. 85 86 The offset is a number of seconds, positive or negative. 87*/ 88 89 90/*! 91 \fn bool BTimeZone::SupportsDaylightSaving() const 92 \brief Return true if the time zone has daylight saving rules 93*/ 94 95 96/*! 97 \fn status_t BTimeZone::InitCheck() const 98 \brief Return \c false if there was an error creating the timezone 99 for instance if you called the constructor or SetTo() with an invalid 100 timezone code.) 101*/ 102 103 104/*! 105 \fn status_t BTimeZone::SetTo(const char* zoneCode) 106 \brief Set the timezone to another code. 107 108 \returns \c false if there was an error (likely due to an invalid 109 timezone code.) 110*/ 111