The QCalendarWidget class provides a monthly based calendar widget allowing the user to select a date. More...

#include <qcalendarwidget.h>

Inheritance diagram for QCalendarWidget:

Collaboration diagram for QCalendarWidget:

Public Types
enum	HorizontalHeaderFormat { NoHorizontalHeader , SingleLetterDayNames , ShortDayNames , LongDayNames }
	This enum type defines the various formats the horizontal header can display. More...

enum	VerticalHeaderFormat { NoVerticalHeader , ISOWeekNumbers }
	This enum type defines the various formats the vertical header can display. More...

enum	SelectionMode { NoSelection , SingleSelection }
	This enum describes the types of selection offered to the user for selecting dates in the calendar. More...

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
	This enum describes how to render the widget when calling QWidget::render(). More...

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled , PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB }

Public Slots
void	setSelectedDate (QDate date)

void	setDateRange (QDate min, QDate max)
	Defines a date range by setting the minimumDate and maximumDate properties.

void	setCurrentPage (int year, int month)
	Displays the given month of the given year without changing the selected date.

void	setGridVisible (bool show)

void	setNavigationBarVisible (bool visible)

void	showNextMonth ()
	Shows the next month relative to the currently displayed month.

void	showPreviousMonth ()
	Shows the previous month relative to the currently displayed month.

void	showNextYear ()
	Shows the currently displayed month in the next year relative to the currently displayed year.

void	showPreviousYear ()
	Shows the currently displayed month in the previous year relative to the currently displayed year.

void	showSelectedDate ()
	Shows the month of the selected date.

void	showToday ()
	Shows the month of the today's date.

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)
	Disables widget input events if disable is true; otherwise enables input events.

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

void	update ()
	Updates the widget unless updates are disabled or the widget is hidden.

void	repaint ()
	Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)
	Convenience function, equivalent to setVisible(!hidden).

void	show ()
	Shows the widget and its child widgets.

void	hide ()
	Hides the widget.

void	showMinimized ()
	Shows the widget minimized, as an icon.

void	showMaximized ()
	Shows the widget maximized.

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	Restores the widget after it has been maximized or minimized.

bool	close ()
	Closes this widget.

void	raise ()
	Raises this widget to the top of the parent widget's stack.

void	lower ()
	Lowers the widget to the bottom of the parent widget's stack.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	selectionChanged ()
	This signal is emitted when the currently selected date is changed.

void	clicked (QDate date)
	This signal is emitted when a mouse button is clicked.

void	activated (QDate date)
	This signal is emitted whenever the user presses the Return or Enter key or double-clicks a date in the calendar widget.

void	currentPageChanged (int year, int month)
	This signal is emitted when the currently shown month is changed.

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)
	This signal is emitted when the window's title has changed, with the new title as an argument.

void	windowIconChanged (const QIcon &icon)
	This signal is emitted when the window's icon has changed, with the new icon as an argument.

void	windowIconTextChanged (const QString &iconText)
	This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

void	customContextMenuRequested (const QPoint &pos)
	This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QCalendarWidget (QWidget *parent=nullptr)
	Constructs a calendar widget with the given parent.

	~QCalendarWidget ()
	Destroys the calendar widget.

virtual QSize	sizeHint () const override
	\reimp

virtual QSize	minimumSizeHint () const override
	\reimp

QDate	selectedDate () const

int	yearShown () const
	Returns the year of the currently displayed month.

int	monthShown () const
	Returns the currently displayed month.

QDate	minimumDate () const

void	setMinimumDate (QDate date)

void	clearMinimumDate ()

QDate	maximumDate () const

void	setMaximumDate (QDate date)

void	clearMaximumDate ()

Qt::DayOfWeek	firstDayOfWeek () const

void	setFirstDayOfWeek (Qt::DayOfWeek dayOfWeek)

bool	isNavigationBarVisible () const

bool	isGridVisible () const

QCalendar	calendar () const

void	setCalendar (QCalendar calendar)

SelectionMode	selectionMode () const

void	setSelectionMode (SelectionMode mode)

HorizontalHeaderFormat	horizontalHeaderFormat () const

void	setHorizontalHeaderFormat (HorizontalHeaderFormat format)

VerticalHeaderFormat	verticalHeaderFormat () const

void	setVerticalHeaderFormat (VerticalHeaderFormat format)

QTextCharFormat	headerTextFormat () const
	Returns the text char format for rendering the header.

void	setHeaderTextFormat (const QTextCharFormat &format)
	Sets the text char format for rendering the header to format.

QTextCharFormat	weekdayTextFormat (Qt::DayOfWeek dayOfWeek) const
	Returns the text char format for rendering of day in the week dayOfWeek.

void	setWeekdayTextFormat (Qt::DayOfWeek dayOfWeek, const QTextCharFormat &format)
	Sets the text char format for rendering of day in the week dayOfWeek to format.

QMap< QDate, QTextCharFormat >	dateTextFormat () const
	Returns a QMap from QDate to QTextCharFormat showing all dates that use a special format that alters their rendering.

QTextCharFormat	dateTextFormat (QDate date) const
	Returns a QTextCharFormat for date.

void	setDateTextFormat (QDate date, const QTextCharFormat &format)
	Sets the format used to render the given date to that specified by format.

bool	isDateEditEnabled () const

void	setDateEditEnabled (bool enable)

int	dateEditAcceptDelay () const

void	setDateEditAcceptDelay (int delay)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	Constructs a widget which is a child of parent, with widget flags set to f.

	~QWidget ()
	Destroys the widget.

int	devType () const override

WId	winId () const
	Returns the window system identifier of the widget.

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)
	Sets the widget's GUI style to style.

bool	isWindow () const
	Returns `true` if the widget is an independent window, otherwise returns `false`.

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const
	Returns `true` if this widget would become enabled if ancestor is enabled; otherwise returns `false`.

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).

void	setFixedSize (const QSize &)
	Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

void	setFixedSize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.

void	setFixedWidth (int w)
	Sets both the minimum and maximum width of the widget to w without changing the heights.

void	setFixedHeight (int h)
	Sets both the minimum and maximum heights of the widget to h without changing the widths.

QPointF	mapToGlobal (const QPointF &) const
	Translates the widget coordinate pos to global screen coordinates.

QPoint	mapToGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromGlobal (const QPointF &) const
	Translates the global screen coordinate pos to widget coordinates.

QPoint	mapFromGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapToParent (const QPointF &) const
	Translates the widget coordinate pos to a coordinate in the parent widget.

QPoint	mapToParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromParent (const QPointF &) const
	Translates the parent widget coordinate pos to widget coordinates.

QPoint	mapFromParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapTo (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos to the coordinate system of parent.

QPoint	mapTo (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFrom (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.

QPoint	mapFrom (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QWidget *	window () const
	Returns the window for this widget, i.e.

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)
	Sets the background role of the widget to role.

QPalette::ColorRole	backgroundRole () const
	Returns the background role of the widget.

void	setForegroundRole (QPalette::ColorRole)
	Sets the foreground role of the widget to role.

QPalette::ColorRole	foregroundRole () const
	Returns the foreground role.

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const
	Returns the font metrics for the widget's current font.

QFontInfo	fontInfo () const
	Returns the font info for the widget's current font.

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const
	Returns `true` if the widget is under the mouse cursor; otherwise returns `false`.

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)
	Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.

void	setMask (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.

QRegion	mask () const
	Returns the mask currently set on a widget.

void	clearMask ()
	Removes any mask set by setMask().

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
	Subscribes the widget to a given gesture with specific flags.

void	ungrabGesture (Qt::GestureType type)
	Unsubscribes the widget from a given gesture type.

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)
	Sets the window's role to role.

QString	windowRole () const
	Returns the window's role, or an empty string.

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()
	Sets the top-level widget containing this widget to be the active window.

void	clearFocus ()
	Takes keyboard input focus from the widget.

void	setFocus (Qt::FocusReason reason)
	Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)
	Sets the widget's focus proxy to widget w.

QWidget *	focusProxy () const
	Returns the focus proxy, or \nullptr if there is no focus proxy.

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()
	Grabs the mouse input.

void	grabMouse (const QCursor &)

void	releaseMouse ()
	Releases the mouse grab.

void	grabKeyboard ()
	Grabs the keyboard input.

void	releaseKeyboard ()
	Releases the keyboard grab.

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
	Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.

void	releaseShortcut (int id)
	Removes the shortcut with the given id from Qt's shortcut system.

void	setShortcutEnabled (int id, bool enable=true)
	If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.

void	update (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.

void	update (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	repaint (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.

void	repaint (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.

void	repaint (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	stackUnder (QWidget *)
	Places the widget under w in the parent widget's stack.

void	move (int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).

void	move (const QPoint &)

void	resize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()
	Adjusts the size of the widget to fit its contents.

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const
	Returns `true` if this widget would become visible if ancestor is shown; otherwise returns `false`.

bool	isHidden () const
	Returns `true` if the widget is hidden, otherwise returns `false`.

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const
	Returns the current window state.

void	setWindowState (Qt::WindowStates state)
	Sets the window state to windowState.

void	overrideWindowState (Qt::WindowStates state)

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.

virtual int	heightForWidth (int) const
	Returns the preferred height for this widget, given the width w.

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const
	Returns the unobscured region where paint events can occur.

void	setContentsMargins (int left, int top, int right, int bottom)
	Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.

void	setContentsMargins (const QMargins &margins)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins.

QRect	contentsRect () const
	Returns the area inside the widget's margins.

QLayout *	layout () const
	Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.

void	setLayout (QLayout *)
	Sets the layout manager for this widget to layout.

void	updateGeometry ()
	Notifies the layout system that this widget has changed and may need to change geometry.

void	setParent (QWidget *parent)
	Sets the parent of the widget to parent, and resets the window flags.

void	setParent (QWidget *parent, Qt::WindowFlags f)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.

void	scroll (int dx, int dy)
	Scrolls the widget including its children dx pixels to the right and dy downward.

void	scroll (int dx, int dy, const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.

QWidget *	focusWidget () const
	Returns the last child of this widget that setFocus had been called on.

QWidget *	nextInFocusChain () const
	Returns the next widget in this widget's focus chain.

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain.

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)
	Appends the action action to this widget's list of actions.

void	addActions (const QList< QAction * > &actions)
	Appends the actions actions to this widget's list of actions.

void	insertActions (QAction before, const QList< QAction > &actions)
	Inserts the actions actions to this widget's list of actions, before the action before.

void	insertAction (QAction before, QAction action)
	Inserts the action action to this widget's list of actions, before the action before.

void	removeAction (QAction *action)
	Removes the action action from this widget's list of actions.

QList< QAction * >	actions () const
	Returns the (possibly empty) list of this widget's actions.

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const
	Returns the parent of this widget, or \nullptr if it does not have any parent widget.

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const
	Window flags are a combination of a type (e.g.

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)
	Sets the window flags for the widget to flags, without telling the window system.

Qt::WindowType	windowType () const
	Returns the window type of this widget.

QWidget *	childAt (int x, int y) const
	Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.

QWidget *	childAt (const QPoint &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.

QWidget *	childAt (const QPointF &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	setAttribute (Qt::WidgetAttribute, bool on=true)
	Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

bool	testAttribute (Qt::WidgetAttribute) const
	Returns `true` if attribute attribute is set on this widget; otherwise returns `false`.

QPaintEngine *	paintEngine () const override
	Returns the widget's paint engine.

void	ensurePolished () const
	Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

bool	isAncestorOf (const QWidget *child) const
	Returns `true` if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns `false`.

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const
	If this is a native widget, return the associated QWindow.

QScreen *	screen () const
	Returns the screen the widget is on.

void	setScreen (QScreen *)
	Sets the screen on which the widget should be shown to screen.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const
	This method is only relevant for input widgets.

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
bool	event (QEvent *event) override
	\reimp

bool	eventFilter (QObject watched, QEvent event) override
	\reimp

void	mousePressEvent (QMouseEvent *event) override
	\reimp

void	resizeEvent (QResizeEvent *event) override
	\reimp

void	keyPressEvent (QKeyEvent *event) override
	\reimp

virtual void	paintCell (QPainter *painter, const QRect &rect, QDate date) const
	Paints the cell specified by the given date, using the given painter and rect.

void	updateCell (QDate date)

void	updateCells ()

Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.

virtual void	focusInEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.

virtual void	focusOutEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.

virtual void	enterEvent (QEnterEvent *event)
	This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

virtual void	leaveEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

virtual void	paintEvent (QPaintEvent *event)
	This event handler can be reimplemented in a subclass to receive paint events passed in event.

virtual void	moveEvent (QMoveEvent *event)
	This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.

virtual void	closeEvent (QCloseEvent *event)
	This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.

virtual void	contextMenuEvent (QContextMenuEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.

virtual void	actionEvent (QActionEvent *event)
	This event handler is called with the given event whenever the widget's actions are changed.

virtual void	showEvent (QShowEvent *event)
	This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.

virtual void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

virtual void	changeEvent (QEvent *)
	This event handler can be reimplemented to handle state changes.

int	metric (PaintDeviceMetric) const override
	Internal implementation of the virtual QPaintDevice::metric() function.

void	initPainter (QPainter *painter) const override
	Initializes the painter pen, background and font to the same as the given widget's.

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)
	This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
	Creates a new widget window.

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)
	Frees up window system resources.

virtual bool	focusNextPrevChild (bool next)
	Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusNextChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusPreviousChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

double	getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const

Properties
QDate	selectedDate
	the currently selected date.

QDate	minimumDate
	the minimum date of the currently specified date range.

QDate	maximumDate
	the maximum date of the currently specified date range.

Qt::DayOfWeek	firstDayOfWeek
	a value identifying the day displayed in the first column.

bool	gridVisible
	whether the table grid is displayed.

SelectionMode	selectionMode
	the type of selection the user can make in the calendar

HorizontalHeaderFormat	horizontalHeaderFormat
	the format of the horizontal header.

VerticalHeaderFormat	verticalHeaderFormat
	the format of the vertical header.

bool	navigationBarVisible
	whether the navigation bar is shown or not

bool	dateEditEnabled
	whether the date edit popup is enabled

int	dateEditAcceptDelay
	the time an inactive date edit is shown before its contents are accepted

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget

bool	enabled
	whether the widget is enabled

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

int	x
	the x coordinate of the widget relative to its parent including any window frame

int	y
	the y coordinate of the widget relative to its parent and including any window frame

QPoint	pos
	the position of the widget within its parent widget

QSize	frameSize
	the size of the widget including any window frame

QSize	size
	the size of the widget excluding any window frame

int	width
	the width of the widget excluding any window frame

int	height
	the height of the widget excluding any window frame

QRect	rect
	the internal geometry of the widget excluding any window frame

QRect	childrenRect
	the bounding rectangle of the widget's children

QRegion	childrenRegion
	the combined region occupied by the widget's children

QSizePolicy	sizePolicy
	the default layout behavior of the widget

QSize	minimumSize
	the widget's minimum size

QSize	maximumSize
	the widget's maximum size in pixels

int	minimumWidth
	the widget's minimum width in pixels

int	minimumHeight
	the widget's minimum height in pixels

int	maximumWidth
	the widget's maximum width in pixels

int	maximumHeight
	the widget's maximum height in pixels

QSize	sizeIncrement
	the size increment of the widget

QSize	baseSize
	the base size of the widget

QPalette	palette
	the widget's palette

QFont	font
	the font currently set for the widget

QCursor	cursor
	the cursor shape for this widget

bool	mouseTracking
	whether mouse tracking is enabled for the widget

bool	tabletTracking
	whether tablet tracking is enabled for the widget

bool	isActiveWindow
	whether this widget's window is the active window

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu

bool	updatesEnabled
	whether updates are enabled

bool	visible
	whether the widget is visible

bool	minimized
	whether this widget is minimized (iconified)

bool	maximized
	whether this widget is maximized

bool	fullScreen
	whether the widget is shown in full screen mode

QSize	sizeHint
	the recommended size for the widget

QSize	minimumSizeHint
	the recommended minimum size for the widget

bool	acceptDrops
	whether drop events are enabled for this widget

QString	windowTitle
	the window title (caption)

QIcon	windowIcon
	the widget's icon

QString	windowIconText
	the text to be displayed on the icon of a minimized window

double	windowOpacity
	The level of opacity for the window.

bool	windowModified
	whether the document shown in the window has unsaved changes

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget.

bool	autoFillBackground
	whether the widget background is filled automatically

QString	styleSheet
	the widget's style sheet

QLocale	locale
	the widget's locale

QString	windowFilePath
	the file path associated with a widget

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has.

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )
	Puts the second widget after the first widget in the focus order.

static void	setTabOrder (std::initializer_list< QWidget * > widgets)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static QWidget *	mouseGrabber ()
	Returns the widget that is currently grabbing the mouse input.

static QWidget *	keyboardGrabber ()
	Returns the widget that is currently grabbing the keyboard input.

static QWidget *	find (WId)
	Returns a pointer to the widget with window identifier/handle id.

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Creates a QWidget that makes it possible to embed window into a QWidget-based application.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

static int	encodeMetricF (PaintDeviceMetric metric, double value)

Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
	Updates the widget's micro focus and informs input methods that the state specified by query has changed.

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Symbols inherited from QWidget
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QCalendarWidget class provides a monthly based calendar widget allowing the user to select a date.

Since: 4.2

\inmodule QtWidgets

The widget is initialized with the current month and year, but QCalendarWidget provides several public slots to change the year and month that is shown.

By default, today's date is selected, and the user can select a date using both mouse and keyboard. The currently selected date can be retrieved using the selectedDate() function. It is possible to constrain the user selection to a given date range by setting the minimumDate and maximumDate properties. Alternatively, both properties can be set in one go using the setDateRange() convenience slot. Set the \l selectionMode property to NoSelection to prohibit the user from selecting at all. Note that a date also can be selected programmatically using the setSelectedDate() slot.

The currently displayed month and year can be retrieved using the monthShown() and yearShown() functions, respectively.

A newly created calendar widget uses abbreviated day names, and both Saturdays and Sundays are marked in red. The calendar grid is not visible. The week numbers are displayed, and the first column day is the first day of the week for the calendar's locale.

The notation of the days can be altered to a single letter abbreviations ("M" for "Monday") by setting the horizontalHeaderFormat property to QCalendarWidget::SingleLetterDayNames. Setting the same property to QCalendarWidget::LongDayNames makes the header display the complete day names. The week numbers can be removed by setting the verticalHeaderFormat property to QCalendarWidget::NoVerticalHeader. The calendar grid can be turned on by setting the gridVisible property to true using the setGridVisible() function:

\table \row

\row
QCalendarWidget *calendar;

calendar->setGridVisible(true);

\endtable

Finally, the day in the first column can be altered using the setFirstDayOfWeek() function.

The QCalendarWidget class also provides three signals, selectionChanged(), activated() and currentPageChanged() making it possible to respond to user interaction.

The rendering of the headers, weekdays or single days can be largely customized by setting QTextCharFormat's for some special weekday, a special date or for the rendering of the headers.

Only a subset of the properties in QTextCharFormat are used by the calendar widget. Currently, the foreground, background and font properties are used to determine the rendering of individual cells in the widget.

See also: QDate, QDateEdit, QTextCharFormat

Definition at line 19 of file qcalendarwidget.h.

Member Enumeration Documentation

◆ HorizontalHeaderFormat

enum QCalendarWidget::HorizontalHeaderFormat

This enum type defines the various formats the horizontal header can display.

\value SingleLetterDayNames The header displays a single letter abbreviation for day names (e.g. M for Monday). \value ShortDayNames The header displays a short abbreviation for day names (e.g. Mon for Monday). \value LongDayNames The header displays complete day names (e.g. Monday). \value NoHorizontalHeader The header is hidden.

See also: horizontalHeaderFormat(), VerticalHeaderFormat

Enumerator
NoHorizontalHeader
SingleLetterDayNames
ShortDayNames
LongDayNames

Definition at line 38 of file qcalendarwidget.h.

◆ SelectionMode

enum QCalendarWidget::SelectionMode

This enum describes the types of selection offered to the user for selecting dates in the calendar.

\value NoSelection Dates cannot be selected. \value SingleSelection Single dates can be selected.

See also: selectionMode

Enumerator
NoSelection
SingleSelection

Definition at line 52 of file qcalendarwidget.h.

◆ VerticalHeaderFormat

enum QCalendarWidget::VerticalHeaderFormat

This enum type defines the various formats the vertical header can display.

\value ISOWeekNumbers The header displays ISO week numbers as described by \l QDate::weekNumber(). \value NoVerticalHeader The header is hidden.

See also: verticalHeaderFormat(), HorizontalHeaderFormat

Enumerator
NoVerticalHeader
ISOWeekNumbers

Definition at line 46 of file qcalendarwidget.h.

Constructor & Destructor Documentation

◆ QCalendarWidget()

QCalendarWidget::QCalendarWidget ( QWidget * parent = nullptr )

explicit

Constructs a calendar widget with the given parent.

The widget is initialized with the current month and year, and the currently selected date is today.

See also: setCurrentPage()

Definition at line 2103 of file qcalendarwidget.cpp.

◆ ~QCalendarWidget()

QCalendarWidget::~QCalendarWidget ( )

Destroys the calendar widget.

Definition at line 2171 of file qcalendarwidget.cpp.

Member Function Documentation

◆ activated

void QCalendarWidget::activated ( QDate date )

signal

This signal is emitted whenever the user presses the Return or Enter key or double-clicks a date in the calendar widget.

◆ calendar()

QCalendar QCalendarWidget::calendar ( ) const

Since: 5.14 Report the calendar system in use by this widget.

See also: setCalendar()

Definition at line 2741 of file qcalendarwidget.cpp.

◆ clearMaximumDate()

void QCalendarWidget::clearMaximumDate ( )

Definition at line 2587 of file qcalendarwidget.cpp.

◆ clearMinimumDate()

void QCalendarWidget::clearMinimumDate ( )

Definition at line 2531 of file qcalendarwidget.cpp.

◆ clicked

void QCalendarWidget::clicked ( QDate date )

signal

This signal is emitted when a mouse button is clicked.

The date the mouse was clicked on is specified by date. The signal is only emitted when clicked on a valid date, e.g., dates are not outside the minimumDate() and maximumDate(). If the selection mode is NoSelection, this signal will not be emitted.

◆ currentPageChanged

void QCalendarWidget::currentPageChanged	(	int	year,
		int	month )

signal

This signal is emitted when the currently shown month is changed.

The new year and month are passed as parameters.

See also: setCurrentPage()

◆ dateEditAcceptDelay()

int QCalendarWidget::dateEditAcceptDelay ( ) const

Definition at line 2965 of file qcalendarwidget.cpp.

◆ dateTextFormat() [1/2]

QMap< QDate, QTextCharFormat > QCalendarWidget::dateTextFormat ( ) const

Returns a QMap from QDate to QTextCharFormat showing all dates that use a special format that alters their rendering.

Definition at line 2886 of file qcalendarwidget.cpp.

◆ dateTextFormat() [2/2]

QTextCharFormat QCalendarWidget::dateTextFormat ( QDate date ) const

Returns a QTextCharFormat for date.

The char format can be empty if the date is not renderd specially.

Definition at line 2896 of file qcalendarwidget.cpp.

◆ event()

bool QCalendarWidget::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 3094 of file qcalendarwidget.cpp.

◆ eventFilter()

bool QCalendarWidget::eventFilter	(	QObject *	watched,
		QEvent *	event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 3129 of file qcalendarwidget.cpp.

◆ firstDayOfWeek()

Qt::DayOfWeek QCalendarWidget::firstDayOfWeek ( ) const

Definition at line 2824 of file qcalendarwidget.cpp.

◆ headerTextFormat()

QTextCharFormat QCalendarWidget::headerTextFormat ( ) const

Returns the text char format for rendering the header.

Definition at line 2833 of file qcalendarwidget.cpp.

◆ horizontalHeaderFormat()

QCalendarWidget::HorizontalHeaderFormat QCalendarWidget::horizontalHeaderFormat ( ) const

Definition at line 2665 of file qcalendarwidget.cpp.

◆ isDateEditEnabled()

bool QCalendarWidget::isDateEditEnabled ( ) const

Definition at line 2936 of file qcalendarwidget.cpp.

◆ isGridVisible()

bool QCalendarWidget::isGridVisible ( ) const

Definition at line 2728 of file qcalendarwidget.cpp.

◆ isNavigationBarVisible()

bool QCalendarWidget::isNavigationBarVisible ( ) const

Definition at line 3075 of file qcalendarwidget.cpp.

◆ keyPressEvent()

void QCalendarWidget::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3183 of file qcalendarwidget.cpp.

◆ maximumDate()

QDate QCalendarWidget::maximumDate ( ) const

Definition at line 2562 of file qcalendarwidget.cpp.

◆ minimumDate()

QDate QCalendarWidget::minimumDate ( ) const

Definition at line 2506 of file qcalendarwidget.cpp.

◆ minimumSizeHint()

QSize QCalendarWidget::minimumSizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 2186 of file qcalendarwidget.cpp.

◆ monthShown()

int QCalendarWidget::monthShown ( ) const

Returns the currently displayed month.

Months are numbered from 1 to 12.

See also: yearShown(), setCurrentPage()

Definition at line 2340 of file qcalendarwidget.cpp.

◆ mousePressEvent()

void QCalendarWidget::mousePressEvent ( QMouseEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3157 of file qcalendarwidget.cpp.

◆ paintCell()

void QCalendarWidget::paintCell	(	QPainter *	painter,
		const QRect &	rect,
		QDate	date ) const

protectedvirtual

Paints the cell specified by the given date, using the given painter and rect.

Definition at line 2280 of file qcalendarwidget.cpp.

◆ resizeEvent()

void QCalendarWidget::resizeEvent ( QResizeEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3167 of file qcalendarwidget.cpp.

◆ selectedDate()

QDate QCalendarWidget::selectedDate ( ) const

Definition at line 2297 of file qcalendarwidget.cpp.

◆ selectionChanged

void QCalendarWidget::selectionChanged ( )

signal

This signal is emitted when the currently selected date is changed.

The currently selected date can be changed by the user using the mouse or keyboard, or by the programmer using setSelectedDate().

See also: selectedDate()

◆ selectionMode()

QCalendarWidget::SelectionMode QCalendarWidget::selectionMode ( ) const

Definition at line 2792 of file qcalendarwidget.cpp.

◆ setCalendar()

void QCalendarWidget::setCalendar ( QCalendar c )

Since: 5.14 Set c as the calendar system to be used by this widget.

The widget can use any supported calendar system. By default, it uses the Gregorian calendar.

See also: calendar()

Definition at line 2757 of file qcalendarwidget.cpp.

◆ setCurrentPage

void QCalendarWidget::setCurrentPage	(	int	year,
		int	month )

slot

Displays the given month of the given year without changing the selected date.

Use the setSelectedDate() function to alter the selected date.

The currently displayed month and year can be retrieved using the monthShown() and yearShown() functions respectively.

See also: yearShown(), monthShown(), showPreviousMonth(), showNextMonth(), showPreviousYear(), showNextYear()

Definition at line 2358 of file qcalendarwidget.cpp.

◆ setDateEditAcceptDelay()

void QCalendarWidget::setDateEditAcceptDelay ( int delay )

Definition at line 2971 of file qcalendarwidget.cpp.

◆ setDateEditEnabled()

void QCalendarWidget::setDateEditEnabled ( bool enable )

Definition at line 2942 of file qcalendarwidget.cpp.

◆ setDateRange

void QCalendarWidget::setDateRange	(	QDate	min,
		QDate	max )

slot

Defines a date range by setting the minimumDate and maximumDate properties.

The date range restricts the user selection, i.e. the user can only select dates within the specified date range. Note that

QCalendarWidget *calendar;
 
calendar->setDateRange(min, max);

is analogous to

QCalendarWidget *calendar;
 
calendar->setMinimumDate(min);
calendar->setMaximumDate(max);

If either the min or max parameters are not valid QDate objects, this function does nothing.

See also: setMinimumDate(), setMaximumDate()

Definition at line 2611 of file qcalendarwidget.cpp.

◆ setDateTextFormat()

void QCalendarWidget::setDateTextFormat	(	QDate	date,
		const QTextCharFormat &	format )

Sets the format used to render the given date to that specified by format.

If date is null, all date formats are cleared.

Definition at line 2907 of file qcalendarwidget.cpp.

◆ setFirstDayOfWeek()

void QCalendarWidget::setFirstDayOfWeek ( Qt::DayOfWeek dayOfWeek )

Definition at line 2814 of file qcalendarwidget.cpp.

◆ setGridVisible

void QCalendarWidget::setGridVisible ( bool show )

slot

Definition at line 2767 of file qcalendarwidget.cpp.

◆ setHeaderTextFormat()

void QCalendarWidget::setHeaderTextFormat ( const QTextCharFormat & format )

Sets the text char format for rendering the header to format.

If you also set a weekday text format, this format's foreground and background color will take precedence over the header's format. The other formatting information will still be decided by the header's format.

Definition at line 2846 of file qcalendarwidget.cpp.

◆ setHorizontalHeaderFormat()

void QCalendarWidget::setHorizontalHeaderFormat ( QCalendarWidget::HorizontalHeaderFormat format )

Definition at line 2653 of file qcalendarwidget.cpp.

◆ setMaximumDate()

void QCalendarWidget::setMaximumDate ( QDate date )

Definition at line 2568 of file qcalendarwidget.cpp.

◆ setMinimumDate()

void QCalendarWidget::setMinimumDate ( QDate date )

Definition at line 2512 of file qcalendarwidget.cpp.

◆ setNavigationBarVisible

void QCalendarWidget::setNavigationBarVisible ( bool visible )

slot

Definition at line 3082 of file qcalendarwidget.cpp.

◆ setSelectedDate

void QCalendarWidget::setSelectedDate ( QDate date )

slot

Definition at line 2303 of file qcalendarwidget.cpp.

◆ setSelectionMode()

void QCalendarWidget::setSelectionMode ( SelectionMode mode )

Definition at line 2798 of file qcalendarwidget.cpp.

◆ setVerticalHeaderFormat()

void QCalendarWidget::setVerticalHeaderFormat ( QCalendarWidget::VerticalHeaderFormat format )

Definition at line 2699 of file qcalendarwidget.cpp.

◆ setWeekdayTextFormat()

void QCalendarWidget::setWeekdayTextFormat	(	Qt::DayOfWeek	dayOfWeek,
		const QTextCharFormat &	format )

Sets the text char format for rendering of day in the week dayOfWeek to format.

The format will take precedence over the header format in case of foreground and background color. Other text formatting information is taken from the headers format.

See also: setHeaderTextFormat()

Definition at line 2873 of file qcalendarwidget.cpp.

◆ showNextMonth

void QCalendarWidget::showNextMonth ( )

slot

Shows the next month relative to the currently displayed month.

Note that the selected date is not changed.

See also: showPreviousMonth(), setCurrentPage(), setSelectedDate()

Definition at line 2386 of file qcalendarwidget.cpp.

◆ showNextYear

void QCalendarWidget::showNextYear ( )

slot

Shows the currently displayed month in the next year relative to the currently displayed year.

Note that the selected date is not changed.

See also: showPreviousYear(), setCurrentPage(), setSelectedDate()

Definition at line 2430 of file qcalendarwidget.cpp.

◆ showPreviousMonth

void QCalendarWidget::showPreviousMonth ( )

slot

Shows the previous month relative to the currently displayed month.

Note that the selected date is not changed.

See also: showNextMonth(), setCurrentPage(), setSelectedDate()

Definition at line 2407 of file qcalendarwidget.cpp.

◆ showPreviousYear

void QCalendarWidget::showPreviousYear ( )

slot

Shows the currently displayed month in the previous year relative to the currently displayed year.

Note that the selected date is not changed.

See also: showNextYear(), setCurrentPage(), setSelectedDate()

Definition at line 2446 of file qcalendarwidget.cpp.

◆ showSelectedDate

void QCalendarWidget::showSelectedDate ( )

slot

Shows the month of the selected date.

See also: selectedDate(), setCurrentPage()

Definition at line 2459 of file qcalendarwidget.cpp.

◆ showToday

void QCalendarWidget::showToday ( )

slot

Shows the month of the today's date.

See also: selectedDate(), setCurrentPage()

Definition at line 2472 of file qcalendarwidget.cpp.

◆ sizeHint()

QSize QCalendarWidget::sizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 2178 of file qcalendarwidget.cpp.

◆ updateCell()

void QCalendarWidget::updateCell ( QDate date )

protected

Since: 4.4

Updates the cell specified by the given date unless updates are disabled or the cell is hidden.

See also: updateCells(), yearShown(), monthShown()

Definition at line 2985 of file qcalendarwidget.cpp.

◆ updateCells()

void QCalendarWidget::updateCells ( )

protected

Since: 4.4

Updates all visible cells unless updates are disabled.

See also: updateCell()

Definition at line 3015 of file qcalendarwidget.cpp.

◆ verticalHeaderFormat()

QCalendarWidget::VerticalHeaderFormat QCalendarWidget::verticalHeaderFormat ( ) const

Definition at line 2690 of file qcalendarwidget.cpp.

◆ weekdayTextFormat()

QTextCharFormat QCalendarWidget::weekdayTextFormat ( Qt::DayOfWeek dayOfWeek ) const

Returns the text char format for rendering of day in the week dayOfWeek.

See also: headerTextFormat()

Definition at line 2860 of file qcalendarwidget.cpp.

◆ yearShown()

int QCalendarWidget::yearShown ( ) const

Returns the year of the currently displayed month.

Months are numbered from 1 to 12.

See also: monthShown(), setCurrentPage()

Definition at line 2327 of file qcalendarwidget.cpp.

Property Documentation

◆ dateEditAcceptDelay

int QCalendarWidget::dateEditAcceptDelay

readwrite

the time an inactive date edit is shown before its contents are accepted

Since: 4.3

If the calendar widget's \l{dateEditEnabled}{date edit is enabled}, this property specifies the amount of time (in milliseconds) that the date edit remains open after the most recent user input. Once this time has elapsed, the date specified in the date edit is accepted and the popup is closed.

By default, the delay is defined to be 1500 milliseconds (1.5 seconds).

Definition at line 35 of file qcalendarwidget.h.

◆ dateEditEnabled

bool QCalendarWidget::dateEditEnabled

readwrite

whether the date edit popup is enabled

Since: 4.3

If this property is enabled, pressing a non-modifier key will cause a date edit to popup if the calendar widget has focus, allowing the user to specify a date in the form specified by the current locale.

By default, this property is enabled.

The date edit is simpler in appearance than QDateEdit, but allows the user to navigate between fields using the left and right cursor keys, increment and decrement individual fields using the up and down cursor keys, and enter values directly using the number keys.

See also: QCalendarWidget::dateEditAcceptDelay

Definition at line 34 of file qcalendarwidget.h.

◆ firstDayOfWeek

Qt::DayOfWeek QCalendarWidget::firstDayOfWeek

readwrite

a value identifying the day displayed in the first column.

By default, the day displayed in the first column is the first day of the week for the calendar's locale.

Definition at line 26 of file qcalendarwidget.h.

◆ gridVisible

bool QCalendarWidget::gridVisible

readwrite

whether the table grid is displayed.

\table \row

\inlineimage qcalendarwidget-grid.png \row
QCalendarWidget *calendar;

calendar->setGridVisible(true);

QCalendarWidget
The QCalendarWidget class provides a monthly based calendar widget allowing the user to select a date...
Definition qcalendarwidget.h:20

QCalendarWidget::setDateRange
void setDateRange(QDate min, QDate max)
Defines a date range by setting the minimumDate and maximumDate properties.
Definition qcalendarwidget.cpp:2611

QCalendarWidget::setGridVisible
void setGridVisible(bool show)
Definition qcalendarwidget.cpp:2767

QCalendarWidget::setMaximumDate
void setMaximumDate(QDate date)
Definition qcalendarwidget.cpp:2568

QCalendarWidget::setMinimumDate
void setMinimumDate(QDate date)
Definition qcalendarwidget.cpp:2512

QDate
\inmodule QtCore \reentrant
Definition qdatetime.h:29

calendar
QCalendarWidget * calendar
[0]
Definition src_gui_widgets_qcalendarwidget.cpp:5

\endtable

The default value is false.

Definition at line 27 of file qcalendarwidget.h.

◆ horizontalHeaderFormat

HorizontalHeaderFormat QCalendarWidget::horizontalHeaderFormat

readwrite

the format of the horizontal header.

The default value is QCalendarWidget::ShortDayNames.

Definition at line 29 of file qcalendarwidget.h.

◆ maximumDate

QDate QCalendarWidget::maximumDate

readwrite

the maximum date of the currently specified date range.

The user will not be able to select a date which is after the currently set maximum date.

\table \row

\row
QCalendarWidget *calendar;

calendar->setGridVisible(true);

calendar->setMaximumDate(QDate(2006, 7, 3));

\endtable

When setting a maximum date, the minimumDate and selectedDate properties are adjusted if the selection range becomes invalid. If the provided date is not a valid QDate object, the setMaximumDate() function does nothing.

The default maximum date is December 31, 9999 CE. You can restore this default by calling clearMaximumDate() (since Qt 6.6).

See also: setDateRange()

Definition at line 25 of file qcalendarwidget.h.

◆ minimumDate

QDate QCalendarWidget::minimumDate

readwrite

the minimum date of the currently specified date range.

The user will not be able to select a date that is before the currently set minimum date.

\table \row

\row
QCalendarWidget *calendar;

calendar->setGridVisible(true);

calendar->setMinimumDate(QDate(2006, 6, 19));

\endtable

When setting a minimum date, the maximumDate and selectedDate properties are adjusted if the selection range becomes invalid. If the provided date is not a valid QDate object, the setMinimumDate() function does nothing.

The default minimum date is November 25, 4714 BCE. You can restore this default by calling clearMinimumDate() (since Qt 6.6).

See also: setDateRange()

Definition at line 24 of file qcalendarwidget.h.

◆ navigationBarVisible

bool QCalendarWidget::navigationBarVisible

readwrite

whether the navigation bar is shown or not

Since: 4.3

When this property is true (the default), the next month, previous month, month selection, year selection controls are shown on top.

When the property is set to false, these controls are hidden.

Definition at line 33 of file qcalendarwidget.h.

◆ selectedDate

QDate QCalendarWidget::selectedDate

readwrite

the currently selected date.

The selected date must be within the date range specified by the minimumDate and maximumDate properties. By default, the selected date is the current date.

See also: setDateRange()

Definition at line 23 of file qcalendarwidget.h.

◆ selectionMode

SelectionMode QCalendarWidget::selectionMode

readwrite

the type of selection the user can make in the calendar

When this property is set to SingleSelection, the user can select a date within the minimum and maximum allowed dates, using either the mouse or the keyboard.

When the property is set to NoSelection, the user will be unable to select dates, but they can still be selected programmatically. Note that the date that is selected when the property is set to NoSelection will still be the selected date of the calendar.

The default value is SingleSelection.

Definition at line 28 of file qcalendarwidget.h.

◆ verticalHeaderFormat

VerticalHeaderFormat QCalendarWidget::verticalHeaderFormat

readwrite

the format of the vertical header.

The default value is QCalendarWidget::ISOWeekNumber.

Definition at line 31 of file qcalendarwidget.h.

The documentation for this class was generated from the following files:

qtbase/src/widgets/widgets/qcalendarwidget.h (51272017a7a4ba29a1bd1af093422778d0c51a58)
qtbase/src/widgets/widgets/qcalendarwidget.cpp (33cc65328819836374eb4823e571789b066003f5)

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HorizontalHeaderFormat

◆ SelectionMode

◆ VerticalHeaderFormat

Constructor & Destructor Documentation

◆ QCalendarWidget()

◆ ~QCalendarWidget()

Member Function Documentation

◆ activated

◆ calendar()

◆ clearMaximumDate()

◆ clearMinimumDate()

◆ clicked

◆ currentPageChanged

◆ dateEditAcceptDelay()

◆ dateTextFormat() [1/2]

◆ dateTextFormat() [2/2]

◆ event()

◆ eventFilter()

◆ firstDayOfWeek()

◆ headerTextFormat()

◆ horizontalHeaderFormat()

◆ isDateEditEnabled()

◆ isGridVisible()

◆ isNavigationBarVisible()

◆ keyPressEvent()

◆ maximumDate()

◆ minimumDate()

◆ minimumSizeHint()

◆ monthShown()

◆ mousePressEvent()

◆ paintCell()

◆ resizeEvent()

◆ selectedDate()

◆ selectionChanged

◆ selectionMode()

◆ setCalendar()

◆ setCurrentPage

◆ setDateEditAcceptDelay()

◆ setDateEditEnabled()

◆ setDateRange

◆ setDateTextFormat()

◆ setFirstDayOfWeek()

◆ setGridVisible

◆ setHeaderTextFormat()

◆ setHorizontalHeaderFormat()

◆ setMaximumDate()

◆ setMinimumDate()

◆ setNavigationBarVisible

◆ setSelectedDate

◆ setSelectionMode()

◆ setVerticalHeaderFormat()

◆ setWeekdayTextFormat()

◆ showNextMonth

◆ showNextYear

◆ showPreviousMonth

◆ showPreviousYear

◆ showSelectedDate

◆ showToday

◆ sizeHint()

◆ updateCell()

◆ updateCells()

◆ verticalHeaderFormat()

◆ weekdayTextFormat()

◆ yearShown()

Property Documentation

◆ dateEditAcceptDelay

◆ dateEditEnabled

◆ firstDayOfWeek

◆ gridVisible

◆ horizontalHeaderFormat

◆ maximumDate