Documentation/Nightly/Developers/Tutorials/QtDesigner - Revision history

Arankin at 01:12, 23 January 2018

2018-01-23T01:12:16Z

Arankin: Updating link to connection mode documentation for Qt

2018-01-23T01:11:41Z

Updating link to connection mode documentation for Qt

Finetjul: /* Qt Designer requirements */

2013-08-21T18:14:28Z

Qt Designer requirements

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:54:25Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Finetjul: /* Frequently Asked Questions */

2012-08-23T17:36:29Z

Frequently Asked Questions

JChris.FillionR: 4.1 -> Nightly

2012-08-22T17:04:27Z

4.1 -> Nightly

New page

=Using custom widgets in Qt Designer=
==Straight to the point==
*Windows
**Compile Slicer in Release mode OR build Qt in Debug
*All
<pre>
cd Slicer-build;
./Slicer --designer
</pre>

If the option <code>--designer</code> is not available, you should consider using QtCreator. See [[Documentation/{{documentation/version}}/Developers/Tutorials/QtCreator|here]] for more details.

==Qt Designer requirements==
In order to have the CTK and MRML widgets in Qt Designer, Qt Designer offers 2 options:
*the first (not detailed here) is to copy (or symlink) the CTK and MRML plugin libraries into %QT_DIR%/plugins/designer,
*the second is to set the environment variable <code>QT_PLUGIN_PATH</code> to the directory Slicer-build/bin containing the subdirectory designer with the plugin libraries. 

'''Note:''' Qt requires that the directory containing the designer plugins is named "designer".

Consider reading the [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/designer-manual.html Qt Designer documentation]

=== Windows notes ===
On Windows, Qt Designer can only load plugins that have been compiled in the same build mode than Qt Designer. For example, if Qt is built in Debug mode, the plugins must also be built in Debug mode to be loaded by Qt Designer. 
If Qt is configured to build in both debug and release modes, Qt Designer is built in release mode only. If that case, it is necessary to ensure that plugins are also built in release mode. Otherwise, you can open the solution file for Qt, and recompile Designer in debug mode.

==Running Qt Designer with the correct environment variables==
*On Windows, compile Slicer in the same build mode than Qt. If Qt is in Debug mode, compile Slicer in Debug mode, if it's in Release or Debug&Release mode, compile Slicer in Release mode.
*run Qt Designer via Slicer launcher located in Slicer-build.
{| style="border: 1px solid darkgray;"
!align=left style="border-bottom: 1px solid grey;"|Mac Os X
!align=left style="border-bottom: 1px solid grey;"|Linux
!align=left style="border-bottom: 1px solid grey;"|Windows
|-
|colspan="2"|
$ cd Slicer-build
$ ./Slicer --designer
|
> cd Slicer-build
> .\Slicer.exe --designer
|}
If the option <code>--designer</code> is not available, you should consider using QtCreator. See [[Documentation/{{documentation/version}}/Developers/Tutorials/QtCreator|here]] for more details.

{|
|[[Image:Screenshot-Qt Designer.png|thumb|300px|Qt Desginer loaded with CTKWidgets and qMRMLWidgets]]

|}

==Build Slicer==
* Once you are satisfied with UI, save the file, quit Designer and build Slicer to take the changes into account.
{| style="border: 1px solid darkgray;"
!align=left style="border-bottom: 1px solid grey;"|Mac Os X
!align=left style="border-bottom: 1px solid grey;"|Linux
!align=left style="border-bottom: 1px solid grey;"|Windows
|-
|colspan="2"|
$ make -j4
or just build the related project
$ make -j4 qSlicerMY_MODULE_NAMEModuleWidget
| Open the inner solution file ''...Slicer-Superbuild\Slicer-build\Slicer.sln'' and build the solution (F7) or build project <code>qSlicerMY_MODULE_NAMEModuleWidgets</code>
|}
It generates a ''ui_qSlicerMY_MODULE_NAMEModule.h'' file in ''...Slicer-Superbuild/Slicer-buildModules/Loadable/MY_MODULE_NAME/''.

That file is used by ''...Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAMEModuleWidget.cxx''.

Note: The <code>objectName</code>s of each widget in the UI correspond (see the Property editor) to the variable names in C++. From your code, you can access the widgets by their objectName.
* And launch Slicer to see the result
{| style="border: 1px solid darkgray;"
!align=left style="border-bottom: 1px solid grey;"|Mac Os X
!align=left style="border-bottom: 1px solid grey;"|Linux
!align=left style="border-bottom: 1px solid grey;"|Windows
|-
|colspan="2"|<pre>$ ./Slicer</pre>
| <pre>> .\Slicer.exe</pre>
|}
== Frequently Asked Questions ==
* My [http://slicer.org/doc/html/classqMRMLNodeComboBox.html qMRMLNodeComboBox] widget is always disabled (gray) in my module.
To be enabled, qMRMLNodeComboBox needs a MRML scene. You can set a MRML scene to the combobox programmatically or directly from Qt Designer. For the latter, you need to be in [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/designer-connection-mode.html Connection mode] and connect the signal [http://slicer.org/doc/html/classqSlicerWidget.html#a9c28318f7810ccce517ea7a1b0051da4 mrmlSceneChanged(vtkMRMLScene*)] of the module panel (of type [http://slicer.org/doc/html/classqSlicerWidget.html qSlicerWidget]) with the slot [http://slicer.org/doc/html/classqMRMLNodeComboBox.html#a2249be3ccec4783b592f738f1ef7bea3 setMRMLScene(vtkMRMLScene*)].

@@ Line 77: / Line 77: @@
 == Frequently Asked Questions ==
 * My [http://slicer.org/doc/html/classqMRMLNodeComboBox.html qMRMLNodeComboBox] widget is always disabled (gray) in my module.
-To be enabled, qMRMLNodeComboBox needs a MRML scene. You can set a MRML scene to the combobox programmatically or directly from Qt Designer. Doing it in Qt Designer is the recommended way, to do so you need to be in [http://doc.qt.io/archives/qt-4.8/designer-connection-mode.html Connection mode] and connect the signal [http://slicer.org/doc/html/classqSlicerWidget.html#a9c28318f7810ccce517ea7a1b0051da4 mrmlSceneChanged(vtkMRMLScene*)] of the module panel (of type [http://slicer.org/doc/html/classqSlicerWidget.html qSlicerWidget]) with the slot [http://slicer.org/doc/html/classqMRMLNodeComboBox.html#a2249be3ccec4783b592f738f1ef7bea3 setMRMLScene(vtkMRMLScene*)].
+To be enabled, qMRMLNodeComboBox needs a MRML scene. You can set a MRML scene to the combobox programmatically or directly from Qt Designer. Doing it in Qt Designer is the recommended way, to do so you need to be in [http://doc.qt.io/qt-5/designer-connection-mode.html Connection mode] and connect the signal [http://slicer.org/doc/html/classqSlicerWidget.html#a9c28318f7810ccce517ea7a1b0051da4 mrmlSceneChanged(vtkMRMLScene*)] of the module panel (of type [http://slicer.org/doc/html/classqSlicerWidget.html qSlicerWidget]) with the slot [http://slicer.org/doc/html/classqMRMLNodeComboBox.html#a2249be3ccec4783b592f738f1ef7bea3 setMRMLScene(vtkMRMLScene*)].
 The programmatic connection can be done in the <code>setup()</code> method of the module widget (or <code>init()</code> of the module widget pimpl):
   void qSlicerDataModuleWidget::setup()

@@ Line 77: / Line 77: @@
 == Frequently Asked Questions ==
 * My [http://slicer.org/doc/html/classqMRMLNodeComboBox.html qMRMLNodeComboBox] widget is always disabled (gray) in my module.
-To be enabled, qMRMLNodeComboBox needs a MRML scene. You can set a MRML scene to the combobox programmatically or directly from Qt Designer. Doing it in Qt Designer is the recommended way, to do so you need to be in [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/designer-connection-mode.html Connection mode] and connect the signal [http://slicer.org/doc/html/classqSlicerWidget.html#a9c28318f7810ccce517ea7a1b0051da4 mrmlSceneChanged(vtkMRMLScene*)] of the module panel (of type [http://slicer.org/doc/html/classqSlicerWidget.html qSlicerWidget]) with the slot [http://slicer.org/doc/html/classqMRMLNodeComboBox.html#a2249be3ccec4783b592f738f1ef7bea3 setMRMLScene(vtkMRMLScene*)].
+To be enabled, qMRMLNodeComboBox needs a MRML scene. You can set a MRML scene to the combobox programmatically or directly from Qt Designer. Doing it in Qt Designer is the recommended way, to do so you need to be in [http://doc.qt.io/archives/qt-4.8/designer-connection-mode.html Connection mode] and connect the signal [http://slicer.org/doc/html/classqSlicerWidget.html#a9c28318f7810ccce517ea7a1b0051da4 mrmlSceneChanged(vtkMRMLScene*)] of the module panel (of type [http://slicer.org/doc/html/classqSlicerWidget.html qSlicerWidget]) with the slot [http://slicer.org/doc/html/classqMRMLNodeComboBox.html#a2249be3ccec4783b592f738f1ef7bea3 setMRMLScene(vtkMRMLScene*)].
 The programmatic connection can be done in the <code>setup()</code> method of the module widget (or <code>init()</code> of the module widget pimpl):
   void qSlicerDataModuleWidget::setup()

← Older revision		Revision as of 07:54, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Using custom widgets in Qt Designer=		=Using custom widgets in Qt Designer=
	==Straight to the point==		==Straight to the point==

@@ Line 19: / Line 19: @@
 '''Note:''' Qt requires that the directory containing the designer plugins is named "designer".
-Consider reading the [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/designer-manual.html Qt Designer documentation]
+Consider reading the [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/designer-manual.html Qt Designer documentation].
 === Windows notes ===