Skip to content

Interface customization: menus and toolbars #10863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
selmaVH1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Interface customization: menus and toolbars #10863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/user_manual/introduction/img/customization.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 20 additions & 6 deletions docs/user_manual/introduction/qgis_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2406,11 +2406,10 @@ Customization
=============

The :guilabel:`Customization` dialog lets you (de)activate almost every element in the QGIS
user interface. This can be very useful if you want to provide your end-users with a
'light' version of QGIS, containing only the icons, menus or panels they need.
user interface, and create your own custom toolbars and menus. This can be very useful if you
want to provide your end-users with a 'light' version of QGIS, containing only the icons, menus
or panels they need, or a focused workspace built around a specific set of actions.

.. note::
Before your changes are applied, you need to restart QGIS.

.. _figure_customization:

Expand All @@ -2431,6 +2430,17 @@ The configurable item can be:
* a **Toolbar**: the whole bar or some of its icons
* or any **widget** from any dialog in QGIS: label, button, combobox...

In addition to showing or hiding existing interface elements, you can also create
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this block about adding new menu/toolbar should be one paragraph down. The |select| tool is about hiding/showing items in the dialog, i.e., still the same topic as above

user-defined toolbars and menus. To do so, select the :guilabel:`Menus` or
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we go with numbered list here, to clearly show the different steps and be more verbose when appropriate?

:guilabel:`Toolbars` item in the customization tree and click the |add| :sup:`Add a user defined menu or toolbar`
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also possible from a right-click --> Add user item. a probably more meaningful, contextual label would be better

button. To populate it with actions, open the action panel by clicking the
|listActions| button, search for the desired actions and drag and drop them onto
the user-defined menu or toolbar in the customization tree. Items within user-defined
toolbars and menus can be reordered using drag and drop.
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, I'm unable to reorder the items in a user-defined toolbar. The single option I have is to remove the item and drag it again, now to the expected place. Trying to select and drag a custom item simply selects adjacent items in the tree


To remove a user-defined toolbar or menu, select it and click the |deleteSelected|
:sup:`Delete selected item` button.
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:sup:`Delete selected item` button.
:sup:`Delete selected items` button.

Also accessible from right-click with cryptic "Delete user item"


With |select| :sup:`Switch to catching widgets in main application`, you
can click on an item in QGIS interface that you want to be hidden and
QGIS automatically unchecks the corresponding entry in the Customization dialog.
Expand All @@ -2439,10 +2449,10 @@ You can also use the :guilabel:`Search` box to find items by their name or label
Once you setup your configuration, click :guilabel:`Apply` or :guilabel:`OK` to validate your
changes. This configuration becomes the one used by default by QGIS at the next startup.
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can mention that "Reset" button undoes changes done in the dialog since the last saved/applied configuration.


The modifications can also be saved in a ``.ini`` file using |fileSave|
The modifications can also be saved in a ``.xml`` file using |fileSave|
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The modifications can also be saved in a ``.xml`` file using |fileSave|
The modifications can also be saved in a :file`.xml` file using |fileSave|

:sup:`Save To File` button. This is a handy way to share a common QGIS
interface among multiple users. Just click on |fileOpen| :sup:`Load from File`
from the destination computer in order to import the ``.ini`` file.
from the destination computer in order to import the ``.xml`` file.
Copy link
Copy Markdown
Collaborator

@DelazJ DelazJ Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
from the destination computer in order to import the ``.xml`` file.
from the destination computer in order to import the :file:`.xml` file.

You can also run :ref:`command line tools <custom_commandline>` and save various
setups for different use cases as well.

Expand Down Expand Up @@ -2923,6 +2933,8 @@ in the QGIS user profile.
:width: 1.5em
.. |action| image:: /static/common/action.png
:width: 2em
.. |add| image:: /static/common/mActionAdd.png
:width: 1.5em
.. |checkbox| image:: /static/common/checkbox.png
:width: 1.3em
.. |codeEditor| image:: /static/common/mIconCodeEditor.png
Expand Down Expand Up @@ -2967,6 +2979,8 @@ in the QGIS user profile.
:width: 1.5em
.. |keyboardShortcuts| image:: /static/common/mActionKeyboardShortcuts.png
:width: 1.5em
.. |listActions| image:: /static/common/mActionListActions.png
:width: 2.5em
.. |measure| image:: /static/common/mActionMeasure.png
:width: 1.5em
.. |measureBearing| image:: /static/common/mActionMeasureBearing.png
Expand Down
Binary file added static/common/mActionListActions.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions substitutions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,8 @@
:width: 2.5em
.. |linkQGisToGeoref| image:: /static/common/mActionLinkQGisToGeoref.png
:width: 2.5em
.. |listActions| image:: /static/common/mActionListActions.png
:width: 2.5em
.. |loadGCPpoints| image:: /static/common/mActionLoadGCPpoints.png
:width: 1.5em
.. |localCRS| replace:: ``WGS 84 / UTM 34S``
Expand Down
Loading