forked from qt-creator/qt-creator
Add some documentation on action manager and commands
Change-Id: I03d8292120b30973155248471b12d1627536fb39 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
BIN
doc/qtcreatordev/images/actionmanager.png
Normal file
BIN
doc/qtcreatordev/images/actionmanager.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
854
doc/qtcreatordev/images/actionmanager.qmodel
Normal file
854
doc/qtcreatordev/images/actionmanager.qmodel
Normal file
@@ -0,0 +1,854 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<qmt>
|
||||
<project>
|
||||
<uid>{f7c67e69-57c5-4eb1-9303-f12bb2ae0a23}</uid>
|
||||
<root-package>
|
||||
<instance>
|
||||
<MPackage>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{9a360a3d-a5ff-4fa0-9a86-540d2cbdfa28}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>actionmanager</name>
|
||||
<children>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{6f6e0572-b8cc-4d97-95c5-edae83d0a3d2}</uid>
|
||||
<target>
|
||||
<instance type="MCanvasDiagram">
|
||||
<MCanvasDiagram>
|
||||
<base-MDiagram>
|
||||
<MDiagram>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{6f6e0572-b8cc-4d97-95c5-edae83d0a3d2}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>actionmanager</name>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
<elements>
|
||||
<qlist>
|
||||
<item>
|
||||
<instance type="DItem">
|
||||
<DItem>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{0a2e2d40-ad38-4b91-b9c1-6af2e3d2cf95}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</object>
|
||||
<name>ActionManager</name>
|
||||
<pos>x:300;y:90</pos>
|
||||
<rect>x:-50;y:-15;w:100;h:30</rect>
|
||||
<visual-role>0</visual-role>
|
||||
<visual-role2>1</visual-role2>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<shape-editable>false</shape-editable>
|
||||
</DItem>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DItem">
|
||||
<DItem>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{d918082a-dd32-48b8-bdcb-21ade3c1d067}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{a3950ef4-9fd9-466f-a575-dc75790749c3}</object>
|
||||
<name>QAction</name>
|
||||
<pos>x:125;y:340</pos>
|
||||
<rect>x:-30;y:-15;w:60;h:30</rect>
|
||||
<visual-role>0</visual-role>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<shape-editable>false</shape-editable>
|
||||
</DItem>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{d197d1e0-23ef-4041-845f-27c65fe11b70}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<text>Context</text>
|
||||
<pos>x:125;y:335</pos>
|
||||
<rect>x:-50;y:-40;w:100;h:80</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{613641ea-8fec-4b44-890b-8c6ea42eb9eb}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<text>Plugin</text>
|
||||
<pos>x:125;y:330</pos>
|
||||
<rect>x:-65;y:-70;w:130;h:140</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DItem">
|
||||
<DItem>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{c9758c28-e527-4f1b-b911-9c4f7571571c}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{ac06f227-7618-422e-a87e-5913950c91d7}</object>
|
||||
<name>QAction</name>
|
||||
<pos>x:275;y:340</pos>
|
||||
<rect>x:-30;y:-15;w:60;h:30</rect>
|
||||
<visual-role>0</visual-role>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<shape-editable>false</shape-editable>
|
||||
</DItem>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DItem">
|
||||
<DItem>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{d87082a8-6b2b-404f-abd3-9082585166f4}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{0cc14318-53df-4193-8aeb-0d29d4cd1561}</object>
|
||||
<name>QAction</name>
|
||||
<pos>x:405;y:340</pos>
|
||||
<rect>x:-30;y:-15;w:60;h:30</rect>
|
||||
<visual-role>0</visual-role>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<shape-editable>false</shape-editable>
|
||||
</DItem>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{168c5e3d-54bc-412c-9cb1-9b5481100f2b}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<text>Context</text>
|
||||
<pos>x:275;y:335</pos>
|
||||
<rect>x:-50;y:-40;w:100;h:80</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{3447fe60-8ac5-4fe9-b518-80daba7e960a}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<text>Context</text>
|
||||
<pos>x:405;y:335</pos>
|
||||
<rect>x:-50;y:-40;w:100;h:80</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{fcf93e87-8ce6-43ea-ab5e-7ca651d1f429}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<text>Plugin</text>
|
||||
<pos>x:340;y:335</pos>
|
||||
<rect>x:-135;y:-70;w:270;h:140</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DClass">
|
||||
<DClass>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{8df1e5cf-5e76-453a-ba69-0fcf31f46d4e}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{68e762c3-f1cc-479b-9700-bdb01f208340}</object>
|
||||
<name>Command</name>
|
||||
<pos>x:195;y:180</pos>
|
||||
<rect>x:-40;y:-35;w:80;h:70</rect>
|
||||
<visual-role>0</visual-role>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<show-all-members>true</show-all-members>
|
||||
</DClass>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DDependency">
|
||||
<DDependency>
|
||||
<base-DRelation>
|
||||
<DRelation>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{a4401c84-57c3-4f34-a88d-f35e28239944}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{42259fbc-5917-4caf-836e-0828a032d908}</object>
|
||||
<a>{0a2e2d40-ad38-4b91-b9c1-6af2e3d2cf95}</a>
|
||||
<b>{8df1e5cf-5e76-453a-ba69-0fcf31f46d4e}</b>
|
||||
</DRelation>
|
||||
</base-DRelation>
|
||||
</DDependency>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DClass">
|
||||
<DClass>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{7ff85acd-0d85-4fe2-8cc9-d0511f96443c}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{39911558-001e-4d0b-9827-d1d372049e86}</object>
|
||||
<name>Command</name>
|
||||
<pos>x:405;y:180</pos>
|
||||
<rect>x:-40;y:-35;w:80;h:70</rect>
|
||||
<visual-role>0</visual-role>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<show-all-members>true</show-all-members>
|
||||
</DClass>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DDependency">
|
||||
<DDependency>
|
||||
<base-DRelation>
|
||||
<DRelation>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{815d855b-8814-4ac7-8b75-17c3adb45344}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{fa3943f6-6bf7-4040-acae-d04c880fb329}</object>
|
||||
<a>{0a2e2d40-ad38-4b91-b9c1-6af2e3d2cf95}</a>
|
||||
<b>{7ff85acd-0d85-4fe2-8cc9-d0511f96443c}</b>
|
||||
</DRelation>
|
||||
</base-DRelation>
|
||||
</DDependency>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DDependency">
|
||||
<DDependency>
|
||||
<base-DRelation>
|
||||
<DRelation>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{f4567b84-e58c-4212-8d0b-c7040c00639a}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{8d18c30e-51c8-4fa2-ad22-ad6962273120}</object>
|
||||
<a>{8df1e5cf-5e76-453a-ba69-0fcf31f46d4e}</a>
|
||||
<b>{d918082a-dd32-48b8-bdcb-21ade3c1d067}</b>
|
||||
</DRelation>
|
||||
</base-DRelation>
|
||||
</DDependency>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DDependency">
|
||||
<DDependency>
|
||||
<base-DRelation>
|
||||
<DRelation>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{df1469a1-91d8-4c05-8b19-fddffbfc05d6}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{8d11e47d-b745-4bf4-b7d2-eb042c307ddf}</object>
|
||||
<a>{8df1e5cf-5e76-453a-ba69-0fcf31f46d4e}</a>
|
||||
<b>{c9758c28-e527-4f1b-b911-9c4f7571571c}</b>
|
||||
</DRelation>
|
||||
</base-DRelation>
|
||||
</DDependency>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DDependency">
|
||||
<DDependency>
|
||||
<base-DRelation>
|
||||
<DRelation>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{b6288087-3aca-4e28-988c-c11ca3def425}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{9f1e7858-c06c-4c7c-97d6-209d3c96360f}</object>
|
||||
<a>{7ff85acd-0d85-4fe2-8cc9-d0511f96443c}</a>
|
||||
<b>{d87082a8-6b2b-404f-abd3-9082585166f4}</b>
|
||||
</DRelation>
|
||||
</base-DRelation>
|
||||
</DDependency>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DItem">
|
||||
<DItem>
|
||||
<base-DObject>
|
||||
<DObject>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{ee71f328-354b-4993-8a63-8f4605285440}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<object>{158de17f-753a-4b00-8ddf-2f4432871d07}</object>
|
||||
<name>Menu</name>
|
||||
<pos>x:100;y:190</pos>
|
||||
<rect>x:-25;y:-15;w:50;h:30</rect>
|
||||
<visual-role>0</visual-role>
|
||||
<visual-role2>1</visual-role2>
|
||||
</DObject>
|
||||
</base-DObject>
|
||||
<shape-editable>false</shape-editable>
|
||||
</DItem>
|
||||
</instance>
|
||||
</item>
|
||||
<item>
|
||||
<instance type="DBoundary">
|
||||
<DBoundary>
|
||||
<base-DElement>
|
||||
<DElement>
|
||||
<uid>{5b8fc43d-fb36-4523-ac54-4262dc0affce}</uid>
|
||||
</DElement>
|
||||
</base-DElement>
|
||||
<pos>x:270;y:190</pos>
|
||||
<rect>x:-205;y:-20;w:410;h:40</rect>
|
||||
</DBoundary>
|
||||
</instance>
|
||||
</item>
|
||||
</qlist>
|
||||
</elements>
|
||||
<last-modified>1586427331500</last-modified>
|
||||
<toolbarid>General</toolbarid>
|
||||
</MDiagram>
|
||||
</base-MDiagram>
|
||||
</MCanvasDiagram>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>ActionManager</name>
|
||||
<relations>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{d5111c81-0745-4724-8d01-8ac36994e31c}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{d5111c81-0745-4724-8d01-8ac36994e31c}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</a>
|
||||
<b>{c2d3f5b7-87c5-4f67-9911-96a4a251ddd5}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{6308a511-1fd1-472d-bdc2-0bf173c6850c}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{6308a511-1fd1-472d-bdc2-0bf173c6850c}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</a>
|
||||
<b>{d6694b35-bb04-4830-9713-99470b22b7d7}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{42259fbc-5917-4caf-836e-0828a032d908}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{42259fbc-5917-4caf-836e-0828a032d908}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</a>
|
||||
<b>{68e762c3-f1cc-479b-9700-bdb01f208340}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{fa3943f6-6bf7-4040-acae-d04c880fb329}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{fa3943f6-6bf7-4040-acae-d04c880fb329}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{0fa7cf39-5531-4f41-9e2f-d890ef2a248d}</a>
|
||||
<b>{39911558-001e-4d0b-9827-d1d372049e86}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</relations>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{c2d3f5b7-87c5-4f67-9911-96a4a251ddd5}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{c2d3f5b7-87c5-4f67-9911-96a4a251ddd5}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>Command</name>
|
||||
<relations>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{e5b7a324-70ab-46b9-8d36-9f2ad6c0db57}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{e5b7a324-70ab-46b9-8d36-9f2ad6c0db57}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{c2d3f5b7-87c5-4f67-9911-96a4a251ddd5}</a>
|
||||
<b>{a3950ef4-9fd9-466f-a575-dc75790749c3}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{703dd2bc-f99c-41b7-8f90-a7292645feb8}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{703dd2bc-f99c-41b7-8f90-a7292645feb8}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{c2d3f5b7-87c5-4f67-9911-96a4a251ddd5}</a>
|
||||
<b>{ac06f227-7618-422e-a87e-5913950c91d7}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</relations>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{d6694b35-bb04-4830-9713-99470b22b7d7}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{d6694b35-bb04-4830-9713-99470b22b7d7}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>Command</name>
|
||||
<relations>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{4dc1c5bd-a124-4961-ad65-476e66cb6efe}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{4dc1c5bd-a124-4961-ad65-476e66cb6efe}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{d6694b35-bb04-4830-9713-99470b22b7d7}</a>
|
||||
<b>{0cc14318-53df-4193-8aeb-0d29d4cd1561}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</relations>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{a3950ef4-9fd9-466f-a575-dc75790749c3}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{a3950ef4-9fd9-466f-a575-dc75790749c3}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>QAction</name>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{ac06f227-7618-422e-a87e-5913950c91d7}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{ac06f227-7618-422e-a87e-5913950c91d7}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>QAction</name>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{0cc14318-53df-4193-8aeb-0d29d4cd1561}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{0cc14318-53df-4193-8aeb-0d29d4cd1561}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>QAction</name>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{68e762c3-f1cc-479b-9700-bdb01f208340}</uid>
|
||||
<target>
|
||||
<instance type="MClass">
|
||||
<MClass>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{68e762c3-f1cc-479b-9700-bdb01f208340}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>Command</name>
|
||||
<relations>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{8d18c30e-51c8-4fa2-ad22-ad6962273120}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{8d18c30e-51c8-4fa2-ad22-ad6962273120}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{68e762c3-f1cc-479b-9700-bdb01f208340}</a>
|
||||
<b>{a3950ef4-9fd9-466f-a575-dc75790749c3}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{8d11e47d-b745-4bf4-b7d2-eb042c307ddf}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{8d11e47d-b745-4bf4-b7d2-eb042c307ddf}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{68e762c3-f1cc-479b-9700-bdb01f208340}</a>
|
||||
<b>{ac06f227-7618-422e-a87e-5913950c91d7}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</relations>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
<members>
|
||||
<qlist>
|
||||
<item>
|
||||
<MClassMember>
|
||||
<uid>{5d8da03d-d556-4eed-ae0d-6d306453496e}</uid>
|
||||
<type>1</type>
|
||||
<declaration>QAction</declaration>
|
||||
</MClassMember>
|
||||
</item>
|
||||
</qlist>
|
||||
</members>
|
||||
</MClass>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{39911558-001e-4d0b-9827-d1d372049e86}</uid>
|
||||
<target>
|
||||
<instance type="MClass">
|
||||
<MClass>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{39911558-001e-4d0b-9827-d1d372049e86}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>Command</name>
|
||||
<relations>
|
||||
<handles>
|
||||
<handles>
|
||||
<qlist>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{9f1e7858-c06c-4c7c-97d6-209d3c96360f}</uid>
|
||||
<target>
|
||||
<instance type="MDependency">
|
||||
<MDependency>
|
||||
<base-MRelation>
|
||||
<MRelation>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{9f1e7858-c06c-4c7c-97d6-209d3c96360f}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<a>{39911558-001e-4d0b-9827-d1d372049e86}</a>
|
||||
<b>{0cc14318-53df-4193-8aeb-0d29d4cd1561}</b>
|
||||
</MRelation>
|
||||
</base-MRelation>
|
||||
</MDependency>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</relations>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
<members>
|
||||
<qlist>
|
||||
<item>
|
||||
<MClassMember>
|
||||
<uid>{2d428a77-4751-4fa7-bbb7-7f58995da129}</uid>
|
||||
<type>1</type>
|
||||
<declaration>QAction</declaration>
|
||||
</MClassMember>
|
||||
</item>
|
||||
</qlist>
|
||||
</members>
|
||||
</MClass>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
<item>
|
||||
<handle>
|
||||
<uid>{158de17f-753a-4b00-8ddf-2f4432871d07}</uid>
|
||||
<target>
|
||||
<instance type="MItem">
|
||||
<MItem>
|
||||
<base-MObject>
|
||||
<MObject>
|
||||
<base-MElement>
|
||||
<MElement>
|
||||
<uid>{158de17f-753a-4b00-8ddf-2f4432871d07}</uid>
|
||||
</MElement>
|
||||
</base-MElement>
|
||||
<name>Menu</name>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MItem>
|
||||
</instance>
|
||||
</target>
|
||||
</handle>
|
||||
</item>
|
||||
</qlist>
|
||||
</handles>
|
||||
</handles>
|
||||
</children>
|
||||
</MObject>
|
||||
</base-MObject>
|
||||
</MPackage>
|
||||
</instance>
|
||||
</root-package>
|
||||
</project>
|
||||
</qmt>
|
||||
193
doc/qtcreatordev/src/actionmanager.qdoc
Normal file
193
doc/qtcreatordev/src/actionmanager.qdoc
Normal file
@@ -0,0 +1,193 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2020 The Qt Company Ltd.
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** This file is part of the Qt Creator documentation.
|
||||
**
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and The Qt Company. For licensing terms
|
||||
** and conditions see https://www.qt.io/terms-conditions. For further
|
||||
** information use the contact form at https://www.qt.io/contact-us.
|
||||
**
|
||||
** GNU Free Documentation License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU Free
|
||||
** Documentation License version 1.3 as published by the Free Software
|
||||
** Foundation and appearing in the file included in the packaging of
|
||||
** this file. Please review the following information to ensure
|
||||
** the GNU Free Documentation License version 1.3 requirements
|
||||
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\page actionmanager.html
|
||||
\title The Action Manager and Commands
|
||||
|
||||
\QC provides a central options page for managing shortcuts for actions in
|
||||
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
|
||||
\uicontrol Keyboard. Plugins must tell \QC about the actions they provide,
|
||||
so they can appear in the options. Also some actions, like \uicontrol Edit >
|
||||
\uicontrol Undo, need to be dispatched to different plugins depending on the
|
||||
context which the user is currently in, for example a text editor, or
|
||||
a UI design component. The Core::ActionManager and Core::Command classes
|
||||
are used to manage this.
|
||||
|
||||
The action manager contains a list of Core::Command instances. Each command
|
||||
represents an entry in the keyboard shortcut settings.
|
||||
|
||||
A command also manages which actual QAction is currently represented by the
|
||||
command, depending on context. For this, a command has its own QAction which
|
||||
is accessible via Core::Command::action(), and should be used when adding
|
||||
the command to the UI like the menu and tool buttons. This QAction delegates
|
||||
its \c triggered() and \c toggled() signals to the currently active QAction.
|
||||
|
||||
\image actionmanager.png
|
||||
|
||||
\section1 Command
|
||||
|
||||
The class Core::Command represents an action with a shortcut that can be
|
||||
set by the user in the settings, and can be delegated to an actual
|
||||
QAction in a plugin, depending on context.
|
||||
|
||||
A command is referred to by its unique ID. Plugins use the ID when
|
||||
registering an action for the command in a specified context with
|
||||
Core::ActionManager::registerAction(). That method returns a Core::Command
|
||||
instance that is then used to further configure the action.
|
||||
If multiple QActions are registered for the same command (the same ID),
|
||||
they must be registered for different contexts.
|
||||
The ID is also used for grouping in the options page: everything up to the
|
||||
first dot in the ID is used as the category, under which to show the
|
||||
command.
|
||||
|
||||
By default, the options page shows the text of the currently active QAction
|
||||
in addition to the ID. If that does not fit the purpose well, you can set a
|
||||
different display text with Core::Command::setDescription().
|
||||
|
||||
Use the command's Core::Command::setDefaultKeySequence() method to set the
|
||||
default key sequence that is used if the user doesn't customize it.
|
||||
The shortcut on the QAction that you register with
|
||||
Core::ActionManager::registerAction() is never used, so do not set that.
|
||||
|
||||
Core::Command::action() returns the action that should be used for UI and
|
||||
user interaction. Add this to menus and tool buttons. You should never
|
||||
set properties like the enabled or visibility state on this QAction
|
||||
directly. It is managed by the action manager and reflects the state of the
|
||||
currently active QAction in some plugin.
|
||||
|
||||
The QAction that you registered in the action manager is for your internal
|
||||
purposes. Use that to connect your logic to the QAction::triggered()
|
||||
signal, and to set the enabled and visibility state.
|
||||
Core::Command::action() will reflect these changes, if your QAction is
|
||||
active, determined by the active context. For performance reasons the
|
||||
action text, tool tip and icon are not updated by default. They are only
|
||||
copied from the first QAction registered for the command. Set the
|
||||
corresponding Core::Command::CommandAttribute if you need dynamic updates
|
||||
of these properties.
|
||||
|
||||
\section1 Contexts
|
||||
|
||||
When plugins register a QAction for a command, they need to provide a
|
||||
Core::Context. Which of the registered QActions for a command is currently
|
||||
active is decided via an ordered list of current contexts.
|
||||
|
||||
Contexts are collected from multiple sources:
|
||||
|
||||
\list
|
||||
\li Global context. This is a context that is always active, with lowest
|
||||
priority order.
|
||||
\li Application focus. Instances of QWidget can be associated to a
|
||||
context via Core::IContext. All contexts from the current focus
|
||||
widget up the widget hierarchy are added to the current context.
|
||||
\li Manually managed contexts. Contexts can be added and removed
|
||||
manually via ICore::updateAdditionalContexts().
|
||||
\endlist
|
||||
|
||||
\section2 Using IContext
|
||||
|
||||
Core::IContext is a separate object that associates the QWidget from
|
||||
Core::IContext::widget() with the context Core::IContext::context().
|
||||
|
||||
To associate a widget with a context, create a Core::IContext instance,
|
||||
set the widget and context on it, and register it with
|
||||
Core::ICore::addContextObject(). Whenever your widget is in the parent
|
||||
chain of the application focus widget, the context that you specified
|
||||
will be active as well.
|
||||
|
||||
\code
|
||||
auto contextObj = new Core::IContext(this);
|
||||
contextObj->setWidget(myWidget);
|
||||
contextObj->setContext(myContext);
|
||||
Core::ICore::addContextObject(contextObj);
|
||||
\endcode
|
||||
|
||||
You also have to unregister the IContext object with
|
||||
Core::ICore::removeContextObject() when you do not need it anymore.
|
||||
|
||||
Some constructs in \QC automatically have an associated context, like
|
||||
Core::IEditor and Core::IMode.
|
||||
|
||||
\section2 Manually Managing Contexts
|
||||
|
||||
If you want a context to be active or inactive independently of the
|
||||
application focus, you can add and remove contexts manually with
|
||||
Core::ICore::updateAdditionalContexts(), Core::ICore::addAdditionalContext()
|
||||
and Core::ICore::removeAdditionalContext().
|
||||
Prefer Core::ICore::updateAdditionalContexts() if you need to remove and add
|
||||
contexts, to avoid overhead introduced by removing and adding contexts
|
||||
in separate calls.
|
||||
|
||||
\section1 Registering Actions
|
||||
|
||||
Prefer registering actions in your plugin's
|
||||
ExtensionSystem::IPlugin::initialize() method. This way any plugin depending
|
||||
on your plugin has access to these actions.
|
||||
|
||||
\code
|
||||
namespace Constants {
|
||||
const char ACTION_ID[] = "Example.Action";
|
||||
} // Constants
|
||||
|
||||
bool ExamplePlugin::initialize(const QStringList &arguments, QString *errorString)
|
||||
{
|
||||
// some other setup ...
|
||||
|
||||
QAction *action = new QAction(tr("Example Action"), this);
|
||||
Core::Command *cmd = Core::ActionManager::registerAction(action, Constants::ACTION_ID,
|
||||
Core::Context(Core::Constants::C_GLOBAL));
|
||||
cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Alt+Meta+A")));
|
||||
connect(action, &QAction::triggered, this, [this] {
|
||||
// do something
|
||||
});
|
||||
|
||||
// more setup ...
|
||||
|
||||
return true;
|
||||
}
|
||||
\endcode
|
||||
|
||||
This snippet sets up a sample action with the ID \c ACTION_ID that is always
|
||||
active (specified by the context \c {Core::Constants::C_GLOBAL}), and gives
|
||||
it the keyboard shortcut \c {Ctrl+Alt+Meta+A}. The \c {QAction *action}
|
||||
that is registered for the global context for the action is owned by the
|
||||
plugin. Connect to this QAction's triggered signal, and manage the action's
|
||||
state by calling the corresponding methods on this QAction instance.
|
||||
|
||||
\section1 Summary
|
||||
|
||||
\list
|
||||
\li Use Core::ActionManager::registerAction() to register your own
|
||||
QAction for a command with the specified ID.
|
||||
\li If multiple QActions are registered for the same command, they need
|
||||
to be registered for different contexts.
|
||||
\li Use Core::Command::setDefaultKeySequence(), do \e not use
|
||||
QAction::setShortcut().
|
||||
\li Use Core::Command::action() for user-facing purposes, such as
|
||||
menus and tool buttons.
|
||||
\li Use your own QAction to set properties like text and icon, and to
|
||||
connect your application logic.
|
||||
\endlist
|
||||
*/
|
||||
@@ -63,6 +63,7 @@
|
||||
|
||||
\list
|
||||
\li \l{The Plugin Manager, the Object Pool, and Registered Objects}
|
||||
\li \l{The Action Manager and Commands}
|
||||
\omit
|
||||
\li \l{Aggregations}
|
||||
\li \l{Extending and Providing Interfaces}
|
||||
|
||||
Reference in New Issue
Block a user