Qt Documentation

Contents

CalendarStyle QML Type

Provides custom styling for Calendar. More...

Import Statement: import QtQuick.Controls.Styles 1.4
Since: Qt 5.3

Properties

Detailed Description

Component Map

The calendar has the following styleable components:

backgroundFills the entire control.

navigationBar

dayOfWeekDelegateOne instance per day of week.

weekNumberDelegateOne instance per week.

dayDelegateOne instance per day of month.

Custom Style Example

Calendar {
    anchors.centerIn: parent

    style: CalendarStyle {
        gridVisible: false
        dayDelegate: Rectangle {
            gradient: Gradient {
                GradientStop {
                    position: 0.00
                    color: styleData.selected ? "#111" : (styleData.visibleMonth && styleData.valid ? "#444" : "#666");
                }
                GradientStop {
                    position: 1.00
                    color: styleData.selected ? "#444" : (styleData.visibleMonth && styleData.valid ? "#111" : "#666");
                }
                GradientStop {
                    position: 1.00
                    color: styleData.selected ? "#777" : (styleData.visibleMonth && styleData.valid ? "#111" : "#666");
                }
            }

            Label {
                text: styleData.date.getDate()
                anchors.centerIn: parent
                color: styleData.valid ? "white" : "grey"
            }

            Rectangle {
                width: parent.width
                height: 1
                color: "#555"
                anchors.bottom: parent.bottom
            }

            Rectangle {
                width: 1
                height: parent.height
                color: "#555"
                anchors.right: parent.right
            }
        }
    }
}

Property Documentation

background : Component

The background of the calendar.

The implicit size of the calendar is calculated based on the implicit size of the background delegate.


[read-only] control : Calendar

The Calendar this style is attached to.


dayDelegate : Component

The delegate that styles each date in the calendar.

The properties provided to each delegate are:

readonly property date styleData.dateThe date this delegate represents.
readonly property bool styleData.selectedtrue if this is the selected date.
readonly property int styleData.indexThe index of this delegate.
readonly property bool styleData.validtrue if this date is greater than or equal to than minimumDate and less than or equal to maximumDate.
readonly property bool styleData.todaytrue if this date is equal to today's date.
readonly property bool styleData.visibleMonthtrue if the month in this date is the visible month.
readonly property bool styleData.hoveredtrue if the mouse is over this cell.

Note: This property is true even when the mouse is hovered over an invalid date.

readonly property bool styleData.pressedtrue if the mouse is pressed on this cell.

Note: This property is true even when the mouse is pressed on an invalid date.


dayOfWeekDelegate : Component

The delegate that styles each weekday.

The height of the weekday row is calculated based on the maximum implicit height of the delegates.

The properties provided to each delegate are:

readonly property int styleData.indexThe index (0-6) of the delegate.
readonly property int styleData.dayOfWeekThe day of the week this delegate represents. Possible values:
  • Locale.Sunday
  • Locale.Monday
  • Locale.Tuesday
  • Locale.Wednesday
  • Locale.Thursday
  • Locale.Friday
  • Locale.Saturday

gridColor : color

The color of the grid lines.


gridVisible : bool

This property determines the visibility of the grid.

The default value is true.


The navigation bar of the calendar.

Styles the bar at the top of the calendar that contains the next month/previous month buttons and the selected date label.

The properties provided to the delegate are:

readonly property string styleData.titleThe title of the calendar.

weekNumberDelegate : Component

The delegate that styles each week number.

The width of the week number column is calculated based on the maximum implicit width of the delegates.

The properties provided to each delegate are:

readonly property int styleData.indexThe index (0-5) of the delegate.
readonly property int styleData.weekNumberThe number of the week this delegate represents.

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.