1
0
mirror of https://github.com/jaredtao/TaoQuick.git synced 2025-01-19 20:22:56 +08:00

change default language for README.md

This commit is contained in:
jared 2020-10-29 09:37:45 +08:00
parent c897a8b5be
commit 47ec10e1e5
3 changed files with 505 additions and 505 deletions

View File

@ -1,266 +0,0 @@
[简体中文](README.md)
-------------------------------------------------------------
# catalogue
- [catalogue](#catalogue)
- [TaoQuick](#taoquick)
- [Badge preview](#badge-preview)
- [Project](#project)
- [Build](#build)
- [Release](#release)
- [Repository status](#repository-status)
- [Issue](#issue)
- [Other status](#other-status)
- [Some Demo Preview](#some-demo-preview)
- [Main Page](#main-page)
- [Change Skin](#change-skin)
- [Multi-Language](#multi-language)
- [Some Button Controls](#some-button-controls)
- [Data entry Controls](#data-entry-controls)
- [Table Controls](#table-controls)
- [Rect Drag Controls](#rect-drag-controls)
- [Wizard](#wizard)
- [ShaderToy-Snail](#shadertoy-snail)
- [ShaderToy-SuperMario](#shadertoy-supermario)
- [Environment](#environment)
- [Project Struct](#project-struct)
- [TaoQuick Core Library](#taoquick-core-library)
- [Use TaoQuick](#use-taoquick)
- [Sponsorship](#sponsorship)
# TaoQuick
This is a QtQuick/Qml Component library, integrated some commonly used QtQuick components, and
make the appropriate function expansion to facilitate development of Qml applications.
## Badge preview
### Project
|[Best Practices plan][CII-link]|[License][license-link]|
|:--:|:--:|
|![CII-badge]|![license-badge]|
[license-link]: https://github.com/jaredtao/TaoQuick/blob/master/LICENSE "LICENSE"
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg "MIT"
[CII-badge]: https://bestpractices.coreinfrastructure.org/projects/3060/badge
[CII-link]: https://bestpractices.coreinfrastructure.org/projects/3060
### Build
| [Windows][win-link]| [Ubuntu][ubuntu-link]|[MacOS][macos-link]|[Android][android-link]|[IOS][ios-link]|
|---------------|---------------|-----------------|-----------------|----------------|
| ![win-badge] | ![ubuntu-badge] | ![macos-badge] |![android-badge] |![ios-badge] |
[win-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AWindows "WindowsAction"
[win-badge]: https://github.com/JaredTao/TaoQuick/workflows/Windows/badge.svg "Windows"
[ubuntu-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AUbuntu "UbuntuAction"
[ubuntu-badge]: https://github.com/JaredTao/TaoQuick/workflows/Ubuntu/badge.svg "Ubuntu"
[macos-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AMacOS "MacOSAction"
[macos-badge]: https://github.com/JaredTao/TaoQuick/workflows/MacOS/badge.svg "MacOS"
[android-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AAndroid "AndroidAction"
[android-badge]: https://github.com/JaredTao/TaoQuick/workflows/Android/badge.svg "Android"
[ios-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AIOS "IOSAction"
[ios-badge]: https://github.com/JaredTao/TaoQuick/workflows/IOS/badge.svg "IOS"
### Release
|[Released][release-link]|[Download][download-link]|Download count|
|:--:|:--:|:--:|
|![release-badge] |![download-badge]|![download-latest]|
[release-link]: https://github.com/jaredtao/TaoQuick/releases "Release status"
[release-badge]: https://img.shields.io/github/release/jaredtao/TaoQuick.svg?style=flat-square "Release status"
[download-link]: https://github.com/jaredtao/TaoQuick/releases/latest "Download status"
[download-badge]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/total.svg "Download status"
[download-latest]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/latest/total.svg "latest status"
### Repository status
|Tag|Languages|Top Language|code size|repo size|
|:--: |:--: |:--:|:--:|:--:|
|![tag-latest]|![languanges]|![taolanguage]|![code-size]|![repo-size]|
[languanges]: https://img.shields.io/github/languages/count/jaredtao/taoquick.svg "language count"
[taolanguage]: https://img.shields.io/github/languages/top/jaredtao/taoquick.svg "top language"
[code-size]: https://img.shields.io/github/languages/code-size/jaredtao/taoquick.svg "code size"
[repo-size]: https://img.shields.io/github/repo-size/jaredtao/taoquick.svg "repo-size"
[tag-latest]: https://img.shields.io/github/tag/jaredtao/taoquick.svg
### Issue
|[Issues][issues-link]|pull request|
|:--:|:--:|
|![issuse-badge]|![pull-request]|
[issues-link]: https://github.com/jaredtao/TaoQuick/issues
[issuse-badge]: https://img.shields.io/github/issues/jaredtao/taoquick.svg?style=popout
[issue-closed]: https://img.shields.io/github/issues-closed/jaredtao/taoquick.svg
[pull-request]: https://img.shields.io/github/issues-pr/jaredtao/taoquick.svg
[pull-closed]: https://img.shields.io/github/issues-pr-closed/jaredtao/taoquick.svg
### Other status
|commit freq|last commit|date|forks|stars|
|:--:|:--:|:--:|:--:|:--:|
|![commit-active]|![commit-latest]|![release-date]|![forks-badge]|![stars-badge]|
[forks-badge]: https://img.shields.io/github/forks/jaredtao/taoquick.svg "forks"
[stars-badge]: https://img.shields.io/github/stars/jaredtao/taoquick.svg "stars"
[commit-active]: https://img.shields.io/github/commit-activity/w/jaredtao/taoquick.svg
[commit-latest]: https://img.shields.io/github/last-commit/jaredtao/taoquick.svg
[release-date]: https://img.shields.io/github/release-date/jaredtao/taoquick.svg
## Some Demo Preview
### Main Page
![](preview/main-en.png)
### Change Skin
![](preview/skin-en.png)
### Multi-Language
![](preview/I18n-en.png)
### Some Button Controls
![](preview/Buttons-en.png)
### Data entry Controls
![](preview/Data-en.png)
### Table Controls
![](preview/Table-en.png)
### Rect Drag Controls
![](preview/rect-en.png)
### Wizard
![](preview/wizard-en.png)
![](preview/wizard.gif)
### ShaderToy-Snail
![](preview/snail.png)
### ShaderToy-SuperMario
![](preview/SuperMario.png)
## Environment
* Qt 5.9.0 or later
* compatibility Qt5.15、Qt6
## Project Struct
Project Struct as flow:
![](doc/struct1.png)
echo content as table
|Content|Reference|Remark|
|----|----|----|
|src|TaoQuick Core Library|some qml code, picture and scripts for support designer, not has c++ code|
|exampes|some demo|show how to use TaoQuick Core Library|
|3rdparty|thrid party library||
|mkspecs|qmake extern||
|.github|github-actions|CI CD|
## TaoQuick Core Library
Core Library source code path:
src/TaoQuick/imports/TaoQuick/Qml
Content:
![](doc/core.png)
To avoid confusion with Qt default components, TaoQuick components names all begin with Cus (The abbreviation of Custom)
CusConfig is global configuration, mainly contain font、 theme and so on, all components are displayed in this configuration
Other Contents reference to above table
|Content|Reference|Remark|
|----|----|----|
|Basic|Basic Controls| such as Text, ToolTip, It is used to unify the basic components in the whole project and facilitate the global replacement when the project becomes huge|
|CusBackground|A simple background box|it is usually placed at the beginning of the program to absorb mouse focus from the white space|
|CusButton|button|Some commonly used buttons have been encapsulated, and various effects can be customized again|
|CusCheckBox|CheckBox||
|CusComboBox|ComboBox||
|CusImage|Basic Image||
|CusInput|Input||
|CusLabel|Label||
|CusListView|List|Simaple custom scrollbars|
|CusPopup|Popup||
|CusScroll|ScrollBar||
|CusSlider|Slider||
|CusSpinBox|SpinBox||
|CusTable|Table|It needs to be used with specific C++ model to support the selection, check, draw rect selection, anti-selection, continuous selection and all selection|
|Effect|Effect|Animation、PageSwitch and ShaderToy|
|Misc|Others||
## Use TaoQuick
You just need import '.pri' file to project, TaoQuick will be use as local file or qrc resource.
Compared with 'Qml module' and 'Qml C++ plugin', this usage has the following advantages:
* After importing '.pri', no additional compile, generation of dll or plugin are required
* No additional copy resources are required to deployment the program
* After importing '.pri', Qt Creater can support TaoQuick Qml code highlighting and double-clicking the Follow symbol
* After import the module 'import TaoQuick 1.0' in Qml, you can use the TaoQuick component in The Designer mode of Qt Creater by dragging or visual property editor.(principle: Generate metainfo required by Designer via some script)
![](preview/designer.png)
detail use step
1. copy src/TaoQuick to your project, in any location
2. Import 'pri' files in the corresponding TaoQuick folder in your project 'pro' file
for eaxmple:
```qmake
include(TaoQuick/TaoQuick.pri)
```
or
```qmake
include(src/TaoQuick/imports/imports.pri)
```
***
## Sponsorship
If you feel the share content is good, treat the author a drink.
<img src="https://github.com/jaredtao/jaredtao.github.io/blob/master/img/weixin.jpg?raw=true" width="30%" height="30%" /><img src="https://github.com/jaredtao/jaredtao.github.io/blob/master/img/zhifubao.jpg?raw=true" width="30%" height="30%" />
it's WeChat Pay and Alipay

391
README-zh.md Normal file
View File

@ -0,0 +1,391 @@
[English](README.md)
[github原始仓库https://github.com/jaredtao/TaoQuick](https://github.com/jaredtao/TaoQuick)
[gitee镜像仓库https://gitee.com/jaredtao/TaoQuick](https://gitee.com/jaredtao/TaoQuick)
-------------------------------------------------------------
# 目录
- [目录](#目录)
- [TaoQuick](#taoquick)
- [徽章预览](#徽章预览)
- [项目](#项目)
- [编译](#编译)
- [发布](#发布)
- [仓库状态](#仓库状态)
- [Issue](#issue)
- [其它状态](#其它状态)
- [部分效果预览](#部分效果预览)
- [主页](#主页)
- [换皮肤](#换皮肤)
- [多语言](#多语言)
- [各种按钮组件](#各种按钮组件)
- [数据输入组件](#数据输入组件)
- [表格组件](#表格组件)
- [矩形框组件](#矩形框组件)
- [用户向导](#用户向导)
- [动画特效-箭头流动](#动画特效-箭头流动)
- [动画特效-跟上节奏](#动画特效-跟上节奏)
- [ShaderToy-蜗牛](#shadertoy-蜗牛)
- [ShaderToy-超级玛丽](#shadertoy-超级玛丽)
- [开发环境](#开发环境)
- [项目结构](#项目结构)
- [核心库 TaoQuick](#核心库-taoquick)
- [使用核心库TaoQuick](#使用核心库taoquick)
- [联系作者](#联系作者)
- [寻找同道中人](#寻找同道中人)
- [赞助](#赞助)
- [赞助列表](#赞助列表)
# TaoQuick
这是一个QtQuick/Qml组件库集成了常用的QtQuick组件并做了适当的属性封装、功能扩展以方便开发Qml程序。
实现原理可以参考《Qml组件化编程》《Qml特效》系列教程以下网站都有收录:
[涛哥的博客](https://jaredtao.github.io)
[涛哥的博客-国内镜像](https://jaredtao.gitee.io)
## 徽章预览
### 项目
|[最佳实践计划][CII-link]|[许可][license-link]|
|:--:|:--:|
|![CII-badge]|![license-badge]|
[CII-badge]: https://bestpractices.coreinfrastructure.org/projects/3060/badge
[CII-link]: https://bestpractices.coreinfrastructure.org/projects/3060
[license-link]: https://github.com/jaredtao/TaoQuick/blob/master/LICENSE "LICENSE"
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg "MIT"
### 编译
| [Windows][win-link]| [Ubuntu][ubuntu-link]|[MacOS][macos-link]|[Android][android-link]|[IOS][ios-link]|
|---------------|---------------|-----------------|-----------------|----------------|
| ![win-badge] | ![ubuntu-badge] | ![macos-badge] |![android-badge] |![ios-badge] |
[win-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AWindows "WindowsAction"
[win-badge]: https://github.com/JaredTao/TaoQuick/workflows/Windows/badge.svg "Windows"
[ubuntu-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AUbuntu "UbuntuAction"
[ubuntu-badge]: https://github.com/JaredTao/TaoQuick/workflows/Ubuntu/badge.svg "Ubuntu"
[macos-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AMacOS "MacOSAction"
[macos-badge]: https://github.com/JaredTao/TaoQuick/workflows/MacOS/badge.svg "MacOS"
[android-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AAndroid "AndroidAction"
[android-badge]: https://github.com/JaredTao/TaoQuick/workflows/Android/badge.svg "Android"
[ios-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AIOS "IOSAction"
[ios-badge]: https://github.com/JaredTao/TaoQuick/workflows/IOS/badge.svg "IOS"
### 发布
|[已发布][release-link]|[下载][download-link]|下载次数|
|:--:|:--:|:--:|
|![release-badge] |![download-badge]|![download-latest]|
[release-link]: https://github.com/jaredtao/TaoQuick/releases "Release status"
[release-badge]: https://img.shields.io/github/release/jaredtao/TaoQuick.svg?style=flat-square "Release status"
[download-link]: https://github.com/jaredtao/TaoQuick/releases/latest "Download status"
[download-badge]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/total.svg "Download status"
[download-latest]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/latest/total.svg "latest status"
### 仓库状态
|最新标签|用到的编程语言数量|用最多的编程语言|代码大小|仓库大小|
|:--: |:--: |:--:|:--:|:--:|
|![tag-latest]|![languanges]|![taolanguage]|![code-size]|![repo-size]|
[languanges]: https://img.shields.io/github/languages/count/jaredtao/taoquick.svg "language count"
[taolanguage]: https://img.shields.io/github/languages/top/jaredtao/taoquick.svg "top language"
[code-size]: https://img.shields.io/github/languages/code-size/jaredtao/taoquick.svg "code size"
[repo-size]: https://img.shields.io/github/repo-size/jaredtao/taoquick.svg "repo-size"
[tag-latest]: https://img.shields.io/github/tag/jaredtao/taoquick.svg
### Issue
|[Issues][issues-link]|关掉的issue|pull请求|关掉的pull|
|:--:|:--:|:--:|:--:|
|![issuse-badge]|![issue-closed]|![pull-request]|![pull-closed]|
[issues-link]: https://github.com/jaredtao/TaoQuick/issues
[issuse-badge]: https://img.shields.io/github/issues/jaredtao/taoquick.svg?style=popout
[issue-closed]: https://img.shields.io/github/issues-closed/jaredtao/taoquick.svg
[pull-request]: https://img.shields.io/github/issues-pr/jaredtao/taoquick.svg
[pull-closed]: https://img.shields.io/github/issues-pr-closed/jaredtao/taoquick.svg
### 其它状态
|提交频率|最后一次提交|发布时间|forks|stars|
|:--:|:--:|:--:|:--:|:--:|
|![commit-active]|![commit-latest]|![release-date]|![forks-badge]|![stars-badge]|
[forks-badge]: https://img.shields.io/github/forks/jaredtao/taoquick.svg "forks"
[stars-badge]: https://img.shields.io/github/stars/jaredtao/taoquick.svg "stars"
[commit-active]: https://img.shields.io/github/commit-activity/w/jaredtao/taoquick.svg
[commit-latest]: https://img.shields.io/github/last-commit/jaredtao/taoquick.svg
[release-date]: https://img.shields.io/github/release-date/jaredtao/taoquick.svg
## 部分效果预览
### 主页
![](preview/main.png)
### 换皮肤
![](preview/skin.png)
### 多语言
![](preview/I18n.png)
### 各种按钮组件
![](preview/Buttons.png)
### 数据输入组件
![](preview/Data.png)
### 表格组件
![](preview/Table.png)
### 矩形框组件
![](preview/rect.png)
### 用户向导
![](preview/wizard.png)
![](preview/wizard.gif)
### 动画特效-箭头流动
![](preview/Arrow.png)
### 动画特效-跟上节奏
![](preview/byte.png)
### ShaderToy-蜗牛
![](preview/snail.png)
### ShaderToy-超级玛丽
![](preview/SuperMario.png)
## 开发环境
* Qt 5.9.0 以上
* 已兼容Qt5.15、Qt6
## 项目结构
项目结构如下
![](doc/struct1.png)
各目录说明如下表:
|目录|说明|备注|
|----|----|----|
|src|TaoQuick核心库|主要是qml代码和图片资源,以及designer支持相关的配置和脚本,不包含c++代码|
|exampes|各种示例程序|演示如何使用TaoQuick核心库,其中TaoQuickShow比较全面地展示TaoQuick的各项功能|
|3rdparty|第三方库||
|mkspecs|qmake功能的扩展||
|.github|github-actions配置|持续集成相关配置,用于自动化构建、发布|
## 核心库 TaoQuick
核心库目录为
src/TaoQuick/imports/TaoQuick/Qml
核心库结构如下
![](doc/core.png)
为了避免与Qt默认组件混淆组件名称全部以Cus开头 (Custom的缩写)
CusConfig是核心库的全局配置,主要包括字体、颜色等,所有组件都按照此配置显示
其它各目录说明如下表:
|目录|说明|备注|
|----|----|----|
|Basic|基础的组件,诸如文本、悬浮提示等|用于统一整个工程中的基础组件,方便在工程变的庞大时,做全局替换|
|CusBackground|一个简单的背景框|一般放在程序的最开始,用来吸收空白区域的鼠标焦点|
|CusButton|按钮|已封装一部分经常用到的按钮,也可以二次定制各种效果|
|CusCheckBox|勾选||
|CusComboBox|下拉框||
|CusImage|基础的图像||
|CusInput|输入框||
|CusLabel|文本标签||
|CusListView|列表|简单的定制了滚动条|
|CusPopup|弹出框||
|CusScroll|滚动条||
|CusSlider|可拖动进度条||
|CusSpinBox|调节框||
|CusTable|表格|需要配合特定的C++ model使用,支持以行为单位的选中、打勾、鼠标框选、反选、连选、全选等|
|Effect|特效|动画、页面切换效果、ShaderToy等|
|Misc|其它杂项||
## 使用核心库TaoQuick
使用核心库,只需要在项目中导入'.pri'文件即可TaoQuick组件将以本地文件或qrc资源的方式被引用。
此种用法, 与Qml模块、Qml C++插件等方式相比,有以下优势:
* 导入pri后, 不需要额外编译、生成dll或插件
* 发布程序时不需要额外拷贝资源
* 导入pri后, Qt Creater即可支持TaoQuick的Qml代码高亮、双击跳转
* 导入pri后在Qml中导入模块(import TaoQuick 1.0),即可在Qt Creater 的 designer模式中通过拖拽使用TaoQuick组件、可视化开发UI (原理: 通过脚本生成designer需要的metainfo)
![](preview/designer.png)
具体使用步骤:
1. 将src/TaoQuick文件夹拷贝到你的项目中任意位置
2. 在你的项目pro文件中,导入对应的TaoQuick文件夹中的pri文件即可
```qmake
include(TaoQuick/TaoQuick.pri)
```
或者
```qmake
include(src/TaoQuick/imports/imports.pri)
```
都可以,只要路径对应到实际的文件即可
***
## 联系作者
作者:武威的涛哥
欢迎联系我,乐于提供技术咨询服务,可洽谈技术支持、商业合作。
微信: xsd2410421
QQ: 759378563
邮箱: jared2020@163.com
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/weixin_connect.jpg?raw=true" width="30.35%" height="30%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qq_connect.jpg?raw=true" width="28%" height="28%" />
*****
## 寻找同道中人
欢迎加入涛哥的QQ群: Qt进阶之路
此群是高质量群Qt界大佬众多不灌水闲聊日常交流技术、分享书籍、帮助解决实际问题。
1群734623697
2群342341405
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qqgroup.jpg?raw=true" width="28%" height="28%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qqgroup2.jpg?raw=true" width="28%" height="28%" />
******
## 赞助
觉得分享的内容还不错, 就请作者喝杯奶茶吧~~
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/weixin.jpg?raw=true" width="30%" height="30%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/zhifubao.jpg?raw=true" width="30%" height="30%" />
## 赞助列表
感谢以下网友的赞助与支持(排名不分先后)
hxhlb (花心胡萝卜工作室)
咸鱼猴
Qt侠-刘典武
一去、二三里
大樹
丝绸-郑天佐
寒山-居士
小风电子
Qt君
海盗船
雨田哥
游龙
Rj
重庆-胡某某
Ivy
孙十一少
田宇
power
敢敢
扣脚翁
白菜豆腐
甜不辣
Mr.Hu
秾芳教主
焖哥
蓝色幻想
Martin Zuo
windsmoon
小手冰凉
永远=没有终点
我是王大狗
米粒旅行
...

353
README.md
View File

@ -1,70 +1,54 @@
[English](README-en.md)
[github原始仓库https://github.com/jaredtao/TaoQuick](https://github.com/jaredtao/TaoQuick)
[gitee镜像仓库https://gitee.com/jaredtao/TaoQuick](https://gitee.com/jaredtao/TaoQuick)
[简体中文](README-zh.md)
-------------------------------------------------------------
# 目录
- [目录](#目录)
# catalogue
- [catalogue](#catalogue)
- [TaoQuick](#taoquick)
- [徽章预览](#徽章预览)
- [项目](#项目)
- [编译](#编译)
- [发布](#发布)
- [仓库状态](#仓库状态)
- [Badge preview](#badge-preview)
- [Project](#project)
- [Build](#build)
- [Release](#release)
- [Repository status](#repository-status)
- [Issue](#issue)
- [其它状态](#其它状态)
- [部分效果预览](#部分效果预览)
- [主页](#主页)
- [换皮肤](#换皮肤)
- [多语言](#多语言)
- [各种按钮组件](#各种按钮组件)
- [数据输入组件](#数据输入组件)
- [表格组件](#表格组件)
- [矩形框组件](#矩形框组件)
- [用户向导](#用户向导)
- [动画特效-箭头流动](#动画特效-箭头流动)
- [动画特效-跟上节奏](#动画特效-跟上节奏)
- [ShaderToy-蜗牛](#shadertoy-蜗牛)
- [ShaderToy-超级玛丽](#shadertoy-超级玛丽)
- [开发环境](#开发环境)
- [项目结构](#项目结构)
- [核心库 TaoQuick](#核心库-taoquick)
- [使用核心库TaoQuick](#使用核心库taoquick)
- [联系作者](#联系作者)
- [寻找同道中人](#寻找同道中人)
- [赞助](#赞助)
- [赞助列表](#赞助列表)
- [Other status](#other-status)
- [Some Demo Preview](#some-demo-preview)
- [Main Page](#main-page)
- [Change Skin](#change-skin)
- [Multi-Language](#multi-language)
- [Some Button Controls](#some-button-controls)
- [Data entry Controls](#data-entry-controls)
- [Table Controls](#table-controls)
- [Rect Drag Controls](#rect-drag-controls)
- [Wizard](#wizard)
- [ShaderToy-Snail](#shadertoy-snail)
- [ShaderToy-SuperMario](#shadertoy-supermario)
- [Environment](#environment)
- [Project Struct](#project-struct)
- [TaoQuick Core Library](#taoquick-core-library)
- [Use TaoQuick](#use-taoquick)
- [Sponsorship](#sponsorship)
# TaoQuick
这是一个QtQuick/Qml组件库集成了常用的QtQuick组件并做了适当的属性封装、功能扩展以方便开发Qml程序。
This is a QtQuick/Qml Component library, integrated some commonly used QtQuick components, and
实现原理可以参考《Qml组件化编程》《Qml特效》系列教程以下网站都有收录:
make the appropriate function expansion to facilitate development of Qml applications.
[涛哥的博客](https://jaredtao.github.io)
## Badge preview
[涛哥的博客-国内镜像](https://jaredtao.gitee.io)
### Project
## 徽章预览
### 项目
|[最佳实践计划][CII-link]|[许可][license-link]|
|[Best Practices plan][CII-link]|[License][license-link]|
|:--:|:--:|
|![CII-badge]|![license-badge]|
[license-link]: https://github.com/jaredtao/TaoQuick/blob/master/LICENSE "LICENSE"
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg "MIT"
[CII-badge]: https://bestpractices.coreinfrastructure.org/projects/3060/badge
[CII-link]: https://bestpractices.coreinfrastructure.org/projects/3060
[license-link]: https://github.com/jaredtao/TaoQuick/blob/master/LICENSE "LICENSE"
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg "MIT"
### 编译
### Build
| [Windows][win-link]| [Ubuntu][ubuntu-link]|[MacOS][macos-link]|[Android][android-link]|[IOS][ios-link]|
|---------------|---------------|-----------------|-----------------|----------------|
@ -86,9 +70,9 @@
[ios-link]: https://github.com/JaredTao/TaoQuick/actions?query=workflow%3AIOS "IOSAction"
[ios-badge]: https://github.com/JaredTao/TaoQuick/workflows/IOS/badge.svg "IOS"
### 发布
### Release
|[已发布][release-link]|[下载][download-link]|下载次数|
|[Released][release-link]|[Download][download-link]|Download count|
|:--:|:--:|:--:|
|![release-badge] |![download-badge]|![download-latest]|
@ -98,9 +82,9 @@
[download-badge]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/total.svg "Download status"
[download-latest]: https://img.shields.io/github/downloads/jaredtao/TaoQuick/latest/total.svg "latest status"
### 仓库状态
### Repository status
|最新标签|用到的编程语言数量|用最多的编程语言|代码大小|仓库大小|
|Tag|Languages|Top Language|code size|repo size|
|:--: |:--: |:--:|:--:|:--:|
|![tag-latest]|![languanges]|![taolanguage]|![code-size]|![repo-size]|
@ -111,9 +95,9 @@
[tag-latest]: https://img.shields.io/github/tag/jaredtao/taoquick.svg
### Issue
|[Issues][issues-link]|关掉的issue|pull请求|关掉的pull|
|:--:|:--:|:--:|:--:|
|![issuse-badge]|![issue-closed]|![pull-request]|![pull-closed]|
|[Issues][issues-link]|pull request|
|:--:|:--:|
|![issuse-badge]|![pull-request]|
[issues-link]: https://github.com/jaredtao/TaoQuick/issues
[issuse-badge]: https://img.shields.io/github/issues/jaredtao/taoquick.svg?style=popout
@ -121,9 +105,9 @@
[pull-request]: https://img.shields.io/github/issues-pr/jaredtao/taoquick.svg
[pull-closed]: https://img.shields.io/github/issues-pr-closed/jaredtao/taoquick.svg
### 其它状态
### Other status
|提交频率|最后一次提交|发布时间|forks|stars|
|commit freq|last commit|date|forks|stars|
|:--:|:--:|:--:|:--:|:--:|
|![commit-active]|![commit-latest]|![release-date]|![forks-badge]|![stars-badge]|
@ -134,258 +118,149 @@
[release-date]: https://img.shields.io/github/release-date/jaredtao/taoquick.svg
## 部分效果预览
## Some Demo Preview
### 主页
### Main Page
![](preview/main.png)
![](preview/main-en.png)
### 换皮肤
### Change Skin
![](preview/skin.png)
![](preview/skin-en.png)
### 多语言
### Multi-Language
![](preview/I18n.png)
![](preview/I18n-en.png)
### 各种按钮组件
### Some Button Controls
![](preview/Buttons.png)
![](preview/Buttons-en.png)
### 数据输入组件
### Data entry Controls
![](preview/Data.png)
![](preview/Data-en.png)
### 表格组件
### Table Controls
![](preview/Table.png)
![](preview/Table-en.png)
### 矩形框组件
### Rect Drag Controls
![](preview/rect.png)
![](preview/rect-en.png)
### 用户向导
### Wizard
![](preview/wizard.png)
![](preview/wizard-en.png)
![](preview/wizard.gif)
### 动画特效-箭头流动
![](preview/Arrow.png)
### 动画特效-跟上节奏
![](preview/byte.png)
### ShaderToy-蜗牛
### ShaderToy-Snail
![](preview/snail.png)
### ShaderToy-超级玛丽
### ShaderToy-SuperMario
![](preview/SuperMario.png)
## 开发环境
## Environment
* Qt 5.9.0 以上
* Qt 5.9.0 or later
* 已兼容Qt5.15、Qt6
* compatibility Qt5.15、Qt6
## 项目结构
## Project Struct
项目结构如下
Project Struct as flow:
![](doc/struct1.png)
各目录说明如下表:
|目录|说明|备注|
echo content as table
|Content|Reference|Remark|
|----|----|----|
|src|TaoQuick核心库|主要是qml代码和图片资源,以及designer支持相关的配置和脚本,不包含c++代码|
|exampes|各种示例程序|演示如何使用TaoQuick核心库,其中TaoQuickShow比较全面地展示TaoQuick的各项功能|
|3rdparty|第三方库||
|mkspecs|qmake功能的扩展||
|.github|github-actions配置|持续集成相关配置,用于自动化构建、发布|
|src|TaoQuick Core Library|some qml code, picture and scripts for support designer, not has c++ code|
|exampes|some demo|show how to use TaoQuick Core Library|
|3rdparty|thrid party library||
|mkspecs|qmake extern||
|.github|github-actions|CI CD|
## 核心库 TaoQuick
## TaoQuick Core Library
核心库目录为
Core Library source code path:
src/TaoQuick/imports/TaoQuick/Qml
核心库结构如下
Content:
![](doc/core.png)
为了避免与Qt默认组件混淆组件名称全部以Cus开头 (Custom的缩写)
To avoid confusion with Qt default components, TaoQuick components names all begin with Cus (The abbreviation of Custom)
CusConfig是核心库的全局配置,主要包括字体、颜色等,所有组件都按照此配置显示
CusConfig is global configuration, mainly contain font、 theme and so on, all components are displayed in this configuration
其它各目录说明如下表
Other Contents reference to above table
|目录|说明|备注|
|Content|Reference|Remark|
|----|----|----|
|Basic|基础的组件,诸如文本、悬浮提示等|用于统一整个工程中的基础组件,方便在工程变的庞大时,做全局替换|
|CusBackground|一个简单的背景框|一般放在程序的最开始,用来吸收空白区域的鼠标焦点|
|CusButton|按钮|已封装一部分经常用到的按钮,也可以二次定制各种效果|
|CusCheckBox|勾选||
|CusComboBox|下拉框||
|CusImage|基础的图像||
|CusInput|输入框||
|CusLabel|文本标签||
|CusListView|列表|简单的定制了滚动条|
|CusPopup|弹出框||
|CusScroll|滚动条||
|CusSlider|可拖动进度条||
|CusSpinBox|调节框||
|CusTable|表格|需要配合特定的C++ model使用,支持以行为单位的选中、打勾、鼠标框选、反选、连选、全选等|
|Effect|特效|动画、页面切换效果、ShaderToy等|
|Misc|其它杂项||
|Basic|Basic Controls| such as Text, ToolTip, It is used to unify the basic components in the whole project and facilitate the global replacement when the project becomes huge|
|CusBackground|A simple background box|it is usually placed at the beginning of the program to absorb mouse focus from the white space|
|CusButton|button|Some commonly used buttons have been encapsulated, and various effects can be customized again|
|CusCheckBox|CheckBox||
|CusComboBox|ComboBox||
|CusImage|Basic Image||
|CusInput|Input||
|CusLabel|Label||
|CusListView|List|Simaple custom scrollbars|
|CusPopup|Popup||
|CusScroll|ScrollBar||
|CusSlider|Slider||
|CusSpinBox|SpinBox||
|CusTable|Table|It needs to be used with specific C++ model to support the selection, check, draw rect selection, anti-selection, continuous selection and all selection|
|Effect|Effect|Animation、PageSwitch and ShaderToy|
|Misc|Others||
## 使用核心库TaoQuick
## Use TaoQuick
使用核心库,只需要在项目中导入'.pri'文件即可TaoQuick组件将以本地文件或qrc资源的方式被引用。
You just need import '.pri' file to project, TaoQuick will be use as local file or qrc resource.
此种用法, 与Qml模块、Qml C++插件等方式相比,有以下优势:
Compared with 'Qml module' and 'Qml C++ plugin', this usage has the following advantages:
* 导入pri后, 不需要额外编译、生成dll或插件
* After importing '.pri', no additional compile, generation of dll or plugin are required
* 发布程序时不需要额外拷贝资源
* No additional copy resources are required to deployment the program
* 导入pri后, Qt Creater即可支持TaoQuick的Qml代码高亮、双击跳转
* After importing '.pri', Qt Creater can support TaoQuick Qml code highlighting and double-clicking the Follow symbol
* 导入pri后在Qml中导入模块(import TaoQuick 1.0),即可在Qt Creater 的 designer模式中通过拖拽使用TaoQuick组件、可视化开发UI (原理: 通过脚本生成designer需要的metainfo)
* After import the module 'import TaoQuick 1.0' in Qml, you can use the TaoQuick component in The Designer mode of Qt Creater by dragging or visual property editor.(principle: Generate metainfo required by Designer via some script)
![](preview/designer.png)
具体使用步骤
detail use step
1. 将src/TaoQuick文件夹拷贝到你的项目中任意位置
1. copy src/TaoQuick to your project, in any location
2. 在你的项目pro文件中,导入对应的TaoQuick文件夹中的pri文件即可
2. Import 'pri' files in the corresponding TaoQuick folder in your project 'pro' file
for eaxmple:
```qmake
include(TaoQuick/TaoQuick.pri)
```
或者
or
```qmake
include(src/TaoQuick/imports/imports.pri)
```
都可以,只要路径对应到实际的文件即可
***
## 联系作者
作者:武威的涛哥
## Sponsorship
欢迎联系我,乐于提供技术咨询服务,可洽谈技术支持、商业合作。
If you feel the share content is good, treat the author a drink.
微信: xsd2410421
<img src="https://github.com/jaredtao/jaredtao.github.io/blob/master/img/weixin.jpg?raw=true" width="30%" height="30%" /><img src="https://github.com/jaredtao/jaredtao.github.io/blob/master/img/zhifubao.jpg?raw=true" width="30%" height="30%" />
QQ: 759378563
邮箱: jared2020@163.com
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/weixin_connect.jpg?raw=true" width="30.35%" height="30%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qq_connect.jpg?raw=true" width="28%" height="28%" />
*****
## 寻找同道中人
欢迎加入涛哥的QQ群: Qt进阶之路
此群是高质量群Qt界大佬众多不灌水闲聊日常交流技术、分享书籍、帮助解决实际问题。
1群734623697
2群342341405
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qqgroup.jpg?raw=true" width="28%" height="28%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/qqgroup2.jpg?raw=true" width="28%" height="28%" />
******
## 赞助
觉得分享的内容还不错, 就请作者喝杯奶茶吧~~
<img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/weixin.jpg?raw=true" width="30%" height="30%" /><img src="https://gitee.com/jaredtao/jaredtao/raw/master/img/zhifubao.jpg?raw=true" width="30%" height="30%" />
## 赞助列表
感谢以下网友的赞助与支持(排名不分先后)
hxhlb (花心胡萝卜工作室)
咸鱼猴
Qt侠-刘典武
一去、二三里
大樹
丝绸-郑天佐
寒山-居士
小风电子
Qt君
海盗船
雨田哥
游龙
Rj
重庆-胡某某
Ivy
孙十一少
田宇
power
敢敢
扣脚翁
白菜豆腐
甜不辣
Mr.Hu
秾芳教主
焖哥
蓝色幻想
Martin Zuo
windsmoon
小手冰凉
永远=没有终点
我是王大狗
米粒旅行
...
it's WeChat Pay and Alipay