Date

Represents a day between January 1, Year 1 and a few thousand years in the future. None of its members should be accessed directly.

If the #GDate-struct is obtained from g_date_new(), it will be safe to mutate but invalid and thus not safe for calendrical computations.

If it's declared on the stack, it will contain garbage so must be initialized with g_date_clear(). g_date_clear() makes the date invalid but safe. An invalid date doesn't represent a day, it's "empty." A date becomes valid after you set it to a Julian day or you set a day, month, and year.

final

class Date {

GDate* gDate;

bool ownedRef;

GDate* getDateStruct(bool transferOwnership);

void* getStruct();

this(GDate* gDate, bool ownedRef);

uint julianDays [@property getter];

uint julianDays [@property setter];

uint julian [@property getter];

uint julian [@property setter];

uint dmy [@property getter];

uint dmy [@property setter];

uint day [@property getter];

uint day [@property setter];

uint month [@property getter];

uint month [@property setter];

uint year [@property getter];

uint year [@property setter];

this(GDateDay day, GDateMonth month, GDateYear year);

this(uint julianDay);

void addDays(uint nDays);

void addMonths(uint nMonths);

void addYears(uint nYears);

void clamp(Date minDate, Date maxDate);

void clear(uint nDates);

int compare(Date rhs);

int daysBetween(Date date2);

GDateDay getDay();

uint getDayOfYear();

uint getIso8601WeekOfYear();

uint getJulian();

uint getMondayWeekOfYear();

GDateMonth getMonth();

uint getSundayWeekOfYear();

GDateWeekday getWeekday();

GDateYear getYear();

bool isFirstOfMonth();

bool isLastOfMonth();

void order(Date date2);

void setDay(GDateDay day);

void setDmy(GDateDay day, GDateMonth month, GDateYear y);

void setJulian(uint julianDate);

void setMonth(GDateMonth month);

void setParse(string str);

void setTime(GTime time);

void set_time_t(uint timet);

void setTimeVal(TimeVal timeval);

void setYear(GDateYear year);

void subtractDays(uint nDays);

void subtractMonths(uint nMonths);

void subtractYears(uint nYears);

void toStructTm(void* tm);

bool valid();

static ubyte getDaysInMonth(GDateMonth month, GDateYear year);

static ubyte getMondayWeeksInYear(GDateYear year);

static ubyte getSundayWeeksInYear(GDateYear year);

static bool isLeapYear(GDateYear year);

static size_t strftime(string s, size_t slen, string format, Date date);

static bool validDay(GDateDay day);

static bool validDmy(GDateDay day, GDateMonth month, GDateYear year);

static bool validJulian(uint julianDate);

static bool validMonth(GDateMonth month);

static bool validWeekday(GDateWeekday weekday);

static bool validYear(GDateYear year);

}

Constructors

this this(GDate* gDate, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Allocates a #GDate and initializes it to a safe state. The new date will be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free().
this this(GDateDay day, GDateMonth month, GDateYear year): Like g_date_new(), but also sets the value of the date. Assuming the day-month-year triplet you pass in represents an existing day, the returned date will be valid.
this this(uint julianDay): Like g_date_new(), but also sets the value of the date. Assuming the Julian day number you pass in is valid (greater than 0, less than an unreasonably large number), the returned date will be valid.

Destructor

~this ~this(): Undocumented in source.

Members

Functions

addDays void addDays(uint nDays): Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid.
addMonths void addMonths(uint nMonths): Increments a date by some number of months. If the day of the month is greater than 28, this routine may change the day of the month (because the destination month may not have the current day in it). The date must be valid.
addYears void addYears(uint nYears): Increments a date by some number of years. If the date is February 29, and the destination year is not a leap year, the date will be changed to February 28. The date must be valid.
clamp void clamp(Date minDate, Date maxDate): If @date is prior to @min_date, sets @date equal to @min_date. If @date falls after @max_date, sets @date equal to @max_date. Otherwise, @date is unchanged. Either of @min_date and @max_date may be %NULL. All non-%NULL dates must be valid.
clear void clear(uint nDates): Initializes one or more #GDate structs to a safe but invalid state. The cleared dates will not represent an existing date, but will not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid().
compare int compare(Date rhs): qsort()-style comparison function for dates. Both dates must be valid.
copy Date copy(): Copies a GDate to a newly-allocated GDate. If the input was invalid (as determined by g_date_valid()), the invalid state will be copied as is into the new object.
daysBetween int daysBetween(Date date2): Computes the number of days between two dates. If @date2 is prior to @date1, the returned value is negative. Both dates must be valid.
free void free(): Frees a #GDate returned from g_date_new().
getDateStruct GDate* getDateStruct(bool transferOwnership): Get the main Gtk struct
getDay GDateDay getDay(): Returns the day of the month. The date must be valid.
getDayOfYear uint getDayOfYear(): Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid.
getIso8601WeekOfYear uint getIso8601WeekOfYear(): Returns the week of the year, where weeks are interpreted according to ISO 8601.
getJulian uint getJulian(): Returns the Julian day or "serial number" of the #GDate. The Julian day is simply the number of days since January 1, Year 1; i.e., January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid.
getMondayWeekOfYear uint getMondayWeekOfYear(): Returns the week of the year, where weeks are understood to start on Monday. If the date is before the first Monday of the year, return 0. The date must be valid.
getMonth GDateMonth getMonth(): Returns the month of the year. The date must be valid.
getStruct void* getStruct(): the main Gtk struct as a void*
getSundayWeekOfYear uint getSundayWeekOfYear(): Returns the week of the year during which this date falls, if weeks are understood to begin on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year.
getWeekday GDateWeekday getWeekday(): Returns the day of the week for a #GDate. The date must be valid.
getYear GDateYear getYear(): Returns the year of a #GDate. The date must be valid.
isFirstOfMonth bool isFirstOfMonth(): Returns %TRUE if the date is on the first of a month. The date must be valid.
isLastOfMonth bool isLastOfMonth(): Returns %TRUE if the date is the last day of the month. The date must be valid.
order void order(Date date2): Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case.
setDay void setDay(GDateDay day): Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.
setDmy void setDmy(GDateDay day, GDateMonth month, GDateYear y): Sets the value of a #GDate from a day, month, and year. The day-month-year triplet must be valid; if you aren't sure it is, call g_date_valid_dmy() to check before you set it.
setJulian void setJulian(uint julianDate): Sets the value of a #GDate from a Julian day number.
setMonth void setMonth(GDateMonth month): Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.
setParse void setParse(string str): Parses a user-inputted string @str, and try to figure out what date it represents, taking the [current locale]setlocale into account. If the string is successfully parsed, the date will be valid after the call. Otherwise, it will be invalid. You should check using g_date_valid() to see whether the parsing succeeded.
setTime void setTime(GTime time): Sets the value of a date from a #GTime value. The time to date conversion is done using the user's current timezone.
setTimeVal void setTimeVal(TimeVal timeval): Sets the value of a date from a #GTimeVal value. Note that the @tv_usec member is ignored, because #GDate can't make use of the additional precision.
setYear void setYear(GDateYear year): Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.
set_time_t void set_time_t(uint timet): Sets the value of a date to the date corresponding to a time specified as a time_t. The time to date conversion is done using the user's current timezone.
subtractDays void subtractDays(uint nDays): Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid.
subtractMonths void subtractMonths(uint nMonths): Moves a date some number of months into the past. If the current day of the month doesn't exist in the destination month, the day of the month may change. The date must be valid.
subtractYears void subtractYears(uint nYears): Moves a date some number of years into the past. If the current day doesn't exist in the destination year (i.e. it's February 29 and you move to a non-leap-year) then the day is changed to February 29. The date must be valid.
toStructTm void toStructTm(void* tm): Fills in the date-related bits of a struct tm using the @date value. Initializes the non-date parts with something safe but meaningless.
valid bool valid(): Returns %TRUE if the #GDate represents an existing day. The date must not contain garbage; it should have been initialized with g_date_clear() if it wasn't allocated by one of the g_date_new() variants.

Properties

day uint day [@property getter]
uint day [@property setter]: the day of the day-month-year representation of the date, as a number between 1 and 31
dmy uint dmy [@property getter]
uint dmy [@property setter]: this is set if @day, @month and @year are valid
julian uint julian [@property getter]
uint julian [@property setter]: this bit is set if @julian_days is valid
julianDays uint julianDays [@property getter]
uint julianDays [@property setter]: the Julian representation of the date
month uint month [@property getter]
uint month [@property setter]: the day of the day-month-year representation of the date, as a number between 1 and 12
year uint year [@property getter]
uint year [@property setter]: the day of the day-month-year representation of the date

Static functions

getDaysInMonth ubyte getDaysInMonth(GDateMonth month, GDateYear year): Returns the number of days in a month, taking leap years into account.
getMondayWeeksInYear ubyte getMondayWeeksInYear(GDateYear year): Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap year. This function is basically telling you how many Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.)
getSundayWeeksInYear ubyte getSundayWeeksInYear(GDateYear year): Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap year. This function is basically telling you how many Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.)
isLeapYear bool isLeapYear(GDateYear year): Returns %TRUE if the year is a leap year.
strftime size_t strftime(string s, size_t slen, string format, Date date): Generates a printed representation of the date, in a locale setlocale-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats give undefined results. Date must be valid. Unlike strftime() (which uses the locale encoding), works on a UTF-8 format string and stores a UTF-8 result.
validDay bool validDay(GDateDay day): Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive).
validDmy bool validDmy(GDateDay day, GDateMonth month, GDateYear year): Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future).
validJulian bool validJulian(uint julianDate): Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit.
validMonth bool validMonth(GDateMonth month): Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months.
validWeekday bool validWeekday(GDateWeekday weekday): Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays.
validYear bool validYear(GDateYear year): Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand.

Variables

gDate GDate* gDate;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.

Meta

Source

See Implementation

glib Date classes

Date