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