// Generated by gmmproc 2.86.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, see <https://www.gnu.org/licenses/>.
 */


#include <gtkmm/widget.h>
#include <glibmm/datetime.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 GTKMM_API Calendar_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS

namespace Gtk
{


/** Displays a Gregorian calendar, one month at a time.
 *
 * The selected date can be retrieved from a `%Gtk::Calendar` using
 * get_date(). It can be altered with set_date().
 *
 * To place a visual marker on a particular day, use
 * mark_day() and to remove the marker, unmark_day(). Alternative, all
 * marks can be cleared with clear_marks().
 *
 * Users should be aware that, although the Gregorian calendar is the
 * legal calendar in most countries, it was adopted progressively
 * between 1582 and 1929. Display before these dates is likely to be
 * historically incorrect.
 *
 * # Shortcuts and Gestures
 *
 * `%Gtk::Calendar` supports the following gestures:
 *
 * - Scrolling up or down will switch to the previous or next month.
 * - Date strings can be dropped for setting the current day.
 *
 * The %Calendar widget looks like this:
 * @image html calendar1.png
 *
 * @ingroup Widgets
 */

class GTKMM_API 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 GTKMM_API 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();

#ifndef DOXYGEN_SHOULD_SKIP_THIS


  static GType get_base_type();
#endif

  /// Provides access to the underlying C GObject.
  GtkCalendar*       gobj()       { return reinterpret_cast<GtkCalendar*>(gobject_); }

  /// Provides access to the underlying C GObject.
  const GtkCalendar* gobj() const { return reinterpret_cast<GtkCalendar*>(gobject_); }

private:

public:
  Calendar();

  
#ifndef GTKMM_DISABLE_DEPRECATED

  /** Switches to @a day's year and month and select its day.
   * 
   * Deprecated: 4.20: Use set_date() instead.
   * 
   * @deprecated 4.20: Use set_date() instead.
   * 
   * @param day A `Glib::DateTime` representing the day to select.
   */
  void select_day(const Glib::DateTime& day);
#endif // GTKMM_DISABLE_DEPRECATED


  /** Places a visual marker on a particular day of the current month.
   * 
   * @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 whether week numbers are shown in the calendar.
   * 
   * @param value Whether to show week numbers alongside the days.
   */
  void set_show_week_numbers(bool value =  true);
  
  /** Returns whether @a self is showing week numbers right
   * now.
   * 
   * This is the value of the property_show_week_numbers()
   * property.
   * 
   * Return: Whether the calendar is showing week numbers.
   */
  bool get_show_week_numbers() const;
  
  /** Sets whether the calendar should show a heading.
   * 
   * The heading contains the current year and month as well as
   * buttons for changing both.
   * 
   * @param value Whether to show the heading in the calendar.
   */
  void set_show_heading(bool value =  true);
  
  /** Returns whether @a self is currently showing the heading.
   * 
   * This is the value of the property_show_heading()
   * property.
   * 
   * Return: Whether the calendar is showing a heading.
   */
  bool get_show_heading() const;
  
  /** Sets whether the calendar shows day names.
   * 
   * @param value Whether to show day names above the day numbers.
   */
  void set_show_day_names(bool value =  true);
  
  /** Returns whether @a self is currently showing the names
   * of the week days.
   * 
   * This is the value of the property_show_day_names()
   * property.
   * 
   * @return Whether the calendar shows day names.
   */
  bool get_show_day_names() const;

  
  /** Sets the day for the selected date.
   * 
   * The new date must be valid. For example, setting the day to 31 when the
   * month is February will fail.
   * 
   * @newin{4,14}
   * 
   * @param day The desired day for the selected date (as a number between 1 and 31).
   */
  void set_day(int day);
  
  /** Gets the day of the selected date.
   * 
   * @newin{4,14}
   * 
   * @return The day of the selected date.
   */
  int get_day() const;
  
  /** Sets the month for the selected date.
   * 
   * The new date must be valid. For example, setting the month to 1 (February)
   * when the day is 31 will fail.
   * 
   * @newin{4,14}
   * 
   * @param month The desired month for the selected date (as a number between 0 and 11).
   */
  void set_month(int month);
  
  /** Gets the month of the selected date.
   * 
   * @newin{4,14}
   * 
   * @return The month of the selected date (as a number between 0 and 11).
   */
  int get_month() const;
  
  /** Sets the year for the selected date.
   * 
   * The new date must be valid. For example, setting the year to 2023 when the
   * date is February 29 will fail.
   * 
   * @newin{4,14}
   * 
   * @param year The desired year for the selected date (within Glib::DateTime
   * limits, i.e. from 0001 to 9999).
   */
  void set_year(int year);
  
  /** Gets the year of the selected date.
   * 
   * @newin{4,14}
   * 
   * @return The year of the selected date.
   */
  int get_year() const;

  
  /** Switches to @a day's year and month and selects its day.
   * 
   * @newin{4,20}
   * 
   * @param day A `Glib::DateTime` representing the day to select.
   */
  void set_date(const Glib::DateTime& day);
  
  /** Returns a `Glib::DateTime` representing the shown
   * year, month and the selected day.
   * 
   * The returned date is in the local time zone.
   * 
   * @return The `Glib::DateTime` representing the selected date.
   */
  Glib::DateTime get_date() const;

  
  /** Returns if the @a day of the @a calendar is already marked.
   * 
   * @param day The day number between 1 and 31.
   * @return Whether the day is marked.
   */
  bool get_day_is_marked(guint day) const;

  // no_default_handler because GtkCalendarClass is private.
  
  /**
   * @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_%prev_month()</tt>
   *
   * Flags: Run First
   *
   * Emitted when the user switches 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 switches 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 switches 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 switches to the next year.
   */

  Glib::SignalProxy<void()> signal_next_year();


  /** The selected date.
   * 
   * This property gets initially set to the current date.
   * 
   * @newin{4,20}
   *
   * @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< Glib::DateTime > property_date() ;

/** The selected date.
   * 
   * This property gets initially set to the current date.
   * 
   * @newin{4,20}
   *
   * @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< Glib::DateTime > property_date() const;

  
#ifndef GTKMM_DISABLE_DEPRECATED

/** The selected year.
   * 
   * This property gets initially set to the current year.
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 1
   *
   * @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.
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 1
   *
   * @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;

#endif // GTKMM_DISABLE_DEPRECATED

  
#ifndef GTKMM_DISABLE_DEPRECATED

/** The selected month (as a number between 0 and 11).
   * 
   * This property gets initially set to the current month.
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 0
   *
   * @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.
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 0
   *
   * @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;

#endif // GTKMM_DISABLE_DEPRECATED

  
#ifndef GTKMM_DISABLE_DEPRECATED

/** The selected day (as a number between 1 and 31).
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 1
   *
   * @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).
   * 
   * Deprecated: 4.20: This property will be removed in GTK 5.
   * Use property_date() instead.
   * 
   * @deprecated 4.20: This property will be removed in GTK 5. Use property_date() instead.
   *
   * Default value: 1
   *
   * @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;

#endif // GTKMM_DISABLE_DEPRECATED

  /** Determines whether a heading is displayed.
   *
   * Default value: <tt>true</tt>
   *
   * @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.
   *
   * Default value: <tt>true</tt>
   *
   * @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.
   *
   * Default value: <tt>true</tt>
   *
   * @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.
   *
   * Default value: <tt>true</tt>
   *
   * @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 week numbers are displayed.
   *
   * Default value: <tt>false</tt>
   *
   * @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.
   *
   * Default value: <tt>false</tt>
   *
   * @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;


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


};

} // 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
   */
  GTKMM_API
  Gtk::Calendar* wrap(GtkCalendar* object, bool take_copy = false);
} //namespace Glib


#endif /* _GTKMM_CALENDAR_H */

