[516:14] static extends: object
Alternate constructors for GDate. Usage:
GDateCtors.<name>(...). The primary constructor lives
directly on GDate.
newJulian (int julian_day)
Create a new #GDate representing the given Julian date. The @julian_day you pass in must be valid. Use g_date_valid_julian() if needed to validate it. The returned #GDate is guaranteed to be non-%NULL and valid.
julian_day is days since January 1, Year 1.A new GDate.[64:7] extends: object
GDate is a struct for calendrical calculations. The GDate data structure
represents a day between January 1, Year 1, and sometime a few thousand years
in the future (right now it will go to the year 65535 or so, but
[method@GLib.Date.set_parse] only parses up to the year 8000 or so - just
count on "a few thousand"). GDate is meant to represent everyday dates, not
astronomical dates or historical dates or ISO timestamps or the like. It
extrapolates the current Gregorian calendar forward and backward in time;
there is no attempt to change the calendar to match time periods or
locations. GDate does not store time information; it represents a day. The
GDate implementation has several nice features; it is only a 64-bit struct,
so storing large numbers of dates is very efficient. It can keep both a
Julian and day-month-year representation of the date, since some calculations
are much easier with one representation or the other. A Julian representation
is simply a count of days since some fixed day in the past; for #GDate the
fixed day is January 1, 1 AD. ("Julian" dates in the #GDate API aren't really
Julian dates in the technical sense; technically, Julian dates count from the
start of the Julian period, Jan 1, 4713 BC). GDate is simple to use. First
you need a "blank" date; you can get a dynamically allocated date from
[ctor@GLib.Date.new], or you can declare an automatic variable or array and
initialize it by calling [method@GLib.Date.clear]. A cleared date is safe;
it's safe to call [method@GLib.Date.set_dmy] and the other mutator functions
to initialize the value of a cleared date. However, a cleared date is
initially invalid, meaning that it doesn't represent a day that exists. It is
undefined to call any of the date calculation routines on an invalid date. If
you obtain a date from a user or other unpredictable source, you should check
its validity with the [method@GLib.Date.valid] predicate.
[method@GLib.Date.valid] is also used to check for errors with
[method@GLib.Date.set_parse] and other functions that can fail. Dates can be
invalidated by calling [method@GLib.Date.clear] again. It is very important
to use the API to access the GDate struct. Often only the day-month-year or
only the Julian representation is valid. Sometimes neither is valid. Use the
API. GLib also features GDateTime which represents a precise time.
GDate (Handle = null)
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().
Handle is an optional native handle or wrapper whose handle to adopt; when the native constructor is called.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.add_days (int n_days)
Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid.
n_days is number of days to move the date forward.None.add_months (int n_months)
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.
n_months is number of months to move forward.None.add_years (int n_years)
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.
n_years is number of years to move forward.None.clamp (object min_date, object max_date)
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.
min_date is minimum accepted value for @date.max_date is maximum accepted value for @date.None.clear (int n_dates)
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().
n_dates is number of dates to clear.None.compare (object rhs)
qsort()-style comparison function for dates. Both dates must be valid.
rhs is second date to compare.0 for equal, less than zero if @lhs is less than @rhs, greater than zero if @lhs is greater than @rhs.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.
a newly-allocated #GDate initialized from @date.days_between (object date2)
Computes the number of days between two dates. If @date2 is prior to
the returned value is negative. Both dates must be valid.date2 is the second date.the number of days between @date1 and @date2.free ()
Frees a #GDate returned from g_date_new().
None.get_day_of_year ()
Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid.
day of the year.get_iso8601_week_of_year ()
Returns the week of the year, where weeks are interpreted according to ISO 8601.
ISO 8601 week number of the year..get_julian ()
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.
Julian day.get_monday_week_of_year ()
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.
week of the year.get_month ()
Returns the month of the year. The date must be valid.
month of the year as a #GDateMonth.get_sunday_week_of_year ()
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.
week number.get_week_of_year (string first_day_of_week)
Calculates the week of the year during which this date falls. The result depends on which day is considered the first day of the week, which varies by locale. Both
dateandfirst_day_of_weekmust be valid. If
is before the start of the first week of the year (for example, before the first Monday in January if @first_day_of_week is [enum@GLib.DateWeekday.MONDAY]) then zero will be returned.first_day_of_week is the day which is considered the first day of the week (for example, this would be [enum@GLib.DateWeekday.SUNDAY] in US locales, [enum@GLib.DateWeekday.MONDAY] in British locales, and [enum@GLib.DateWeekday.SATURDAY] in Egyptian locales.week number (starting from 1), or 0 if @date is before the start of the first week of the year.get_weekday ()
Returns the day of the week for a #GDate. The date must be valid.
day of the week as a #GDateWeekday..is_first_of_month ()
Returns %TRUE if the date is on the first of a month. The date must be valid.
%TRUE if the date is the first of the month.is_last_of_month ()
Returns %TRUE if the date is the last day of the month. The date must be valid.
%TRUE if the date is the last day of the month.order (object date2)
Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case.
date2 is the second date.None.set_julian (int julian_date)
Sets the value of a #GDate from a Julian day number.
julian_date is Julian day number (days since January 1, Year 1).None.set_month (string month)
Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.
month is month to set.None.set_parse (string str)
Parses a user-inputted string @str, and try to figure out what date it represents, taking the current locale 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. This function is not appropriate for file formats and the like; it isn't very precise, and its exact behavior varies with the locale. It's intended to be a heuristic routine that guesses what the user means by a given string (and it does work pretty well in that capacity).
str is string to parse.None.set_time_t (int 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. To set the value of a date to the current day, you could write: |[ time_t now = time (NULL); if (now == (time_t) -1) // handle the error g_date_set_time_t (date, now); ]|
timet is time_t value to set.None.set_time_val (object 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. The time to date conversion is done using the user's current timezone.
timeval is #GTimeVal value to set.None.subtract_days (int n_days)
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.
n_days is number of days to move.None.subtract_months (int n_months)
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.
n_months is number of months to move.None.subtract_years (int n_years)
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.
n_years is number of years to move.None.to_struct_tm (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.
tm is struct tm to fill.None.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.
Whether the date is valid.[13:14] static extends: object
Generated struct layout helper for GIR record Date.
layout ()
Returns the Panama struct layout for
Date.
