wip

This allows code to link to subclasses of SideBarButton.

.cmake-format.py

@@ -0,0 +1,240 @@
+# ----------------------------------
+# Options affecting listfile parsing
+# ----------------------------------
+with section("parse"):
+
+    # Specify structure for custom cmake functions
+    additional_commands = {'foo': {'flags': ['BAR', 'BAZ'],
+                                   'kwargs': {'DEPENDS': '*', 'HEADERS': '*', 'SOURCES': '*'}}}
+
+    # Override configurations per-command where available
+    override_spec = {}
+
+    # Specify variable tags.
+    vartags = []
+
+    # Specify property tags.
+    proptags = []
+
+# -----------------------------
+# Options affecting formatting.
+# -----------------------------
+with section("format"):
+
+    # Disable formatting entirely, making cmake-format a no-op
+    disable = False
+
+    # How wide to allow formatted cmake files
+    line_width = 120
+
+    # How many spaces to tab for indent
+    tab_size = 4
+
+    # If true, lines are indented using tab characters (utf-8 0x09) instead of
+    # <tab_size> space characters (utf-8 0x20). In cases where the layout would
+    # require a fractional tab character, the behavior of the  fractional
+    # indentation is governed by <fractional_tab_policy>
+    use_tabchars = False
+
+    # If <use_tabchars> is True, then the value of this variable indicates how
+    # fractional indentions are handled during whitespace replacement. If set to
+    # 'use-space', fractional indentation is left as spaces (utf-8 0x20). If set
+    # to `round-up` fractional indentation is replaced with a single tab character
+    # (utf-8 0x09) effectively shifting the column to the next tabstop
+    fractional_tab_policy = 'use-space'
+
+    # If an argument group contains more than this many sub-groups (parg or kwarg
+    # groups) then force it to a vertical layout.
+    max_subgroups_hwrap = 2
+
+    # If a positional argument group contains more than this many arguments, then
+    # force it to a vertical layout.
+    max_pargs_hwrap = 6
+
+    # If a cmdline positional group consumes more than this many lines without
+    # nesting, then invalidate the layout (and nest)
+    max_rows_cmdline = 2
+
+    # If true, separate flow control names from their parentheses with a space
+    separate_ctrl_name_with_space = False
+
+    # If true, separate function names from parentheses with a space
+    separate_fn_name_with_space = False
+
+    # If a statement is wrapped to more than one line, than dangle the closing
+    # parenthesis on its own line.
+    dangle_parens = True
+
+    # If the trailing parenthesis must be 'dangled' on its on line, then align it
+    # to this reference: `prefix`: the start of the statement,  `prefix-indent`:
+    # the start of the statement, plus one indentation  level, `child`: align to
+    # the column of the arguments
+    dangle_align = 'prefix'
+
+    # If the statement spelling length (including space and parenthesis) is
+    # smaller than this amount, then force reject nested layouts.
+    min_prefix_chars = 4
+
+    # If the statement spelling length (including space and parenthesis) is larger
+    # than the tab width by more than this amount, then force reject un-nested
+    # layouts.
+    max_prefix_chars = 10
+
+    # If a candidate layout is wrapped horizontally but it exceeds this many
+    # lines, then reject the layout.
+    max_lines_hwrap = 2
+
+    # What style line endings to use in the output.
+    line_ending = 'unix'
+
+    # Format command names consistently as 'lower' or 'upper' case
+    command_case = 'lower'
+
+    # Format keywords consistently as 'lower' or 'upper' case
+    keyword_case = 'upper'
+
+    # A list of command names which should always be wrapped
+    always_wrap = []
+
+    # If true, the argument lists which are known to be sortable will be sorted
+    # lexicographicall
+    enable_sort = True
+
+    # If true, the parsers may infer whether or not an argument list is sortable
+    # (without annotation).
+    autosort = False
+
+    # By default, if cmake-format cannot successfully fit everything into the
+    # desired linewidth it will apply the last, most agressive attempt that it
+    # made. If this flag is True, however, cmake-format will print error, exit
+    # with non-zero status code, and write-out nothing
+    require_valid_layout = False
+
+    # A dictionary mapping layout nodes to a list of wrap decisions. See the
+    # documentation for more information.
+    layout_passes = {}
+
+# ------------------------------------------------
+# Options affecting comment reflow and formatting.
+# ------------------------------------------------
+with section("markup"):
+
+    # What character to use for bulleted lists
+    bullet_char = '*'
+
+    # What character to use as punctuation after numerals in an enumerated list
+    enum_char = '.'
+
+    # If comment markup is enabled, don't reflow the first comment block in each
+    # listfile. Use this to preserve formatting of your copyright/license
+    # statements.
+    first_comment_is_literal = False
+
+    # If comment markup is enabled, don't reflow any comment block which matches
+    # this (regex) pattern. Default is `None` (disabled).
+    literal_comment_pattern = None
+
+    # Regular expression to match preformat fences in comments default=
+    # ``r'^\s*([`~]{3}[`~]*)(.*)$'``
+    fence_pattern = '^\\s*([`~]{3}[`~]*)(.*)$'
+
+    # Regular expression to match rulers in comments default=
+    # ``r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'``
+    ruler_pattern = '^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$'
+
+    # If a comment line matches starts with this pattern then it is explicitly a
+    # trailing comment for the preceeding argument. Default is '#<'
+    explicit_trailing_pattern = '#<'
+
+    # If a comment line starts with at least this many consecutive hash
+    # characters, then don't lstrip() them off. This allows for lazy hash rulers
+    # where the first hash char is not separated by space
+    hashruler_min_length = 10
+
+    # If true, then insert a space between the first hash char and remaining hash
+    # chars in a hash ruler, and normalize its length to fill the column
+    canonicalize_hashrulers = True
+
+    # enable comment markup parsing and reflow
+    enable_markup = False
+
+# ----------------------------
+# Options affecting the linter
+# ----------------------------
+with section("lint"):
+
+    # a list of lint codes to disable
+    disabled_codes = []
+
+    # regular expression pattern describing valid function names
+    function_pattern = '[0-9a-z_]+'
+
+    # regular expression pattern describing valid macro names
+    macro_pattern = '[0-9a-z_]+'
+
+    # regular expression pattern describing valid names for variables with global
+    # (cache) scope
+    global_var_pattern = '[A-Z][0-9A-Z_]+'
+
+    # regular expression pattern describing valid names for variables with global
+    # scope (but internal semantic)
+    internal_var_pattern = '[A-Z][0-9A-Z_]+'
+
+    # regular expression pattern describing valid names for variables with local
+    # scope
+    local_var_pattern = '[_A-Za-z][A-Za-z0-9_]+'
+
+    # regular expression pattern describing valid names for privatedirectory
+    # variables
+    private_var_pattern = '[0-9a-z_]+'
+
+    # regular expression pattern describing valid names for public directory
+    # variables
+    public_var_pattern = '.*'
+
+    # regular expression pattern describing valid names for function/macro
+    # arguments and loop variables.
+    argument_var_pattern = '[a-z_][a-z0-9_]+'
+
+    # regular expression pattern describing valid names for keywords used in
+    # functions or macros
+    keyword_pattern = '[A-Z][0-9A-Z_]+'
+
+    # In the heuristic for C0201, how many conditionals to match within a loop in
+    # before considering the loop a parser.
+    max_conditionals_custom_parser = 2
+
+    # Require at least this many newlines between statements
+    min_statement_spacing = 1
+
+    # Require no more than this many newlines between statements
+    max_statement_spacing = 2
+    max_returns = 6
+    max_branches = 15
+    max_arguments = 10
+    max_localvars = 15
+    max_statements = 50
+
+# -------------------------------
+# Options affecting file encoding
+# -------------------------------
+with section("encode"):
+
+    # If true, emit the unicode byte-order mark (BOM) at the start of the file
+    emit_byteorder_mark = False
+
+    # Specify the encoding of the input file. Defaults to utf-8
+    input_encoding = 'utf-8'
+
+    # Specify the encoding of the output file. Defaults to utf-8. Note that cmake
+    # only claims to support utf-8 so be careful when using anything else
+    output_encoding = 'utf-8'
+
+# -------------------------------------
+# Miscellaneous configurations options.
+# -------------------------------------
+with section("misc"):
+
+    # A dictionary containing any per-command configuration overrides. Currently
+    # only `command_case` is supported.
+    per_command = {}

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
-skip = ./build-*,.git
+skip = ./build-*,.git,*.svg,rc_assets.py
 interactive = 3
 ignore-words-list = overlay,overlayed

.gitignore

@@ -47,6 +47,7 @@ mylayout.json
 *.cbp
 *.pyc
 /python/examples/rc_assets.py
+/python/examples-qt6/rc_assets.py
 *.pri
 /docks-w
 kddockwidgets_minimal_example
@@ -64,3 +65,5 @@ kddockwidgets_minimal_example
 *.sln
 *.dir
 .vscode
+/.cache
+/compile_commands.json

.krazy

@@ -8,6 +8,8 @@ EXTRA kdabcopyright-reuse,kdabcontactus,fosslicense-reuse
 
 #exclude checks now being done by clazy or clang-tools
 EXCLUDE strings,explicit,normalize,passbyvalue,operators,nullstrcompare,nullstrassign,doublequote_chars,qobject,sigsandslots,staticobjects,dpointer,inline,postfixop
+#exclude spelling as codespell is much, much better tool
+EXCLUDE spelling
 #exclude more checks
 EXCLUDE style
 
@@ -18,6 +20,6 @@ SKIP Doxyfile.cmake
 SKIP /KDDockWidgetsConfig.cmake.in
 #skip more files
 SKIP CMakePresets.json
+SKIP \.cmake-format\.py
 #skip the borrowed code in the cmake subdir
-SKIP /cmake/InstallLocation.cmake|/cmake/ECM/|/cmake/KDAB/
+SKIP /cmake/ECM/|/cmake/KDAB/
-

.mdlrc

@@ -0,0 +1 @@
+style ".mdlrc.rb"

.mdlrc.rb

@@ -0,0 +1,4 @@
+all
+rule 'MD013', :line_length => 100, :tables => false
+rule 'MD029', :style => :ordered
+exclude_rule 'MD033'

.pep8

@@ -0,0 +1,2 @@
+[pycodestyle]
+max_line_length = 120

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: ^(cmake/ECM|cmake/KDAB/)
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-yaml
+    args: [--allow-multiple-documents]
+  - id: check-json
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v14.0.0
+  hooks:
+  - id: clang-format
+    exclude: (.json)
+- repo: https://github.com/PyCQA/pylint
+  rev: v2.12.2
+  hooks:
+  - id: pylint
+    exclude: ^(.cmake-format.py|conan/conanfile.py)
+    additional_dependencies: ["PySide2", "PySide6"]
+- repo: https://github.com/pre-commit/mirrors-autopep8
+  rev: v1.6.0
+  hooks:
+  - id: autopep8
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+  - id: codespell
+- repo: https://github.com/cheshirekow/cmake-format-precommit
+  rev: v0.6.13
+  hooks:
+  - id: cmake-lint
+    exclude: (.py.cmake|Doxyfile.cmake)
+  - id: cmake-format
+    exclude: (.py.cmake|Doxyfile.cmake)
+- repo: https://github.com/markdownlint/markdownlint
+  rev: v0.11.0
+  hooks:
+  - id: markdownlint
+    entry: mdl
+    language: ruby
+    files: \.(md|mdown|markdown)$
+- repo: https://github.com/fsfe/reuse-tool
+  rev: v1.0.0
+  hooks:
+  - id: reuse

.pylintrc

@@ -0,0 +1,595 @@
+[MASTER]
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-whitelist=
+
+# Specify a score threshold to be exceeded before program exits with error.
+fail-under=10.0
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Add files or directories matching the regex patterns to the blacklist. The
+# regex matches against base names, not paths.
+ignore-patterns=rc_assets.py
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=1
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python module names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
+confidence=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=print-statement,
+        parameter-unpacking,
+        unpacking-in-except,
+        old-raise-syntax,
+        backtick,
+        long-suffix,
+        old-ne-operator,
+        old-octal-literal,
+        import-star-module-level,
+        non-ascii-bytes-literal,
+        raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead,
+        apply-builtin,
+        basestring-builtin,
+        buffer-builtin,
+        cmp-builtin,
+        coerce-builtin,
+        execfile-builtin,
+        file-builtin,
+        long-builtin,
+        raw_input-builtin,
+        reduce-builtin,
+        standarderror-builtin,
+        unicode-builtin,
+        xrange-builtin,
+        coerce-method,
+        delslice-method,
+        getslice-method,
+        setslice-method,
+        no-absolute-import,
+        old-division,
+        dict-iter-method,
+        dict-view-method,
+        next-method-called,
+        metaclass-assignment,
+        indexing-exception,
+        raising-string,
+        reload-builtin,
+        oct-method,
+        hex-method,
+        nonzero-method,
+        cmp-method,
+        input-builtin,
+        round-builtin,
+        intern-builtin,
+        unichr-builtin,
+        map-builtin-not-iterating,
+        zip-builtin-not-iterating,
+        range-builtin-not-iterating,
+        filter-builtin-not-iterating,
+        using-cmp-argument,
+        eq-without-hash,
+        div-method,
+        idiv-method,
+        rdiv-method,
+        exception-message-attribute,
+        invalid-str-codec,
+        sys-max-int,
+        bad-python3-import,
+        deprecated-string-function,
+        deprecated-str-translate-call,
+        deprecated-itertools-function,
+        deprecated-types-field,
+        next-method-defined,
+        dict-items-not-iterating,
+        dict-keys-not-iterating,
+        dict-values-not-iterating,
+        deprecated-operator-function,
+        deprecated-urllib-function,
+        xreadlines-attribute,
+        deprecated-sys-function,
+        exception-escape,
+        comprehension-escape,
+        consider-using-f-string,
+        R0801,I1101,E0401
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=c-extension-no-member=
+
+
+[REPORTS]
+
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'error', 'warning', 'refactor', and 'convention'
+# which contain the number of messages in each category, as well as 'statement'
+# which is the total number of statements analyzed. This score is used by the
+# global evaluation report (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+#msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Tells whether to display a full report or only the messages.
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=6
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+argument-naming-style=camelCase
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style.
+#argument-rgx=
+
+# Naming style matching correct attribute names.
+attr-naming-style=camelCase
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+          bar,
+          baz,
+          toto,
+          tutu,
+          tata
+
+# Bad variable names regexes, separated by a comma. If names match any regex,
+# they will always be refused
+bad-names-rgxs=
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style.
+#class-attribute-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=camelCase
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=camelCase
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=i,
+           j,
+           k,
+           ex,
+           Run,
+           _
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs=^[a-z]?$
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=any
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=any
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Naming style matching correct variable names.
+variable-naming-style=camelCase
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style.
+#variable-rgx="[a-z0-9_]{1,30}$"
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[LOGGING]
+
+# The type of string formatting that logging methods do. `old` means using %
+# formatting, `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+      XXX,
+      TODO
+
+# Regular expression of note tags to take in consideration.
+#notes-rgx=
+
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=yes
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: en_AG (hunspell), en_AU
+# (hunspell), en_BS (hunspell), en_BW (hunspell), en_BZ (hunspell), en_CA
+# (hunspell), en_DK (hunspell), en_GB (hunspell), en_GH (hunspell), en_HK
+# (hunspell), en_IE (hunspell), en_IN (hunspell), en_JM (hunspell), en_MW
+# (hunspell), en_NA (hunspell), en_NG (hunspell), en_NZ (hunspell), en_PH
+# (hunspell), en_SG (hunspell), en_TT (hunspell), en_US (hunspell), en_ZA
+# (hunspell), en_ZM (hunspell), en_ZW (hunspell).
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=no
+
+# This flag controls whether the implicit-str-concat should generate a warning
+# on implicit string concatenation in sequences defined over several lines.
+check-str-concat-over-line-jumps=no
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis). It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+          _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp,
+                      __post_init__
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+                  _fields,
+                  _replace,
+                  _source,
+                  _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=cls
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method.
+max-args=10
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement (see R0916).
+max-bool-expr=6
+
+# Maximum number of branch for function / method body.
+max-branches=15
+
+# Maximum number of locals for function / method body.
+max-locals=20
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[IMPORTS]
+
+# List of modules that can be imported at any level, not just the top level
+# one.
+allow-any-import-level=
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=optparse,tkinter.tix
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled).
+ext-import-graph=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled).
+import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "BaseException, Exception".
+overgeneral-exceptions=BaseException,
+                       Exception

.reuse/dep5

@@ -1,18 +1,29 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: KDDockWidgets
-Upstream-Contact:  <info@kdab.com>
+Upstream-Contact: <info@kdab.com>
 Source: https://www.github.com/KDAB/KDDockWidgets
 
-Files: *.qrc *.json *.xml *.html src/fwd_headers/*
+#misc source code
-Copyright: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+Files: *.qrc *.json *.xml src/fwd_headers/*
+Copyright: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 License: GPL-2.0-only OR GPL-3.0-only
 
+#misc documentation
+Files: CONTRIBUTORS.txt Changelog README.md README-QtQuick.md README-WASM.md README-Wayland.md README-bindings.md README-troubleshooting conan/README.txt python/examples/README.txt python/examples-qt6/README.txt docs/KDDockWidgets-CopyrightAssignmentForm.pdf *.html
+Copyright: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+License: GPL-2.0-only OR GPL-3.0-only
+
+#misc config files
+Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format .clang-format .clazy .gitignore .mdlrc .mdlrc.rb .pep8 .pylintrc appveyor.yml code.dev-*.code-workspace docs/api/Doxyfile.cmake distro/*
+Copyright: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+License: BSD-3-Clause
+
 #artwork
 Files: screencap.gif images/* src/img/* docs/api/*.png examples/dockwidgets/assets/*.png src/img/classic_indicators/*.png
-Copyright: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+Copyright: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 License: GPL-2.0-only OR GPL-3.0-only
 
 #3rdparty
 Files: cmake/ECM/modules/*
-Copyright:
+Copyright: The KDE Project
 License: BSD-3-Clause

.travis.yml

@@ -1,66 +0,0 @@
-env:
-  global:
-    - secure: "NlWO/NTPlOU6cowOMuPOvjAprXVwIjmpHHf9CoMR71E2c/eBFFKIHj10kXuyFwz2KihHAIExmo9OlGtGniNWobvIrVrabO3dsOSb6UGbPAQkzQiyQLKsDNQAZx3nMuWEKBtMsVRee6rd7/2uGTY4WB5Ot3VhrUYcN1FoRgQQ9gk="
-
-branches:
-  only:
-    - master
-
-matrix:
-  include:
-    - os: linux
-      dist: bionic
-    - os: osx
-      osx_image: xcode11.5
-      env:
-        - QT_SELECT=qt5
-        - CMAKE_PREFIX_PATH=/usr/local/opt/qt
-
-language: cpp
-compiler:
-  - gcc
-  - clang
-
-script:
-  - mkdir build
-  - cd build
-  - cmake -DCMAKE_BUILD_TYPE=Release -DKDDockWidgets_TESTS=True -KDDockWidgets_EXAMPLES=True  -DKDDockWidgets_DEVELOPER_MODE=True ..
-  - make
-  - make test
-
-notifications:
-  email:
-    recipients:
-    - allen.winter@kdab.com
-    - sergio.martins@kdab.com
-    on_success:  never
-    on_failure: always
-
-dist: bionic
-addons:
-  apt:
-    update: true
-    packages:
-    - qt5-default
-    - qtbase5-dev
-    - qtbase5-dev-tools
-    - qtbase5-private-dev
-    - qttools5-dev
-    - qttools5-dev-tools
-    - qtdeclarative5-dev
-    - qtdeclarative5-dev-tools
-    - libqt5xmlpatterns5-dev
-    - libqt5xmlpatterns5
-    - qtxmlpatterns5-dev-tools
-    - libqt5x11extras5-dev
-  homebrew:
-    update: true
-    packages:
-    - qt5
-  coverity_scan:
-    project:
-      name: KDAB/KDDockWidgets
-    notification_email: allen.winter@kdab.com
-    build_command_prepend: cd build && cmake ..
-    build_command: make
-    branch_pattern: coverity_scan

CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -21,7 +21,7 @@
 #
 # -DKDDockWidgets_TESTS=[true|false]
 #  Build the test harness.
-#  Currently ignored unless you also set KDDockWidgets_DEVELOPER_MODE=True
+#  Currently ignored (except for Python bindings) unless KDDockWidgets_DEVELOPER_MODE=True.
 #  Default=false
 #
 # -DKDDockWidgets_EXAMPLES=[true|false]
@@ -72,28 +72,38 @@
 cmake_minimum_required(VERSION 3.7)
 
 # Allow using a non-KDAB install location.
-set(KDAB_INSTALL True CACHE INTERNAL "Install to default KDAB Location")
+set(KDAB_INSTALL
+    True
+    CACHE INTERNAL "Install to default KDAB Location"
+)
 if(DEFINED CMAKE_INSTALL_PREFIX)
-  if(NOT "${CMAKE_INSTALL_PREFIX}" STREQUAL "")
+    if(NOT "${CMAKE_INSTALL_PREFIX}" STREQUAL "")
-    set(KDAB_INSTALL False CACHE INTERNAL "Install to non-KDAB Location")
+        set(KDAB_INSTALL
-  endif()
+            False
+            CACHE INTERNAL "Install to non-KDAB Location"
+        )
+    endif()
 endif()
 
 if(${CMAKE_VERSION} VERSION_LESS "3.12.0")
-  project(KDDockWidgets LANGUAGES CXX)
+    project(KDDockWidgets LANGUAGES CXX)
 else()
-  project(KDDockWidgets
+    project(
-          DESCRIPTION "An advanced docking system for Qt"
+        KDDockWidgets
-          HOMEPAGE_URL "https://github.com/KDAB/KDDockWidgets"
+        DESCRIPTION "An advanced docking system for Qt"
-          LANGUAGES CXX)
+        HOMEPAGE_URL "https://github.com/KDAB/KDDockWidgets"
+        LANGUAGES CXX
+    )
 endif()
 
 set(${PROJECT_NAME}_VERSION_MAJOR 1)
-set(${PROJECT_NAME}_VERSION_MINOR 4)
+set(${PROJECT_NAME}_VERSION_MINOR 5)
-set(${PROJECT_NAME}_VERSION_PATCH 95)
+set(${PROJECT_NAME}_VERSION_PATCH 99)
-set(${PROJECT_NAME}_VERSION ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH})
+set(${PROJECT_NAME}_VERSION
+    ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH}
+)
 set(PROJECT_VERSION ${${PROJECT_NAME}_VERSION}) #PROJECT_VERSION is needed by some ECM modules
-set(${PROJECT_NAME}_SOVERSION "1.5")
+set(${PROJECT_NAME}_SOVERSION "1.6")
 
 include(FeatureSummary)
 
@@ -106,69 +116,80 @@ option(${PROJECT_NAME}_TESTS "Build the tests" OFF)
 option(${PROJECT_NAME}_EXAMPLES "Build the examples" ON)
 option(${PROJECT_NAME}_DOCS "Build the API documentation" OFF)
 option(${PROJECT_NAME}_WERROR "Use -Werror (will be true for developer-mode unconditionally)" OFF)
-option(${PROJECT_NAME}_X11EXTRAS "On Linux, link against QtX11Extras so we can detect if the compositor supports transparency. Not applicable to other platforms or Qt6." ON)
+option(${PROJECT_NAME}_X11EXTRAS
+       "Link with QtX11Extras to detect if the compositor supports transparency. Not applicable to non-Linux or Qt6."
+       ON
+)
+option(${PROJECT_NAME}_XLib "On Linux, link against XLib, for a more robust window z-order detection." OFF)
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/ECM/modules")
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/KDAB/modules")
 
 # Set a default build type if none was specified
 set(default_build_type "Release")
 if(EXISTS "${CMAKE_SOURCE_DIR}/.git" OR ${PROJECT_NAME}_DEVELOPER_MODE)
-  set(default_build_type "Debug")
+    set(default_build_type "Debug")
 endif()
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-  message(STATUS "Setting build type to ${default_build_type} as none was specified.")
+    message(STATUS "Setting build type to ${default_build_type} as none was specified.")
-  set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE STRING "Choose the type of build." FORCE)
+    set(CMAKE_BUILD_TYPE
-  # Set the possible values of build type for cmake-gui
+        "${default_build_type}"
-  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+        CACHE STRING "Choose the type of build." FORCE
+    )
+    # Set the possible values of build type for cmake-gui
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+endif()
+
+if(${PROJECT_NAME}_XLib)
+    add_definitions(-DKDDockWidgets_XLIB)
 endif()
 
 if(${PROJECT_NAME}_QT6)
-  set(Qt_VERSION_MAJOR 6)
+    set(Qt_VERSION_MAJOR 6)
-  set(QT_MIN_VERSION "6.0.0")
+    set(QT_MIN_VERSION "6.3.0")
-  find_package(Qt6Widgets ${QT_MIN_VERSION} REQUIRED)
+    set(${PROJECT_NAME}_LIBRARY_QTID "-qt6")
-  find_package(Qt6Test ${QT_MIN_VERSION} REQUIRED)
-  set(${PROJECT_NAME}_LIBRARY_QTID "-qt6")
 else()
-  set(Qt_VERSION_MAJOR 5)
+    set(Qt_VERSION_MAJOR 5)
-  set(QT_MIN_VERSION "5.12")
+    set(QT_MIN_VERSION "5.15")
-  find_package(Qt5Widgets ${QT_MIN_VERSION} REQUIRED)
+    set(${PROJECT_NAME}_LIBRARY_QTID "")
-  find_package(Qt5Test ${QT_MIN_VERSION} REQUIRED)
-  set(${PROJECT_NAME}_LIBRARY_QTID "")
 endif()
+find_package(Qt${Qt_VERSION_MAJOR} ${QT_MIN_VERSION} NO_MODULE REQUIRED COMPONENTS Widgets Test)
 include(KDQtInstallPaths) #to set QT_INSTALL_FOO variables
 
 set(${PROJECT_NAME}_DEPS "widgets")
 if(${PROJECT_NAME}_QTQUICK)
-  find_package(Qt${Qt_VERSION_MAJOR}Quick)
+    find_package(Qt${Qt_VERSION_MAJOR} NO_MODULE REQUIRED COMPONENTS Quick QuickControls2)
-  find_package(Qt${Qt_VERSION_MAJOR}QuickControls2)
+    add_definitions(-DKDDOCKWIDGETS_QTQUICK)
-  add_definitions(-DKDDOCKWIDGETS_QTQUICK)
+    set(${PROJECT_NAME}_DEPS "${${PROJECT_NAME}_DEPS} quick quickcontrols2")
-  set(${PROJECT_NAME}_DEPS "${${PROJECT_NAME}_DEPS} quick quickcontrols2")
 else()
-  add_definitions(-DKDDOCKWIDGETS_QTWIDGETS)
+    add_definitions(-DKDDOCKWIDGETS_QTWIDGETS)
 endif()
 
-if(NOT WIN32 AND NOT APPLE AND NOT EMSCRIPTEN AND NOT ${PROJECT_NAME}_QT6 AND ${PROJECT_NAME}_X11EXTRAS)
+if(NOT WIN32
-  set(${PROJECT_NAME}_DEPS "${${PROJECT_NAME}_DEPS} x11extras")
+   AND NOT APPLE
+   AND NOT EMSCRIPTEN
+   AND NOT ${PROJECT_NAME}_QT6
+   AND ${PROJECT_NAME}_X11EXTRAS
+)
+    set(${PROJECT_NAME}_DEPS "${${PROJECT_NAME}_DEPS} x11extras")
 endif()
 
 #Always build the test harness in developer-mode
 if(${PROJECT_NAME}_DEVELOPER_MODE)
-  set(${PROJECT_NAME}_TESTS ON)
+    set(${PROJECT_NAME}_TESTS ON)
-  set(${PROJECT_NAME}_WERROR ON)
+    set(${PROJECT_NAME}_WERROR ON)
-  include(ECMEnableSanitizers)
+    include(ECMEnableSanitizers)
 endif()
 
 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
-  set(IS_CLANG_BUILD TRUE)
+    set(IS_CLANG_BUILD TRUE)
 else()
-  set(IS_CLANG_BUILD FALSE)
+    set(IS_CLANG_BUILD FALSE)
 endif()
 
 if(${PROJECT_NAME}_QTQUICK)
-  set(CMAKE_CXX_STANDARD 17)
+    set(CMAKE_CXX_STANDARD 17)
-  set(CMAKE_CXX_STANDARD_REQUIRED ON)
+    set(CMAKE_CXX_STANDARD_REQUIRED ON)
 endif()
 
 set(CMAKE_AUTOMOC ON)
@@ -179,164 +200,196 @@ set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 set(CMAKE_VISIBILITY_INLINES_HIDDEN 1)
 
+# Sets compiler flags for the specified target, taking platform into consideration.
 macro(set_compiler_flags targetName)
-  if(${PROJECT_NAME}_DEVELOPER_MODE)
+    if(${PROJECT_NAME}_DEVELOPER_MODE)
-    target_compile_definitions(${targetName} PUBLIC DOCKS_DEVELOPER_MODE PRIVATE QT_FORCE_ASSERTS)
+        target_compile_definitions(
+            ${targetName}
+            PUBLIC DOCKS_DEVELOPER_MODE
+            PRIVATE QT_FORCE_ASSERTS
+        )
 
-    if(NOT MSVC)
+        if(NOT MSVC)
-      target_compile_options(${targetName} PRIVATE -Wall -Wextra)
+            target_compile_options(${targetName} PRIVATE -Wall -Wextra)
+        endif()
+
+        if(APPLE)
+            target_compile_options(${targetName} PRIVATE -Wweak-vtables)
+        endif()
     endif()
 
-    if(APPLE)
+    # Enable -Werror
-      target_compile_options(${targetName} PRIVATE -Wweak-vtables)
+    if(${PROJECT_NAME}_WERROR AND (NOT MSVC OR IS_CLANG_BUILD)) # clang-cl accepts these too
+        target_compile_options(${targetName} PRIVATE -Werror -Wundef -Wno-error=deprecated-declarations)
     endif()
-  endif()
-
-  # Enable -Werror
-  if(${PROJECT_NAME}_WERROR AND (NOT MSVC OR IS_CLANG_BUILD)) # clang-cl accepts these too
-    target_compile_options(${targetName} PRIVATE -Werror -Wundef -Wno-error=deprecated-declarations)
-  endif()
 endmacro()
 
-if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT APPLE) OR
+if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT APPLE)
-  (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE) OR
+   OR (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE)
-  (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" AND NOT WIN32))
+   OR (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" AND NOT WIN32)
-  # Linker warnings should be treated as errors
+)
-  set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_SHARED_LINKER_FLAGS}")
+    # Linker warnings should be treated as errors
-  set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_MODULE_LINKER_FLAGS}")
+    set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_SHARED_LINKER_FLAGS}")
+    set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_MODULE_LINKER_FLAGS}")
 
-  string(TOUPPER "CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE}" compileflags)
+    string(TOUPPER "CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE}" compileflags)
-  if("${CMAKE_CXX_FLAGS} ${${compileflags}}" MATCHES "-fsanitize")
+    if("${CMAKE_CXX_FLAGS} ${${compileflags}}" MATCHES "-fsanitize")
-      set(sanitizers_enabled TRUE)
+        set(sanitizers_enabled TRUE)
-  else()
+    else()
-      set(sanitizers_enabled FALSE)
+        set(sanitizers_enabled FALSE)
-  endif()
+    endif()
 
-  # cannot enable this for clang + sanitizers
+    if(APPLE OR LINUX)
-  if (NOT sanitizers_enabled OR NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+        # cannot enable this for clang + sanitizers
-      # Do not allow undefined symbols, even in non-symbolic shared libraries
+        if(NOT sanitizers_enabled OR NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-      set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_SHARED_LINKER_FLAGS}")
+            # Do not allow undefined symbols, even in non-symbolic shared libraries
-      set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_MODULE_LINKER_FLAGS}")
+            set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_SHARED_LINKER_FLAGS}")
-  endif()
+            set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_MODULE_LINKER_FLAGS}")
+        endif()
+    endif()
 endif()
 
 if(${PROJECT_NAME}_STATIC)
-  set(${PROJECT_NAME}_LIBRARY_MODE "STATIC")
+    set(${PROJECT_NAME}_LIBRARY_MODE "STATIC")
 else()
-  set(${PROJECT_NAME}_LIBRARY_MODE "SHARED")
+    set(${PROJECT_NAME}_LIBRARY_MODE "SHARED")
 endif()
 
 if(KDAB_INSTALL)
-  if(UNIX)
+    if(UNIX)
-    set(CMAKE_INSTALL_PREFIX "/usr/local/KDAB/${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}" CACHE INTERNAL "Install to default KDAB Location")
+        set(CMAKE_INSTALL_PREFIX
-  elseif(WIN32)
+            "/usr/local/KDAB/${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}"
-    set(CMAKE_INSTALL_PREFIX "C:\\KDAB\\${PROJECT_NAME}-$$VERSION" CACHE INTERNAL "Install to default KDAB Location")
+            CACHE INTERNAL "Install to default KDAB Location"
-  endif()
+        )
+    elseif(WIN32)
+        set(CMAKE_INSTALL_PREFIX
+            "C:\\KDAB\\${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}"
+            CACHE INTERNAL "Install to default KDAB Location"
+        )
+    endif()
 endif()
 
 # setup default install locations
-include(InstallLocation)
+include(KDInstallLocation)
 
 if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-  set(${PROJECT_NAME}_IS_ROOT_PROJECT TRUE)
+    set(${PROJECT_NAME}_IS_ROOT_PROJECT TRUE)
 
-  message(STATUS "Building ${PROJECT_NAME} ${${PROJECT_NAME}_VERSION} in ${CMAKE_BUILD_TYPE} mode. Installing to ${CMAKE_INSTALL_PREFIX}")
+    message(STATUS "Building ${PROJECT_NAME} ${${PROJECT_NAME}_VERSION} in ${CMAKE_BUILD_TYPE} mode. "
-
+                   "Installing to ${CMAKE_INSTALL_PREFIX}"
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
-  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
-  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
-
-  install(FILES LICENSE.txt README.md DESTINATION ${INSTALL_DOC_DIR})
-  install(DIRECTORY LICENSES DESTINATION ${INSTALL_DOC_DIR})
-
-  # Generate .pri file for qmake users
-  #TODO: ECM does not support Qt6 yet
-  if(Qt_VERSION_MAJOR EQUAL 5 AND
-    CMAKE_VERSION VERSION_GREATER "3.11.99" AND NOT CMAKE_CONFIGURATION_TYPES) # Not working with VS generator or older cmake versions
-    include(ECMGeneratePriFile)
-    set(PROJECT_VERSION_STRING ${${PROJECT_NAME}_VERSION})
-    ecm_generate_pri_file(BASE_NAME KDDockWidgets
-      LIB_NAME kddockwidgets
-      DEPS ${${PROJECT_NAME}_DEPS}
-      FILENAME_VAR pri_filename
-      INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
     )
-    install(FILES ${pri_filename} DESTINATION ${ECM_MKSPECS_INSTALL_DIR})
+
-  endif()
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
+    set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/lib")
+
+    install(FILES LICENSE.txt README.md DESTINATION ${INSTALL_DOC_DIR})
+    install(DIRECTORY LICENSES DESTINATION ${INSTALL_DOC_DIR})
+
+    # Generate .pri file for qmake users
+    # (except for older cmake versions and when using the VS generator)
+    if(CMAKE_VERSION VERSION_GREATER "3.11.99" AND NOT CMAKE_CONFIGURATION_TYPES)
+        include(ECMGeneratePriFile)
+        set(PROJECT_VERSION_STRING ${${PROJECT_NAME}_VERSION})
+        ecm_generate_pri_file(
+            BASE_NAME
+            KDDockWidgets
+            LIB_NAME
+            kddockwidgets${${PROJECT_NAME}_LIBRARY_QTID}
+            DEPS
+            ${${PROJECT_NAME}_DEPS}
+            FILENAME_VAR
+            pri_filename
+            INCLUDE_INSTALL_DIR
+            ${CMAKE_INSTALL_INCLUDEDIR}
+        )
+        install(FILES ${pri_filename} DESTINATION ${ECM_MKSPECS_INSTALL_DIR})
+    endif()
+else()
+    #Always disable tests, examples, docs when used as a submodule
+    set(${PROJECT_NAME}_IS_ROOT_PROJECT FALSE)
+    set(${PROJECT_NAME}_TESTS FALSE)
+    set(${PROJECT_NAME}_EXAMPLES FALSE)
+    set(${PROJECT_NAME}_DOCS FALSE)
+endif()
+
+if(${PROJECT_NAME}_TESTS)
+    enable_testing()
 endif()
 
 add_subdirectory(src)
 
-if(${PROJECT_NAME}_IS_ROOT_PROJECT)
+if(${PROJECT_NAME}_PYTHON_BINDINGS)
-  if(${PROJECT_NAME}_EXAMPLES)
+    if(CMAKE_BUILD_TYPE MATCHES "^[Dd]eb" OR ${PROJECT_NAME}_STATIC)
-    if(${PROJECT_NAME}_QTQUICK)
+        message(FATAL_ERROR "** Python Bindings are disabled in debug or static builds.")
-      add_subdirectory(examples/qtquick)
-    else()
-      add_subdirectory(examples/dockwidgets)
-      add_subdirectory(examples/minimal)
-      add_subdirectory(examples/minimal-mdi)
-      set_compiler_flags(kddockwidgets_example)
-      set_compiler_flags(kddockwidgets_minimal_example)
     endif()
-  endif()
+    if(CMAKE_UNITY_BUILD)
-
+        message(FATAL_ERROR "** Python Bindings are disabled in Unity builds. " "Try again with CMAKE_UNITY_BUILD=OFF")
-  if(${PROJECT_NAME}_DEVELOPER_MODE)
-
-    if(${PROJECT_NAME}_TESTS)
-      enable_testing()
-      add_subdirectory(tests)
-
-      # Require Qt5.15.1 or higher to run the tests_launcher tests on Mac
-      if(NOT APPLE OR Qt5Widgets_VERSION VERSION_GREATER 5.15.0)
-        # tst_docks.exe is pretty big (160 tests), so split it in more runs so we can use threads.
-        add_test(NAME tst_docks0 COMMAND tests_launcher 0 5)
-        add_test(NAME tst_docks1 COMMAND tests_launcher 1 5)
-        add_test(NAME tst_docks2 COMMAND tests_launcher 2 5)
-        add_test(NAME tst_docks3 COMMAND tests_launcher 3 5)
-        add_test(NAME tst_docks4 COMMAND tests_launcher 4 5)
-        add_test(NAME tst_docks5 COMMAND tests_launcher 5 5)
-        add_test(NAME tst_docks6 COMMAND tests_launcher 6 5)
-        add_test(NAME tst_docks7 COMMAND tests_launcher 7 5)
-        add_test(NAME tst_docks8 COMMAND tests_launcher 8 5)
-        add_test(NAME tst_docks9 COMMAND tests_launcher 9 5)
-        add_test(NAME tst_docks10 COMMAND tests_launcher 10 5)
-        add_test(NAME tst_docks11 COMMAND tests_launcher 10 5)
-        add_test(NAME tst_docks12 COMMAND tests_launcher 11 5)
-        add_test(NAME tst_docks13 COMMAND tests_launcher 12 5)
-        add_test(NAME tst_docks14 COMMAND tests_launcher 13 5)
-        add_test(NAME tst_docks15 COMMAND tests_launcher 14 5)
-        add_test(NAME tst_docks16 COMMAND tests_launcher 15 5)
-        add_test(NAME tst_docks17 COMMAND tests_launcher 16 5)
-        add_test(NAME tst_docks18 COMMAND tests_launcher 17 5)
-        add_test(NAME tst_docks19 COMMAND tests_launcher 18 5)
-        add_test(NAME tst_docks20 COMMAND tests_launcher 19 5)
-        add_test(NAME tst_docks21 COMMAND tests_launcher 20 5) # one more for rounding leftovers
-      endif()
-      if(NOT ${PROJECT_NAME}_QTQUICK)
-        # tst_multisplitter depends on QWidget
-        add_test(NAME tst_multisplitter COMMAND tst_multisplitter)
-      endif()
-
     endif()
-  endif()
+endif()
-
+if(${PROJECT_NAME}_PYTHON_BINDINGS)
-  if(${PROJECT_NAME}_DOCS)
+    add_subdirectory(python)
-    add_subdirectory(docs) # needs to go last, in case there are build source files
-  else()
-    add_custom_target(docs
-      COMMAND ${CMAKE_COMMAND} -E echo "Sorry, there is no docs target since KDDockWidgets_DOCS=OFF."
-      "Re-run cmake with the -DKDDockWidgets_DOCS=True option if you want to generate the documentation.")
-  endif()
-
-  # Add uninstall target
-  include(ECMUninstallTarget)
 endif()
 
-if(${PROJECT_NAME}_PYTHON_BINDINGS)
+if(${PROJECT_NAME}_EXAMPLES)
-  if(CMAKE_BUILD_TYPE MATCHES "^[Dd]eb" OR ${PROJECT_NAME}_STATIC)
+    if(${PROJECT_NAME}_QTQUICK)
-    message(FATAL_ERROR "** Python Bindings are disabled in debug or static builds.")
+        add_subdirectory(examples/qtquick)
-  endif()
+    else()
-  add_subdirectory(python)
+        add_subdirectory(examples/dockwidgets)
+        add_subdirectory(examples/minimal)
+        add_subdirectory(examples/minimal-mdi)
+        add_subdirectory(examples/mdi_with_docking)
+        set_compiler_flags(kddockwidgets_example)
+        set_compiler_flags(kddockwidgets_minimal_example)
+        set_compiler_flags(kddockwidgets_mdi_with_docking_example)
+    endif()
+endif()
+
+if(${PROJECT_NAME}_TESTS)
+    if(${PROJECT_NAME}_DEVELOPER_MODE)
+        add_subdirectory(tests)
+
+        # Require Qt5.15.1 or higher to run the tests_launcher tests on Mac
+        if(NOT APPLE OR Qt5Widgets_VERSION VERSION_GREATER 5.15.0)
+            # tst_docks.exe is pretty big (160 tests), so split it in more runs so we can use threads.
+            add_test(NAME tst_docks0 COMMAND tests_launcher 0 5)
+            add_test(NAME tst_docks1 COMMAND tests_launcher 1 5)
+            add_test(NAME tst_docks2 COMMAND tests_launcher 2 5)
+            add_test(NAME tst_docks3 COMMAND tests_launcher 3 5)
+            add_test(NAME tst_docks4 COMMAND tests_launcher 4 5)
+            add_test(NAME tst_docks5 COMMAND tests_launcher 5 5)
+            add_test(NAME tst_docks6 COMMAND tests_launcher 6 5)
+            add_test(NAME tst_docks7 COMMAND tests_launcher 7 5)
+            add_test(NAME tst_docks8 COMMAND tests_launcher 8 5)
+            add_test(NAME tst_docks9 COMMAND tests_launcher 9 5)
+            add_test(NAME tst_docks10 COMMAND tests_launcher 10 5)
+            add_test(NAME tst_docks11 COMMAND tests_launcher 10 5)
+            add_test(NAME tst_docks12 COMMAND tests_launcher 11 5)
+            add_test(NAME tst_docks13 COMMAND tests_launcher 12 5)
+            add_test(NAME tst_docks14 COMMAND tests_launcher 13 5)
+            add_test(NAME tst_docks15 COMMAND tests_launcher 14 5)
+            add_test(NAME tst_docks16 COMMAND tests_launcher 15 5)
+            add_test(NAME tst_docks17 COMMAND tests_launcher 16 5)
+            add_test(NAME tst_docks18 COMMAND tests_launcher 17 5)
+            add_test(NAME tst_docks19 COMMAND tests_launcher 18 5)
+            add_test(NAME tst_docks20 COMMAND tests_launcher 19 5)
+            add_test(NAME tst_docks21 COMMAND tests_launcher 20 5) # one more for rounding leftovers
+        endif()
+        if(NOT ${PROJECT_NAME}_QTQUICK)
+            # tst_multisplitter depends on QWidget
+            add_test(NAME tst_multisplitter COMMAND tst_multisplitter)
+        endif()
+
+    endif()
+endif()
+
+if(${PROJECT_NAME}_DOCS)
+    add_subdirectory(docs) # needs to go last, in case there are build source files
+endif()
+
+if(${PROJECT_NAME}_IS_ROOT_PROJECT)
+    # Add uninstall target (not for submodules since parent projects typically have uninstall too)
+    include(ECMUninstallTarget)
 endif()
 
 feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)

CMakePresets.json

@@ -9,7 +9,6 @@
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug",
                 "KDDockWidgets_DEVELOPER_MODE": "ON",
-                "ECM_ENABLE_SANITIZERS" : "'address;undefined'",
                 "CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
                 "KDDockWidgets_FUZZER" : "OFF"
             },
@@ -18,16 +17,17 @@
             }
         },
         {
-            "name": "dev-gammaray",
+            "name": "dev-asan",
-            "displayName": "dev-gammaray",
+            "displayName": "dev-asan",
-            "description": "A Gammaray friendly build. (No ASAN)",
+            "description": "An ASAN/UBSAN build",
             "generator": "Ninja",
-            "binaryDir": "${sourceDir}/build-dev-gammaray",
+            "binaryDir": "${sourceDir}/build-dev-asan",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug",
                 "KDDockWidgets_DEVELOPER_MODE": "ON",
                 "CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
-                "KDDockWidgets_FUZZER" : "OFF"
+                "KDDockWidgets_FUZZER" : "OFF",
+                "ECM_ENABLE_SANITIZERS" : "'address;undefined'"
             },
             "warnings" : {
                 "uninitialized" : true
@@ -164,6 +164,23 @@
             "displayName": "dev6",
             "generator": "Ninja",
             "binaryDir": "${sourceDir}/build-dev6",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_QT6": "ON",
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
+                "KDDockWidgets_FUZZER" : "OFF",
+                "CMAKE_PREFIX_PATH" : "$env{QT6_DIR}"
+            },
+            "environment": {
+                "PATH": "$env{QT6_DIR}/bin:$penv{PATH}"
+            }
+        },
+        {
+            "name": "dev-asan6",
+            "displayName": "dev-asan6",
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/build-dev-asan6",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug",
                 "KDDockWidgets_QT6": "ON",
@@ -295,6 +312,161 @@
                 "QML2_IMPORT_PATH" : "$env{QT6_DIR}/imports:$env{QT6_DIR}/qml",
                 "LD_LIBRARY_PATH" : "$env{QT6_DIR}/lib"
             }
+        },
+        {
+            "name": "dev-time-trace",
+            "displayName": "dev-time-trace",
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/build-dev-time-trace",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
+                "KDDockWidgets_FUZZER" : "OFF",
+                "CMAKE_C_FLAGS_INIT" : "-ftime-trace",
+                "CMAKE_CXX_FLAGS_INIT": "-ftime-trace"
+            },
+            "warnings" : {
+                "uninitialized" : true
+            },
+            "environment": {
+                "CC": "clang",
+                "CXX": "clang++",
+                "CCACHE_DISABLE" : "ON"
+            }
+        },
+        {
+            "name": "dev6-time-trace",
+            "displayName": "dev6-time-trace",
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/build-dev6-time-trace",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
+                "KDDockWidgets_FUZZER" : "OFF",
+                "KDDockWidgets_QT6" : "ON",
+                "CMAKE_C_FLAGS_INIT" : "-ftime-trace",
+                "CMAKE_CXX_FLAGS_INIT": "-ftime-trace"
+            },
+            "warnings" : {
+                "uninitialized" : true
+            },
+            "environment": {
+                "CC": "clang",
+                "CXX": "clang++",
+                "CCACHE_DISABLE" : "ON"
+            }
+        },
+        {
+            "name": "ci-dev-qtwidgets-qt5",
+            "displayName": "ci-dev-qtwidgets-qt5",
+            "description": "Qt5 QtWidgets dev-mode build",
+            "binaryDir": "${sourceDir}/build-ci-dev-qtwidgets-qt5",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        },
+        {
+            "name": "ci-dev-qtquick-qt5",
+            "displayName": "ci-dev-qtquick-qt5",
+            "description": "Qt5 QtQuick dev-mode build",
+            "binaryDir": "${sourceDir}/build-ci-dev-qtquick-qt5",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_QTQUICK": "ON"
+            }
+        },
+        {
+            "name": "ci-qtwidgets-qt5",
+            "displayName": "ci-qtwidgets-qt5",
+            "description": "Qt5 QtWidgets release build",
+            "binaryDir": "${sourceDir}/build-ci-qtwidgets-qt5",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "OFF",
+                "CMAKE_BUILD_TYPE": "Release"
+            }
+        },
+        {
+            "name": "ci-qtquick-qt5",
+            "displayName": "ci-qtquick-qt5",
+            "description": "Qt5 QtQuick release build",
+            "binaryDir": "${sourceDir}/build-ci-qtquick-qt5",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "OFF",
+                "CMAKE_BUILD_TYPE": "Release",
+                "KDDockWidgets_QTQUICK": "ON"
+            }
+        },
+        {
+            "name": "ci-dev-qtwidgets-qt6",
+            "displayName": "ci-dev-qtwidgets-qt6",
+            "description": "Qt6 dev-mode",
+            "binaryDir": "${sourceDir}/build-ci-dev-qtwidgets-qt6",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_QT6": "ON"
+            }
+        },
+        {
+            "name": "ci-dev-qtquick-qt6",
+            "displayName": "ci-dev-qtquick-qt6",
+            "description": "Qt6 dev-mode",
+            "binaryDir": "${sourceDir}/build-ci-dev-qtquick-qt6",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "ON",
+                "CMAKE_BUILD_TYPE": "Debug",
+                "KDDockWidgets_QT6": "ON"
+            }
+        },
+        {
+            "name": "ci-qtwidgets-qt6",
+            "description": "Qt6 QtWidgets release build",
+            "displayName": "ci-qtwidgets-qt6",
+            "binaryDir": "${sourceDir}/build-ci-qtwidgets-qt6",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "OFF",
+                "CMAKE_BUILD_TYPE": "Release",
+                "KDDockWidgets_QT6": "ON"
+            }
+        },
+        {
+            "name": "ci-qtquick-qt6",
+            "description": "Qt6 QtQuick release build",
+            "displayName": "ci-qtquick-qt6",
+            "binaryDir": "${sourceDir}/build-ci-qtquick-qt6",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "KDDockWidgets_DEVELOPER_MODE": "OFF",
+                "CMAKE_BUILD_TYPE": "Release",
+                "KDDockWidgets_QT6": "ON",
+                "KDDockWidgets_QTQUICK": "ON"
+            }
+        },
+        {
+            "name": "ci-static",
+            "inherits":["static"],
+            "binaryDir": "${sourceDir}/build-ci-static"
+        },
+        {
+            "name": "ci-static-qtquick",
+            "inherits":["static-qtquick"],
+            "binaryDir": "${sourceDir}/build-ci-static-qtquick"
+        },
+        {
+            "name": "ci-python",
+            "inherits":["python"],
+            "binaryDir": "${sourceDir}/build-python"
         }
     ],
     "buildPresets": [

Changelog

@@ -1,11 +1,27 @@
-* v1.5.0 (unreleased)
+* v1.6.0 (unreleased)
+ - Minimum Qt6 version is now 6.3.0
+ - Fixed restoring of normal geometry when closing a maximized window (#259)
+ - Experimental support for docking into dock widgets which are in a MDI area.
+ - Fixed potential crash involving infinite loop between QWidget::create() and QWidget::createWinId()
+ - Moved DropIndicatorOverlayInterface::DropLocation enum to KDDockWidgets namespace scope
+ - Added Config::setDropIndicatorAllowedFunc() and corresponding example
+   (kddockwidgets_example --hide-certain-docking-indicators)
+ - Fixed case where unfloating wouldn't restore to the main window (#44 and #96)
+ - Fixed MainWindow not propagating close events to docked widgets
+ - X11: Improved detecting which window is under the cursor, by using native X11 API
+ - X11: Fixed dragging a maximized floating window. Its size is now restored to normal size when the drag starts.
+ - Added DockWidgetBase::currentTabIndex()
+ - Added InitialVisibilityOption::PreserveCurrentTab
+ - Added MainWindow::internalLayout() for advanced customization
+
+* v1.5.0 (24 November 2021)
  - Install the Python bindings to "site-packages"
  - The Python bindings for Qt6 use the "PyKDDockWidgetsQt6" namespace
  - Co-installable with Qt6
  - Adds support for non-detachable central widget, MainWindowOption_HasCentralWidget. (#225)
-
+ - Fix corrupt layout when restoring old JSON
-* v1.4.1 (unreleased)
+ - Fix "Unpin" button not showing up in overlayed widgets
- -
+ - Minimum Qt version is now 5.15
 
 * v1.4.0 (16 July 2021)
   - No longer supports Qt versions less than 5.12

LICENSE.GPL.txt

@@ -1,4 +1,4 @@
- The KDDockWidgets software is Copyright (C) 2018-2021 Klaralvdalens Datakonsult AB.
+ The KDDockWidgets software is Copyright (C) 2018-2022 Klaralvdalens Datakonsult AB.
 
  You may use, distribute and copy the KDDockWidgets software under the terms of
  the GNU General Public License version 2 or under the terms of GNU General

LICENSE.txt

@@ -1,4 +1,4 @@
-KDDockWidgets is (C) 2018-2021, Klarälvdalens Datakonsult AB, and is licensed
+KDDockWidgets is (C) 2018-2022, Klarälvdalens Datakonsult AB, and is licensed
 according to the terms of the:
  GNU General Public License version 2.0 (see LICENSES/GPL-2.0-only.txt)
 or the

README-QtQuick.md

@@ -1,12 +1,13 @@
-Supported Qt versions and toolchains
+# KDDockWidgets and QtQuick
-=====================================
 
-KDDockWidgets for QtQuick requires a C++17 capable compiler and either
+## Supported Qt versions and toolchains
-Qt >= 5.15.0 or Qt >= 6.2.
 
+KDDockWidgets for QtQuick requires a C++17 capable compiler and Qt >= 6.2.1.
 
-TROUBLESHOOTING
+Qt 5.15.2 will probably also work, but it's not built and tested by KDAB CI, we
-===============
+advise users to move to Qt6 as soon as possible.
+
+## Troubleshooting
 
 - QtGraphicalEffects is not supported, as it's buggy when moving between different QWindows.
   See for example QTBUG-94943, KDDockWidgets issue #213. Also search the Qt bug tracker

README-WASM.md

@@ -1,33 +1,40 @@
-WebAssembly
+# KDDockWidgets with WebAssembly
-===========
 
 KDDockWidgets works with WebAssembly with the following known limitations:
 
 - Classic drop indicators are not supported, only the segmented ones. This is because
-WASM doesn't support windows with translucency.
+  WASM doesn't support windows with translucency.
 
 - Might be slow on Linux, depending on your browser, while dragging or resizing windows.
-Please file a bug with Qt, as it's out of scope for KDDW to fix.
+  Please file a bug with Qt, as it's out of scope for KDDW to fix.
 
-Demo:
+## Demo
-=====
 
-A demo is available at https://demos.kdab.com/wasm/kddockwidgets/dockwidgets.html
+A demo is available at <https://demos.kdab.com/wasm/kddockwidgets/dockwidgets.html>.
 
-Build tips for KDDW:
+## Build tips for KDDW
-====================
+
+- Visit <https://doc.qt.io/qt-5/wasm.html> if you haven't yet
 
-- Visit https://doc.qt.io/qt-5/wasm.html if you haven't yet
 - Open a terminal suitable for WASM development (with the correct Qt and toolchain in PATH, etc)
-- KDDockWidgets can be built with `cmake -DCMAKE_TOOLCHAIN_FILE=/usr/local/emsdk-1.39.8/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake -DCMAKE_FIND_ROOT_PATH=~/Qt/5.15.1/wasm_32/ -DKDDockWidgets_EXAMPLES=OFF -DCMAKE_BUILD_TYPE=Release`
-  (Adapt the paths to your own situation)
 
-Builds tips for your own app:
+- KDDockWidgets can be built with:
-=============================
+
+```bash
+    cmake \
+      -DCMAKE_TOOLCHAIN_FILE=/usr/local/emsdk-1.39.8/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake
+      -DCMAKE_FIND_ROOT_PATH=~/Qt/5.15.1/wasm_32/ -DKDDockWidgets_EXAMPLES=OFF -DCMAKE_BUILD_TYPE=Release`
+    (Adapt the paths to your own situation)
+```
+
+## Builds tips for your own app ==
+
 - Link to KDDW (libkddockwidgets.a, or similar)
+
 - As the build is static, don't forget to initialize KDDW's resources:
-```
+
-#ifdef QT_STATIC
+```cpp
-    Q_INIT_RESOURCE(kddockwidgets_resources);
+    #ifdef QT_STATIC
-#endif
+        Q_INIT_RESOURCE(kddockwidgets_resources);
+    #endif
 ```

README-Wayland.md

@@ -1,13 +1,13 @@
+# KDDockWidgets and Wayland
+
 Wayland support is done and has been tested on KDE (Kwin) and weston.
 
-Limitations
+## Limitations
-============
 
 Wayland works very differently than traditional desktops and imposes us some,
 limitations. Here's a list of different behaviours which KDDockWidgets will have
 when running on Wayland:
 
-
 - A title bar can either be used for drag&dock or for moving the window around.
 
 - For this reason, floating windows now have two title bars.
@@ -28,7 +28,5 @@ when running on Wayland:
 - Kwin specific:
   - The pixmap that's shown during a drag can't be bigger than 250x250. Might be a bug.
 
-
-
 All in all it's pretty decent and usable. Any further improvements should be done at the server or
 protocol level now.

README-bindings.md

@@ -1,26 +1,29 @@
+# KDDockWidgets and Python bindings
+
 These are the instructions for building the Python bindings for KDDockWidgets.
 
 Make sure you have PySide2, shiboken2 and shiboken2-generator installed.
 As this time, you cannot get shiboken2-generator because the wheels are not on PyPi.
 To use the wheels do this:
 
-```
+```bash
 % pip3 install \
     --index-url=http://download.qt.io/official_releases/QtForPython/ \
     --trusted-host download.qt.io \
     shiboken2 pyside2 shiboken2_generator
 ```
 
-For more info visit https://doc.qt.io/qtforpython/shiboken2/gettingstarted.html
+For more info visit <https://doc.qt.io/qtforpython/shiboken2/gettingstarted.html>.
 
 afterwards run 'pip3 list | grep PySide2'
 Note the version *must* match the same Qt you intend to use when building KDDockWidgets.
 
 Not supported:
- - Debug builds
+
- - static builds
+- debug builds
- - python2 bindings
+- static builds
- - only some 32-bit platforms are supported.  see https://wiki.qt.io/Qt_for_Python
+- python2 bindings
+- only some 32-bit platforms are supported (see <https://wiki.qt.io/Qt_for_Python>)
 
 Tell CMake to build the bindings by passing the `-DKDDockWidgets_PYTHON_BINDINGS=True' option,
 followed by the make command.
@@ -33,42 +36,42 @@ to CMake (adjust to the python path on your system).
 
 To run the KDDW python example
 
-```
+```bash
-$ export PYTHONPATH=/kddw/install/path # Only if needed
+    export PYTHONPATH=/kddw/install/path # Only if needed
-$ cd python/examples/
+    cd python/examples/
-$ rcc -g python -o rc_assets.py ../../examples/dockwidgets/resources_example.qrc
+    rcc -g python -o rc_assets.py ../../examples/dockwidgets/resources_example.qrc
-$ python3 main.py
+    python3 main.py
 ```
 
 Build Issues
 
-* If you see errors like "Unable to locate Clang's built-in include directory"
+- If you see errors like "Unable to locate Clang's built-in include directory"
-  then first make sure you have llvm installed.  If you still have problems try
+  then first mROUBLESHOOTINGake sure you have llvm installed.  If you still have problems try
   setting the environment variable `LLVM_INSTALL_DIR` to point to your llvm installation.
 
   Examples:
 
-  ```
+```bash
-  export LLVM_INSTALL_DIR=/usr/local/opt/llvm-11
+    export LLVM_INSTALL_DIR=/usr/local/opt/llvm-11
-  set "LLVM_INSTALL_DIR=C:\Program Files\LLVM" #Windows
+    set "LLVM_INSTALL_DIR=C:\Program Files\LLVM" #Windows
-  ```
+```
 
-* When building the examples you may encounter errors loading shared libraries from shiboken2_generator.
+- When building the examples you may encounter errors loading shared libraries from shiboken2_generator.
 
   Try:
 
-  ```
+```bash
-  export LD_LIBRARY_PATH=/usr/local/lib/python/dist-packages/PySide2/Qt/lib #linux
+    export LD_LIBRARY_PATH=/usr/local/lib/python/dist-packages/PySide2/Qt/lib #linux
-  export DYLD_LIBRARY_PATH=/usr/local/lib/python/dist-packages/PySide2/Qt/lib #Mac
+    export DYLD_LIBRARY_PATH=/usr/local/lib/python/dist-packages/PySide2/Qt/lib #Mac
-  #adjust to wherever your PySide is installed
+    (Adjust to wherever your PySide is installed)
-  ```
+```
 
-* On Windows the `libclang.dll` that ship with QtForPython is not compatible with MSVC2019.
+- On Windows the `libclang.dll` that ship with QtForPython is not compatible with MSVC2019.
   To fix this, copy the `libclang.dll` that comes with llvm into shiboken2, like so:
 
-  ```
+```bash
-  cd C:\Python37\Lib\site-packages\shiboken2_generator
+    cd C:\Python37\Lib\site-packages\shiboken2_generator
-  copy libclang.dll libclang.dll.save
+    copy libclang.dll libclang.dll.save
-  copy "C:\Program Files\llvm\bin\libclang.dll" libclang.dll
+    copy "C:\Program Files\llvm\bin\libclang.dll" libclang.dll
-  #Python3 installation in C:\Python37 and llvm in c:\Program Files\llvm. adjust as needed
+    (Python3 installation in C:\Python37 and llvm in c:\Program Files\llvm. adjust as needed)
-  ```
+```

README.md

@@ -1,7 +1,7 @@
+# KDDockWidgets
+
 [![Build Status](https://travis-ci.com/KDAB/KDDockWidgets.svg?branch=master)](https://travis-ci.com/KDAB/KDDockWidgets)
 
-KDDockWidgets
-=============
 `KDDockWidgets` is a Qt dock widget library written by KDAB, suitable for replacing
 `QDockWidget` and implementing advanced functionalities missing in Qt.
 
@@ -9,9 +9,8 @@ Although `KDDockWidgets` is ready to be used out of the box, it can also be seen
 as a framework to allow building very tailored custom docking systems. It tries
 to expose every internal widget and every knob for the app developer to tune.
 
+## Motivation
 
-Motivation
-==========
 Throughout the years KDAB contributed and funded bug fixes and features to `QDockWidget`.
 Sadly, this was very painful. Each bug fix or feature took many days of implementation,
 and an equal number of days just to fix dozens of regressions.
@@ -22,15 +21,15 @@ creative with their requests, so it was clear we needed a better docking framewo
 
 You will find more information in these places:
 
- * [our official home page](https://www.kdab.com/development-resources/qt-tools/kddockwidgets)
+- [our official home page](https://www.kdab.com/development-resources/qt-tools/kddockwidgets)
- * [online detailed browsable API reference](https://docs.kdab.com/kddockwidgets)
+- [online detailed browsable API reference](https://docs.kdab.com/kddockwidgets)
- * [our example programs](examples/)
+- [our example programs](examples/)
 
 We also have an [in browser demo](https://demos.kdab.com/wasm/kddockwidgets/dockwidgets.html). Note
 however that this demo isn't fully featured, as it's running on Qt for WebAssembly.
 
-Features
+## Features
-========
+
 - Provide advanced docking that QDockWidget doesn't support
   - Native window resize on Windows (allowing for Aero-snap even with custom title bar decorations)
   - Arrow drop indicators for great drop precision
@@ -66,55 +65,70 @@ Features
 - Optional minimize and maximize button on the title bar
 - FloatingWindows can be utility windows or full native
 
-Screen capture
+## Screen capture
-==============
+
 ![Screen capture](./screencap.gif?raw=true "The docking system in action")
 
+## Building and requirements
 
-Trying out the examples
+To build KDDockWidgets you'll need:
-=======================
-A full demo that showcases most of the features lives in [examples/dockwidgets](examples/dockwidgets).
 
-A simpler example can be found in [examples/minimal](examples/minimal),
+- CMake
-which might be more indicated to learn the API, as it's less overwhelming than the full demo.
+- Qt 5.15.x or Qt6 >= 6.2
+- Ninja (Other generators might work but are untested)
+- C++17 capable compiler
+- Qt Widgets module
+- Qt X11Extras module if on Linux/X11
+- Qt Quick and QuickControls2 modules if using the QtQuick support
+- Qt private development headers, for instance, for Qt5:
+  - SUSE: libqt5-qtbase-private-headers-devel
+  - Ubuntu, debian-based: qtbase5-private-dev
+  - Fedora, redhat-based: qt5-qtbase-private-devel
+  - others: consult your distro
 
-Open a terminal capable of building Qt5 applications.
+Open a terminal capable of building Qt applications.
 Make sure you have cmake, ninja, compiler, Qt, etc in PATH.
 
 Adapt the instructions to suit your cmake generator and operating system.
-Build and install the KDDockWidgets framework:
 
-```
+```bash
-$ cmake -G Ninja -DCMAKE_INSTALL_PREFIX=/path/where/to/install ../path/to/kddockwidgets
+    cmake -G Ninja -DCMAKE_INSTALL_PREFIX=/path/where/to/install ../path/to/kddockwidgets
-$ cmake --build .
+    cmake --build .
-$ cmake --build . --target install
+    cmake --build . --target install
-```
-
-Now build and run the example:
-
-```
-$ cd path/to/kddockwidgets/examples/dockwidgets/
-$ cmake -G Ninja -DCMAKE_PREFIX_PATH=/path/where/to/install
-$ cmake --build .
-$ ./kddockwidgets_example
 ```
 
 The installation directory defaults to `c:\KDAB\KDDockWidgets-<version>` on Windows
 and `/usr/local/KDAB/KDDockWidgets-<version>` on non-Windows.
 
-You can change the installation location by passing the option `-DCMAKE_INSTALL_PREFIX=/install/path` to cmake.
+Change the installation location by passing the option `-DCMAKE_INSTALL_PREFIX=/install/path` to CMake.
+
+## Trying out the examples
+
+A full demo that showcases most of the features lives in [examples/dockwidgets](examples/dockwidgets).
+
+A simpler example can be found in [examples/minimal](examples/minimal),
+which might be more indicated to learn the API, as it's less overwhelming than the full demo.
+
+To build and run the example:
+
+```bash
+    cd path/to/kddockwidgets/examples/dockwidgets/
+    cmake -G Ninja -DCMAKE_PREFIX_PATH=/path/where/kddw/is/installed
+    cmake --build .
+    ./kddockwidgets_example
+```
+
+## Using
 
-Using
-=====
 From your CMake Qt5 project, add
 
-```
+```cmake
     find_package(KDDockWidgets CONFIG)
 ```
 
 or for Qt6
 
-```
+```cmake
     find_package(KDDockWidgets-qt6 CONFIG)
 ```
 
@@ -124,58 +138,56 @@ That's all you need to do (the imported target also brings in the include direct
 You may also need to modify the `CMAKE_PREFIX_PATH` environment variable depending
 on where you installed KDDockWidgets.
 
+## Python Bindings
 
-Python Bindings
-================
 Please refer to [README-bindings.md](README-bindings.md).
 
-Versioning
+## Versioning
-==========
 
 New features go to master while the stable branch only accepts non-intrusive bug fixes.
 
-We'll try to remain source-compatible across versions. API will get a deprecation
+We'll try to remain source and binary compatible across versions. API will get
-notice before being removed in the next version. Note that this source-compatibility
+a deprecation notice before being removed in the next version. Note that this
-effort is only for the public API. Private API (headers ending in _p.h) might change so you
+compatibility effort is only for the public API. Private API (headers ending
-shouldn't depend on them. Private API is only exposed so more advanced users can
+in _p.h) might change so you shouldn't depend on them. Private API is only
-override, for example `paintEvent()`, and not so they can change internal business logic.
+exposed so more advanced users can override, for example `paintEvent()`, and
+not so they can change internal business logic.
 
 We don't promise or test binary compatibility. It's advised that you recompile
 your application whenever updating KDDW.
 
+## Styling
 
-Supported Qt versions and toolchains
+Almost all private widgets used by KDDW can be derived by the user to give them
-=====================================
+a custom look. That's done by providing your own FrameworkWidgetFactory. Run
-KDDockWidgets requires Qt5 >= 5.12 or Qt6 >= 6.1.
+"kddockwidgets_example -p" to see that in action.
-The QtQuick support requires Qt5 >= 5.15 or Qt6 >= 6.1.
 
+Qt StyleSheets are not, and will not, be supported. See the comments in
+`examples/dockwidgets/MyTitleBar_CSS.h` for why. You can however use some minimal
+CSS, as shown in that example, just don't report bugs about it.
 
-Regarding compilers, whatever toolchain is able to build Qt 5.9 should also be
+Warning: When using private headers, be sure to rebuild your application whenever you
-fine. Note however that MSVC 2013 isn't supported anymore due to compiler crashes.
+update to a new KDDW version. Binary compatibility is only kept when using public
+headers.
 
+## Licensing
 
-Licensing
+KDDockWidgets is (C) 2019-2022, Klarälvdalens Datakonsult AB, and is licensed according to
-=========
-KDDockWidgets is (C) 2019-2021, Klarälvdalens Datakonsult AB, and is licensed according to
 the terms of the [GPL 2.0](LICENSES/GPL-2.0-only.txt) or [GPL 3.0](LICENSES/GPL-3.0-only.txt).
 
 Contact KDAB at <info@kdab.com> to inquire about commercial licensing.
 
+## Get Involved
 
-Get Involved
+Please submit your issue reports to our GitHub space at <https://github.com/KDAB/KDDockWidgets>.
-============
-Please submit your issue reports to our GitHub space at
-https://github.com/KDAB/KDDockWidgets
 
-
+When reporting bugs please make it easy for the maintainer to reproduce it. Use `examples/minimal/`
-When reporting bugs please make it easy for the maintainer to reproduce it. Use `examples/minimal/` or
+or `examples/dockwidgets/` for reproducing the problem. If you did modifications to the example
-`examples/dockwidgets/` for reproducing the problem. If you did modifications to the example in order to
+in order to reproduce then please attach the *patch* and not a picture of your changes. You can
-reproduce then please attach the *patch* and not a picture of your changes. You can get a patch by doing
+get a patch by doing `git diff > repro.diff` at the repo root.
-`git diff > repro.diff` at the repo root.
 
 Also state which KDDW sha1, branch or version you're using, and which operating system.
 
-
 KDAB will happily accept external contributions; however, **all** contributions require a
 signed [Copyright Assignment Agreement](docs/KDDockWidgets-CopyrightAssignmentForm.pdf).
 
@@ -185,8 +197,8 @@ Contact info@kdab.com for more information.
 
 Thanks to our [contributors](CONTRIBUTORS.txt).
 
-About KDAB
+## About KDAB
-==========
+
 KDDockWidgets is supported and maintained by Klarälvdalens Datakonsult AB (KDAB).
 
 The KDAB Group is the global No.1 software consultancy for Qt, C++ and
@@ -198,10 +210,10 @@ We continue to help develop parts of Qt and are one of the major contributors
 to the Qt Project. We can give advanced or standard trainings anywhere
 around the globe on Qt as well as C++, OpenGL, 3D and more.
 
-Please visit https://www.kdab.com to meet the people who write code like this.
+Please visit <https://www.kdab.com> to meet the people who write code like this.
 
 Stay up-to-date with KDAB product announcements:
 
-* [KDAB Newsletter](https://news.kdab.com)
+- [KDAB Newsletter](https://news.kdab.com)
-* [KDAB Blogs](https://www.kdab.com/category/blogs)
+- [KDAB Blogs](https://www.kdab.com/category/blogs)
-* [KDAB on Twitter](https://twitter.com/KDABQt)
+- [KDAB on Twitter](https://twitter.com/KDABQt)

appveyor.yml

@@ -19,6 +19,8 @@ skip_tags: false
 
 # Build worker image
 image:
+  - Ubuntu2004
+  - macos
   - Visual Studio 2019
 
 # scripts that are called at very beginning, before repo cloning
@@ -36,16 +38,31 @@ platform:
 # build Configuration, i.e. Debug, Release, etc.
 configuration:
   - Release
+  - Debug
+
+environment:
+  matrix:
+    - useqt6: False
+    - useqt6: True
 
 install:
-  - call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
+  - sh: if [ "`uname -s`" = "Darwin" ]; then brew install ninja; else sudo apt-get -y update; sudo apt-get -y install mesa-common-dev libglu1-mesa-dev libxkbcommon-dev libxkbcommon-x11-dev; fi
-  - set QTDIR=C:\Qt\5.15\msvc2019_64
+
-  - set PATH=%QTDIR%\bin;%PATH%
+before_build:
+  - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
+  - cmd: set PATH=C:\Qt\6.2\msvc2019_64\bin;C:\Qt\5.15\msvc2019_64\bin;%PATH%
+  - sh: if [ "`uname -s`" = "Darwin" ]; then export PATH=$HOME/Qt/6.1/macos/bin:$HOME/Qt/5.15/clang_64/bin:$PATH; else export PATH=$HOME/Qt/6.2/gcc_64/bin:$HOME/Qt/5.15/gcc_64/bin:$PATH; fi
+
 build_script:
   - mkdir build
   - cd build
-  - cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=%CONFIGURATION% -DKDDockWidgets_TESTS=True -DKDDockWidgets_EXAMPLES=True  -DKDDockWidgets_DEVELOPER_MODE=True ..
+  - cmd: cmake -G Ninja -DCMAKE_BUILD_TYPE=%CONFIGURATION% -DKDDockWidgets_QT6=%useqt6% -DKDDockWidgets_TESTS=True -DKDDockWidgets_EXAMPLES=True -DKDDockWidgets_DEVELOPER_MODE=True ..
-  - nmake
+  - sh: cmake -G Ninja -DCMAKE_BUILD_TYPE=$CONFIGURATION -DKDDockWidgets_QT6=$useqt6 -DKDDockWidgets_TESTS=True -DKDDockWidgets_EXAMPLES=True -DKDDockWidgets_DEVELOPER_MODE=True ..
+  - cmake --build .
+  - cmd: cmake --build . --target install
+  - sh: sudo cmake --build . --target install
+  - cmd: set PATH=.\bin;%PATH%
+  - ctest --test-dir .
 
 # to disable automatic builds
 #build: off
@@ -54,11 +71,8 @@ build_script:
 #       tests configuration       #
 #---------------------------------#
 
-test_script:
-  - nmake test
-
 # to disable automatic tests
-#test: off
+test: off
 
 
 #---------------------------------#

cmake/ECM/modules/ECMGenerateHeaders.cmake

@@ -22,24 +22,24 @@ Generate C/C++ CamelCase forwarding headers.
       [COMMON_HEADER <HeaderName>]
       [RELATIVE <relative_path>])
 
-For each CamelCase header name passed to HEADER_NAMES, a file of that name
+For each CamelCase header name passed to ``HEADER_NAMES``, a file of that name
 will be generated that will include a version with ``.h`` or, if set,
 ``.<header_extension>`` appended.
 For example, the generated header ``ClassA`` will include ``classa.h`` (or
-``ClassA.h``, see ORIGINAL).
+``ClassA.h``, see ``ORIGINAL``).
 If a CamelCaseName consists of multiple comma-separated files, e.g.
 ``ClassA,ClassB,ClassC``, then multiple camelcase header files will be
 generated which are redirects to the first header file.
 The file locations of these generated headers will be stored in
 <camelcase_forwarding_headers_var>.
 
-ORIGINAL specifies how the name of the original header is written: lowercased
+``ORIGINAL`` specifies how the name of the original header is written: lowercased
-or also camelcased.  The default is LOWERCASE. Since 1.8.0.
+or also camelcased.  The default is "LOWERCASE". Since 1.8.0.
 
-HEADER_EXTENSION specifies what file name extension is used for the header
+``HEADER_EXTENSION`` specifies what file name extension is used for the header
 files.  The default is "h". Since 5.48.0.
 
-PREFIX places the generated headers in subdirectories.  This should be a
+``PREFIX`` places the generated headers in subdirectories.  This should be a
 CamelCase name like ``KParts``, which will cause the CamelCase forwarding
 headers to be placed in the ``KParts`` directory (e.g. ``KParts/Part``).  It
 will also, for the convenience of code in the source distribution, generate
@@ -47,36 +47,36 @@ forwarding headers based on the original names (e.g. ``kparts/part.h``).  This
 allows includes like ``"#include <kparts/part.h>"`` to be used before
 installation, as long as the include_directories are set appropriately.
 
-OUTPUT_DIR specifies where the files will be generated; this should be within
+``OUTPUT_DIR`` specifies where the files will be generated; this should be within
 the build directory. By default, ``${CMAKE_CURRENT_BINARY_DIR}`` will be used.
 This option can be used to avoid file conflicts.
 
-REQUIRED_HEADERS specifies an output variable name where all the required
+``REQUIRED_HEADERS`` specifies an output variable name where all the required
 headers will be appended so that they can be installed together with the
 generated ones.  This is mostly intended as a convenience so that adding a new
 header to a project only requires specifying the CamelCase variant in the
 CMakeLists.txt file; the original variant will then be added to this
 variable.
 
-COMMON_HEADER generates an additional convenience header which includes all
+``COMMON_HEADER`` generates an additional convenience header which includes all
 other header files.
 
-The RELATIVE argument indicates where the original headers can be found
+The ``RELATIVE`` argument indicates where the original headers can be found
-relative to CMAKE_CURRENT_SOURCE_DIR.  It does not affect the generated
+relative to ``CMAKE_CURRENT_SOURCE_DIR``.  It does not affect the generated
-CamelCase forwarding files, but ecm_generate_headers() uses it when checking
+CamelCase forwarding files, but ``ecm_generate_headers()`` uses it when checking
 that the original header exists, and to generate originally named forwarding
-headers when PREFIX is set.
+headers when ``PREFIX`` is set.
 
 To allow other parts of the source distribution (eg: tests) to use the
 generated headers before installation, it may be desirable to set the
-INCLUDE_DIRECTORIES property for the library target to output_dir.  For
+``INCLUDE_DIRECTORIES`` property for the library target to output_dir.  For
-example, if OUTPUT_DIR is CMAKE_CURRENT_BINARY_DIR (the default), you could do
+example, if ``OUTPUT_DIR`` is ``CMAKE_CURRENT_BINARY_DIR`` (the default), you could do
 
 .. code-block:: cmake
 
   target_include_directories(MyLib PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>")
 
-Example usage (without PREFIX):
+Example usage (without ``PREFIX``):
 
 .. code-block:: cmake
 
@@ -93,7 +93,7 @@ Example usage (without PREFIX):
           DESTINATION ${CMAKE_INSTALL_PREFIX}/include
           COMPONENT Devel)
 
-Example usage (with PREFIX):
+Example usage (with ``PREFIX``):
 
 .. code-block:: cmake
 

cmake/ECM/modules/ECMGeneratePriFile.cmake

@@ -26,7 +26,8 @@ the default qmake ``mkspecs`` directory or of a directory that will be in the
                         [VERSION <version>] # since 5.83
                         [DEPS "<dep> [<dep> [...]]"]
                         [FILENAME_VAR <filename_variable>]
-                        [INCLUDE_INSTALL_DIR <dir>]
+                        [INCLUDE_INSTALL_DIRS <dir> [<dir> [...]]]  # since 5.92
+                        [INCLUDE_INSTALL_DIR <dir>] # deprecated since 5.92
                         [LIB_INSTALL_DIR <dir>])
 
 If your CMake project produces a Qt-based library, you may expect there to be
@@ -36,31 +37,34 @@ library convenient for them, in much the same way that CMake config files make
 things convenient for CMake-based applications. ``ecm_generate_pri_file()``
 generates just such a file.
 
-VERSION specifies the version of the library the ``.pri`` file describes. If
+``VERSION`` specifies the version of the library the ``.pri`` file describes. If
 not set, the value is taken from the context variable ``PROJECT_VERSION``.
 This variable is usually set by the ``project(... VERSION ...)`` command or,
-if CMake policy CMP0048 is not NEW, by :module:`ECMSetupVersion`.
+if CMake policy CMP0048 is not ``NEW``, by :module:`ECMSetupVersion`.
 For backward-compatibility with older ECM versions the
 ``PROJECT_VERSION_STRING`` variable as set by :module:`ECMSetupVersion`
 will be preferred over ``PROJECT_VERSION`` if set, unless the minimum
 required version of ECM is 5.83 and newer. Since 5.83.
 
-BASE_NAME specifies the name qmake project (.pro) files should use to refer to
+``BASE_NAME`` specifies the name qmake project (.pro) files should use to refer to
-the library (eg: KArchive).  LIB_NAME is the name of the actual library to
+the library (eg: KArchive).  ``LIB_NAME`` is the name of the actual library to
-link to (ie: the first argument to add_library()).  DEPS is a space-separated
+link to (ie: the first argument to add_library()).  ``DEPS`` is a space-separated
 list of the base names of other libraries (for Qt libraries, use the same
 names you use with the ``QT`` variable in a qmake project file, such as "core"
-for QtCore).  FILENAME_VAR specifies the name of a variable to store the path
+for QtCore).  ``FILENAME_VAR`` specifies the name of a variable to store the path
 to the generated file in.
 
-INCLUDE_INSTALL_DIR is the path (relative to ``CMAKE_INSTALL_PREFIX``) that
+``INCLUDE_INSTALL_DIRS`` are the paths (relative to ``CMAKE_INSTALL_PREFIX``) that
 include files will be installed to. It defaults to
 ``${INCLUDE_INSTALL_DIR}/<baseName>`` if the ``INCLUDE_INSTALL_DIR`` variable
 is set. If that variable is not set, the ``CMAKE_INSTALL_INCLUDEDIR`` variable
-is used instead, and if neither are set ``include`` is used.  LIB_INSTALL_DIR
+is used instead, and if neither are set ``include`` is used.  ``LIB_INSTALL_DIR``
 operates similarly for the installation location for libraries; it defaults to
 ``${LIB_INSTALL_DIR}``, ``${CMAKE_INSTALL_LIBDIR}`` or ``lib``, in that order.
 
+``INCLUDE_INSTALL_DIR`` is the old variant of ``INCLUDE_INSTALL_DIRS``, taking only one
+directory.
+
 Example usage:
 
 .. code-block:: cmake
@@ -85,19 +89,19 @@ Since pre-1.0.0.
 
 # Replicate the logic from KDEInstallDirs.cmake as we can't depend on it
 # Ask qmake if we're using the same prefix as Qt
-set(_askqmake OFF)
+set(_should_query_qt OFF)
 if(NOT DEFINED KDE_INSTALL_USE_QT_SYS_PATHS)
-    include(ECMQueryQmake)
+    include(ECMQueryQt)
-    query_qmake(qt_install_prefix_dir QT_INSTALL_PREFIX TRY)
+    ecm_query_qt(qt_install_prefix_dir QT_INSTALL_PREFIX TRY)
     if(qt_install_prefix_dir STREQUAL "${CMAKE_INSTALL_PREFIX}")
-        set(_askqmake ON)
+        set(_should_query_qt ON)
     endif()
 endif()
 
-if(KDE_INSTALL_USE_QT_SYS_PATHS OR _askqmake)
+if(KDE_INSTALL_USE_QT_SYS_PATHS OR _should_query_qt)
-  include(ECMQueryQmake)
+  include(ECMQueryQt)
-  query_qmake(qt_install_prefix_dir QT_INSTALL_PREFIX)
+  ecm_query_qt(qt_install_prefix_dir QT_INSTALL_PREFIX)
-  query_qmake(qt_host_data_dir QT_HOST_DATA)
+  ecm_query_qt(qt_host_data_dir QT_HOST_DATA)
   if(qt_install_prefix_dir STREQUAL "${CMAKE_INSTALL_PREFIX}")
     file(RELATIVE_PATH qt_host_data_dir ${qt_install_prefix_dir} ${qt_host_data_dir})
   endif()
@@ -114,7 +118,7 @@ endif()
 function(ECM_GENERATE_PRI_FILE)
   set(options )
   set(oneValueArgs BASE_NAME LIB_NAME DEPS FILENAME_VAR INCLUDE_INSTALL_DIR LIB_INSTALL_DIR VERSION)
-  set(multiValueArgs )
+  set(multiValueArgs INCLUDE_INSTALL_DIRS)
 
   cmake_parse_arguments(EGPF "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
 
@@ -145,13 +149,19 @@ function(ECM_GENERATE_PRI_FILE)
       endif()
     endif()
   endif()
-  if(NOT EGPF_INCLUDE_INSTALL_DIR)
+  if(EGPF_INCLUDE_INSTALL_DIR)
+    if(EGPF_INCLUDE_INSTALL_DIRS)
+      message(FATAL_ERROR "Only one argument of INCLUDE_INSTALL_DIR & INCLUDE_INSTALL_DIRS can be used in ECM_GENERATE_PRI_FILE() call")
+    endif()
+    set(EGPF_INCLUDE_INSTALL_DIRS ${EGPF_INCLUDE_INSTALL_DIR})
+  endif()
+  if(NOT EGPF_INCLUDE_INSTALL_DIRS)
       if(INCLUDE_INSTALL_DIR)
-          set(EGPF_INCLUDE_INSTALL_DIR "${INCLUDE_INSTALL_DIR}/${EGPF_BASE_NAME}")
+          set(EGPF_INCLUDE_INSTALL_DIRS "${INCLUDE_INSTALL_DIR}/${EGPF_BASE_NAME}")
       elseif(CMAKE_INSTALL_INCLUDEDIR)
-          set(EGPF_INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}/${EGPF_BASE_NAME}")
+          set(EGPF_INCLUDE_INSTALL_DIRS "${CMAKE_INSTALL_INCLUDEDIR}/${EGPF_BASE_NAME}")
       else()
-          set(EGPF_INCLUDE_INSTALL_DIR "include/${EGPF_BASE_NAME}")
+          set(EGPF_INCLUDE_INSTALL_DIRS "include/${EGPF_BASE_NAME}")
       endif()
   endif()
   if(NOT EGPF_LIB_INSTALL_DIR)
@@ -193,11 +203,15 @@ function(ECM_GENERATE_PRI_FILE)
   set(PRI_TARGET_BASENAME ${EGPF_BASE_NAME})
   set(PRI_TARGET_LIBNAME ${EGPF_LIB_NAME})
   set(PRI_TARGET_QTDEPS ${EGPF_DEPS})
-  if(IS_ABSOLUTE "${EGPF_INCLUDE_INSTALL_DIR}")
+  set(PRI_TARGET_INCLUDES)
-      set(PRI_TARGET_INCLUDES "${EGPF_INCLUDE_INSTALL_DIR}")
+  foreach(_dir ${EGPF_INCLUDE_INSTALL_DIRS})
-  else()
+    # separate list entries with space
-      set(PRI_TARGET_INCLUDES "${BASEPATH}/${EGPF_INCLUDE_INSTALL_DIR}")
+    if(IS_ABSOLUTE "${_dir}")
-  endif()
+        string(APPEND PRI_TARGET_INCLUDES " ${_dir}")
+    else()
+        string(APPEND PRI_TARGET_INCLUDES " ${BASEPATH}/${_dir}")
+    endif()
+  endforeach()
   if(IS_ABSOLUTE "${EGPF_LIB_INSTALL_DIR}")
       set(PRI_TARGET_LIBS "${EGPF_LIB_INSTALL_DIR}")
   else()

cmake/ECM/modules/ECMQueryQmake.cmake

@@ -1,46 +0,0 @@
-find_package(Qt5Core QUIET)
-
-if (Qt5Core_FOUND)
-    set(_qmake_executable_default "qmake-qt5")
-endif ()
-if (TARGET Qt5::qmake)
-    get_target_property(_qmake_executable_default Qt5::qmake LOCATION)
-endif()
-set(QMAKE_EXECUTABLE ${_qmake_executable_default}
-    CACHE FILEPATH "Location of the Qt5 qmake executable")
-
-# Helper method
-# This is not public API (yet)!
-# Usage: query_qmake(<result_variable> <qt_variable> [TRY])
-# Passing TRY will result in the method not failing fatal if no qmake executable
-# has been found, but instead simply returning an empty string
-function(query_qmake result_variable qt_variable)
-    set(options TRY)
-    set(oneValueArgs )
-    set(multiValueArgs )
-
-    cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
-
-    if(NOT QMAKE_EXECUTABLE)
-        if(ARGS_TRY)
-            set(${result_variable} "" PARENT_SCOPE)
-            message(STATUS "No qmake Qt5 binary found. Can't check ${qt_variable}")
-            return()
-        else()
-            message(FATAL_ERROR "No qmake Qt5 binary found. Can't check ${qt_variable} as required")
-        endif()
-    endif()
-    execute_process(
-        COMMAND ${QMAKE_EXECUTABLE} -query "${qt_variable}"
-        RESULT_VARIABLE return_code
-        OUTPUT_VARIABLE output
-    )
-    if(return_code EQUAL 0)
-        string(STRIP "${output}" output)
-        file(TO_CMAKE_PATH "${output}" output_path)
-        set(${result_variable} "${output_path}" PARENT_SCOPE)
-    else()
-        message(WARNING "Failed call: ${QMAKE_EXECUTABLE} -query \"${qt_variable}\"")
-        message(FATAL_ERROR "QMake call failed: ${return_code}")
-    endif()
-endfunction()

cmake/ECM/modules/ECMQueryQt.cmake

@@ -0,0 +1,100 @@
+# SPDX-FileCopyrightText: 2014 Rohan Garg <rohan16garg@gmail.com>
+# SPDX-FileCopyrightText: 2014 Alex Merry <alex.merry@kde.org>
+# SPDX-FileCopyrightText: 2014-2016 Aleix Pol <aleixpol@kde.org>
+# SPDX-FileCopyrightText: 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
+# SPDX-FileCopyrightText: 2022 Ahmad Samir <a.samir78@gmail.com>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#[=======================================================================[.rst:
+ECMQueryQt
+---------------
+This module can be used to query the installation paths used by Qt.
+
+For Qt5 this uses ``qmake``, and for Qt6 this used ``qtpaths`` (the latter has built-in
+support to query the paths of a target platform when cross-compiling).
+
+This module defines the following function:
+::
+
+    ecm_query_qt(<result_variable> <qt_variable> [TRY])
+
+Passing ``TRY`` will result in the method not making the build fail if the executable
+used for querying has not been found, but instead simply print a warning message and
+return an empty string.
+
+Example usage:
+
+.. code-block:: cmake
+
+    include(ECMQueryQt)
+    ecm_query_qt(bin_dir QT_INSTALL_BINS)
+
+If the call succeeds ``${bin_dir}`` will be set to ``<prefix>/path/to/bin/dir`` (e.g.
+``/usr/lib64/qt/bin/``).
+
+Since: 5.93
+#]=======================================================================]
+
+include(${CMAKE_CURRENT_LIST_DIR}/QtVersionOption.cmake)
+include(CheckLanguage)
+check_language(CXX)
+if (CMAKE_CXX_COMPILER)
+    # Enable the CXX language to let CMake look for config files in library dirs.
+    # See: https://gitlab.kitware.com/cmake/cmake/-/issues/23266
+    enable_language(CXX)
+endif()
+
+if (QT_MAJOR_VERSION STREQUAL "5")
+    # QUIET to accommodate the TRY option
+    find_package(Qt${QT_MAJOR_VERSION}Core QUIET)
+    if(TARGET Qt5::qmake)
+        get_target_property(_qmake_executable_default Qt5::qmake LOCATION)
+
+        set(QUERY_EXECUTABLE ${_qmake_executable_default}
+            CACHE FILEPATH "Location of the Qt5 qmake executable")
+        set(_exec_name_text "Qt5 qmake")
+        set(_cli_option "-query")
+    endif()
+elseif(QT_MAJOR_VERSION STREQUAL "6")
+    # QUIET to accommodate the TRY option
+    find_package(Qt6 COMPONENTS CoreTools QUIET CONFIG)
+    if (TARGET Qt6::qtpaths)
+        get_target_property(_qtpaths_executable Qt6::qtpaths LOCATION)
+
+        set(QUERY_EXECUTABLE ${_qtpaths_executable}
+            CACHE FILEPATH "Location of the Qt6 qtpaths executable")
+        set(_exec_name_text "Qt6 qtpaths")
+        set(_cli_option "--query")
+    endif()
+endif()
+
+function(ecm_query_qt result_variable qt_variable)
+    set(options TRY)
+    set(oneValueArgs)
+    set(multiValueArgs)
+
+    cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT QUERY_EXECUTABLE)
+        if(ARGS_TRY)
+            set(${result_variable} "" PARENT_SCOPE)
+            message(STATUS "No ${_exec_name_text} executable found. Can't check ${qt_variable}")
+            return()
+        else()
+            message(FATAL_ERROR "No ${_exec_name_text} executable found. Can't check ${qt_variable} as required")
+        endif()
+    endif()
+    execute_process(
+        COMMAND ${QUERY_EXECUTABLE} ${_cli_option} "${qt_variable}"
+        RESULT_VARIABLE return_code
+        OUTPUT_VARIABLE output
+    )
+    if(return_code EQUAL 0)
+        string(STRIP "${output}" output)
+        file(TO_CMAKE_PATH "${output}" output_path)
+        set(${result_variable} "${output_path}" PARENT_SCOPE)
+    else()
+        message(WARNING "Failed call: ${_command} \"${qt_variable}\"")
+        message(FATAL_ERROR "${_exec_name_text} call failed: ${return_code}")
+    endif()
+endfunction()

cmake/ECM/modules/ECMSetupVersion.cmake

@@ -36,7 +36,7 @@ version of ECM is < 5.83)::
 
   <prefix>_VERSION_STRING - <version> (use <prefix>_VERSION instead)
 
-If CMake policy CMP0048 is not NEW, the following CMake variables will also
+If CMake policy CMP0048 is not ``NEW``, the following CMake variables will also
 be set::
 
   PROJECT_VERSION_MAJOR   - <major>
@@ -44,14 +44,14 @@ be set::
   PROJECT_VERSION_PATCH   - <patch>
   PROJECT_VERSION         - <version>
 
-For backward-compatibility, if CMake policy CMP0048 is not NEW, also this variable is set
+For backward-compatibility, if CMake policy CMP0048 is not ``NEW``, also this variable is set
 (only if the minimum required version of ECM is < 5.83)::
 
   PROJECT_VERSION_STRING  - <version> (use PROJECT_VERSION instead)
 
-If the VERSION_HEADER option is used, a simple C header is generated with the
+If the ``VERSION_HEADER`` option is used, a simple C header is generated with the
 given filename. If filename is a relative path, it is interpreted as relative
-to CMAKE_CURRENT_BINARY_DIR.  The generated header contains the following
+to ``CMAKE_CURRENT_BINARY_DIR``.  The generated header contains the following
 macros::
 
    <prefix>_VERSION_MAJOR  - <major> as an integer
@@ -64,15 +64,15 @@ macros::
 next 8 bits and ``<major>`` in the remaining bits.  Note that ``<patch>`` and
 ``<minor>`` must be less than 256.
 
-If the PACKAGE_VERSION_FILE option is used, a simple CMake package version
+If the ``PACKAGE_VERSION_FILE`` option is used, a simple CMake package version
-file is created using the write_basic_package_version_file() macro provided by
+file is created using the ``write_basic_package_version_file()`` macro provided by
 CMake. It should be installed in the same location as the Config.cmake file of
-the library so that it can be found by find_package().  If the filename is a
+the library so that it can be found by ``find_package()``.  If the filename is a
-relative path, it is interpreted as relative to CMAKE_CURRENT_BINARY_DIR. The
+relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The
-optional COMPATIBILITY option is forwarded to
+optional ``COMPATIBILITY`` option is forwarded to
-write_basic_package_version_file(), and defaults to AnyNewerVersion.
+``write_basic_package_version_file()``, and defaults to ``AnyNewerVersion``.
 
-If CMake policy CMP0048 is NEW, an alternative form of the command is
+If CMake policy CMP0048 is ``NEW``, an alternative form of the command is
 available::
 
   ecm_setup_version(PROJECT
@@ -81,14 +81,14 @@ available::
                     [VERSION_HEADER <filename>]
                     [PACKAGE_VERSION_FILE <filename>] )
 
-This will use the version information set by the project() command.
+This will use the version information set by the ``project()`` command.
-VARIABLE_PREFIX defaults to the project name.  Note that PROJECT must be the
+``VARIABLE_PREFIX`` defaults to the project name.  Note that ``PROJECT`` must be the
 first argument.  In all other respects, it behaves like the other form of the
 command.
 
 Since pre-1.0.0.
 
-COMPATIBILITY option available since 1.6.0.
+``COMPATIBILITY`` option available since 1.6.0.
 #]=======================================================================]
 
 include(CMakePackageConfigHelpers)
@@ -132,9 +132,10 @@ function(ecm_setup_version _version)
 
     if(use_project_version)
         set(_version "${PROJECT_VERSION}")
-        set(_major "${PROJECT_VERSION_MAJOR}")
+        # drop leading 0 from values to avoid bogus octal values in c/C++ e.g. with 08 or 09
-        set(_minor "${PROJECT_VERSION_MINOR}")
+        string(REGEX REPLACE "0*([0-9]+)" "\\1" _major "${PROJECT_VERSION_MAJOR}")
-        set(_patch "${PROJECT_VERSION_PATCH}")
+        string(REGEX REPLACE "0*([0-9]+)" "\\1" _minor "${PROJECT_VERSION_MINOR}")
+        string(REGEX REPLACE "0*([0-9]+)" "\\1" _patch "${PROJECT_VERSION_PATCH}")
     else()
         string(REGEX REPLACE "^0*([0-9]+)\\.[0-9]+\\.[0-9]+.*" "\\1" _major "${_version}")
         string(REGEX REPLACE "^[0-9]+\\.0*([0-9]+)\\.[0-9]+.*" "\\1" _minor "${_version}")

cmake/ECM/modules/QtVersionOption.cmake

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2021 Volker Krause <vkrause@kde.org>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+#[=======================================================================[.rst:
+QtVersionOption
+---------------
+
+Adds a build option to select the major Qt version if necessary,
+that is, if the major Qt version has not yet been determined otherwise
+(e.g. by a corresponding ``find_package()`` call).
+This module is typically included by other modules requiring knowledge
+about the major Qt version.
+
+``QT_MAJOR_VERSION`` is defined to either be "5" or "6".
+
+Since 5.82.0.
+#]=======================================================================]
+
+if (DEFINED QT_MAJOR_VERSION)
+    return()
+endif()
+
+if (TARGET Qt5::Core)
+    set(QT_MAJOR_VERSION 5)
+elseif (TARGET Qt6::Core)
+    set(QT_MAJOR_VERSION 6)
+else()
+    option(BUILD_WITH_QT6 "Build against Qt 6" OFF)
+
+    if (BUILD_WITH_QT6)
+        set(QT_MAJOR_VERSION 6)
+    else()
+        set(QT_MAJOR_VERSION 5)
+    endif()
+endif()

cmake/KDAB/modules/FindPySide2.cmake

@@ -1,5 +1,5 @@
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -58,7 +58,11 @@ else()
         OUTPUT_STRIP_TRAILING_WHITESPACE
     )
     if(NOT PYSIDE2_BASEDIR)
-        message(FATAL_ERROR "The PySide2 module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+        message(
+            FATAL_ERROR
+                "The PySide2 module could not be imported. Make sure you have it installed "
+                "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+        )
     endif()
 
     set(PYSIDE_BASEDIR ${PYSIDE2_BASEDIR} CACHE PATH "Top level install of PySide2" FORCE)

cmake/KDAB/modules/FindPySide6.cmake

@@ -1,5 +1,5 @@
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -33,7 +33,11 @@ execute_process(
     OUTPUT_STRIP_TRAILING_WHITESPACE
 )
 if(NOT PYSIDE6_BASEDIR)
-    message(FATAL_ERROR "The PySide6 module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+    message(
+        FATAL_ERROR
+            "The PySide6 module could not be imported. Make sure you have it installed "
+            "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+    )
 endif()
 
 if(PYSIDE6_BASEDIR)

cmake/KDAB/modules/FindShiboken2.cmake

@@ -1,5 +1,5 @@
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -11,7 +11,8 @@
 #  SHIBOKEN_BUILD_TYPE         - Tells if Shiboken was compiled in Release or Debug mode.
 
 # You can install Shiboken from Qt repository with
-# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython --trusted-host download.qt.io shiboken2-generator
+# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython \
+#     --trusted-host download.qt.io shiboken2-generator
 
 find_package(PkgConfig)
 if(PKG_CONFIG_FOUND)
@@ -51,7 +52,11 @@ else()
         OUTPUT_STRIP_TRAILING_WHITESPACE
     )
     if(NOT SHIBOKEN_GENERATOR_BASEDIR)
-        message(FATAL_ERROR "The shiboken2_generator module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+        message(
+            FATAL_ERROR
+            "The shiboken2_generator module could not be imported. Make sure you have it installed "
+            "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+        )
     endif()
     execute_process(
         COMMAND ${Python3_EXECUTABLE} -c "if True:
@@ -66,7 +71,11 @@ else()
         OUTPUT_STRIP_TRAILING_WHITESPACE
     )
     if(NOT SHIBOKEN_BASEDIR)
-        message(FATAL_ERROR "The shiboken2 module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+        message(
+            FATAL_ERROR
+            "The shiboken2 module could not be imported. Make sure you have it installed "
+            "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+        )
     endif()
     execute_process(
         COMMAND ${Python3_EXECUTABLE} -c "if True:

cmake/KDAB/modules/FindShiboken6.cmake

@@ -1,5 +1,5 @@
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -11,7 +11,8 @@
 #  SHIBOKEN_BUILD_TYPE         - Tells if Shiboken was compiled in Release or Debug mode.
 
 # You can install Shiboken from Qt repository with
-# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython --trusted-host download.qt.io shiboken6-generator
+# pip3 install --index-url=https://download.qt.io/official_releases/QtForPython \
+#     --trusted-host download.qt.io shiboken6-generator
 
 set(SHIBOKEN_FOUND FALSE)
 
@@ -28,7 +29,11 @@ execute_process(
     OUTPUT_STRIP_TRAILING_WHITESPACE
 )
 if(NOT SHIBOKEN_GENERATOR_BASEDIR)
-  message(FATAL_ERROR "The shiboken6_generator module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+    message(
+        FATAL_ERROR
+            "The shiboken6_generator module could not be imported. Make sure you have it installed "
+            "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+    )
 endif()
 execute_process(
     COMMAND ${Python3_EXECUTABLE} -c "if True:
@@ -43,7 +48,11 @@ execute_process(
     OUTPUT_STRIP_TRAILING_WHITESPACE
 )
 if(NOT SHIBOKEN_BASEDIR)
-  message(FATAL_ERROR "The shiboken6 module could not be imported. Make sure you have it installed by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\"")
+    message(
+        FATAL_ERROR
+            "The shiboken6 module could not be imported. Make sure you have it installed "
+            "by checking the output of \"pip${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR} list\""
+    )
 endif()
 execute_process(
     COMMAND ${Python3_EXECUTABLE} -c "if True:
@@ -142,7 +151,7 @@ if(SHIBOKEN_FOUND)
     message(STATUS "Shiboken binary:            ${SHIBOKEN_BINARY}")
     message(STATUS "Shiboken version:           ${SHIBOKEN_VERSION}")
 
-    # Create shiboke2 target
+    # Create shiboken2 target
     add_library(Shiboken6::libshiboken SHARED IMPORTED GLOBAL)
     if(MSVC)
         set_property(TARGET Shiboken6::libshiboken PROPERTY
@@ -161,7 +170,8 @@ if(SHIBOKEN_FOUND)
     set_property(TARGET Shiboken6::shiboken PROPERTY IMPORTED_LOCATION ${SHIBOKEN_BINARY})
 endif()
 
-find_package_handle_standard_args(Shiboken6
+find_package_handle_standard_args(
+    Shiboken6
     REQUIRED_VARS SHIBOKEN_BASEDIR SHIBOKEN_INCLUDE_DIR SHIBOKEN_LIBRARY SHIBOKEN_BINARY
     VERSION_VAR SHIBOKEN_VERSION
 )

cmake/KDAB/modules/KDInstallLocation.cmake

@@ -1,3 +1,9 @@
+#
+# SPDX-FileCopyrightText: 2012-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+
 # Some default installation locations. These should be global, with any project
 # specific locations added to the end. These paths are all relative to the
 # install prefix.
@@ -9,27 +15,27 @@
 include(GNUInstallDirs)
 
 if(NOT INSTALL_RUNTIME_DIR)
-  set(INSTALL_RUNTIME_DIR ${CMAKE_INSTALL_BINDIR})
+    set(INSTALL_RUNTIME_DIR ${CMAKE_INSTALL_BINDIR})
 endif()
 if(NOT INSTALL_LIBRARY_DIR)
-  set(INSTALL_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR})
+    set(INSTALL_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR})
 endif()
 if(NOT INSTALL_ARCHIVE_DIR)
-  set(INSTALL_ARCHIVE_DIR ${CMAKE_INSTALL_LIBDIR})
+    set(INSTALL_ARCHIVE_DIR ${CMAKE_INSTALL_LIBDIR})
 endif()
 if(NOT INSTALL_INCLUDE_DIR)
-  set(INSTALL_INCLUDE_DIR ${CMAKE_INSTALL_INCLUDEDIR})
+    set(INSTALL_INCLUDE_DIR ${CMAKE_INSTALL_INCLUDEDIR})
 endif()
 if(NOT INSTALL_DATADIR)
-  set(INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR})
+    set(INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR})
 endif()
 if(NOT INSTALL_DOC_DIR)
-  set(INSTALL_DOC_DIR ${CMAKE_INSTALL_DOCDIR}${KDDockWidgets_LIBRARY_QTID})
+    set(INSTALL_DOC_DIR ${CMAKE_INSTALL_DOCDIR}${KDDockWidgets_LIBRARY_QTID})
 endif()
 
 set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 if(APPLE)
-  set(CMAKE_MACOSX_RPATH ON)
+    set(CMAKE_MACOSX_RPATH ON)
 else()
-  set(CMAKE_INSTALL_RPATH "$ORIGIN/../${INSTALL_LIBRARY_DIR}")
+    set(CMAKE_INSTALL_RPATH "$ORIGIN/../${INSTALL_LIBRARY_DIR}")
 endif()

cmake/KDAB/modules/KDQtInstallPaths.cmake

@@ -1,5 +1,5 @@
 #
-# SPDX-FileCopyrightText: 2016-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2016-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Allen Winter <allen.winter@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -28,14 +28,14 @@ execute_process(
     OUTPUT_VARIABLE ALL_VARS
 )
 if(NOT return_code EQUAL 0)
-    message(WARNING "Failed call: ${QMAKE_EXECUTABLE} -query")
+    message(WARNING "Failed call: ${QT_QMAKE_EXECUTABLE} -query")
     message(FATAL_ERROR "QMake call failed: ${return_code}")
 endif()
 
 string(REPLACE "\n" ";" VARS_LIST ${ALL_VARS})
-foreach(QVAL ${VARS_LIST})
+foreach(qval ${VARS_LIST})
-    if(QVAL MATCHES "QT_INSTALL_")
+    if(qval MATCHES "QT_INSTALL_")
-        string(REPLACE ":" ";" QVAL_LIST ${QVAL})
+        string(REPLACE ":" ";" QVAL_LIST ${qval})
         list(LENGTH QVAL_LIST listlen)
         list(GET QVAL_LIST 0 var)
         if(WIN32 AND ${listlen} GREATER 2)

cmake/KDAB/modules/PySide2ModuleBuild.cmake

@@ -1,12 +1,15 @@
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 #
 
 if(NOT ${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX)
-    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE FILEPATH "Custom path to install python bindings.")
+    # cmake-lint: disable=C0103
+    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}
+        CACHE FILEPATH "Custom path to install python bindings."
+    )
 endif()
 
 message(STATUS "PYTHON INSTALL PREFIX ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}")
@@ -19,6 +22,10 @@ endif()
 #Qt5 requires C++14
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+#remove noisy compiler warnings (as the generated code is not necessarily super-warning-free)
+if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-all -Wno-extra")
+endif()
 
 # On macOS, check if Qt is a framework build. This affects how include paths should be handled.
 get_target_property(QtCore_is_framework Qt5::Core FRAMEWORK)
@@ -61,6 +68,7 @@ if(WIN32 OR DEFINED AVOID_PROTECTED_HACK)
     add_definitions(-DAVOID_PROTECTED_HACK)
 endif()
 
+# Replace all semicolons in a string with this platform's path separator
 macro(make_path varname)
     # accepts any number of path variables
     string(REPLACE ";" "${PATH_SEP}" ${varname} "${ARGN}")
@@ -69,35 +77,35 @@ endmacro()
 # Creates a PySide module target based on the arguments
 # This will:
 # 1 - Create a Cmake custom-target that call shiboken-generator passign the correct arguments
-# 2 - Create a Cmake library target called "Py${LIBRARY_NAME}" the output name of this target
+# 2 - Create a Cmake library target called "Py${libraryName}" the output name of this target
 #     will be changed to match PySide template
 # Args:
-#   LIBRARY_NAME - The name of the output module
+#   libraryName - The name of the output module
-#   TYPESYSTEM_PATHS - A list of paths where shiboken should look for typesystem files
+#   typesystemPaths - A list of paths where shiboken should look for typesystem files
-#   INCLUDE_PATHS - Include paths necessary to parse your class. *This is not the same as build*
+#   includePaths - Include paths necessary to parse your class. *This is not the same as build*
-#   OUTPUT_SOURCES - The files that will be generated by shiboken
+#   outputSource - The files that will be generated by shiboken
-#   TARGET_INCLUDE_DIRS - This will be passed to target_include_directories
+#   targetIncludeDirs - This will be passed to target_include_directories
-#   TARGET_LINK_LIBRARIES - This will be passed to target_link_libraries
+#   targetLinkLibraries - This will be passed to targetLinkLibraries
-#   GLOBAL_INCLUDE - A header-file that contains all classes that will be generated
+#   globalInclude - A header-file that contains all classes that will be generated
-#   TYPESYSTEM_XML - The target binding typesystem (that should be the full path)
+#   typesystemXML - The target binding typesystem (that should be the full path)
-#   DEPENDS - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
+#   dependsArg - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
 #             trigger if one of these files changes
-#   MODULE_OUTPUT_DIR - Where the library file should be stored
+#   moduleOutputDir - Where the library file should be stored
-macro(CREATE_PYTHON_BINDINGS
+macro(create_python_bindings
-    LIBRARY_NAME
+    libraryName
-    TYPESYSTEM_PATHS
+    typesystemPaths
-    INCLUDE_PATHS
+    includePaths
-    OUTPUT_SOURCES
+    outputSource
-    TARGET_INCLUDE_DIRS
+    targetIncludeDirs
-    TARGET_LINK_LIBRARIES
+    targetLinkLibraries
-    GLOBAL_INCLUDE
+    globalInclude
-    TYPESYSTEM_XML
+    typesystemXML
-    DEPENDS
+    dependsArg
-    MODULE_OUTPUT_DIR)
+    moduleOutputDir)
 
     # Transform the path separators into something shiboken understands.
-    make_path(shiboken_include_dirs ${INCLUDE_PATHS})
+    make_path(shiboken_include_dirs ${includePaths})
-    make_path(shiboken_typesystem_dirs ${TYPESYSTEM_PATHS})
+    make_path(shiboken_typesystem_dirs ${typesystemPaths})
     get_property(raw_python_dir_include_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES)
     make_path(python_dir_include_dirs ${raw_python_dir_include_dirs})
     set(shiboken_include_dirs "${shiboken_include_dirs}${PATH_SEP}${python_dir_include_dirs}")
@@ -108,54 +116,55 @@ macro(CREATE_PYTHON_BINDINGS
         make_path(shiboken_framework_include_dirs ${shiboken_framework_include_dirs})
         set(shiboken_framework_include_dirs_option "--framework-include-paths=${shiboken_framework_include_dirs}")
     endif()
-    set_property(SOURCE ${OUTPUT_SOURCES} PROPERTY SKIP_AUTOGEN ON)
+    set_property(SOURCE ${outputSource} PROPERTY SKIP_AUTOGEN ON)
-    add_custom_command(OUTPUT ${OUTPUT_SOURCES}
+    add_custom_command(
+        OUTPUT ${outputSource}
         COMMAND $<TARGET_PROPERTY:Shiboken2::shiboken,LOCATION> ${GENERATOR_EXTRA_FLAGS}
-                ${GLOBAL_INCLUDE}
+                ${globalInclude}
                 --include-paths=${shiboken_include_dirs}
                 --typesystem-paths=${shiboken_typesystem_dirs}
                 ${shiboken_framework_include_dirs_option}
                 --output-directory=${CMAKE_CURRENT_BINARY_DIR}
-                ${TYPESYSTEM_XML}
+                ${typesystemXML}
-        DEPENDS ${TYPESYSTEM_XML} ${DEPENDS}
+        DEPENDS ${typesystemXML} ${dependsArg}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMENT "Running generator for ${LIBRARY_NAME} binding...")
+        COMMENT "Running generator for ${libraryName} binding..."
+    )
 
-        set(TARGET_NAME "Py${LIBRARY_NAME}")
+    set(TARGET_NAME "Py${libraryName}")
-        set(MODULE_NAME "${LIBRARY_NAME}")
+    set(MODULE_NAME "${libraryName}")
-        add_library(${TARGET_NAME} MODULE ${OUTPUT_SOURCES})
+    add_library(${TARGET_NAME} MODULE ${outputSource})
 
-        set_target_properties(${TARGET_NAME} PROPERTIES
+    set_target_properties(
-            PREFIX ""
+        ${TARGET_NAME} PROPERTIES
-            OUTPUT_NAME ${MODULE_NAME}
+        PREFIX ""
-            LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR}
+        OUTPUT_NAME ${MODULE_NAME}
-        )
+        LIBRARY_OUTPUT_DIRECTORY ${moduleOutputDir}
-        if(APPLE)
+    )
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
+    if(APPLE)
-        elseif(NOT WIN32) #ie. linux
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+    elseif(NOT WIN32) #ie. linux
-        endif()
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+    endif()
 
-        if(WIN32)
+    if(WIN32)
-            set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
+        set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
-        endif()
+    endif()
 
-        target_include_directories(${TARGET_NAME} PUBLIC
+    target_include_directories(${TARGET_NAME} PUBLIC ${targetIncludeDirs})
-            ${TARGET_INCLUDE_DIRS}
-        )
 
-        target_link_libraries(${TARGET_NAME}
+    target_link_libraries(
-            ${TARGET_LINK_LIBRARIES}
+        ${TARGET_NAME}
-            PySide2::pyside2
+        ${targetLinkLibraries}
-            Shiboken2::libshiboken
+        PySide2::pyside2
-        )
+        Shiboken2::libshiboken
-        target_compile_definitions(${TARGET_NAME}
+    )
-            PRIVATE Py_LIMITED_API=0x03050000
+    target_compile_definitions(${TARGET_NAME} PRIVATE Py_LIMITED_API=0x03050000)
-        )
+    if(APPLE)
-        if(APPLE)
+        set_property(TARGET ${TARGET_NAME} APPEND PROPERTY LINK_FLAGS "-undefined dynamic_lookup")
-            set_property(TARGET ${TARGET_NAME} APPEND PROPERTY
+    endif()
-                LINK_FLAGS "-undefined dynamic_lookup")
+    install(
-        endif()
+        TARGETS ${TARGET_NAME}
-        install(TARGETS ${TARGET_NAME}
+        LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
-            LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX})
+    )
 endmacro()

cmake/KDAB/modules/PySide6ModuleBuild.cmake

@@ -1,12 +1,15 @@
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 #
 
 if(NOT ${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX)
-    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE FILEPATH "Custom path to install python bindings.")
+    # cmake-lint: disable=C0103
+    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}
+        CACHE FILEPATH "Custom path to install python bindings."
+    )
 endif()
 
 message(STATUS "PYTHON INSTALL PREFIX ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}")
@@ -19,6 +22,10 @@ endif()
 #Qt6 requires C++17
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+#remove noisy compiler warnings (as the generated code is not necessarily super-warning-free)
+if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-all -Wno-extra")
+endif()
 
 # On macOS, check if Qt is a framework build. This affects how include paths should be handled.
 get_target_property(QtCore_is_framework Qt6::Core FRAMEWORK)
@@ -61,6 +68,7 @@ if(WIN32 OR DEFINED AVOID_PROTECTED_HACK)
     add_definitions(-DAVOID_PROTECTED_HACK)
 endif()
 
+# Replace all semicolons in a string with this platform's path separator
 macro(make_path varname)
     # accepts any number of path variables
     string(REPLACE ";" "${PATH_SEP}" ${varname} "${ARGN}")
@@ -69,35 +77,35 @@ endmacro()
 # Creates a PySide module target based on the arguments
 # This will:
 # 1 - Create a Cmake custom-target that call shiboken-generator passign the correct arguments
-# 2 - Create a Cmake library target called "Py${LIBRARY_NAME}" the output name of this target
+# 2 - Create a Cmake library target called "Py${libraryName}" the output name of this target
 #     will be changed to match PySide template
 # Args:
-#   LIBRARY_NAME - The name of the output module
+#   libraryName - The name of the output module
-#   TYPESYSTEM_PATHS - A list of paths where shiboken should look for typesystem files
+#   typesystemPaths - A list of paths where shiboken should look for typesystem files
-#   INCLUDE_PATHS - Include paths necessary to parse your class. *This is not the same as build*
+#   includePaths - Include paths necessary to parse your class. *This is not the same as build*
-#   OUTPUT_SOURCES - The files that will be generated by shiboken
+#   outputSource - The files that will be generated by shiboken
-#   TARGET_INCLUDE_DIRS - This will be passed to target_include_directories
+#   targetIncludeDirs - This will be passed to target_include_directories
-#   TARGET_LINK_LIBRARIES - This will be passed to target_link_libraries
+#   targetLinkLibraries - This will be passed to targetLinkLibraries
-#   GLOBAL_INCLUDE - A header-file that contains all classes that will be generated
+#   globalInclude - A header-file that contains all classes that will be generated
-#   TYPESYSTEM_XML - The target binding typesystem (that should be the full path)
+#   typesystemXML - The target binding typesystem (that should be the full path)
-#   DEPENDS - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
+#   dependsArg - This var will be passed to add_custom_command(DEPENDS) so a new generation will be
 #             trigger if one of these files changes
-#   MODULE_OUTPUT_DIR - Where the library file should be stored
+#   moduleOutputDir - Where the library file should be stored
-macro(CREATE_PYTHON_BINDINGS
+macro(create_python_bindings
-    LIBRARY_NAME
+    libraryName
-    TYPESYSTEM_PATHS
+    typesystemPaths
-    INCLUDE_PATHS
+    includePaths
-    OUTPUT_SOURCES
+    outputSource
-    TARGET_INCLUDE_DIRS
+    targetIncludeDirs
-    TARGET_LINK_LIBRARIES
+    targetLinkLibraries
-    GLOBAL_INCLUDE
+    globalInclude
-    TYPESYSTEM_XML
+    typesystemXML
-    DEPENDS
+    dependsArg
-    MODULE_OUTPUT_DIR)
+    moduleOutputDir)
 
     # Transform the path separators into something shiboken understands.
-    make_path(shiboken_include_dirs ${INCLUDE_PATHS})
+    make_path(shiboken_include_dirs ${includePaths})
-    make_path(shiboken_typesystem_dirs ${TYPESYSTEM_PATHS})
+    make_path(shiboken_typesystem_dirs ${typesystemPaths})
     get_property(raw_python_dir_include_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES)
     make_path(python_dir_include_dirs ${raw_python_dir_include_dirs})
     set(shiboken_include_dirs "${shiboken_include_dirs}${PATH_SEP}${python_dir_include_dirs}")
@@ -108,54 +116,55 @@ macro(CREATE_PYTHON_BINDINGS
         make_path(shiboken_framework_include_dirs ${shiboken_framework_include_dirs})
         set(shiboken_framework_include_dirs_option "--framework-include-paths=${shiboken_framework_include_dirs}")
     endif()
-    set_property(SOURCE ${OUTPUT_SOURCES} PROPERTY SKIP_AUTOGEN ON)
+    set_property(SOURCE ${outputSource} PROPERTY SKIP_AUTOGEN ON)
-    add_custom_command(OUTPUT ${OUTPUT_SOURCES}
+    add_custom_command(
+        OUTPUT ${outputSource}
         COMMAND $<TARGET_PROPERTY:Shiboken6::shiboken,LOCATION> ${GENERATOR_EXTRA_FLAGS}
-                ${GLOBAL_INCLUDE}
+                ${globalInclude}
                 --include-paths=${shiboken_include_dirs}
                 --typesystem-paths=${shiboken_typesystem_dirs}
                 ${shiboken_framework_include_dirs_option}
                 --output-directory=${CMAKE_CURRENT_BINARY_DIR}
-                ${TYPESYSTEM_XML}
+                ${typesystemXML}
-        DEPENDS ${TYPESYSTEM_XML} ${DEPENDS}
+        DEPENDS ${typesystemXML} ${dependsArg}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMENT "Running generator for ${LIBRARY_NAME} binding...")
+        COMMENT "Running generator for ${libraryName} binding..."
+    )
 
-        set(TARGET_NAME "Py${LIBRARY_NAME}")
+    set(TARGET_NAME "Py${libraryName}")
-        set(MODULE_NAME "${LIBRARY_NAME}")
+    set(MODULE_NAME "${libraryName}")
-        add_library(${TARGET_NAME} MODULE ${OUTPUT_SOURCES})
+    add_library(${TARGET_NAME} MODULE ${outputSource})
 
-        set_target_properties(${TARGET_NAME} PROPERTIES
+    set_target_properties(
-            PREFIX ""
+        ${TARGET_NAME} PROPERTIES
-            OUTPUT_NAME ${MODULE_NAME}
+        PREFIX ""
-            LIBRARY_OUTPUT_DIRECTORY ${MODULE_OUTPUT_DIR}
+        OUTPUT_NAME ${MODULE_NAME}
-        )
+        LIBRARY_OUTPUT_DIRECTORY ${moduleOutputDir}
-        if(APPLE)
+    )
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
+    if(APPLE)
-        elseif(NOT WIN32) #ie. linux
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@loader_path")
-            set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+    elseif(NOT WIN32) #ie. linux
-        endif()
+        set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "$ORIGIN")
+    endif()
 
-        if(WIN32)
+    if(WIN32)
-            set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
+        set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".pyd")
-        endif()
+    endif()
 
-        target_include_directories(${TARGET_NAME} PUBLIC
+    target_include_directories(${TARGET_NAME} PUBLIC ${targetIncludeDirs})
-            ${TARGET_INCLUDE_DIRS}
-        )
 
-        target_link_libraries(${TARGET_NAME}
+    target_link_libraries(
-            ${TARGET_LINK_LIBRARIES}
+        ${TARGET_NAME}
-            PySide6::pyside6
+        ${targetLinkLibraries}
-            Shiboken6::libshiboken
+        PySide6::pyside6
-        )
+        Shiboken6::libshiboken
-        target_compile_definitions(${TARGET_NAME}
+    )
-            PRIVATE Py_LIMITED_API=0x03050000
+    target_compile_definitions(${TARGET_NAME} PRIVATE Py_LIMITED_API=0x03050000)
-        )
+    if(APPLE)
-        if(APPLE)
+        set_property(TARGET ${TARGET_NAME} APPEND PROPERTY LINK_FLAGS "-undefined dynamic_lookup")
-            set_property(TARGET ${TARGET_NAME} APPEND PROPERTY
+    endif()
-                LINK_FLAGS "-undefined dynamic_lookup")
+    install(
-        endif()
+        TARGETS ${TARGET_NAME}
-        install(TARGETS ${TARGET_NAME}
+        LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
-            LIBRARY DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX})
+    )
 endmacro()

code.dev-qtquick.code-workspace

@@ -9,7 +9,8 @@
     "C_Cpp.default.cStandard": "c17",
     "files.trimTrailingWhitespace": true,
     "editor.formatOnType": true,
-    "C_Cpp.autocompleteAddParentheses": true
+    "C_Cpp.autocompleteAddParentheses": true,
+    "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json"
   },
   "launch": {
     "version": "0.2.0",

code.dev-qtwidgets.code-workspace

@@ -9,98 +9,51 @@
     "C_Cpp.default.cStandard": "c17",
     "files.trimTrailingWhitespace": true,
     "editor.formatOnType": true,
-    "C_Cpp.autocompleteAddParentheses": true
+    "C_Cpp.autocompleteAddParentheses": true,
+    "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json"
   },
   "launch": {
     "version": "0.2.0",
     "configurations": [
       {
-        "name": "gdb-kddockwidgets_example",
+        "name": "kddockwidgets_example",
-        "type": "cppdbg",
+        "type": "lldb",
         "request": "launch",
         "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_example",
         "args": [],
-        "cwd": "${workspaceFolder}",
+        "cwd": "${workspaceFolder}"
-        "MIMode": "gdb",
-        "stopAtEntry": false,
-        "externalConsole": false
       },
       {
-        "name": "gdb-kddockwidgets_minimal_example",
+        "name": "kddockwidgets_minimal_example",
-        "type": "cppdbg",
+        "type": "lldb",
         "request": "launch",
         "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_minimal_example",
         "args": [],
-        "cwd": "${workspaceFolder}",
+        "cwd": "${workspaceFolder}"
-        "MIMode": "gdb",
-        "stopAtEntry": false,
-        "externalConsole": false
       },
       {
-        "name": "gdb-kddockwidgets_minimal_mdi_example",
+        "name": "kddockwidgets_minimal_mdi_example",
-        "type": "cppdbg",
+        "type": "lldb",
         "request": "launch",
         "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_minimal_mdi_example",
         "args": [],
-        "cwd": "${workspaceFolder}",
+        "cwd": "${workspaceFolder}"
-        "MIMode": "gdb",
-        "stopAtEntry": false,
-        "externalConsole": false
       },
       {
-        "name": "gdb-tst_docks",
+        "name": "kddockwidgets_mdi_with_docking_example",
-        "type": "cppdbg",
+        "type": "lldb",
+        "request": "launch",
+        "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_mdi_with_docking_example",
+        "args": [],
+        "cwd": "${workspaceFolder}"
+      },
+      {
+        "name": "tst_docks",
+        "type": "lldb",
         "request": "launch",
         "program": "${workspaceFolder}/build-dev/bin/tst_docks",
         "args": [],
-        "cwd": "${workspaceFolder}",
+        "cwd": "${workspaceFolder}"
-        "MIMode": "gdb",
-        "stopAtEntry": false,
-        "externalConsole": false
-      },
-      {
-        "name": "lldb-kddockwidgets_example",
-        "type": "cppdbg",
-        "request": "launch",
-        "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_example",
-        "args": [],
-        "cwd": "${workspaceFolder}",
-        "MIMode": "lldb",
-        "stopAtEntry": false,
-        "externalConsole": false
-      },
-      {
-        "name": "lldb-kddockwidgets_minimal_example",
-        "type": "cppdbg",
-        "request": "launch",
-        "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_minimal_example",
-        "args": [],
-        "cwd": "${workspaceFolder}",
-        "MIMode": "lldb",
-        "stopAtEntry": false,
-        "externalConsole": false
-      },
-      {
-        "name": "lldb-kddockwidgets_minimal_mdi_example",
-        "type": "cppdbg",
-        "request": "launch",
-        "program": "${workspaceFolder}/build-dev/bin/kddockwidgets_minimal_mdi_example",
-        "args": [],
-        "cwd": "${workspaceFolder}",
-        "MIMode": "lldb",
-        "stopAtEntry": false,
-        "externalConsole": false
-      },
-      {
-        "name": "lldb-tst_docks",
-        "type": "cppdbg",
-        "request": "launch",
-        "program": "${workspaceFolder}/build-dev/bin/tst_docks",
-        "args": [],
-        "cwd": "${workspaceFolder}",
-        "MIMode": "lldb",
-        "stopAtEntry": false,
-        "externalConsole": false
       },
       {
         "name": "msvc-kddockwidgets_example",

code.dev-qtwidgets6.code-workspace

@@ -9,7 +9,8 @@
     "C_Cpp.default.cStandard": "c17",
     "files.trimTrailingWhitespace": true,
     "editor.formatOnType": true,
-    "C_Cpp.autocompleteAddParentheses": true
+    "C_Cpp.autocompleteAddParentheses": true,
+    "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json"
   },
   "launch": {
     "version": "0.2.0",

conan/conanfile.py

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 #
 # Contact KDAB at <info@kdab.com> for commercial licensing options.
@@ -9,9 +9,10 @@
 
 from conans import ConanFile, CMake, tools
 
+
 class KDDockWidgetsConan(ConanFile):
     name = "kddockwidgets"
-    version = "1.4.0"
+    version = "1.5.0"
     default_user = "kdab"
     default_channel = "stable"
     license = ("https://raw.githubusercontent.com/KDAB/KDDockWidgets/master/LICENSES/GPL-2.0-only.txt",
@@ -20,7 +21,7 @@ class KDDockWidgetsConan(ConanFile):
     url = "https://github.com/KDAB/KDDockWidgets"
     description = "Advanced Dock Widget Framework for Qt"
     generators = "cmake"
-    topics = ("qt", "dockwidget" , "kdab")
+    topics = ("qt", "dockwidget", "kdab")
     settings = "os", "compiler", "build_type", "arch"
     options = {
         "qt_version": "ANY",
@@ -65,4 +66,5 @@ class KDDockWidgetsConan(ConanFile):
         self.env_info.CMAKE_PREFIX_PATH.append(self.package_folder)
 
     def package_id(self):
-        self.info.requires["qt"].minor_mode() # Check only the major and minor version!
+        # Check only the major and minor version!
+        self.info.requires["qt"].minor_mode()

distro/debian.changelog

@@ -1,3 +1,9 @@
+kddockwidgets (1.5.0) release candidate; urgency=high
+
+  * 1.5.0 final
+
+ -- Allen Winter <allen.winter@kdab.com>  Mon, 24 Nov 2021 12:00:00 -0500
+
 kddockwidgets (1.4.0) release candidate; urgency=high
 
   * 1.4.0 final

distro/qt5-debian.control

@@ -6,7 +6,7 @@ Build-Depends: debhelper (>=9), cdbs, cmake
 Standards-Version: 3.9.6
 Homepage: https://github.com/KDAB/KDDockWidgets
 
-Package: kddockwidgets
+Package: qt5-kddockwidgets
 Architecture: any
 Depends: ${misc:Depends}, ${shlibs:Depends}
-Description: KDAB's Dock Widget Framework for Qt 
+Description: KDAB's Dock Widget Framework for Qt

distro/qt5-kddockwidgets.dsc

@@ -1,10 +1,10 @@
 Format: 1.0
 Source: kddockwidgets
-Version: 1.4.0-1
+Version: 1.5.0-1
 Binary: kddockwidgets
 Maintainer: Allen Winter <allen.winter@kdab.com>
 Architecture: any
-Build-Depends: debhelper (>=9), cdbs, cmake, qtbase5-dev, libqt5x11extras5-dev
+Build-Depends: debhelper (>=9), cdbs, cmake, qtbase5-dev, qtbase5-private-dev, libqt5x11extras5-dev, libfontconfig-dev,  libfreetype-dev
 
 Files:
- 00000000000000000000000000000000 00000 qt5-kddockwidgets-1.4.0.tar.gz
+ 00000000000000000000000000000000 00000 qt5-kddockwidgets-1.5.0.tar.gz

distro/qt5-kddockwidgets.spec

@@ -1,5 +1,5 @@
 Name:           qt5-kddockwidgets
-Version:        1.4.0
+Version:        1.5.0
 Release:        1
 Summary:        KDAB's Dock Widget Framework for Qt5
 Source0:        %{name}-%{version}.tar.gz
@@ -14,15 +14,15 @@ Packager:       Klaralvdalens Datakonsult AB (KDAB) <info@kdab.com>
 
 BuildRequires: cmake
 %if %{defined suse_version}
-BuildRequires:  libqt5-qtbase-devel libqt5-qtx11extras-devel
+BuildRequires:  libqt5-qtbase-devel libqt5-qtbase-private-headers-devel libqt5-qtx11extras-devel
 %endif
 
 %if %{defined fedora}
-BuildRequires:  gcc-c++ qt5-qtbase-devel qt5-qtx11extras-devel desktop-file-utils
+BuildRequires:  gcc-c++ qt5-qtbase-devel qt5-qtbase-private-devel qt5-qtx11extras-devel desktop-file-utils util-linux
 %endif
 
 %if %{defined rhel}
-BuildRequires:  gcc-c++ qt5-qtbase-devel qt5-qtx11extras-devel desktop-file-utils
+BuildRequires:  gcc-c++ qt5-qtbase-devel qt5-qtbase-private-devel qt5-qtx11extras-devel desktop-file-utils
 %endif
 
 %description
@@ -98,6 +98,8 @@ cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release
 %{_libdir}/libkddockwidgets.so
 
 %changelog
+* Mon Nov 24 2021 Allen Winter <allen.winter@kdab.com> 1.5.0
+  1.5.0 final
 * Fri Jul 16 2021 Allen Winter <allen.winter@kdab.com> 1.4.0
   1.4.0 final
 * Mon Jun 07 2021 Allen Winter <allen.winter@kdab.com> 1.3.1

distro/qt6-debian.control

@@ -0,0 +1,12 @@
+Source: kddockwidgets
+Section: Miscellaneous
+Priority: optional
+Maintainer: Allen Winter <allen.winter@kdab.com>
+Build-Depends: debhelper (>=9), cdbs, cmake
+Standards-Version: 3.9.6
+Homepage: https://github.com/KDAB/KDDockWidgets
+
+Package: qt6-kddockwidgets
+Architecture: any
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: KDAB's Dock Widget Framework for Qt

distro/qt6-kddockwidgets.dsc

@@ -1,10 +1,10 @@
 Format: 1.0
 Source: kddockwidgets
-Version: 1.4.0-1
+Version: 1.5.0-1
 Binary: kddockwidgets
 Maintainer: Allen Winter <allen.winter@kdab.com>
 Architecture: any
-Build-Depends: debhelper (>=9), cdbs, cmake, qtbase6-dev, libqt6x11extras5-dev
+Build-Depends: debhelper (>=9), cdbs, cmake, qt6-base-dev, qt6-base-private-dev, libgl1-mesa-dev, libfontconfig-dev, libfreetype-dev
 
 Files:
- 00000000000000000000000000000000 00000 qt6-kddockwidgets-1.4.0.tar.gz
+ 00000000000000000000000000000000 00000 qt6-kddockwidgets-1.5.0.tar.gz

distro/qt6-kddockwidgets.spec

@@ -1,5 +1,5 @@
 Name:           qt6-kddockwidgets
-Version:        1.4.0
+Version:        1.5.0
 Release:        1
 Summary:        KDAB's Dock Widget Framework for Qt6
 Source0:        %{name}-%{version}.tar.gz
@@ -14,15 +14,15 @@ Packager:       Klaralvdalens Datakonsult AB (KDAB) <info@kdab.com>
 
 BuildRequires: cmake
 %if %{defined suse_version}
-BuildRequires:  libqt6-qtbase-devel libqt6-qtx11extras-devel
+BuildRequires:  libqt6-qtbase-devel libqt6-qtbase-private-headers-devel libqt6-qtx11extras-devel
 %endif
 
 %if %{defined fedora}
-BuildRequires:  gcc-c++ qt6-qtbase-devel desktop-file-utils
+BuildRequires:  gcc-c++ qt6-qtbase-devel qt6-qtbase-private-devel desktop-file-utils libxkbcommon-devel
 %endif
 
 %if %{defined rhel}
-BuildRequires:  gcc-c++ qt6-qtbase-devel qt6-qtx11extras-devel desktop-file-utils
+BuildRequires:  gcc-c++ qt6-qtbase-devel qt6-qtbase-private-devel qt6-qtx11extras-devel desktop-file-utils libxkbcommon-devel
 %endif
 
 %description
@@ -87,6 +87,8 @@ cmake . -DCMAKE_INSTALL_PREFIX=/usr -DKDDockWidgets_QT6=True -DCMAKE_BUILD_TYPE=
 #%{_prefix}/mkspecs/modules/* ECMGeneratePriFile isn't ported to Qt6 yet
 
 %changelog
+* Mon Nov 24 2021 Allen Winter <allen.winter@kdab.com> 1.5.0
+  1.5.0 final
 * Fri Jul 16 2021 Allen Winter <allen.winter@kdab.com> 1.4.0
   1.4.0 final
 * Mon Jun 07 2021 Allen Winter <allen.winter@kdab.com> 1.3.1

docs/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Allen Winter <allen.winter@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -11,13 +11,14 @@
 
 # Doxygen
 find_package(Doxygen)
-set_package_properties(Doxygen PROPERTIES
+set_package_properties(
-  TYPE OPTIONAL
+    Doxygen PROPERTIES
-  DESCRIPTION "API Documentation system"
+    TYPE OPTIONAL
-  URL "https://www.doxygen.org"
+    DESCRIPTION "API Documentation system"
-  PURPOSE "Needed to build the API documentation."
+    URL "https://www.doxygen.org"
+    PURPOSE "Needed to build the API documentation."
 )
 
 if(DOXYGEN_FOUND)
-  add_subdirectory(api)
+    add_subdirectory(api)
 endif()

docs/api/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Allen Winter <allen.winter@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -11,61 +11,73 @@
 
 # dot should come with Doxygen find_package(Doxygen)
 if(DOXYGEN_DOT_EXECUTABLE)
-  set(HAVE_DOT "YES")
+    set(HAVE_DOT "YES")
 else()
-  set(HAVE_DOT "NO")
+    set(HAVE_DOT "NO")
-  message(STATUS "Unable to provide inheritance diagrams for the API documentation. To fix, install the graphviz project from https://www.graphviz.org")
+    message(STATUS "Unable to provide inheritance diagrams for the API documentation. "
+                   "To fix, install the graphviz project from https://www.graphviz.org"
+    )
 endif()
 
 # qhelpgenerator
-find_program(QHELPGEN_EXECUTABLE qhelpgenerator
+find_program(QHELPGEN_EXECUTABLE qhelpgenerator HINTS ${QT_INSTALL_BINS})
-  HINTS ${QT_INSTALL_BINS}
-)
 if(QHELPGEN_EXECUTABLE)
-  set(HAVE_QHELPGEN "YES")
+    set(HAVE_QHELPGEN "YES")
 else()
-  set(HAVE_QHELPGEN "NO")
+    set(HAVE_QHELPGEN "NO")
-  message(STATUS "Unable to generate the API documentation in qch format. To fix, install the qthelpgenerator program which comes with Qt.")
+    message(STATUS "Unable to generate the API documentation in qch format. "
+                   "To fix, install the qthelpgenerator program which comes with Qt."
+    )
 endif()
 
-find_file(QDOC_QTCORE_TAG qtcore.tags
+find_file(QDOC_QTCORE_TAG qtcore.tags HINTS ${QT_INSTALL_DOCS}/qtcore ${QT_INSTALL_DATA}/doc/qtcore)
-  HINTS ${QT_INSTALL_DOCS}/qtcore
-  HINTS ${QT_INSTALL_DATA}/doc/qtcore
-)
 set(QDOC_TAG_DIR "<QDOC_TAG_DIR_not_found>")
 if(QDOC_QTCORE_TAG)
-  get_filename_component(QDOC_TAG_DIR ${QDOC_QTCORE_TAG} DIRECTORY)
+    get_filename_component(QDOC_TAG_DIR ${QDOC_QTCORE_TAG} DIRECTORY)
-  get_filename_component(QDOC_TAG_DIR ${QDOC_TAG_DIR} DIRECTORY)
+    get_filename_component(QDOC_TAG_DIR ${QDOC_TAG_DIR} DIRECTORY)
 endif()
 
 file(GLOB _dox_deps *.dox *.html)
 set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
 #apidox generation using doxygen
-configure_file(
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
-  ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.cmake
-  ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
-)
 
 add_custom_command(
-  OUTPUT ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch
+    OUTPUT ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch
-  COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+    COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
-  #handle a bug in doxygen where image files referred to in markdown are not copied the output
+    #handle a bug in doxygen where image files referred to in markdown are not copied the output
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/../../screencap.gif ${DOXYGEN_OUTPUT_DIR}/html
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/../../screencap.gif
-  #copy some files by-hand that are referred to by the markdown README
+            ${DOXYGEN_OUTPUT_DIR}/html
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/README-bindings.md ${DOXYGEN_OUTPUT_DIR}/html
+    #copy some files by-hand that are referred to by the markdown README
-  COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/README-bindings.md ${DOXYGEN_OUTPUT_DIR}/html
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/GPL-2.0-only.txt ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/GPL-3.0-only.txt ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/GPL-2.0-only.txt
-  COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/docs
+            ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/docs/KDDockWidgets-CopyrightAssignmentForm.pdf ${DOXYGEN_OUTPUT_DIR}/html/docs
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/LICENSES/GPL-3.0-only.txt
-  COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/examples ${DOXYGEN_OUTPUT_DIR}/html/examples
+            ${DOXYGEN_OUTPUT_DIR}/html/LICENSES
-  DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}/html/docs
-  WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/docs/KDDockWidgets-CopyrightAssignmentForm.pdf
+            ${DOXYGEN_OUTPUT_DIR}/html/docs
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/examples ${DOXYGEN_OUTPUT_DIR}/html/examples
+    DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    COMMENT "Generate the .qch file"
+)
+add_custom_target(
+    kddockwidgets-api.qch ALL
+    DEPENDS ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch
+    COMMENT "Target generate the .qch file"
+)
+add_custom_target(
+    docs
+    DEPENDS kddockwidgets-api.qch
+    COMMENT "Target to generate the documentation"
 )
-add_custom_target(kddockwidgets-api.qch ALL DEPENDS ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch)
-add_custom_target(docs DEPENDS kddockwidgets-api.qch)
 
-set(QCH_INSTALL_DIR ${INSTALL_DOC_DIR} CACHE STRING "Install location of Qt Assistant help files.")
+set(QCH_INSTALL_DIR
+    ${INSTALL_DOC_DIR}
+    CACHE STRING "Install location of Qt Assistant help files."
+)
 install(FILES ${DOXYGEN_OUTPUT_DIR}/qch/kddockwidgets-api.qch DESTINATION ${QCH_INSTALL_DIR})
 install(FILES ${DOXYGEN_OUTPUT_DIR}/kddockwidgets.tags DESTINATION ${INSTALL_DOC_DIR})

docs/api/Doxyfile.cmake

@@ -1102,38 +1102,6 @@ USE_HTAGS              = NO
 
 VERBATIM_HEADERS       = YES
 
-# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
-# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
-# cost of reduced performance. This can be particularly helpful with template
-# rich C++ code for which doxygen's built-in parser lacks the necessary type
-# information.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-# The default value is: NO.
-
-CLANG_ASSISTED_PARSING = NO
-
-# If clang assisted parsing is enabled you can provide the compiler with command
-# line options that you would normally use when invoking the compiler. Note that
-# the include paths will already be set by doxygen for the files and directories
-# specified with INPUT and INCLUDE_PATH.
-# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
-
-CLANG_OPTIONS          =
-
-# If clang assisted parsing is enabled you can provide the clang parser with the
-# path to the directory containing a file called compile_commands.json. This
-# file is the compilation database (see:
-# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
-# options used when the source files were built. This is equivalent to
-# specifying the "-p" option to a clang tool, such as clang-check. These options
-# will then be passed to the parser. Any options specified with CLANG_OPTIONS
-# will be added as well.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-
-CLANG_DATABASE_PATH    =
-
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------

docs/api/footer.html

@@ -1,7 +1,7 @@
     <hr>
     <div style="float: left;">
       <img src="kdab-logo-16x16.png">
-      <font style="font-weight: bold;">&copy; 2019-2021 Klar&auml;lvdalens Datakonsult AB (KDAB)</font>
+      <font style="font-weight: bold;">&copy; 2019-2022 Klar&auml;lvdalens Datakonsult AB (KDAB)</font>
       <br>
       "The Qt, C++ and OpenGL Experts"<br>
       <a href="https://www.kdab.com/">https://www.kdab.com/</a>

examples/dockwidgets/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,23 +17,15 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
 set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/resources_example.qrc)
 
-add_executable(kddockwidgets_example
+add_executable(
-    main.cpp
+    kddockwidgets_example main.cpp MyFrameworkWidgetFactory.cpp MyMainWindow.cpp MyWidget.cpp ${RESOURCES_EXAMPLE_SRC}
-    MyFrameworkWidgetFactory.cpp
-    MyMainWindow.cpp
-    MyWidget.cpp
-    ${RESOURCES_EXAMPLE_SRC}
-)
-
-target_link_libraries(kddockwidgets_example
-  PRIVATE
-    KDAB::kddockwidgets
 )
 
+target_link_libraries(kddockwidgets_example PRIVATE KDAB::kddockwidgets)

examples/dockwidgets/MyFrameworkWidgetFactory.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -62,7 +62,7 @@ public:
         f.setPixelSize(30);
         f.setBold(true);
         p.setFont(f);
-        p.drawText(QPoint(10,40), title());
+        p.drawText(QPoint(10, 40), title());
     }
 };
 
@@ -88,19 +88,19 @@ public:
 
 MySeparator::~MySeparator() = default;
 
-KDDockWidgets::TitleBar * CustomWidgetFactory::createTitleBar(KDDockWidgets::Frame *frame) const
+KDDockWidgets::TitleBar *CustomWidgetFactory::createTitleBar(KDDockWidgets::Frame *frame) const
 {
     // Feel free to return MyTitleBar_CSS here instead, but just for education purposes!
     return new MyTitleBar(frame);
 }
 
-KDDockWidgets::TitleBar * CustomWidgetFactory::createTitleBar(KDDockWidgets::FloatingWindow *fw) const
+KDDockWidgets::TitleBar *CustomWidgetFactory::createTitleBar(KDDockWidgets::FloatingWindow *fw) const
 {
     // Feel free to return MyTitleBar_CSS here instead, but just for education purposes!
     return new MyTitleBar(fw);
 }
 
-Layouting::Separator * CustomWidgetFactory::createSeparator(Layouting::Widget *parent) const
+Layouting::Separator *CustomWidgetFactory::createSeparator(Layouting::Widget *parent) const
 {
     return new MySeparator(parent);
 }

examples/dockwidgets/MyFrameworkWidgetFactory.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/dockwidgets/MyMainWindow.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -47,6 +47,7 @@ static MyWidget *newMyWidget()
 MyMainWindow::MyMainWindow(const QString &uniqueName, KDDockWidgets::MainWindowOptions options,
                            bool dockWidget0IsNonClosable, bool nonDockableDockWidget9, bool restoreIsRelative,
                            bool maxSizeForDockWidget8, bool dockwidget5DoesntCloseBeforeRestore,
+                           bool dock0BlocksCloseEvent,
                            const QString &affinityName, QWidget *parent)
     : MainWindow(uniqueName, options, parent)
     , m_dockWidget0IsNonClosable(dockWidget0IsNonClosable)
@@ -54,6 +55,7 @@ MyMainWindow::MyMainWindow(const QString &uniqueName, KDDockWidgets::MainWindowO
     , m_restoreIsRelative(restoreIsRelative)
     , m_maxSizeForDockWidget8(maxSizeForDockWidget8)
     , m_dockwidget5DoesntCloseBeforeRestore(dockwidget5DoesntCloseBeforeRestore)
+    , m_dock0BlocksCloseEvent(dock0BlocksCloseEvent)
 {
     auto menubar = menuBar();
     auto fileMenu = new QMenu(QStringLiteral("File"), this);
@@ -190,6 +192,9 @@ KDDockWidgets::DockWidgetBase *MyMainWindow::newDockWidget()
         myWidget->setMaximumSize(200, 200);
     }
 
+    if (count == 0 && m_dock0BlocksCloseEvent)
+        myWidget->blockCloseEvent();
+
     dock->setWidget(myWidget);
 
     if (dock->options() & KDDockWidgets::DockWidget::Option_NotDockable) {

examples/dockwidgets/MyMainWindow.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -20,19 +20,20 @@ class MyMainWindow : public KDDockWidgets::MainWindow
 public:
     explicit MyMainWindow(const QString &uniqueName, KDDockWidgets::MainWindowOptions options,
                           bool dockWidget0IsNonClosable, bool nonDockableDockWidget9, bool restoreIsRelative,
-                          bool maxSizeForDockWidget8, bool dockwidget5DoesntCloseBeforeRestore,
+                          bool maxSizeForDockWidget8, bool dockwidget5DoesntCloseBeforeRestore, bool dock0BlocksCloseEvent,
                           const QString &affinityName = {}, // Usually not needed. Just here to show the feature.
                           QWidget *parent = nullptr);
     ~MyMainWindow() override;
 
 private:
     void createDockWidgets();
-    KDDockWidgets::DockWidgetBase* newDockWidget();
+    KDDockWidgets::DockWidgetBase *newDockWidget();
     QMenu *m_toggleMenu = nullptr;
     const bool m_dockWidget0IsNonClosable;
     const bool m_dockWidget9IsNonDockable;
     const bool m_restoreIsRelative;
     const bool m_maxSizeForDockWidget8;
     const bool m_dockwidget5DoesntCloseBeforeRestore;
+    const bool m_dock0BlocksCloseEvent;
     KDDockWidgets::DockWidget::List m_dockwidgets;
 };

examples/dockwidgets/MyTitleBar_CSS.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -9,13 +9,18 @@
   Contact KDAB at <info@kdab.com> for commercial licensing options.
 */
 
+#ifndef EXAMPLETITLEBAR_CSS_H
+#define EXAMPLETITLEBAR_CSS_H
+
+#pragma once
+
 #include <kddockwidgets/private/widgets/TitleBarWidget_p.h>
 
 /**
  * @brief Shows how to implement a custom titlebar which uses "Qt StyleSheets".
- * 
+ *
  * Derive from KDDockWidgets::DefaultWidgetFactory and override the two createTitleBar() methods.
- * 
+ *
  * To try it out, modify examples/dockwidgets/MyFrameworkWidgetFactory.cpp to return a MyTitleBar_CSS instance.
  * Run the example with: ./bin/kddockwidgets_example -p
  *
@@ -77,3 +82,5 @@ public:
 MyTitleBar_CSS::~MyTitleBar_CSS()
 {
 }
+
+#endif

examples/dockwidgets/MyWidget.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -15,6 +15,7 @@
 #include <QDebug>
 #include <QFile>
 #include <QLineEdit>
+#include <QCloseEvent>
 
 static QHash<QString, QImage> s_images; /// clazy:exclude=non-pod-global-static
 
@@ -65,11 +66,25 @@ void MyWidget::drawLogo(QPainter &p)
                                                   : int(maxHeight / ratio);
 
     const int height = int(width * ratio);
-    QRect targetLogoRect(0,0, width, height);
+    QRect targetLogoRect(0, 0, width, height);
     targetLogoRect.moveCenter(rect().center() + QPoint(0, -int(size().height() * 0.00)));
     p.drawImage(targetLogoRect, m_logo, m_logo.rect());
 }
 
+void MyWidget::blockCloseEvent()
+{
+    m_blocksCloseEvent = true;
+}
+
+void MyWidget::closeEvent(QCloseEvent *ev)
+{
+    if (m_blocksCloseEvent) {
+        ev->ignore();
+    } else {
+        QWidget::closeEvent(ev);
+    }
+}
+
 MyWidget1::MyWidget1(MyWidget::QWidget *parent)
     : MyWidget(QStringLiteral(":/assets/triangles.png"), QStringLiteral(":/assets/KDAB_bubble_white.png"), parent)
 {

examples/dockwidgets/MyWidget.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -26,10 +26,16 @@ class MyWidget : public QWidget
 public:
     explicit MyWidget(const QString &backgroundFile, const QString &logoFile, QWidget *parent = nullptr);
     ~MyWidget();
+
+    // These two are just for demonstrating how to block the close event, if desired
+    void blockCloseEvent();
+    void closeEvent(QCloseEvent *) override;
+
 protected:
     void drawLogo(QPainter &);
     QImage m_background;
     QImage m_logo;
+    bool m_blocksCloseEvent = false;
 };
 
 class MyWidget1 : public MyWidget
@@ -37,8 +43,9 @@ class MyWidget1 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget1(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
 };
 
 class MyWidget2 : public MyWidget
@@ -46,8 +53,9 @@ class MyWidget2 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget2(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
 };
 
 class MyWidget3 : public MyWidget
@@ -55,8 +63,9 @@ class MyWidget3 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget3(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
     QImage m_triangle;
 };
 

examples/dockwidgets/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -13,12 +13,14 @@
 #include "MyMainWindow.h"
 #include "MyFrameworkWidgetFactory.h"
 
+#include <algorithm>
 #include <kddockwidgets/Config.h>
 
 #include <QStyleFactory>
 #include <QApplication>
 #include <QDebug>
 #include <QCommandLineParser>
+#include <qnamespace.h>
 
 // clazy:excludeall=qstring-allocations
 
@@ -115,10 +117,14 @@ int main(int argc, char **argv)
                                            QCoreApplication::translate("main", "The title bar's close button will only close the current tab instead of all. Illustrates using Config::Flag_CloseOnlyCurrentTab"));
     parser.addOption(closeOnlyCurrentTab);
 
-    QCommandLineOption dontCloseBeforeRestore("dont-close-widget-before-restore", //krazy:exclude=spelling
+    QCommandLineOption dontCloseBeforeRestore("dont-close-widget-before-restore", // krazy:exclude=spelling
                                               QCoreApplication::translate("main", "DockWidget #5 won't be closed before a restore. Illustrates LayoutSaverOption::DontCloseBeforeRestore"));
     parser.addOption(dontCloseBeforeRestore);
 
+    QCommandLineOption blockCloseEvent("block-close-event",
+                                       QCoreApplication::translate("main", "DockWidget #0 will block close events"));
+    parser.addOption(blockCloseEvent);
+
     QCommandLineOption showButtonsInTabBarIfTitleBarHidden("show-buttons-in-tabbar-if-titlebar-hidden",
                                                            QCoreApplication::translate("main", "If we're not using title bars we'll still show the close and float button in the tab bar"));
     parser.addOption(showButtonsInTabBarIfTitleBarHidden);
@@ -131,6 +137,14 @@ int main(int argc, char **argv)
                                       QCoreApplication::translate("main", "Allow switching tabs via context menu in tabs area"));
     parser.addOption(ctxtMenuOnTabs);
 
+    QCommandLineOption hideCertainDockingIndicators("hide-certain-docking-indicators",
+                                                    QCoreApplication::translate("main", "Illustrates usage of Config::setDropIndicatorAllowedFunc()"));
+    parser.addOption(hideCertainDockingIndicators);
+
+    QCommandLineOption requireControlKey("require-control-key",
+                                         QCoreApplication::translate("main", "The user will have to hold the ctrl key to see drop indicators while dragging"));
+    parser.addOption(requireControlKey);
+
 #if defined(DOCKS_DEVELOPER_MODE)
     parser.addOption(centralFrame);
 
@@ -144,10 +158,10 @@ int main(int argc, char **argv)
     parser.addOption(nativeTitleBar);
     parser.addOption(noDropIndicators);
 
-# if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN)
     QCommandLineOption noAeroSnap("no-aero-snap", QCoreApplication::translate("main", "(internal) Disable AeroSnap"));
     parser.addOption(noAeroSnap);
-# endif
+#endif
 #else
     Q_UNUSED(centralFrame)
 #endif
@@ -190,10 +204,10 @@ int main(int argc, char **argv)
     if (parser.isSet(noDropIndicators))
         KDDockWidgets::DefaultWidgetFactory::s_dropIndicatorType = KDDockWidgets::DropIndicatorType::None;
 
-# if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN)
     if (parser.isSet(noAeroSnap))
         internalFlags |= KDDockWidgets::Config::InternalFlag_NoAeroSnap;
-# endif
+#endif
     Config::self().setInternalFlags(internalFlags);
 #endif
 
@@ -253,14 +267,45 @@ int main(int argc, char **argv)
         return 1;
     }
 
+    if (parser.isSet(hideCertainDockingIndicators)) {
+        // Here we exemplify adding a restriction to "Dock Widget 8"
+        // Dock widget 8 will only be allowed to dock to the outer areasa
+        auto func = [](KDDockWidgets::DropLocation location,
+                       const KDDockWidgets::DockWidgetBase::List &source,
+                       const KDDockWidgets::DockWidgetBase::List &target,
+                       KDDockWidgets::DropArea *) {
+            Q_UNUSED(target); // When dragging into a tab, 'target' would have the list of already tabbed dock widgets
+
+            const bool isDraggingDW8 = std::find_if(source.cbegin(), source.cend(), [](KDDockWidgets::DockWidgetBase *dw) {
+                                           return dw->uniqueName() == QLatin1String("DockWidget #8");
+                                       })
+                != source.cend();
+
+            return (location & KDDockWidgets::DropLocation_Outter) || !isDraggingDW8;
+        };
+
+        KDDockWidgets::Config::self().setDropIndicatorAllowedFunc(func);
+    } else if (parser.isSet(requireControlKey)) {
+        auto func = [](KDDockWidgets::DropLocation,
+                       const KDDockWidgets::DockWidgetBase::List &,
+                       const KDDockWidgets::DockWidgetBase::List &,
+                       KDDockWidgets::DropArea *) -> bool {
+            return qApp->keyboardModifiers() & Qt::ControlModifier;
+        };
+
+        KDDockWidgets::Config::self().setDropIndicatorAllowedFunc(func);
+    }
+
     KDDockWidgets::Config::self().setFlags(flags);
 
+
     const bool nonClosableDockWidget0 = parser.isSet(nonClosableDockWidget);
     const bool restoreIsRelative = parser.isSet(relativeRestore);
     const bool nonDockableDockWidget9 = parser.isSet(nonDockable);
     const bool maxSizeForDockWidget8 = parser.isSet(maxSizeOption);
     const bool dontCloseDockWidget5BeforeRestore = parser.isSet(dontCloseBeforeRestore);
     const bool usesMainWindowsWithAffinity = parser.isSet(multipleMainWindows);
+    const bool dock0BlocksCloseEvent = parser.isSet(blockCloseEvent);
 
 #ifdef KDDOCKWIDGETS_SUPPORTS_NESTED_MAINWINDOWS
     const bool usesDockableMainWindows = parser.isSet(dockableMainWindows);
@@ -270,7 +315,7 @@ int main(int argc, char **argv)
 
     MyMainWindow mainWindow(QStringLiteral("MyMainWindow"), options, nonClosableDockWidget0,
                             nonDockableDockWidget9, restoreIsRelative, maxSizeForDockWidget8,
-                            dontCloseDockWidget5BeforeRestore);
+                            dontCloseDockWidget5BeforeRestore, dock0BlocksCloseEvent);
     mainWindow.setWindowTitle("Main Window 1");
     mainWindow.resize(1200, 1200);
     mainWindow.show();
@@ -289,7 +334,7 @@ int main(int argc, char **argv)
         auto mainWindow2 = new MyMainWindow(QStringLiteral("MyMainWindow-2"), options,
                                             nonClosableDockWidget0, nonDockableDockWidget9,
                                             restoreIsRelative, maxSizeForDockWidget8,
-                                            dontCloseDockWidget5BeforeRestore, affinity);
+                                            dontCloseDockWidget5BeforeRestore, dock0BlocksCloseEvent, affinity);
         if (affinity.isEmpty())
             mainWindow2->setWindowTitle("Main Window 2");
         else
@@ -303,7 +348,7 @@ int main(int argc, char **argv)
         const QString affinity = QStringLiteral("Inner-DockWidgets-2");
         auto dockableMainWindow = new MyMainWindow(QStringLiteral("MyMainWindow-2"), options,
                                                    false, false, restoreIsRelative, false,
-                                                   false, affinity);
+                                                   false, false, affinity);
 
         dockableMainWindow->setAffinities({ affinity });
 

examples/mdi_with_docking/CMakeLists.txt

@@ -0,0 +1,32 @@
+#
+# This file is part of KDDockWidgets.
+#
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# Author: Sergio Martins <sergio.martins@kdab.com>
+#
+# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
+#
+# Contact KDAB at <info@kdab.com> for commercial licensing options.
+#
+
+cmake_minimum_required(VERSION 3.7)
+project(kddockwidgets_mdi_with_docking_example)
+
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_AUTORCC ON)
+set(CMAKE_INCLUDE_CURRENT_DIRS ON)
+
+if(NOT TARGET kddockwidgets)
+    # This will look for Qt, do find_package yourself manually before
+    # if you want to look for a specific Qt version for instance.
+    find_package(KDDockWidgets REQUIRED)
+endif()
+
+set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/../dockwidgets/resources_example.qrc)
+
+# Just to reuse MyWidget.h
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../dockwidgets/)
+
+add_executable(kddockwidgets_mdi_with_docking_example main.cpp ../dockwidgets/MyWidget.cpp ${RESOURCES_EXAMPLE_SRC})
+
+target_link_libraries(kddockwidgets_mdi_with_docking_example PRIVATE KDAB::kddockwidgets)

examples/mdi_with_docking/main.cpp

@@ -0,0 +1,95 @@
+/*
+  This file is part of KDDockWidgets.
+
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  Author: Sérgio Martins <sergio.martins@kdab.com>
+
+  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
+
+  Contact KDAB at <info@kdab.com> for commercial licensing options.
+*/
+
+#include "MyWidget.h"
+
+#include <kddockwidgets/DockWidget.h>
+#include <kddockwidgets/MainWindow.h>
+#include <kddockwidgets/MDIArea.h>
+
+#include <QStyleFactory>
+#include <QApplication>
+#include <QCommandLineParser>
+
+// clazy:excludeall=qstring-allocations
+
+int main(int argc, char **argv)
+{
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+    QApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
+    QApplication::setAttribute(Qt::AA_UseHighDpiPixmaps);
+#endif
+    QApplication app(argc, argv);
+
+    app.setOrganizationName(QStringLiteral("KDAB"));
+    app.setApplicationName(QStringLiteral("App supporting both docking and a MDI area"));
+
+    QCommandLineParser parser;
+    parser.setApplicationDescription("KDDockWidgets MDI mixed with normal docking");
+    parser.addHelpOption();
+
+    QCommandLineOption nestedDocking("n", QCoreApplication::translate("main", "The MDI dock widgets will serve as drop areas, allowing for further nesting"));
+    parser.addOption(nestedDocking);
+
+    parser.process(app);
+
+    // Fusion looks better in general, but feel free to change
+    qApp->setStyle(QStyleFactory::create(QStringLiteral("Fusion")));
+
+    // # 1. Create our main window
+
+    KDDockWidgets::MainWindow mainWindow(QStringLiteral("MyMainWindow"), KDDockWidgets::MainWindowOption_HasCentralWidget);
+    mainWindow.setWindowTitle("Main Window");
+    mainWindow.resize(1600, 1200);
+    mainWindow.show();
+
+    // # 2. Create a dock widget, it needs a unique name
+    auto dock1 = new KDDockWidgets::DockWidget(QStringLiteral("MyDock1"));
+    auto widget1 = new MyWidget1();
+    dock1->setWidget(widget1);
+
+    auto dock2 = new KDDockWidgets::DockWidget(QStringLiteral("MyDock2"));
+    auto widget2 = new MyWidget2();
+    dock2->setWidget(widget2);
+
+    // # 3. Dock them
+    mainWindow.addDockWidget(dock1, KDDockWidgets::Location_OnLeft, nullptr, KDDockWidgets::InitialOption(QSize(300, 0)));
+    mainWindow.addDockWidget(dock2, KDDockWidgets::Location_OnBottom, nullptr, KDDockWidgets::InitialOption(QSize(0, 300)));
+
+    KDDockWidgets::DockWidgetBase::Options options = {};
+    if (parser.isSet(nestedDocking)) {
+        options |= KDDockWidgets::DockWidgetBase::Option_MDINestable;
+    }
+
+    // 4. Create our MDI widgets, which will go into the MDI area
+    auto mdiWidget1 = new KDDockWidgets::DockWidget(QStringLiteral("MDI widget1"), options);
+    mdiWidget1->setWidget(new MyWidget1());
+
+    auto mdiWidget2 = new KDDockWidgets::DockWidget(QStringLiteral("MDI widget2"), options);
+    mdiWidget2->setWidget(new MyWidget2());
+
+    auto mdiWidget3 = new KDDockWidgets::DockWidget(QStringLiteral("MDI widget3"), options);
+    auto widget3 = new MyWidget3();
+    mdiWidget3->setWidget(widget3);
+
+    // Just for my personal testing: Overkill to add an option
+    // widget3->blockCloseEvent();
+
+    auto mdiArea = new KDDockWidgets::MDIArea();
+    mainWindow.setPersistentCentralWidget(mdiArea);
+
+    mdiArea->addDockWidget(mdiWidget1, QPoint(10, 10));
+    mdiArea->addDockWidget(mdiWidget2, QPoint(50, 50));
+    mdiArea->addDockWidget(mdiWidget3, QPoint(110, 110));
+
+
+    return app.exec();
+}

examples/minimal-mdi/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,21 +17,16 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
 set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/../dockwidgets/resources_example.qrc)
 
-add_executable(kddockwidgets_minimal_mdi_example
+# Just to reuse MyWidget.h
-    main.cpp
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../dockwidgets/)
-    ../dockwidgets/MyWidget.cpp
-    ${RESOURCES_EXAMPLE_SRC}
-)
 
-target_link_libraries(kddockwidgets_minimal_mdi_example
+add_executable(kddockwidgets_minimal_mdi_example main.cpp ../dockwidgets/MyWidget.cpp ${RESOURCES_EXAMPLE_SRC})
-  PRIVATE
-    KDAB::kddockwidgets
-)
 
+target_link_libraries(kddockwidgets_minimal_mdi_example PRIVATE KDAB::kddockwidgets)

examples/minimal-mdi/MyWidget.cpp

@@ -1,116 +0,0 @@
-/*
-  This file is part of KDDockWidgets.
-
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
-  Author: Sérgio Martins <sergio.martins@kdab.com>
-
-  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
-
-  Contact KDAB at <info@kdab.com> for commercial licensing options.
-*/
-
-#include "MyWidget.h"
-
-#include <QPainter>
-#include <QDebug>
-#include <QFile>
-#include <QLineEdit>
-
-static QHash<QString, QImage> s_images; /// clazy:exclude=non-pod-global-static
-
-MyWidget::MyWidget(const QString &backgroundFile, const QString &logoFile, QWidget *parent)
-    : QWidget(parent)
-{
-    if (!backgroundFile.isEmpty()) {
-        auto it = s_images.find(backgroundFile);
-        if (it == s_images.end())
-            it = s_images.insert(backgroundFile, QImage(backgroundFile));
-        m_background = it.value();
-    }
-
-    if (!logoFile.isEmpty()) {
-        auto it = s_images.find(logoFile);
-        if (it == s_images.end())
-            it = s_images.insert(logoFile, QImage(logoFile));
-        m_logo = it.value();
-    }
-
-    setFocusPolicy(Qt::StrongFocus);
-#if 0
-    // Uncomment to show focus propagation working
-    new QLineEdit(this);
-    auto l2 = new QLineEdit(this);
-    l2->move(0, 100);
-    setFocusProxy(l2);
-#endif
-}
-
-MyWidget::~MyWidget()
-{
-}
-
-void MyWidget::drawLogo(QPainter &p)
-{
-    if (m_logo.isNull())
-        return;
-
-    const qreal ratio = m_logo.height() / (m_logo.width() * 1.0);
-
-    const int maxWidth = int(0.80 * size().width());
-    const int maxHeight = int(0.80 * size().height());
-
-    const int proposedHeight = int(maxWidth * ratio);
-
-    const int width = proposedHeight <= maxHeight ? maxWidth
-                                                  : int(maxHeight / ratio);
-
-    const int height = int(width * ratio);
-    QRect targetLogoRect(0,0, width, height);
-    targetLogoRect.moveCenter(rect().center() + QPoint(0, -int(size().height() * 0.00)));
-    p.drawImage(targetLogoRect, m_logo, m_logo.rect());
-}
-
-MyWidget1::MyWidget1(MyWidget::QWidget *parent)
-    : MyWidget(QStringLiteral(":/assets/triangles.png"), QStringLiteral(":/assets/KDAB_bubble_white.png"), parent)
-{
-}
-
-void MyWidget1::paintEvent(QPaintEvent *)
-{
-    QPainter p(this);
-    p.fillRect(rect(), QColor(0xCC, 0xCC, 0xCC));
-    p.drawImage(m_background.rect(), m_background, m_background.rect());
-
-    drawLogo(p);
-}
-
-MyWidget2::MyWidget2(MyWidget::QWidget *parent)
-    : MyWidget(QString(), QStringLiteral(":/assets/KDAB_bubble_blue.png"), parent)
-{
-}
-
-void MyWidget2::paintEvent(QPaintEvent *)
-{
-    QPainter p(this);
-    p.fillRect(rect(), Qt::white);
-    drawLogo(p);
-}
-
-MyWidget3::MyWidget3(MyWidget::QWidget *parent)
-    : MyWidget(QStringLiteral(":/assets/base.png"), QStringLiteral(":/assets/KDAB_bubble_fulcolor.png"), parent)
-    , m_triangle(QImage(QStringLiteral(":/assets/tri.png")))
-{
-}
-
-void MyWidget3::paintEvent(QPaintEvent *)
-{
-    QPainter p(this);
-    p.fillRect(rect(), QColor(0xD5, 0xD5, 0xD5));
-
-    p.drawImage(m_background.rect(), m_background, m_background.rect());
-
-    const QRect targetRect = QRect({ width() - m_triangle.width(), height() - m_triangle.height() }, m_triangle.size());
-
-    p.drawImage(targetRect, m_triangle, m_triangle.rect());
-    drawLogo(p);
-}

examples/minimal-mdi/MyWidget.h

@@ -1,65 +0,0 @@
-/*
-  This file is part of KDDockWidgets.
-
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
-  Author: Sérgio Martins <sergio.martins@kdab.com>
-
-  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
-
-  Contact KDAB at <info@kdab.com> for commercial licensing options.
-*/
-
-#ifndef EXAMPLEDOCKABLEWIDGET_H
-#define EXAMPLEDOCKABLEWIDGET_H
-
-#pragma once
-
-#include <QWidget>
-
-QT_BEGIN_NAMESPACE
-class QPainter;
-QT_END_NAMESPACE
-
-class MyWidget : public QWidget
-{
-    Q_OBJECT
-public:
-    MyWidget() = default;
-    explicit MyWidget(const QString &backgroundFile, const QString &logoFile, QWidget *parent = nullptr);
-    ~MyWidget();
-protected:
-    void drawLogo(QPainter &);
-    QImage m_background;
-    QImage m_logo;
-};
-
-class MyWidget1 : public MyWidget
-{
-    Q_OBJECT
-public:
-    explicit MyWidget1(QWidget *parent = nullptr);
-protected:
-    void paintEvent(QPaintEvent*) override;
-};
-
-class MyWidget2 : public MyWidget
-{
-    Q_OBJECT
-public:
-    explicit MyWidget2(QWidget *parent = nullptr);
-protected:
-    void paintEvent(QPaintEvent*) override;
-};
-
-class MyWidget3 : public MyWidget
-{
-    Q_OBJECT
-public:
-    explicit MyWidget3(QWidget *parent = nullptr);
-protected:
-    void paintEvent(QPaintEvent*) override;
-    QImage m_triangle;
-};
-
-
-#endif

examples/minimal-mdi/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -53,6 +53,9 @@ int main(int argc, char **argv)
     auto widget3 = new MyWidget3();
     dock3->setWidget(widget3);
 
+    // Just for my personal testing: Overkill to add an option
+    // widget3->blockCloseEvent();
+
     // # 3. Dock them
     mainWindow.addDockWidget(dock1, QPoint(10, 10));
     mainWindow.addDockWidget(dock2, QPoint(50, 50));

examples/minimal/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,21 +17,13 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
 set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/../dockwidgets/resources_example.qrc)
 
-add_executable(kddockwidgets_minimal_example
+add_executable(kddockwidgets_minimal_example main.cpp ../dockwidgets/MyWidget.cpp ${RESOURCES_EXAMPLE_SRC})
-    main.cpp
-    ../dockwidgets/MyWidget.cpp
-    ${RESOURCES_EXAMPLE_SRC}
-)
-
-target_link_libraries(kddockwidgets_minimal_example
-  PRIVATE
-    KDAB::kddockwidgets
-)
 
+target_link_libraries(kddockwidgets_minimal_example PRIVATE KDAB::kddockwidgets)

examples/minimal/MyWidget.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -65,7 +65,7 @@ void MyWidget::drawLogo(QPainter &p)
                                                   : int(maxHeight / ratio);
 
     const int height = int(width * ratio);
-    QRect targetLogoRect(0,0, width, height);
+    QRect targetLogoRect(0, 0, width, height);
     targetLogoRect.moveCenter(rect().center() + QPoint(0, -int(size().height() * 0.00)));
     p.drawImage(targetLogoRect, m_logo, m_logo.rect());
 }

examples/minimal/MyWidget.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -27,6 +27,7 @@ public:
     MyWidget() = default;
     explicit MyWidget(const QString &backgroundFile, const QString &logoFile, QWidget *parent = nullptr);
     ~MyWidget();
+
 protected:
     void drawLogo(QPainter &);
     QImage m_background;
@@ -38,8 +39,9 @@ class MyWidget1 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget1(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
 };
 
 class MyWidget2 : public MyWidget
@@ -47,8 +49,9 @@ class MyWidget2 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget2(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
 };
 
 class MyWidget3 : public MyWidget
@@ -56,8 +59,9 @@ class MyWidget3 : public MyWidget
     Q_OBJECT
 public:
     explicit MyWidget3(QWidget *parent = nullptr);
+
 protected:
-    void paintEvent(QPaintEvent*) override;
+    void paintEvent(QPaintEvent *) override;
     QImage m_triangle;
 };
 

examples/minimal/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sérgio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -75,7 +75,7 @@ int main(int argc, char **argv)
     mainWindow.addDockWidget(dock3, KDDockWidgets::Location_OnRight, dock2);
 
     // 5. dock4 is docked at the bottom, with 200px height
-    const QSize preferredSize(QSize(/*ignored*/0, 200));
+    const QSize preferredSize(QSize(/*ignored*/ 0, 200));
     mainWindow.addDockWidget(dock4, KDDockWidgets::Location_OnBottom, nullptr, preferredSize);
 
 

examples/qtquick/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,21 +17,15 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
-set(RESOURCES_EXAMPLE_SRC
+set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_example.qrc
+                          ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc)
-
-add_executable(kddockwidgets_customtitlebar_quick
-    main.cpp
-    ${RESOURCES_EXAMPLE_SRC}
 )
 
-target_link_libraries(kddockwidgets_customtitlebar_quick
+add_executable(kddockwidgets_customtitlebar_quick main.cpp ${RESOURCES_EXAMPLE_SRC})
-  PRIVATE
+
-    KDAB::kddockwidgets
+target_link_libraries(kddockwidgets_customtitlebar_quick PRIVATE KDAB::kddockwidgets)
-)

examples/qtquick/customtitlebar/Guest.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/Guest1.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/Guest2.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/Guest3.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/MyTitleBar.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/customtitlebar/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -22,7 +22,6 @@
 class CustomFrameworkWidgetFactory : public KDDockWidgets::DefaultWidgetFactory
 {
 public:
-
     ~CustomFrameworkWidgetFactory() override;
 
     QUrl titleBarFilename() const override

examples/qtquick/customtitlebar/main.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/Another.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,21 +17,15 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
-set(RESOURCES_EXAMPLE_SRC
+set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_example.qrc
+                          ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc)
-
-add_executable(kddockwidgets_example_quick
-    main.cpp
-    ${RESOURCES_EXAMPLE_SRC}
 )
 
-target_link_libraries(kddockwidgets_example_quick
+add_executable(kddockwidgets_example_quick main.cpp ${RESOURCES_EXAMPLE_SRC})
-  PRIVATE
+
-    KDAB::kddockwidgets
+target_link_libraries(kddockwidgets_example_quick PRIVATE KDAB::kddockwidgets)
-)

examples/qtquick/dockwidgets/Guest.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/Guest1.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/Guest2.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/Guest3.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/dockwidgets/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -45,10 +45,10 @@ int main(int argc, char *argv[])
     parser.addOption(nativeTitleBar);
     parser.addOption(noDropIndicators);
 
-# if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN)
     QCommandLineOption noAeroSnap("no-aero-snap", QCoreApplication::translate("main", "(internal) Disable AeroSnap"));
     parser.addOption(noAeroSnap);
-# endif
+#endif
 #endif
 
     auto flags = KDDockWidgets::Config::self().flags();
@@ -68,10 +68,10 @@ int main(int argc, char *argv[])
     else if (parser.isSet(noDropIndicators))
         KDDockWidgets::DefaultWidgetFactory::s_dropIndicatorType = KDDockWidgets::DropIndicatorType::None;
 
-# if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN)
     if (parser.isSet(noAeroSnap))
         internalFlags |= KDDockWidgets::Config::InternalFlag_NoAeroSnap;
-# endif
+#endif
 
     // These are debug-only/development flags, which you can ignore.
     KDDockWidgets::Config::self().setInternalFlags(internalFlags);

examples/qtquick/dockwidgets/main.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/Another.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2019-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Sergio Martins <sergio.martins@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -17,21 +17,15 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 if(NOT TARGET kddockwidgets)
-  # This will look for Qt, do find_package yourself manually before
+    # This will look for Qt, do find_package yourself manually before
-  # if you want to look for a specific Qt version for instance.
+    # if you want to look for a specific Qt version for instance.
-  find_package(KDDockWidgets REQUIRED)
+    find_package(KDDockWidgets REQUIRED)
 endif()
 
-set(RESOURCES_EXAMPLE_SRC
+set(RESOURCES_EXAMPLE_SRC ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_mdi_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/resources_qtquick_mdi_example.qrc
+                          ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../dockwidgets/resources_example.qrc)
-
-add_executable(kddockwidgets_example_mdi_quick
-    main.cpp
-    ${RESOURCES_EXAMPLE_SRC}
 )
 
-target_link_libraries(kddockwidgets_example_mdi_quick
+add_executable(kddockwidgets_example_mdi_quick main.cpp ${RESOURCES_EXAMPLE_SRC})
-  PRIVATE
+
-    KDAB::kddockwidgets
+target_link_libraries(kddockwidgets_example_mdi_quick PRIVATE KDAB::kddockwidgets)
-)

examples/qtquick/mdi/Guest.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/Guest1.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/Guest2.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/Guest3.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

examples/qtquick/mdi/main.cpp

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -48,7 +48,7 @@ int main(int argc, char *argv[])
     auto dw3 = new KDDockWidgets::DockWidgetQuick("Dock #3");
     dw3->setWidget(QStringLiteral("qrc:/Guest3.qml"));
 
-    auto mainWindow = static_cast<KDDockWidgets::MainWindowMDI*>(KDDockWidgets::DockRegistry::self()->mainwindows().constFirst());
+    auto mainWindow = static_cast<KDDockWidgets::MainWindowMDI *>(KDDockWidgets::DockRegistry::self()->mainwindows().constFirst());
 
     mainWindow->addDockWidget(dw1, QPoint(10, 10));
     mainWindow->addDockWidget(dw2, QPoint(50, 50));

examples/qtquick/mdi/main.qml

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Sergio Martins <sergio.martins@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only

python/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -12,19 +12,19 @@ set(PYTHON_BINDING_NAMESPACE "PyKDDockWidgets")
 
 # Just to fix warnings with --warn-uninitialized
 if(NOT DEFINED SHIBOKEN_CUSTOM_PREFIX) #look for shiboken in a custom location
-  set(SHIBOKEN_CUSTOM_PREFIX "")
+    set(SHIBOKEN_CUSTOM_PREFIX "")
 endif()
 if(NOT DEFINED PYSIDE_CUSTOM_PREFIX) #look for pyside in a custom location
-  set(PYSIDE_CUSTOM_PREFIX "")
+    set(PYSIDE_CUSTOM_PREFIX "")
 endif()
 
 if(${PROJECT_NAME}_QT6)
-  set(PYSIDE_MAJOR_VERSION "6")
+    set(PYSIDE_MAJOR_VERSION "6")
-  set(PYTHON_BINDING_NAMESPACE "${PYTHON_BINDING_NAMESPACE}Qt${PYSIDE_MAJOR_VERSION}")
+    set(PYTHON_BINDING_NAMESPACE "${PYTHON_BINDING_NAMESPACE}Qt${PYSIDE_MAJOR_VERSION}")
-  set(QtWidgets_VERSION ${Qt6Widgets_VERSION})
+    set(QtWidgets_VERSION ${Qt6Widgets_VERSION})
 else()
-  set(PYSIDE_MAJOR_VERSION "2")
+    set(PYSIDE_MAJOR_VERSION "2")
-  set(QtWidgets_VERSION ${Qt5Widgets_VERSION})
+    set(QtWidgets_VERSION ${Qt5Widgets_VERSION})
 endif()
 
 find_package(Python3 3.7 REQUIRED COMPONENTS Interpreter Development)
@@ -32,11 +32,14 @@ find_package(Shiboken${PYSIDE_MAJOR_VERSION} REQUIRED)
 find_package(PySide${PYSIDE_MAJOR_VERSION} ${QtWidgets_VERSION} EXACT REQUIRED)
 
 if(NOT ${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX)
-  set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
+    set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
 endif()
-set(BINDINGS_DIR "${INSTALL_LIBRARY_DIR}/python${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR}/site-packages/${PYTHON_BINDING_NAMESPACE}")
+set(Python3_VERSION_MAJORMINOR "${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR}")
+set(BINDINGS_DIR "${INSTALL_LIBRARY_DIR}/python${Python3_VERSION_MAJORMINOR}/site-packages/${PYTHON_BINDING_NAMESPACE}")
 set(${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX "${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}/${BINDINGS_DIR}")
 
 include(PySide${PYSIDE_MAJOR_VERSION}ModuleBuild)
 add_subdirectory(PyKDDockWidgets)
-add_subdirectory(tests)
+if(${PROJECT_NAME}_TESTS)
+    add_subdirectory(tests)
+endif()

python/PyKDDockWidgets/CMakeLists.txt

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -35,65 +35,47 @@ set(PyKDDockWidgets_include_paths
 )
 
 # A list of paths where shiboken should look for typesystem
-set(PyKDDockWidgets_typesystem_paths
+set(PyKDDockWidgets_typesystem_paths # PySide path, this variable was exposed by FindPySide2.cmake
-    # PySide path, this variable was exposed by FindPySide2.cmake
     ${PYSIDE_TYPESYSTEMS}
 )
 
 # Include flags/path that will be set in 'target_include_directories'
-set(PyKDDockWidgets_target_include_directories
+set(PyKDDockWidgets_target_include_directories ${CMAKE_SOURCE_DIR}/src)
-    ${CMAKE_SOURCE_DIR}/src
-)
 
 # Libraries that will be necessary to link the target, this will used in the command 'target_link_libraries'
-set(PyKDDockWidgets_target_link_libraries
+set(PyKDDockWidgets_target_link_libraries KDAB::kddockwidgets Qt${Qt_VERSION_MAJOR}::Core Qt${Qt_VERSION_MAJOR}::Gui
-    KDAB::kddockwidgets
+                                          Qt${Qt_VERSION_MAJOR}::Widgets ${Python3_LIBRARIES}
-    Qt${Qt_VERSION_MAJOR}::Core
-    Qt${Qt_VERSION_MAJOR}::Gui
-    Qt${Qt_VERSION_MAJOR}::Widgets
-    ${Python3_LIBRARIES}
 )
 
 # changes on these files should trigger a new generation
 set(PyKDDockWidgets_DEPENDS
-    ${CMAKE_CURRENT_SOURCE_DIR}/kddockwidgets_global.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/kddockwidgets_global.h ${CMAKE_SOURCE_DIR}/src/DockWidgetBase.h
-    ${CMAKE_SOURCE_DIR}/src/DockWidgetBase.h
+    ${CMAKE_SOURCE_DIR}/src/DockWidget.h ${CMAKE_SOURCE_DIR}/src/MainWindowBase.h ${CMAKE_SOURCE_DIR}/src/MainWindow.h
-    ${CMAKE_SOURCE_DIR}/src/DockWidget.h
-    ${CMAKE_SOURCE_DIR}/src/MainWindowBase.h
-    ${CMAKE_SOURCE_DIR}/src/MainWindow.h
     ${CMAKE_SOURCE_DIR}/src/LayoutSaver.h
 )
 
 create_python_bindings(
-  "KDDockWidgets"
+    "KDDockWidgets"
-  "${PyKDDockWidgets_typesystem_paths}"
+    "${PyKDDockWidgets_typesystem_paths}"
-  "${PyKDDockWidgets_include_paths}"
+    "${PyKDDockWidgets_include_paths}"
-  "${PyKDDockWidgets_SRC}"
+    "${PyKDDockWidgets_SRC}"
-  "${PyKDDockWidgets_target_include_directories}"
+    "${PyKDDockWidgets_target_include_directories}"
-  "${PyKDDockWidgets_target_link_libraries}"
+    "${PyKDDockWidgets_target_link_libraries}"
-  ${CMAKE_CURRENT_SOURCE_DIR}/kddockwidgets_global.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/kddockwidgets_global.h
-  ${CMAKE_CURRENT_SOURCE_DIR}/typesystem_kddockwidgets.xml
+    ${CMAKE_CURRENT_SOURCE_DIR}/typesystem_kddockwidgets.xml
-  "${PyKDDockWidgets_DEPENDS}"
+    "${PyKDDockWidgets_DEPENDS}"
-  ${CMAKE_CURRENT_BINARY_DIR}
+    ${CMAKE_CURRENT_BINARY_DIR}
 )
 
 # Make module import from build dir work
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/__init__.py.cmake ${CMAKE_CURRENT_BINARY_DIR}/__init__.py @ONLY)
 
 # install
-install(
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/__init__.py $<TARGET_FILE:KDAB::kddockwidgets>
-  FILES
+        DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
-    ${CMAKE_CURRENT_BINARY_DIR}/__init__.py
-    $<TARGET_FILE:KDAB::kddockwidgets>
-  DESTINATION
-    ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
 )
 if(NOT WIN32)
-  install(
+    install(FILES $<TARGET_LINKER_FILE:KDAB::kddockwidgets> $<TARGET_SONAME_FILE:KDAB::kddockwidgets>
-    FILES
+            DESTINATION ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
-        $<TARGET_LINKER_FILE:KDAB::kddockwidgets>
+    )
-        $<TARGET_SONAME_FILE:KDAB::kddockwidgets>
-    DESTINATION
-        ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}
-  )
 endif()

python/PyKDDockWidgets/__init__.py.cmake

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -15,15 +15,25 @@ import os
 __all__ = ['KDDockWidgets']
 
 def setupLibraryPath():
-    package_dir = os.path.abspath(os.path.dirname(__file__))
     if sys.platform != 'win32':
         return
 
-    if sys.version_info[0] == 3 and sys.version_info[1] >= 8:
+    if "@PYSIDE_MAJOR_VERSION@" == "6":
-        os.add_dll_directory(package_dir)
+        from shiboken@PYSIDE_MAJOR_VERSION@ import Shiboken
-        return
+    else:
+        from shiboken@PYSIDE_MAJOR_VERSION@ import shiboken@PYSIDE_MAJOR_VERSION@ as Shiboken
 
-    os.environ['PATH'] = os.fspath(package_dir) + os.pathsep + os.environ['PATH']
+    from PySide@PYSIDE_MAJOR_VERSION@ import QtCore
+    extra_dll_dirs = [ os.path.abspath(os.path.dirname(Shiboken.__file__)),
+                       os.path.abspath(os.path.dirname(QtCore.__file__)),
+                       os.path.abspath(os.path.dirname(__file__)) ]
+
+    if sys.version_info[0] == 3 and sys.version_info[1] >= 8:
+        for dll_dir in extra_dll_dirs:
+            os.add_dll_directory(dll_dir)
+
+    for dll_dir in extra_dll_dirs:
+        os.environ['PATH'] = os.fspath(dll_dir) + os.pathsep + os.environ['PATH']
 
 # Preload PySide libraries to avoid missing libraries while loading KDDockWidgets
 try:
@@ -36,15 +46,3 @@ except Exception:
     raise
 
 setupLibraryPath()
-
-
-#
-# This file is part of KDDockWidgets.
-#
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
-# Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
-#
-# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
-#
-# Contact KDAB at <info@kdab.com> for commercial licensing options.
-#

python/PyKDDockWidgets/kddockwidgets_global.h

@@ -1,7 +1,7 @@
 /*
   This file is part of KDDockWidgets.
 
-  SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 
   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -18,7 +18,7 @@
 #define PYTHON_BINDINGS
 
 #ifndef QT_WIDGETS_LIB
-# define QT_WIDGETS_LIB
+#define QT_WIDGETS_LIB
 #endif
 
 #include <kddockwidgets/MainWindowBase.h>

python/examples-qt6/MyMainWindow.py

@@ -1,7 +1,7 @@
 #
 # This file is part of KDDockWidgets.
 #
-# SPDX-FileCopyrightText: 2020-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+# SPDX-FileCopyrightText: 2020-2022 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
 # Author: Renato Araujo Oliveira Filho <renato.araujo@kdab.com>
 #
 # SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
@@ -9,41 +9,51 @@
 # Contact KDAB at <info@kdab.com> for commercial licensing options.
 #
 
-from PyKDDockWidgetsQt6 import KDDockWidgets
+# pylint: disable=missing-module-docstring,missing-function-docstring,missing-class-docstring
 
+# pylint: disable=no-name-in-module
 from PySide6 import QtCore, QtWidgets, QtGui
+from PyKDDockWidgetsQt6 import KDDockWidgets
 
 from MyWidget1 import MyWidget1
 from MyWidget2 import MyWidget2
 from MyWidget3 import MyWidget3
 
-def newMyWidget(parent = None):
+
+def newMyWidget(parent=None):
     randomNumber = QtCore.QRandomGenerator.global_().bounded(0, 100) + 1
-    if (randomNumber < 50):
+    if randomNumber < 50:
-        if (randomNumber < 33):
+        if randomNumber < 33:
             return MyWidget1(parent)
-        else:
+        return MyWidget3(parent)
-            return MyWidget3(parent)
+    return MyWidget2(parent)
-    else:
+
-        return MyWidget2(parent)
 
 class MyMainWindow(KDDockWidgets.MainWindow):
     s_count = 0
     s_menuCount = 0
 
-    def __init__(self, uniqueName, options = KDDockWidgets.MainWindowOption_None, dockWidget0IsNonClosable = False, nonDockableDockWidget9 = False, restoreIsRelative = False, maxSizeForDockWidget8 = False, affinityName = "", parent = None):
+    def __init__(self,
+                 uniqueName,
+                 options=KDDockWidgets.MainWindowOption_None,
+                 dockWidget0IsNonClosable=False,
+                 nonDockableDockWidget9=False,
+                 restoreIsRelative=False,
+                 maxSizeForDockWidget8=False,
+                 affinityName="",
+                 parent=None):
         super().__init__(uniqueName, options, parent)
-        self.m_dockWidget0IsNonClosable = dockWidget0IsNonClosable
+        self.dockWidget0IsNonClosable = dockWidget0IsNonClosable
-        self.m_dockWidget9IsNonDockable = nonDockableDockWidget9
+        self.dockWidget9IsNonDockable = nonDockableDockWidget9
-        self.m_restoreIsRelative = restoreIsRelative
+        self.restoreIsRelative = restoreIsRelative
-        self.m_maxSizeForDockWidget8 = maxSizeForDockWidget8
+        self.maxSizeForDockWidget8 = maxSizeForDockWidget8
-        self.m_dockwidgets = []
+        self.dockwidgets = []
-        
+
         menubar = self.menuBar()
         fileMenu = QtWidgets.QMenu("File")
-        self.m_toggleMenu = QtWidgets.QMenu("Toggle")
+        self.toggleMenu = QtWidgets.QMenu("Toggle")
         menubar.addMenu(fileMenu)
-        menubar.addMenu(self.m_toggleMenu)
+        menubar.addMenu(self.toggleMenu)
 
         newAction = fileMenu.addAction("New DockWidget")
         newAction.triggered.connect(self._newDockWidget)
@@ -63,101 +73,104 @@ class MyMainWindow(KDDockWidgets.MainWindow):
         quitAction = fileMenu.addAction("Quit")
         quitAction.triggered.connect(QtWidgets.QApplication.instance().quit)
 
-        self.setAffinities([ affinityName ])
+        self.setAffinities([affinityName])
         self.createDockWidgets()
 
     def _newDockWidget(self):
         MyMainWindow.s_menuCount += 1
         w = newMyWidget(self)
         w.setGeometry(100, 100, 400, 400)
-        dock = KDDockWidgets.DockWidget("new dock %d"%(MyMainWindow.s_menuCount))
+        dock = KDDockWidgets.DockWidget("new dock %d" % (MyMainWindow.s_menuCount))
         dock.setWidget(w)
         dock.resize(600, 600)
         dock.show()
-        self.m_dockwidgets.append(dock)
+        self.dockwidgets.append(dock)
-        
+
+    # pylint: disable=no-self-use
     def _saveLayout(self):
         #saver = KDDockWidgets.LayoutSaver()
         #result = saver.saveToFile("mylayout.json")
         #print("Saving layout to disk. Result=", result)
         print("Not available")
 
+    # pylint: disable=no-self-use
     def _restoreLayout(self):
         #options = KDDockWidgets.RestoreOption_None
-        #if self.m_restoreIsRelative:
+        # if self.restoreIsRelative:
         #    options |= KDDockWidgets.RestoreOption_RelativeToMainWindow
         #saver = KDDockWidgets.LayoutSaver(options)
-        #saver.restoreFromFile("mylayout.json")
+        # saver.restoreFromFile("mylayout.json")
         print("Not available")
 
     def _closeAll(self):
-        for dw in self.m_dockwidgets:
+        for widget in self.dockwidgets:
-            dw.close()
+            widget.close()
 
     def createDockWidgets(self):
-        if self.m_dockWidget9IsNonDockable:
+        if self.dockWidget9IsNonDockable:
             numDockWidgets = 10
         else:
             numDockWidgets = 9
 
         # numDockWidgets = 2
         # Create 9 KDDockWidget::DockWidget and the respective widgets they're hosting (MyWidget instances)
-        for i in range(numDockWidgets):
+        for _ in range(numDockWidgets):
-            self.m_dockwidgets.append(self.newDockWidget())
+            self.dockwidgets.append(self.newDockWidget())
 
         # MainWindow::addDockWidget() attaches a dock widget to the main window:
-        initialOpts = KDDockWidgets.InitialOption(KDDockWidgets.InitialVisibilityOption.StartHidden, QtCore.QSize(500, 500))
+        initialOpts = KDDockWidgets.InitialOption(KDDockWidgets.InitialVisibilityOption.StartHidden,
-        self.addDockWidget(self.m_dockwidgets[0], KDDockWidgets.Location_OnBottom, None, initialOpts)
+                                                  QtCore.QSize(500, 500))
+        self.addDockWidget(self.dockwidgets[0], KDDockWidgets.Location_OnBottom, None, initialOpts)
 
         # Here, for finer granularity we specify right of dockwidgets[0]:
-        self.addDockWidget(self.m_dockwidgets[1], KDDockWidgets.Location_OnRight, self.m_dockwidgets[0])
+        self.addDockWidget(self.dockwidgets[1], KDDockWidgets.Location_OnRight, self.dockwidgets[0])
-        
+
-        self.addDockWidget(self.m_dockwidgets[2], KDDockWidgets.Location_OnLeft)
+        self.addDockWidget(self.dockwidgets[2], KDDockWidgets.Location_OnLeft)
-        self.addDockWidget(self.m_dockwidgets[3], KDDockWidgets.Location_OnBottom)
+        self.addDockWidget(self.dockwidgets[3], KDDockWidgets.Location_OnBottom)
-        self.addDockWidget(self.m_dockwidgets[4], KDDockWidgets.Location_OnBottom)
+        self.addDockWidget(self.dockwidgets[4], KDDockWidgets.Location_OnBottom)
 
         # Tab two dock widgets together
-        self.m_dockwidgets[3].addDockWidgetAsTab(self.m_dockwidgets[5])
+        self.dockwidgets[3].addDockWidgetAsTab(self.dockwidgets[5])
 
         # 6 is floating, as it wasn't added to the main window via MainWindow::addDockWidget().
         # and we tab 7 with it.
-        self.m_dockwidgets[6].addDockWidgetAsTab(self.m_dockwidgets[7])
+        self.dockwidgets[6].addDockWidgetAsTab(self.dockwidgets[7])
 
         # Floating windows also support nesting, here we add 8 to the bottom of the group
-        self.m_dockwidgets[6].addDockWidgetToContainingWindow(self.m_dockwidgets[8], KDDockWidgets.Location_OnBottom)
+        self.dockwidgets[6].addDockWidgetToContainingWindow(self.dockwidgets[8], KDDockWidgets.Location_OnBottom)
 
-        floatingWindow = self.m_dockwidgets[6].window()
+        floatingWindow = self.dockwidgets[6].window()
         floatingWindow.move(100, 100)
 
     def newDockWidget(self):
         # Passing options is optional, we just want to illustrate Option_NotClosable here
         options = KDDockWidgets.DockWidget.Option_None
-        if (MyMainWindow.s_count == 0) and self.m_dockWidget0IsNonClosable:
+        if (MyMainWindow.s_count == 0) and self.dockWidget0IsNonClosable:
             options |= KDDockWidgets.DockWidget.Option_NotClosable
 
-        if (MyMainWindow.s_count == 9) and self.m_dockWidget9IsNonDockable:
+        if (MyMainWindow.s_count == 9) and self.dockWidget9IsNonDockable:
             options |= KDDockWidgets.DockWidget.Option_NotDockable
 
-        dock = KDDockWidgets.DockWidget("DockWidget #%d"%(MyMainWindow.s_count), options)
+        dock = KDDockWidgets.DockWidget("DockWidget #%d" % (MyMainWindow.s_count), options)
-        dock.setAffinities(self.affinities()); # optional, just to show the feature. Pass -mi to the example to see incompatible dock widgets
+        # optional, just to show the feature. Pass -mi to the example to see incompatible dock widgets
+        dock.setAffinities(self.affinities())
 
         if MyMainWindow.s_count == 1:
             dock.setIcon(QtGui.QIcon.fromTheme("mail-message"))
 
         myWidget = newMyWidget(self)
-        if (MyMainWindow.s_count == 8) and self.m_maxSizeForDockWidget8:
+        if (MyMainWindow.s_count == 8) and self.maxSizeForDockWidget8:
             # Set a maximum size on dock #8
             myWidget.setMaximumSize(200, 200)
 
         dock.setWidget(myWidget)
 
         if dock.options() & KDDockWidgets.DockWidget.Option_NotDockable:
-            dock.setTitle("DockWidget #%d (%s)" %(MyMainWindow.s_count, "non dockable"))
+            dock.setTitle("DockWidget #%d (%s)" % (MyMainWindow.s_count, "non dockable"))
         else:
-            dock.setTitle("DockWidget #%d"%(MyMainWindow.s_count))
+            dock.setTitle("DockWidget #%d" % (MyMainWindow.s_count))
 
         dock.resize(600, 600)
-        self.m_toggleMenu.addAction(dock.toggleAction())
+        self.toggleMenu.addAction(dock.toggleAction())
         MyMainWindow.s_count += 1
         return dock
-