// Generated by gmmproc 2.54.0 -- DO NOT MODIFY!
#ifndef _GTKMM_CALENDAR_H
#define _GTKMM_CALENDAR_H
#include <gtkmmconfig.h>
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/*
* Copyright (C) 1998-2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <gtkmm/widget.h>
#include <glibmm/date.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkCalendar = struct _GtkCalendar;
using GtkCalendarClass = struct _GtkCalendarClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Calendar_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
/** @addtogroup gtkmmEnums gtkmm Enums and Flags */
/**
* @var CalendarDisplayOptions CALENDAR_SHOW_HEADING
* Specifies that the month and year should be displayed.
*
* @var CalendarDisplayOptions CALENDAR_SHOW_DAY_NAMES
* Specifies that three letter day descriptions should be present.
*
* @var CalendarDisplayOptions CALENDAR_NO_MONTH_CHANGE
* Prevents the user from switching months with the calendar.
*
* @var CalendarDisplayOptions CALENDAR_SHOW_WEEK_NUMBERS
* Displays each week numbers of the current year, down the
* left side of the calendar.
*
* @var CalendarDisplayOptions CALENDAR_SHOW_DETAILS
* Just show an indicator, not the full details
* text when details are provided. See Gtk::Calendar::set_detail_func().
*
* @enum CalendarDisplayOptions
*
* These options can be used to influence the display and behaviour of a Gtk::Calendar.
*
* @ingroup gtkmmEnums
* @par Bitwise operators:
* <tt>%CalendarDisplayOptions operator|(CalendarDisplayOptions, CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions operator&(CalendarDisplayOptions, CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions operator^(CalendarDisplayOptions, CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions operator~(CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions& operator|=(CalendarDisplayOptions&, CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions& operator&=(CalendarDisplayOptions&, CalendarDisplayOptions)</tt><br>
* <tt>%CalendarDisplayOptions& operator^=(CalendarDisplayOptions&, CalendarDisplayOptions)</tt><br>
*/
enum CalendarDisplayOptions
{
CALENDAR_SHOW_HEADING = 1 << 0,
CALENDAR_SHOW_DAY_NAMES = 1 << 1,
CALENDAR_NO_MONTH_CHANGE = 1 << 2,
CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
CALENDAR_SHOW_DETAILS = 1 << 5
};
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions operator|(CalendarDisplayOptions lhs, CalendarDisplayOptions rhs)
{ return static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions operator&(CalendarDisplayOptions lhs, CalendarDisplayOptions rhs)
{ return static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions operator^(CalendarDisplayOptions lhs, CalendarDisplayOptions rhs)
{ return static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions operator~(CalendarDisplayOptions flags)
{ return static_cast<CalendarDisplayOptions>(~static_cast<unsigned>(flags)); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions& operator|=(CalendarDisplayOptions& lhs, CalendarDisplayOptions rhs)
{ return (lhs = static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions& operator&=(CalendarDisplayOptions& lhs, CalendarDisplayOptions rhs)
{ return (lhs = static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline CalendarDisplayOptions& operator^=(CalendarDisplayOptions& lhs, CalendarDisplayOptions rhs)
{ return (lhs = static_cast<CalendarDisplayOptions>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::CalendarDisplayOptions> : public Glib::Value_Flags<Gtk::CalendarDisplayOptions>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/** Display a calendar and/or allow the user to select a date.
*
* This is a widget that displays a calendar, one month at a time.
*
* The month and year currently displayed can be altered with
* select_month(). The exact day can be selected from the displayed month
* using select_day().
*
* The way in which the calendar itself is displayed can be altered using
* set_display_options().
*
* The selected date can be retrieved from a GtkCalendar using get_date().
*
* If performing many 'mark' operations, the calendar can be frozen to
* prevent flicker, using freeze(), and 'thawed' again using thaw().
*
* The Calendar widget looks like this:
* @image html calendar1.png
*
* @ingroup Widgets
*/
class Calendar : public Widget
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef Calendar CppObjectType;
typedef Calendar_Class CppClassType;
typedef GtkCalendar BaseObjectType;
typedef GtkCalendarClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
Calendar(Calendar&& src) noexcept;
Calendar& operator=(Calendar&& src) noexcept;
// noncopyable
Calendar(const Calendar&) = delete;
Calendar& operator=(const Calendar&) = delete;
~Calendar() noexcept override;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class Calendar_Class;
static CppClassType calendar_class_;
protected:
explicit Calendar(const Glib::ConstructParams& construct_params);
explicit Calendar(GtkCalendar* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GtkObject.
GtkCalendar* gobj() { return reinterpret_cast<GtkCalendar*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkCalendar* gobj() const { return reinterpret_cast<GtkCalendar*>(gobject_); }
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_month_changed().
virtual void on_month_changed();
/// This is a default handler for the signal signal_day_selected().
virtual void on_day_selected();
/// This is a default handler for the signal signal_day_selected_double_click().
virtual void on_day_selected_double_click();
/// This is a default handler for the signal signal_prev_month().
virtual void on_prev_month();
/// This is a default handler for the signal signal_next_month().
virtual void on_next_month();
/// This is a default handler for the signal signal_prev_year().
virtual void on_prev_year();
/// This is a default handler for the signal signal_next_year().
virtual void on_next_year();
private:
public:
Calendar();
/** Shifts the calendar to a different month.
*
* @param month A month number between 0 and 11.
* @param year The year the month is in.
*/
void select_month(guint month, guint year);
/** Selects a day from the current month.
*
* @param day The day number between 1 and 31, or 0 to unselect
* the currently selected day.
*/
void select_day(guint day);
/** Places a visual marker on a particular day.
*
* @param day The day number to mark between 1 and 31.
*/
void mark_day(guint day);
/** Removes the visual marker from a particular day.
*
* @param day The day number to unmark between 1 and 31.
*/
void unmark_day(guint day);
/** Remove all visual markers.
*/
void clear_marks();
/** Sets display options (whether to display the heading and the month
* headings).
*
* @newin{2,4}
*
* @param flags The display options to set.
*/
void set_display_options(CalendarDisplayOptions flags);
/** Returns the current display options of @a calendar.
*
* @newin{2,4}
*
* @return The display options.
*/
CalendarDisplayOptions get_display_options() const;
/** Obtains the selected date from a Gtk::Calendar.
*
* @param year Location to store the year as a decimal
* number (e.g. 2011), or <tt>nullptr</tt>.
* @param month Location to store the month number
* (between 0 and 11), or <tt>nullptr</tt>.
* @param day Location to store the day number (between
* 1 and 31), or <tt>nullptr</tt>.
*/
void get_date(guint& year, guint& month, guint& day) const;
// Additional method not in GTK (#350584)
/** Get the date as Glib::Date
*
* @param date Referenz to set the date
*/
void get_date(Glib::Date& date) const;
/** Detail markup handler.
* For instance,
* @code
* Glib::ustring on_calendar_details(guint year, guint month, guint day);
* @endcode
*
* @param year The year for which details are needed.
* @param month The month for which details are needed.
* @param day The day of @a month for which details are needed.
* @result Pango markup with details for the specified day, or an empty string.
*
* This callback function provides Pango markup with detail information for the
* specified day. Examples for such details are holidays or appointments. The
* function should return an empty string when no information is available.
*
* @newin{2,14}
*/
typedef sigc::slot<Glib::ustring, guint, guint, guint> SlotDetails;
/** Installs a function which provides Pango markup with detail information
* for each day. Examples for such details are holidays or appointments. That
* information is shown below each day when show-details is set.
* A tooltip containing full detail information is provided if the entire
* text could not fit into the details area, or if the show-details property
* is not set.
*
* The size of the details area can be restricted by setting the
* detail-width-chars and detail-height-rows properties.
*
* @param slot A callback function providing details for each day.
*
* @newin{2,14}
*/
void set_detail_func(const SlotDetails& slot);
/** Updates the width of detail cells.
* See Gtk::Calendar::property_detail_width_chars().
*
* @newin{2,14}
*
* @param chars Detail width in characters.
*/
void set_detail_width_chars(int chars);
/** Updates the height of detail cells.
* See Gtk::Calendar::property_detail_height_rows().
*
* @newin{2,14}
*
* @param rows Detail height in rows.
*/
void set_detail_height_rows(int rows);
/** Queries the width of detail cells, in characters.
* See Gtk::Calendar::property_detail_width_chars().
*
* @newin{2,14}
*
* @return The width of detail cells, in characters.
*/
int get_detail_width_chars() const;
/** Queries the height of detail cells, in rows.
* See Gtk::Calendar::property_detail_width_chars().
*
* @newin{2,14}
*
* @return The height of detail cells, in rows.
*/
int get_detail_height_rows() const;
/** Returns if the @a day of the @a calendar is already marked.
*
* @newin{3,0}
*
* @param day The day number between 1 and 31.
* @return Whether the day is marked.
*/
bool get_day_is_marked(guint day) const;
/**
* @par Slot Prototype:
* <tt>void on_my_%month_changed()</tt>
*
* Flags: Run First
*
* Emitted when the user clicks a button to change the selected month on a
* calendar.
*/
Glib::SignalProxy< void > signal_month_changed();
/**
* @par Slot Prototype:
* <tt>void on_my_%day_selected()</tt>
*
* Flags: Run First
*
* Emitted when the user selects a day.
*/
Glib::SignalProxy< void > signal_day_selected();
/**
* @par Slot Prototype:
* <tt>void on_my_%day_selected_double_click()</tt>
*
* Flags: Run First
*
* Emitted when the user double-clicks a day.
*/
Glib::SignalProxy< void > signal_day_selected_double_click();
/**
* @par Slot Prototype:
* <tt>void on_my_%prev_month()</tt>
*
* Flags: Run First
*
* Emitted when the user switched to the previous month.
*/
Glib::SignalProxy< void > signal_prev_month();
/**
* @par Slot Prototype:
* <tt>void on_my_%next_month()</tt>
*
* Flags: Run First
*
* Emitted when the user switched to the next month.
*/
Glib::SignalProxy< void > signal_next_month();
/**
* @par Slot Prototype:
* <tt>void on_my_%prev_year()</tt>
*
* Flags: Run First
*
* Emitted when user switched to the previous year.
*/
Glib::SignalProxy< void > signal_prev_year();
/**
* @par Slot Prototype:
* <tt>void on_my_%next_year()</tt>
*
* Flags: Run First
*
* Emitted when user switched to the next year.
*/
Glib::SignalProxy< void > signal_next_year();
/** The selected year.
* This property gets initially set to the current year.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_year() ;
/** The selected year.
* This property gets initially set to the current year.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_year() const;
/** The selected month (as a number between 0 and 11).
* This property gets initially set to the current month.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_month() ;
/** The selected month (as a number between 0 and 11).
* This property gets initially set to the current month.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_month() const;
/** The selected day (as a number between 1 and 31, or 0
* to unselect the currently selected day).
* This property gets initially set to the current day.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_day() ;
/** The selected day (as a number between 1 and 31, or 0
* to unselect the currently selected day).
* This property gets initially set to the current day.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_day() const;
/** Determines whether a heading is displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_show_heading() ;
/** Determines whether a heading is displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_show_heading() const;
/** Determines whether day names are displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_show_day_names() ;
/** Determines whether day names are displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_show_day_names() const;
/** Determines whether the selected month can be changed.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_no_month_change() ;
/** Determines whether the selected month can be changed.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_no_month_change() const;
/** Determines whether week numbers are displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_show_week_numbers() ;
/** Determines whether week numbers are displayed.
*
* @newin{2,4}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_show_week_numbers() const;
/** Determines whether details are shown directly in the widget, or if they are
* available only as tooltip. When this property is set days with details are
* marked.
*
* @newin{2,14}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_show_details() ;
/** Determines whether details are shown directly in the widget, or if they are
* available only as tooltip. When this property is set days with details are
* marked.
*
* @newin{2,14}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_show_details() const;
/** Width of a detail cell, in characters.
* A value of 0 allows any width. See Gtk::Calendar::set_detail_func().
*
* @newin{2,14}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_detail_width_chars() ;
/** Width of a detail cell, in characters.
* A value of 0 allows any width. See Gtk::Calendar::set_detail_func().
*
* @newin{2,14}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_detail_width_chars() const;
/** Height of a detail cell, in rows.
* A value of 0 allows any width. See Gtk::Calendar::set_detail_func().
*
* @newin{2,14}
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_detail_height_rows() ;
/** Height of a detail cell, in rows.
* A value of 0 allows any width. See Gtk::Calendar::set_detail_func().
*
* @newin{2,14}
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_detail_height_rows() const;
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::Calendar
*/
Gtk::Calendar* wrap(GtkCalendar* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_CALENDAR_H */