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