![83ddc2d562e39269378a504bf1ce1768.png](https://i-blog.csdnimg.cn/blog_migrate/f6a04dd0b24e17f655108d66ab1abe0a.jpeg)
授人以鱼,不如授人以渔。
我们不可能记住所有类的所有方法,甚至对一个类的所有方法也可能并不会全部记住。不过其实,也并没有必要记住,记住常用的方法就好,这样可以减轻自身负担。所以当我们碰到疑问比如某个类是否有某种方法,或者如何使用某个类的某种方法时,我们就需要去文档里查询。
Qt为我们提供了一个非常方便的文档查询助手——QtAssistant,现在就来学习如何使用。
13.1 下载pyqt5-tools
为了使用QtAssistant,我们必须先下载pyqt5-tools,即PyQt5的工具。
Windows上下载:
pip install pyqt5-tools
下载完毕后我们可以在pyqt5-tools的安装包中找到QtAssistant:
![ed49eda4f4f4a9ffd8e6be2039cd83c4.png](https://i-blog.csdnimg.cn/blog_migrate/c1da8471a26ac20b6a21b09580836078.jpeg)
双击打开后显示如下:
![43b2d2e2fdcbce39f5098e2b3becaf90.png](https://i-blog.csdnimg.cn/blog_migrate/1a182f3e07b53ea85a353e055a6cf34a.jpeg)
现在我们还不能查询任何内容,因为还没有导入文档。读者可以先前往以下链接去下载:
链接: https://pan.baidu.com/s/1wS_vHjKgVHY1KaTf6owDlg 提取码: wpe6
下载来之后我们将文件解压到和Qt Assistant相同的路径下:
![27d215c55d4741b95701680f16f90d1a.png](https://i-blog.csdnimg.cn/blog_migrate/e0b27be62fbafb9f775cec5a1038c249.jpeg)
接着点击Qt Assistant上的Edit->Preferences,弹出以下窗口:
![8980ea1abbbe75e6dd946dc6d32cb449.png](https://i-blog.csdnimg.cn/blog_migrate/3540705c2f620eadb9f89a9efa97e94a.jpeg)
点击Documentation标签页,再点击Add按钮:
![e21f66968da522a23cdfa514e32d0a30.png](https://i-blog.csdnimg.cn/blog_migrate/8bee1967d6f4fba9f64b0151548b5408.jpeg)
将我们刚才解压的Qt-5.9文件夹中所有以.qch结尾的文件添加进来即可:
![4cd63fe8ccef0c8b23758eb248776f88.png](https://i-blog.csdnimg.cn/blog_migrate/702dfb97b74ff2904b065a8d6d0a4f29.jpeg)
![eef2d40c33c8f8d70760c2b1a75375f1.png](https://i-blog.csdnimg.cn/blog_migrate/411281a6e02e71fb737c2478538c8f83.jpeg)
MacOS上下载:
由于目前pyqt5-tools不支持MacOS,所以我们必须去qt的官网下载Qt软件(其中附带QtAssistant):https://www.qt.io/download
进入后选择右边的open source(注意下载前必须先注册登录):
![a097405412e6ac61cd2899b13452b932.png](https://i-blog.csdnimg.cn/blog_migrate/0ec5b5311caa7276134ee96a52ed6cb0.jpeg)
下载完毕后进入安装程序:
![93553355e26fdbf36bdb8a3fc8d6a16b.png](https://i-blog.csdnimg.cn/blog_migrate/01c8918bf5272a0c0d1b20facf5841c1.jpeg)
点击下一步,这里有个登录步骤,可以直接skip掉:
![5d14a849f398b7ce789e82c1b1869a9e.png](https://i-blog.csdnimg.cn/blog_migrate/2fb309188a5689a56ee9166932ab5950.jpeg)
一直点继续,然后选择安装路径,选择完毕后点击继续:
![d0c161b77f659f01abe59c5092aafb08.png](https://i-blog.csdnimg.cn/blog_migrate/31fa7c2e402530d7b70e5ec0a99cceb8.jpeg)
接着选择需要下载的组件,如下图所示进行勾选:
![eda179af5d6f2b55a9f0c9c295a9faf0.png](https://i-blog.csdnimg.cn/blog_migrate/04e83c588bb98b54daf0526039ffdf51.jpeg)
![e7bc0998ae67d32269fcdf48ab9f236e.png](https://i-blog.csdnimg.cn/blog_migrate/c1eb4ecc81d08595ce201e9c3426debb.jpeg)
最后点击继续开始安装,安装完毕后我们可以在以下路径找到QtAssistant(以下为笔者自己的安装路径):
![73fc7d6032e009ca3cf35d92bb74a737.png](https://i-blog.csdnimg.cn/blog_migrate/a6fc59786f5916a5b540d824f67b0ac3.jpeg)
![7a01395fa95bf962d0b667d2d4302733.png](https://i-blog.csdnimg.cn/blog_migrate/c29b4e5351e53215b4ac3e4c71fead45.jpeg)
其他两个工具分别是Designer和Linguist,后续章节会涉及到。
Linux上下载:
目前不支持Linux系统,方法参考”MacOS上下载“,这里简单讲一下开头和结尾即可:
下载来的文件为:
![cc72186345e8deda1318bad92a9f1f7f.png](https://i-blog.csdnimg.cn/blog_migrate/2477de64e774a1387f491a42b9c187f8.png)
此时我们在该文件的相同目录下打开终端(或者你可以cd到目录都行),输入以下命令:
![72bc5626f719981239646161a7e5f7bc.png](https://i-blog.csdnimg.cn/blog_migrate/833812996ef24074721f023860d7c300.png)
然后就可以开始安装了:
![14885f34540b2518860625f9e2ac5ad7.png](https://i-blog.csdnimg.cn/blog_migrate/a789965900abb4d4a1a96b40ddf394e3.jpeg)
安装结束后,我们可以在相应的安装路径下找到QtAssistant,以下是笔者QtAssistant的路径:
![ac0f36bdbaa8a2518ad650be1fcd8b15.png](https://i-blog.csdnimg.cn/blog_migrate/13e11ea1c3f55eeb59210888deffe070.png)
接着我们在当前路径下打开终端,输入./assistant即可:
![f776eb0e3f56b92e18f76325bbd10ab6.png](https://i-blog.csdnimg.cn/blog_migrate/fd689b55ca3c7e224f756c986f08923d.jpeg)
13.2 开始使用QtAssistant
需要注意的一点是,Qt使用的语言为C++,所以文档内容也采用C++,尽管PyQt5使用Python,但目前没有内容采用Python的文档。不过就算不会C++也不要紧,因为用法都是类似的,所以我们还是可以使用该文档进行查询并找到想要的答案。
打开QtAssistant后按照下图步骤进行操作,先点击Index,然后在Look for框中搜索想要查询的类:
![a4bc2aa5aca15ffdeca2f1fe7da30ee0.png](https://i-blog.csdnimg.cn/blog_migrate/56d551dc2404bc17890e20fba8f38435.jpeg)
比方说我们想知道QLineEdit的用法,那么在搜索框中输入QLineEdit,选择第一个,然后右侧框就会显示出有关QLineEdit的所有内容:
![711b6dead7b470a80813b03988e047e8.png](https://i-blog.csdnimg.cn/blog_migrate/3176b66d2116ed3b89671718831440d7.jpeg)
1. 点击后我们可以知道该控件有什么信号了,我们平时经常用的为textChnaged信号:
![26148449cbc7d8feaec7ab23e2bc93f7.png](https://i-blog.csdnimg.cn/blog_migrate/f526392d21a0e15f1e5625f6b9d3ece2.jpeg)
再点击textChanged信号,我们可以找到它的详细解释:
![9f26b255cbc9b474f8f83d30af2ceab6.png](https://i-blog.csdnimg.cn/blog_migrate/61e71448df2e7b9033ca95cfc47a94fa.jpeg)
2. 点击Detailed Description,文档就会显示该控件的详细描述,这可以帮助我们在使用该控件前很好地理解它:
![ccc5e522ea2aa0435210eae6c7d6b741.png](https://i-blog.csdnimg.cn/blog_migrate/eb21b00066bdab4cb236c1046aae80fb.jpeg)
3. 我们可以知道QLineEdit的父类,即QWidget。
4. 点击后文档就会显示QLineEdit的所有方法,方法按字母进行排
![3ed4b9509d646f201ba56b78c9058a0f.png](https://i-blog.csdnimg.cn/blog_migrate/e5e67042ff027ad300e66c7f411f4e48.jpeg)
13.3 线上文档
更新:PyQt5官网的线上文档已经无法使用,可直接到Qt官网查阅文档:Qt文档地址
如果不用QtAssistant软件的话,我们也可以通过以下链接来进行文档查询:
http://pyqt.sourceforge.net/Docs/PyQt5/class_reference.html
![3afef611406993f7794c6805a16b37aa.png](https://i-blog.csdnimg.cn/blog_migrate/cd5bfc44bd74b147653d40ffdd1f205d.jpeg)
同样我们找到QLineEdit,点击后进入如下页面:
![b21c5359acb8f0997aaecce09fd05805.png](https://i-blog.csdnimg.cn/blog_migrate/3b13a48da7903595e4163443048ad80d.jpeg)
可以发现提供的还是C++文档(surprise~~~) ,点击后我们就会进入Qt的官网,页面显示的是QLineEdit有关的内容:
![57326bc294495faefffe595623b7554c.png](https://i-blog.csdnimg.cn/blog_migrate/44fd7035a503bb1e3aaf1b02b6f59eba.jpeg)
13.4 小结
1. 可以使用QtAssistant软件或者线上文档来查询某类的用法;
2. 文档使用C++,但其实类的用法还是相似的。