diff options
author | Balazs Egedi <egedib@inf.u-szeged.hu> | 2021-08-17 12:59:28 +0200 |
---|---|---|
committer | Balazs Egedi <egedib@inf.u-szeged.hu> | 2021-09-13 10:25:48 +0200 |
commit | a32ef7057c01fbcadcf451e7f2b785f7b3dd3942 (patch) | |
tree | 15258c16f6369ad9f3318101102d7da1b3002927 /examples/webenginequick/webengineaction/doc | |
parent | 498c4ac362cb6cbee8a30c8cc46fa4253bf93ee0 (diff) |
Rename Quick examples' folder from webengine to webenginequick
Fix webengine directory path in project files and comments
Pick-to: 6.2 6.2.0
Change-Id: I06ed9ee41111e7135fa9feb152ad2a5eb2262b76
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'examples/webenginequick/webengineaction/doc')
-rw-r--r-- | examples/webenginequick/webengineaction/doc/images/webengineaction-example.png | bin | 0 -> 100266 bytes | |||
-rw-r--r-- | examples/webenginequick/webengineaction/doc/src/webengineaction.qdoc | 68 |
2 files changed, 68 insertions, 0 deletions
diff --git a/examples/webenginequick/webengineaction/doc/images/webengineaction-example.png b/examples/webenginequick/webengineaction/doc/images/webengineaction-example.png Binary files differnew file mode 100644 index 000000000..2e34bbf63 --- /dev/null +++ b/examples/webenginequick/webengineaction/doc/images/webengineaction-example.png diff --git a/examples/webenginequick/webengineaction/doc/src/webengineaction.qdoc b/examples/webenginequick/webengineaction/doc/src/webengineaction.qdoc new file mode 100644 index 000000000..096a16fc4 --- /dev/null +++ b/examples/webenginequick/webengineaction/doc/src/webengineaction.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example webenginequick/webengineaction + \title WebEngine Action Example + \ingroup webengine-examples + \brief A simple browser implemented using WebEngineActions. + + \image webengineaction-example.png + + \e {WebEngine Action Example} demonstrates how to perform actions on a web page + using the \l{WebEngineAction} type. It shows the minimum amount of code needed + to bind browser functionalities to input elements and build up a custom context + menu. + + \include examples-run.qdocinc + + \section1 Working With Web Engine Actions + + An intended use of \l{WebEngineAction} is building a connection between UI + elements and browser commands. It can be added to menus and toolbars via + assigning its properties to the corresponding ones of the element. + + The \l{ToolButton} relies on the properties provided by a + \l{WebEngineAction}. Clicking the button triggers backwards navigation on the + originating \l{WebEngineView} of the action. + + \quotefromfile webenginequick/webengineaction/main.qml + \skipto ToolButton { + \printuntil } + + The simplest way to create custom context menus is enumerating the required + \l{WebEngineAction} types in a data model and instantiating \l{MenuItem} types + for them, for example using a \l{Repeater}. + + \quotefromfile webenginequick/webengineaction/main.qml + \skipto property Menu contextMenu: Menu { + \printuntil /^ {8}\}/ + + Assigning a \l{WebEngineAction} to multiple UI elements will keep them in sync. + As it can be seen in the picture above, if the browser engine disables a + navigation action, both corresponding menu items will be disabled. +*/ |