summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@digia.com>2014-02-14 13:56:24 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-02-15 11:28:42 +0100
commitfa001b41c67784c97110452c5800bef960825264 (patch)
tree83e2795505fdd470cbfae87f700ce5f4f784b735 /src
parente25e72f05b13718d56365c8ed14da58209adaaa5 (diff)
Add Component Map section to CalendarStyle documentation.
The Component Map is a color-coded legend of the components in the style. The format is: <color-coded image showing sections of style> <table of color-component URL pairs> Change-Id: I0e6e4577516669515c083e58a8f875e344f7bdf7 Reviewed-by: Gabriel de Dietrich <gabriel.dedietrich@digia.com> Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/controls/Styles/Base/CalendarStyle.qml26
-rw-r--r--src/controls/doc/images/calendarstyle-components-week-numbers.pngbin0 -> 11611 bytes
-rw-r--r--src/controls/doc/images/square-blue.pngbin0 -> 181 bytes
-rw-r--r--src/controls/doc/images/square-green.pngbin0 -> 181 bytes
-rw-r--r--src/controls/doc/images/square-red.pngbin0 -> 178 bytes
-rw-r--r--src/controls/doc/images/square-white.pngbin0 -> 178 bytes
-rw-r--r--src/controls/doc/images/square-yellow.pngbin0 -> 178 bytes
7 files changed, 25 insertions, 1 deletions
diff --git a/src/controls/Styles/Base/CalendarStyle.qml b/src/controls/Styles/Base/CalendarStyle.qml
index 99330ffe8..7cfb43c1b 100644
--- a/src/controls/Styles/Base/CalendarStyle.qml
+++ b/src/controls/Styles/Base/CalendarStyle.qml
@@ -49,7 +49,31 @@ import QtQuick.Controls.Private 1.0
\ingroup controlsstyling
\brief Provides custom styling for \l Calendar
- Example:
+ \section2 Component Map
+
+ \image calendarstyle-components-week-numbers.png
+
+ The calendar has the following styleable components:
+
+ \table
+ \row \li \image square-white.png
+ \li \l background
+ \li Fills the entire control.
+ \row \li \image square-yellow.png
+ \li \l navigationBar
+ \li
+ \row \li \image square-green.png
+ \li \l dayOfWeekDelegate
+ \li One instance per day of week.
+ \row \li \image square-red.png
+ \li \l weekNumberDelegate
+ \li One instance per week.
+ \row \li \image square-blue.png
+ \li \l dayDelegate
+ \li One instance per day of month.
+ \endtable
+
+ \section2 Custom Style Example
\qml
Calendar {
anchors.centerIn: parent
diff --git a/src/controls/doc/images/calendarstyle-components-week-numbers.png b/src/controls/doc/images/calendarstyle-components-week-numbers.png
new file mode 100644
index 000000000..e98346e50
--- /dev/null
+++ b/src/controls/doc/images/calendarstyle-components-week-numbers.png
Binary files differ
diff --git a/src/controls/doc/images/square-blue.png b/src/controls/doc/images/square-blue.png
new file mode 100644
index 000000000..4b1e9109c
--- /dev/null
+++ b/src/controls/doc/images/square-blue.png
Binary files differ
diff --git a/src/controls/doc/images/square-green.png b/src/controls/doc/images/square-green.png
new file mode 100644
index 000000000..c04d16685
--- /dev/null
+++ b/src/controls/doc/images/square-green.png
Binary files differ
diff --git a/src/controls/doc/images/square-red.png b/src/controls/doc/images/square-red.png
new file mode 100644
index 000000000..c49869536
--- /dev/null
+++ b/src/controls/doc/images/square-red.png
Binary files differ
diff --git a/src/controls/doc/images/square-white.png b/src/controls/doc/images/square-white.png
new file mode 100644
index 000000000..a05eb09c6
--- /dev/null
+++ b/src/controls/doc/images/square-white.png
Binary files differ
diff --git a/src/controls/doc/images/square-yellow.png b/src/controls/doc/images/square-yellow.png
new file mode 100644
index 000000000..40fb3e82d
--- /dev/null
+++ b/src/controls/doc/images/square-yellow.png
Binary files differ