glibmm
2.62.0
About: glibmm is a set of C++ bindings for glib, including crossplatform APIs such as a std::stringlike UTF8 string class, string utility methods, such as a text encoding converter API, file access, and threads.
Fossies Dox: glibmm2.62.0.tar.xz ("inofficial" and yet experimental doxygengenerated source code documentation) 
Julian calendar date. More...
#include <date.h>
Public Types  
enum  Month { BAD_MONTH, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER } 
enum  Weekday { BAD_WEEKDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY } 
enum  DMY { DAY, MONTH, YEAR } 
using  Day = guint8 
using  Year = guint16 
Public Member Functions  
Date ()  
Construct an undefined date. More...  
Date (Day day, Month month, Year year)  
Construct a date with the given day, month and year. More...  
Date (guint32 julian_day)  
Construct a date from a julian day. More...  
Date (const GDate &castitem)  
Construct a Glib::Date by copying the contents of a GDate. More...  
Date (const Date &other)  
Construct a Glib::Date from another. More...  
Date &  operator= (const Date &other) 
Assign another date to this one. More...  
GDate *  gobj () 
Provides access to the underlying C instance. More...  
const GDate *  gobj () const 
Provides access to the underlying C instance. More...  
void  clear () 
Clear the date. More...  
void  set_parse (const Glib::ustring &str) 
Parses a userinputted string str, and try to figure out what date it represents, taking the current locale into account. More...  
G_GNUC_BEGIN_IGNORE_DEPRECATIONS G_GNUC_END_IGNORE_DEPRECATIONS void  set_time (std::time_t timet) 
Sets the value of a date from a <type>std::time_t</type> value. More...  
G_GNUC_BEGIN_IGNORE_DEPRECATIONS void  set_time (const GTimeVal &timeval) 
Sets the value of a date from a GTimeVal value. More...  
G_GNUC_END_IGNORE_DEPRECATIONS void  set_time_current () 
Set this Glib::Date to the current time. More...  
void  set_month (Month month) 
Sets the month of the year. More...  
void  set_day (Day day) 
Sets the day of the month. More...  
void  set_year (Year year) 
Sets the year. More...  
void  set_dmy (Day day, Month month, Year year) 
Sets the value of a day, month, and year. More...  
void  set_julian (guint32 julian_day) 
Sets the value of a GDate from a Julian day number. More...  
Date &  add_days (int n_days) 
Add a number of days to a Date. More...  
Date &  subtract_days (int n_days) 
Subtract n_days to a Date. More...  
Date &  add_months (int n_months) 
Add n_months to a Date. More...  
Date &  subtract_months (int n_months) 
Subtract n_months to a Date. More...  
Date &  add_years (int n_years) 
Add n_days to a Date. More...  
Date &  subtract_years (int n_years) 
Subtract n_years to a Date. More...  
int  days_between (const Date &rhs) const 
Calculate days between two dates. More...  
int  compare (const Date &rhs) const 
Compare two dates. More...  
Date &  clamp (const Date &min_date, const Date &max_date) 
If date is prior to min_date, sets date equal to min_date. More...  
Date &  clamp_min (const Date &min_date) 
If date is prior to min_date, sets date equal to min_date. More...  
Date &  clamp_max (const Date &max_date) 
If date falls after max_date, sets date equal to max_date. More...  
void  order (Date &other) 
Checks if date is less than or equal to other date, and swap the values if this is not the case. More...  
Weekday  get_weekday () const 
Returns the day of the week for a Date. More...  
Month  get_month () const 
Returns the month of the year. More...  
Year  get_year () const 
Returns the year of a Date. More...  
Day  get_day () const 
Returns the day of the month. More...  
guint32  get_julian () const 
Returns the Julian day or "serial number" of the Date. More...  
unsigned int  get_day_of_year () const 
Returns the day of the year, where Jan 1 is the first day of the year. More...  
unsigned int  get_monday_week_of_year () const 
Returns the week of the year, where weeks are understood to start on Monday. More...  
unsigned int  get_sunday_week_of_year () const 
Returns the week of the year during which this date falls, if weeks are understood to being on Sunday. More...  
unsigned int  get_iso8601_week_of_year () const 
Returns the week of the year, where weeks are interpreted according to ISO 8601. More...  
bool  is_first_of_month () const 
Returns true if the date is on the first of a month. More...  
bool  is_last_of_month () const 
Returns true if the date is the last day of the month. More...  
Glib::ustring  format_string (const Glib::ustring &format) const 
Convert date to string. More...  
void  to_struct_tm (struct tm &dest) const 
Fills in the daterelated bits of a struct tm using the date value. More...  
bool  valid () const 
Returns true if the Date represents an existing day. More...  
Static Public Member Functions  
static guint8  get_days_in_month (Month month, Year year) 
Returns the number of days in a month, taking leap years into account. More...  
static guint8  get_monday_weeks_in_year (Year year) 
Returns the number of weeks in the year, where weeks are taken to start on Monday. More...  
static guint8  get_sunday_weeks_in_year (Year year) 
Returns the number of weeks in the year, where weeks are taken to start on Sunday. More...  
static bool  is_leap_year (Year year) 
Returns true if the year is a leap year. More...  
static bool  valid_day (Day day) 
Returns true if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). More...  
static bool  valid_month (Month month) 
Returns true if the month value is valid. More...  
static bool  valid_year (Year year) 
Returns true if the year is valid. More...  
static bool  valid_weekday (Weekday weekday) 
Returns true if the weekday is valid. More...  
static bool  valid_julian (guint32 julian_day) 
Returns true if the Julian day is valid. More...  
static bool  valid_dmy (Day day, Month month, Year year) 
Returns true if the daymonthyear triplet forms a valid, existing day in the range of days Date understands (Year 1 or later, no more than a few thousand years in the future). More...  
Static Public Attributes  
static const Day  BAD_DAY = 0 
static const Year  BAD_YEAR = 0 
static const guint32  BAD_JULIAN = 0 
Private Attributes  
GDate  gobject_ 
Related Functions  
(Note that these are not member functions.)  
bool  operator== (const Date &lhs, const Date &rhs) 
bool  operator!= (const Date &lhs, const Date &rhs) 
bool  operator< (const Date &lhs, const Date &rhs) 
bool  operator> (const Date &lhs, const Date &rhs) 
bool  operator<= (const Date &lhs, const Date &rhs) 
bool  operator>= (const Date &lhs, const Date &rhs) 
using Glib::Date::Day = guint8 
using Glib::Date::Year = guint16 
Glib::Date::Date  (  ) 
Glib::Date::Date  (  Date::Day  day, 
Date::Month  month,  
Date::Year  year  
) 

explicit 

explicit 
Construct a Glib::Date by copying the contents of a GDate.
castitem  The GDate. 
Glib::Date::Date  (  const Date &  other  ) 
Construct a Glib::Date from another.
other  the other Glib::Date. 
Definition at line 59 of file date.cc.
References get_julian(), and gobject_.
Date & Glib::Date::add_days  (  int  n_days  ) 
Date & Glib::Date::add_months  (  int  n_months  ) 
Date & Glib::Date::add_years  (  int  n_years  ) 
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. All dates must be valid. See also clamp_min() and clamp_max(). This method returns a reference to the object itself.
Definition at line 235 of file date.cc.
References gobject_.
void Glib::Date::clear  (  ) 
int Glib::Date::compare  (  const Date &  rhs  )  const 
Compare two dates.
rhs  Date to compare. 
Definition at line 229 of file date.cc.
References gobject_.
Referenced by operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().
int Glib::Date::days_between  (  const Date &  rhs  )  const 
Glib::ustring Glib::Date::format_string  (  const Glib::ustring &  format  )  const 
Convert date to string.
format  A format string as used by strftime() , in UTF8 encoding. Only date formats are allowed, the result of time formats is undefined. 
Glib::ConvertError 
Definition at line 356 of file date.cc.
References gobject_, Glib::locale_from_utf8(), and Glib::locale_to_utf8().
Date::Day Glib::Date::get_day  (  )  const 
unsigned int Glib::Date::get_day_of_year  (  )  const 

static 
unsigned int Glib::Date::get_iso8601_week_of_year  (  )  const 
guint32 Glib::Date::get_julian  (  )  const 
Returns the Julian day or "serial number" of the Date.
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.
Definition at line 286 of file date.cc.
References gobject_.
Referenced by Date(), and operator=().
unsigned int Glib::Date::get_monday_week_of_year  (  )  const 

static 
Returns the number of weeks in the year, where weeks are taken to start on Monday.
Will be 52 or 53. (Years always have 52 7day 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.)
year  Year to count weeks in. 
Date::Month Glib::Date::get_month  (  )  const 
Returns the month of the year.
The date must be valid.
Definition at line 268 of file date.cc.
References gobject_.
unsigned int Glib::Date::get_sunday_week_of_year  (  )  const 

static 
Returns the number of weeks in the year, where weeks are taken to start on Sunday.
Will be 52 or 53. (Years always have 52 7day 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.)
year  Year to count weeks in. 
Date::Weekday Glib::Date::get_weekday  (  )  const 
Returns the day of the week for a Date.
The date must be valid.
Definition at line 262 of file date.cc.
References gobject_.
Date::Year Glib::Date::get_year  (  )  const 

inline 

inline 
bool Glib::Date::is_first_of_month  (  )  const 
bool Glib::Date::is_last_of_month  (  )  const 

static 
Assign another date to this one.
For example:
other  The other Glib::Date. 
Definition at line 67 of file date.cc.
References get_julian(), and gobject_.
void Glib::Date::order  (  Date &  other  ) 
void Glib::Date::set_day  (  Date::Day  day  ) 
void Glib::Date::set_dmy  (  Date::Day  day, 
Date::Month  month,  
Date::Year  year  
) 
void Glib::Date::set_julian  (  guint32  julian_day  ) 
G_GNUC_END_IGNORE_DEPRECATIONS void Glib::Date::set_month  (  Date::Month  month  ) 
void Glib::Date::set_parse  (  const Glib::ustring &  str  ) 
Parses a userinputted 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. 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  String to parse. 
Definition at line 82 of file date.cc.
References Glib::ustring::c_str(), and gobject_.
G_GNUC_BEGIN_IGNORE_DEPRECATIONS void Glib::Date::set_time  (  const GTimeVal &  timeval  ) 
Sets the value of a date from a GTimeVal value.
Note that the tv_usec member is ignored, because Glib::Date can't make use of the additional precision.
timeval  GTimeVal value to set 
Since: 2.10
Definition at line 124 of file date.cc.
References gobject_.
G_GNUC_BEGIN_IGNORE_DEPRECATIONS G_GNUC_END_IGNORE_DEPRECATIONS void Glib::Date::set_time  (  std::time_t  timet  ) 
Sets the value of a date from a <type>std::time_t</type> value.
timet  std::time_t value to set 
Since: 2.10
Definition at line 108 of file date.cc.
References gobject_.
void Glib::Date::set_time_current  (  ) 
Set this Glib::Date to the current time.
Definition at line 114 of file date.cc.
References gobject_.
void Glib::Date::set_year  (  Date::Year  year  ) 
Date & Glib::Date::subtract_days  (  int  n_days  ) 
Date & Glib::Date::subtract_months  (  int  n_months  ) 
Subtract n_months to a Date.
This method returns a reference to the object itself, so you can write code such as:
n_months  Months to subtract. 
Definition at line 193 of file date.cc.
References gobject_.
Date & Glib::Date::subtract_years  (  int  n_years  ) 
void Glib::Date::to_struct_tm  (  struct tm &  dest  )  const 
bool Glib::Date::valid  (  )  const 

static 

static 
Returns true if the daymonthyear triplet forms a valid, existing day in the range of days Date understands (Year 1 or later, no more than a few thousand years in the future).
day  Day to check. 
month  Month to check. 
year  Year to check. 

static 

static 
Returns true if the month value is valid.
The 12 Date::Month enumeration values are the only valid months.
month  Month to check. 

static 
Returns true if the weekday is valid.
The 7 Date::Weekday enumeration values are the only valid.
weekday  Weekday to check. 

static 

private 
Definition at line 234 of file date.h.
Referenced by add_days(), add_months(), add_years(), clamp(), clamp_max(), clamp_min(), clear(), compare(), Date(), days_between(), format_string(), get_day(), get_day_of_year(), get_iso8601_week_of_year(), get_julian(), get_monday_week_of_year(), get_month(), get_sunday_week_of_year(), get_weekday(), get_year(), gobj(), is_first_of_month(), is_last_of_month(), operator=(), order(), set_day(), set_dmy(), set_julian(), set_month(), set_parse(), set_time(), set_time_current(), set_year(), subtract_days(), subtract_months(), subtract_years(), to_struct_tm(), and valid().