DateTime

Struct to store date, time and timezone information altogether. #GstDateTime is refcounted and immutable.

Date information is handled using the proleptic Gregorian calendar.

Provides basic creation functions and accessor functions to its fields.

Constructors

this
this(GstDateTime* gstDateTime, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(bool utc)

Creates a new GstDateTime representing the current date and time.

this
this(long secs, bool utc)

Creates a new GstDateTime using the time since Jan 1, 1970 specified by secs.

this
this(float tzoffset, int year, int month, int day, int hour, int minute, double seconds)

Creates a new #GstDateTime using the date and times in the gregorian calendar in the supplied timezone.

this
this(GLibDateTime dt)

Creates a new #GstDateTime from a #GDateTime object.

this
this(string str)

Tries to parse common variants of ISO-8601 datetime strings into a #GstDateTime. Possible input formats are (for example): 2012-06-30T22:46:43Z, 2012, 2012-06, 2012-06-30, 2012-06-30T22:46:43-0430, 2012-06-30T22:46Z, 2012-06-30T22:46-0430, 2012-06-30 22:46, 2012-06-30 22:46:43, 2012-06-00, 2012-00-00, 2012-00-30, 22:46:43Z, 22:46Z, 22:46:43-0430, 22:46-0430, 22:46:30, 22:46 If no date is provided, it is assumed to be "today" in the timezone provided (if any), otherwise UTC.

this
this(int year, int month, int day, int hour, int minute, double seconds)

Creates a new #GstDateTime using the date and times in the gregorian calendar in the local timezone.

this
this(int year)

Creates a new #GstDateTime using the date and times in the gregorian calendar in the local timezone.

this
this(int year, int month)

Creates a new #GstDateTime using the date and times in the gregorian calendar in the local timezone.

this
this(int year, int month, int day)

Creates a new #GstDateTime using the date and times in the gregorian calendar in the local timezone.

Members

Functions

doref
DateTime doref()

Atomically increments the reference count of @datetime by one.

getDateTimeStruct
GstDateTime* getDateTimeStruct()

Get the main Gtk struct

getDay
int getDay()

Returns the day of the month of this #GstDateTime. Call gst_date_time_has_day before, to avoid warnings.

getHour
int getHour()

Retrieves the hour of the day represented by @datetime in the gregorian calendar. The return is in the range of 0 to 23. Call gst_date_time_has_haur before, to avoid warnings.

getMicrosecond
int getMicrosecond()

Retrieves the fractional part of the seconds in microseconds represented by @datetime in the gregorian calendar.

getMinute
int getMinute()

Retrieves the minute of the hour represented by @datetime in the gregorian calendar. Call gst_date_time_has_minute before, to avoid warnings.

getMonth
int getMonth()

Returns the month of this #GstDateTime. January is 1, February is 2, etc.. Call gst_date_time_has_month before, to avoid warnings.

getSecond
int getSecond()

Retrieves the second of the minute represented by @datetime in the gregorian calendar. Call gst_date_time_has_second before, to avoid warnings.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTimeZoneOffset
float getTimeZoneOffset()

Retrieves the offset from UTC in hours that the timezone specified by @datetime represents. Timezones ahead (to the east) of UTC have positive values, timezones before (to the west) of UTC have negative values. If @datetime represents UTC time, then the offset is zero.

getYear
int getYear()

Returns the year of this #GstDateTime Call gst_date_time_has_year before, to avoid warnings.

hasDay
bool hasDay()

Return: %TRUE if @datetime<!-- -->'s day field is set, otherwise %FALSE

hasMonth
bool hasMonth()

Return: %TRUE if @datetime<!-- -->'s month field is set, otherwise %FALSE

hasSecond
bool hasSecond()

Return: %TRUE if @datetime<!-- -->'s second field is set, otherwise %FALSE

hasTime
bool hasTime()

Return: %TRUE if @datetime<!-- -->'s hour and minute fields are set, otherwise %FALSE

hasYear
bool hasYear()

Return: %TRUE if @datetime<!-- -->'s year field is set (which should always be the case), otherwise %FALSE

toGDateTime
GLibDateTime toGDateTime()

Creates a new #GDateTime from a fully defined #GstDateTime object.

toIso8601String
string toIso8601String()

Create a minimal string compatible with ISO-8601. Possible output formats are (for example): 2012, 2012-06, 2012-06-23, 2012-06-23T23:30Z, 2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100

unref
void unref()

Atomically decrements the reference count of @datetime by one. When the reference count reaches zero, the structure is freed.

Static functions

getType
GType getType()

Variables

gstDateTime
GstDateTime* gstDateTime;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.

Meta