Skip to content

Commit

Permalink
added initial vuepress docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jryannel committed May 21, 2021
1 parent e0bfe3d commit b72f0a3
Show file tree
Hide file tree
Showing 849 changed files with 86,616 additions and 0 deletions.
325 changes: 325 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
module.exports = {
title: 'Qt6 Book',
description: "A book about Qt6",
themeConfig: {
nav: [
],
sidebar: [
ch01Sidebar(),
ch02Sidebar(),
ch03Sidebar(),
ch04Sidebar(),
ch05Sidebar(),
ch06Sidebar(),
ch07Sidebar(),
ch08Sidebar(),
ch09Sidebar(),
ch10Sidebar(),
ch11Sidebar(),
ch12Sidebar(),
ch13Sidebar(),
ch14Sidebar(),
ch15Sidebar(),
ch16Sidebar(),
ch17Sidebar(),
ch18Sidebar(),
],
},
}

function ch18Sidebar() {
return {
title: "Qt for Python",
path: '/ch18-python/qt-python',
collapsable: false,
children: [
'/ch18-python/qt-python',
'/ch18-python/introduction',
'/ch18-python/installing',
'/ch18-python/build-app',
'/ch18-python/limitations',
'/ch18-python/summary',
]
}
}

function ch17Sidebar() {
return {
title: "Extending QML",
path: '/ch17-extensions/extending-qml',
collapsable: false,
children: [
'/ch17-extensions/extending-qml',
'/ch17-extensions/qml-runtime',
'/ch17-extensions/plugin-content',
'/ch17-extensions/create-plugin',
'/ch17-extensions/fileio-demo',
'/ch17-extensions/using-fileio',
'/ch17-extensions/summary',
]
}
}

function ch16Sidebar() {
return {
title: "Qt C++",
path: '/ch16-qtcpp/qtcpp',
collapsable: false,
children: [
'/ch16-qtcpp/qtcpp',
'/ch16-qtcpp/boilerplate',
'/ch16-qtcpp/qobject',
'/ch16-qtcpp/build-system',
'/ch16-qtcpp/common-classes',
'/ch16-qtcpp/cpp-models',
]
}
}

function ch15Sidebar() {
return {
title: "Javascript",
path: '/ch15-javascript/javascript',
collapsable: false,
children: [
'/ch15-javascript/javascript',
'/ch15-javascript/html-qml',
'/ch15-javascript/js-language',
'/ch15-javascript/js-objects',
'/ch15-javascript/js-console',
]
}
}

function ch14Sidebar() {
return {
title: "Dynamic QML",
path: '/ch14-dynamicqml/dynamic-qml',
collapsable: false,
children: [
'/ch14-dynamicqml/dynamic-qml',
'/ch14-dynamicqml/loading-components',
'/ch14-dynamicqml/dynamic-objects',
'/ch14-dynamicqml/tracking-objects',
'/ch14-dynamicqml/summary',
]
}
}

function ch13Sidebar() {
return {
title: "Storage",
path: '/ch13-storage/storage',
collapsable: false,
children: [
'/ch13-storage/storage',
'/ch13-storage/settings',
'/ch13-storage/local-storage',
'/ch13-storage/other-storage',
]
}
}

function ch12Sidebar() {
return {
title: "Networking",
path: '/ch12-networking/networking',
collapsable: false,
children: [
'/ch12-networking/networking',
'/ch12-networking/serve-qml',
'/ch12-networking/templates',
'/ch12-networking/http-requests',
'/ch12-networking/local-files',
'/ch12-networking/rest-api',
'/ch12-networking/authentication',
'/ch12-networking/web-sockets',
'/ch12-networking/summary',
]
}
}

function ch11Sidebar() {
return {
title: "Multimedia",
path: '/ch11-multimedia/multimedia',
collapsable: false,
children: [
'/ch11-multimedia/multimedia',
'/ch11-multimedia/playing-media',
'/ch11-multimedia/sound-effects',
'/ch11-multimedia/video-streams',
'/ch11-multimedia/capturing-images',
'/ch11-multimedia/advanced',
'/ch11-multimedia/summary',
]
}
}

function ch10Sidebar() {
return {
title: "OpenGL Shaders",
path: '/ch10-shaders/shader-effects',
collapsable: false,
children: [
'/ch10-shaders/shader-effects',
'/ch10-shaders/opengl-shaders',
'/ch10-shaders/shader-elements',
'/ch10-shaders/fragment-shaders',
'/ch10-shaders/wave-effect',
'/ch10-shaders/vertex-shader',
'/ch10-shaders/curtain-effect',
'/ch10-shaders/effect-library',
]
}
}

function ch09Sidebar() {
return {
title: "Particles",
path: '/ch09-particles/particle-simulation',
collapsable: false,
children: [
'/ch09-particles/particle-simulation',
'/ch09-particles/concept',
'/ch09-particles/simple-simulation',
'/ch09-particles/particle-parameters',
'/ch09-particles/directed-particles',
'/ch09-particles/affecting-particles',
'/ch09-particles/particle-groups',
'/ch09-particles/summary',
]
}
}

function ch08Sidebar() {
return {
title: "Canvas",
path: '/ch08-canvas/canvas-element',
collapsable: false,
children: [
'/ch08-canvas/canvas-element',
'/ch08-canvas/convenience-api',
'/ch08-canvas/gradients',
'/ch08-canvas/shadows',
'/ch08-canvas/images',
'/ch08-canvas/transformation',
'/ch08-canvas/composition-modes',
'/ch08-canvas/pixel-buffer',
'/ch08-canvas/canvas-paint',
'/ch08-canvas/port-from-html',
]
}
}

function ch07Sidebar() {
return {
title: "Model View",
path: '/ch07-modelview/model-view',
collapsable: false,
children: [
'/ch07-modelview/model-view',
'/ch07-modelview/concept',
'/ch07-modelview/basic-models',
'/ch07-modelview/dynamic-views',
'/ch07-modelview/delegate',
'/ch07-modelview/advanced',
'/ch07-modelview/summary',
]
}
}

function ch06Sidebar() {
return {
title: "QtQuick Controls 2",
path: '/ch06-controls/controls2',
collapsable: false,
children: [
'/ch06-controls/controls2',
'/ch06-controls/introduction',
'/ch06-controls/image-viewer',
'/ch06-controls/common-patterns',
'/ch06-controls/imagine-style',
'/ch06-controls/summary',
]
}
}

function ch05Sidebar() {
return {
title: "Fluid Elements",
path: '/ch05-fluid/fluid-elements',
collapsable: false,
children: [
'/ch05-fluid/fluid-elements',
'/ch05-fluid/animations',
'/ch05-fluid/states-transitions',
'/ch05-fluid/advanced',
]
}
}

function ch04Sidebar() {
return {
title: "Quick Starter",
path: '/ch04-qmlstart/quick-start',
collapsable: false,
children: [
'/ch04-qmlstart/quick-start',
'/ch04-qmlstart/qml-syntax',
'/ch04-qmlstart/core-elements',
'/ch04-qmlstart/components',
'/ch04-qmlstart/transformations',
'/ch04-qmlstart/positioning',
'/ch04-qmlstart/layout',
'/ch04-qmlstart/input',
'/ch04-qmlstart/advanced',
]
}
}

function ch03Sidebar() {
return {
title: "Qt Creator IDE",
path: '/ch03-qtcreator/qt-creator',
collapsable: false,
children: [
'/ch03-qtcreator/qt-creator',
'/ch03-qtcreator/user-interface',
'/ch03-qtcreator/kit-registry',
'/ch03-qtcreator/projects',
'/ch03-qtcreator/editor',
'/ch03-qtcreator/locator',
'/ch03-qtcreator/debugging',
'/ch03-qtcreator/shortcuts',
]
}
}

function ch02Sidebar() {
return {
title: "Getting Started",
path: '/ch02-start/quick-start',
collapsable: false,
children: [
'/ch02-start/quick-start',
'/ch02-start/install',
'/ch02-start/hello-world',
'/ch02-start/app-types',
'/ch02-start/summary',
]
}
}

function ch01Sidebar() {
return {
title: "Meet Qt",
path: '/ch01-meetqt/meet-qt',
collapsable: false,
children: [
'/ch01-meetqt/meet-qt',
'/ch01-meetqt/qt5-blocks',
'/ch01-meetqt/qt5-intro',
]
}
}
Binary file added docs/ch01-meetqt/assets/background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/ch01_diragrams.graffle
Binary file not shown.
Binary file added docs/ch01-meetqt/assets/ch01_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/essential_modules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/pinwheel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/pole.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/qt-modules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/qt5_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/scene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/scene2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/showcase2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/showcase3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ch01-meetqt/assets/showcase4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/ch01-meetqt/meet-qt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Qt and QtQuick

This book provides you with a walk through of the different aspects of application development using Qt 5.12. It focuses on the new Qt Quick technology, but also provides necessary information about writing C++ back-ends and extension for Qt Quick.

This chapter provides a high-level overview of Qt 5. It shows the different application models available for developers, as well as a Qt 5 showcase application, as a sneak preview of things to come. Additionally, the chapter aims to provide a wide overview of the Qt 5 content and how to get in touch with the makers of Qt 5.


## History

Qt 4 has evolved since 2005 and provided a solid ground for thousands of applications and even full desktop and mobile systems. The usage patterns of computer users changed in the recent years. From stationary PCs towards portable notebook and nowadays mobile computers. The classical desktop is more and more replaced with mobile touch-based always connected screens. With it, the desktop UX paradigms also change. Whereas in the past Windows UI has dominated the world we spend more time nowadays on other screens with another UI language.

Qt 4 was designed to satisfy the desktop world to have a coherent set of UI widgets available on all major platforms. The challenge for Qt users has changed today and it lies more to provide a touch-based user interface for a customer-driven user interface and to enable modern user interface on all major desktop and mobile systems. Qt 4.7 started to introduce the Qt Quick technology which allows users to create a set of user interface components from simple elements to achieve a completely new UI, driven by customer demands.

## Qt 5 Focus

Qt 5 is a complete refreshing of the very successful Qt 4 release. With Qt 4.8, the Qt 4 release is almost 7 years old. It’s time to make an amazing toolkit even more amazing. Qt 5 is focused on the following:


* **Outstanding Graphics**: Qt Quick 2 is based on OpenGL (ES) using a scene graph implementation. The recomposed graphics stack allows a new level of graphics effects combined with an ease of use never seen before in this field.


* **Developer Productivity**: QML and JavaScript are the primary means for UI creation. The back-end will be driven by C++. The split between JavaScript and C++ allows a fast iteration for front-end developers concentrating on creating beautiful user interfaces and back-end C++ developers concentrating on stability, performance and extending the runtime.


* **Cross-platform portability**: With the consolidated Qt Platform Abstraction, it is now possible to port Qt to a wider range of platforms easier and faster. Qt 5 is structured around the concept of Qt Essentials and Add-ons, which allows OS developer to focus on the essentials modules and leads to a smaller runtime altogether.


* **Open Development**: Qt is now a truly open-governance project hosted at [qt.io](http://qt.io). The development is open and community driven.

Loading

0 comments on commit b72f0a3

Please sign in to comment.