glib/org.gtkkn.bindings.glib/DateTime

DateTime

class DateTime(pointer: <Error class: unknown class><<Error class: unknown class>>) : Record

GDateTime is a structure that combines a Gregorian date and time into a single structure.

GDateTime provides many conversion and methods to manipulate dates and times. Time precision is provided down to microseconds and the time can range (proleptically) from 0001-01-01 00:00:00 to 9999-12-31 23:59:59.999999. GDateTime follows POSIX time in the sense that it is oblivious to leap seconds.

GDateTime is an immutable object; once it has been created it cannot be modified further. All modifiers will create a new GDateTime. Nearly all such functions can fail due to the date or time going out of range, in which case null will be returned.

GDateTime is reference counted: the reference count is increased by calling method@GLib.DateTime.ref and decreased by calling method@GLib.DateTime.unref. When the reference count drops to 0, the resources allocated by the GDateTime structure are released.

Many parts of the API may produce non-obvious results. As an example, adding two months to January 31st will yield March 31st whereas adding one month and then one month again will yield either March 28th or March 29th. Also note that adding 24 hours is not always the same as adding one day (since days containing daylight savings time transitions are either 23 or 25 hours in length).

Skipped during bindings generation

parameter timespan: TimeSpan
parameter dt2: DateTime
method difference: Return type TimeSpan is unsupported
parameter dt2: DateTime
method get_utc_offset: Return type TimeSpan is unsupported
parameter year: year: Out parameter is not supported

Since

2.26

Constructors

DateTime

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion : RecordCompanion<DateTime, <Error class: unknown class>>

Properties

glibDateTimePointer

val glibDateTimePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

addDays

fun addDays(days: Int): DateTime?

Creates a copy of @datetime and adds the specified number of days to the copy. Add negative values to subtract days.

addFull

fun addFull(years: Int, months: Int, days: Int, hours: Int, minutes: Int, seconds: Double): DateTime?

Creates a new #GDateTime adding the specified values to the current date and time in @datetime. Add negative values to subtract.

addHours

fun addHours(hours: Int): DateTime?

Creates a copy of @datetime and adds the specified number of hours. Add negative values to subtract hours.

addMinutes

fun addMinutes(minutes: Int): DateTime?

Creates a copy of @datetime adding the specified number of minutes. Add negative values to subtract minutes.

addMonths

fun addMonths(months: Int): DateTime?

Creates a copy of @datetime and adds the specified number of months to the copy. Add negative values to subtract months.

addSeconds

fun addSeconds(seconds: Double): DateTime?

Creates a copy of @datetime and adds the specified number of seconds. Add negative values to subtract seconds.

addWeeks

fun addWeeks(weeks: Int): DateTime?

Creates a copy of @datetime and adds the specified number of weeks to the copy. Add negative values to subtract weeks.

addYears

fun addYears(years: Int): DateTime?

Creates a copy of @datetime and adds the specified number of years to the copy. Add negative values to subtract years.

format

fun format(format: String): String

Creates a newly allocated string representing the requested @format.

formatIso8601

fun formatIso8601(): String

Format @datetime in ISO 8601 format, including the date, time and time zone, and return that as a UTF-8 encoded string.

getDayOfMonth

fun getDayOfMonth(): Int

Retrieves the day of the month represented by @datetime in the gregorian calendar.

getDayOfWeek

fun getDayOfWeek(): Int

Retrieves the ISO 8601 day of the week on which @datetime falls (1 is Monday, 2 is Tuesday... 7 is Sunday).

getDayOfYear

fun getDayOfYear(): Int

Retrieves the day of the year represented by @datetime in the Gregorian calendar.

getHour

fun getHour(): Int

Retrieves the hour of the day represented by @datetime

getMicrosecond

fun getMicrosecond(): Int

Retrieves the microsecond of the date represented by @datetime

getMinute

fun getMinute(): Int

Retrieves the minute of the hour represented by @datetime

getMonth

fun getMonth(): Int

Retrieves the month of the year represented by @datetime in the Gregorian calendar.

getSecond

fun getSecond(): Int

Retrieves the second of the minute represented by @datetime

getSeconds

fun getSeconds(): Double

Retrieves the number of seconds since the start of the last minute, including the fractional part.

getTimezone

fun getTimezone(): TimeZone

Get the time zone for this @datetime.

getTimezoneAbbreviation

fun getTimezoneAbbreviation(): String

Determines the time zone abbreviation to be used at the time and in the time zone of @datetime.

getWeekNumberingYear

fun getWeekNumberingYear(): Int

Returns the ISO 8601 week-numbering year in which the week containing

getWeekOfYear

fun getWeekOfYear(): Int

Returns the ISO 8601 week number for the week containing @datetime. The ISO 8601 week number is the same for every day of the week (from Moday through Sunday). That can produce some unusual results (described below).

getYear

fun getYear(): Int

Retrieves the year represented by @datetime in the Gregorian calendar.

hash

fun hash(): <Error class: unknown class>

Hashes @datetime into a #guint, suitable for use within #GHashTable.

isDaylightSavings

fun isDaylightSavings(): Boolean

Determines if daylight savings time is in effect at the time and in the time zone of @datetime.

ref

fun ref(): DateTime

Atomically increments the reference count of @datetime by one.