Where to find documentation on setting up preferences for a workbench.

[keithsloan52]

Where can I find documentation on setting up and using a preference dialog for a workbench.

Thanks

[yorik]

Quick headstart:

- You need to compile the Qt designer plugin that allows you to add preference settings with Qt Designer (only Qt4 I think) https://www.freecadweb.org/wiki/Compile ... ner_plugin
- Create a blank widget in Qt Designer (no buttons or anything)
- Design your preference page, any setting that must be saved (preferences) must be one if the Gui::Pref* widgets that were added by the plugin)
- In any of those, make sure you fill the PrefName (the name of your preference value) and PrefPath (ex: Mod/MyWorkbenchName), which will save your value under BaseApp/Preferences/Mod/MyWorkbebchName
- Save the ui file in your workbench, make sure it's handled by cmake
- In your workbench, for ex. inside the InitGui file, inside the Initialize method (but any other place works too), add: FreeCADGui.addPreferencePage("/path/to/myUiFile.ui","MyGroup"), "MyGroup" being one of the preferences groups on the left. FreeCAD will automatically look for a "preferences-mygroup.svg" file in its known locations (which you can extend with FreeCADGui.addIconPath())
- Make sure the addPreferencePage() method is called only once, otherwise your pref page will be added several times

[Kunda1]

#documentation

[keithsloan52]

Thanks @Yorik

I have tried to cheat as I don't really want to have to build a FreeCAD system and FreeCAD daily uses Qt5 and you mention Qt4.
Plus happy to hand edit the UI xml file. Plus confused when trying to use QtCreator

I tried coping the ui file from OpenSCAD to ~/FreeCAD_Python_GDML/Mod/Resources/ui and did the same add as OpenSCAD i.e.

Code: Select all

FreeCADGui.addPreferencePage(":/ui/openscadprefs-base.ui","OpenSCAD")

Also tried with

Code: Select all

FreeCADGui.addPreferencePage(FreeCAD.getResourceDir() + \
                "Mod/Resources/ui/GDML-base.ui","GDML")

But when I run I get

Code: Select all

UI file does not exist
Traceback (most recent call last):
  File "<string>", line 68, in Initialize

Why does my cheat not work?

[wandererfan]

I tried coping the ui file from OpenSCAD to ~/FreeCAD_Python_GDML/Mod/Resources/ui and did the same add as OpenSCAD i.e.

Code: Select all

FreeCADGui.addPreferencePage(":/ui/openscadprefs-base.ui","OpenSCAD")

Did you add an entry for xxx.ui to the qrc file in "FreeCAD_Python_GDML/Mod/Resources"? ":/ui/..." means look in the "compiled" resource file.

[keithsloan52]

Did you add an entry for xxx.ui to the qrc file in "FreeCAD_Python_GDML/Mod/Resources"? ":/ui/..." means look in the "compiled" resource file.

No, so I have now changed InitGui.py to

Code: Select all

FreeCADGui.addPreferencePage(FreeCAD.getResourceDir() + \
                    "Mod/Resources/ui/openscadprefs-base.ui","OpenSCAD")

But it still cannot find

[keithsloan52]

Okay I have setup the following in Resources/GDML.qrc

Code: Select all

<RCC>
    <qresource>
       <file>ui/openscadprefs-base.ui</file>
       <file>ui/GDML-base.ui</file>
    </qresource>
</RCC>

My InitGui.py has

Code: Select all

FreeCADGui.addPreferencePage(":/ui/openscadprefs-base.ui","OpenSCAD")

But still cannot find.

How does FreeCAD know to use GDML.qrc?

[wandererfan]

How does FreeCAD know to use GDML.qrc?

I knew I had written it down somewhere....

Preferences for Add-on Modules

[Kunda1]

Preferences for Add-on Modules

#documentation

[keithsloan52]

Okay trying to follow https://www.forum.freecadweb.org/viewto ... 22&t=30336

When it says "in the main *.py directory, run pyside-rcc -o myResources.py myqrc.qrc"

By main *.py directory does it mean the workbench's Mod directory where most of the ,py code is?
I default to looking at the OpenSCAD workbench as my goto for developing a workbench, it has the qrc
file in ~/FreeCAD_sf_master/src/Mod/OpenSCAD/Resources. Do the above instructions assume that the qrc
file is also in the Mod directory?

Thanks