Add qmlProtectModule

A C++ analog to the protected qmldir syntax, this is also a potential
performance improvement because we can avoid some file system accesses.

Change-Id: I41781a6cc72aa65bd2d397800345ea16ef442e90
Reviewed-by: Antti Piira <apiira@blackberry.com>
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

1 files changed, 25 insertions, 0 deletions

diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc
index 386f9f49df..7d668a4a11 100644
--- a/src/qml/doc/src/qmlfunctions.qdoc
+++ b/src/qml/doc/src/qmlfunctions.qdoc
@@ -413,3 +413,28 @@
   Returns non-zero if the registration was sucessful.
 */
 
+/*!
+  \fn int qmlProtectModule(const QString &uri, int versionMajor);
+  \relates QQmlEngine
+
+  This function protects a module from having types registered into it. This
+  can be used to prevent other plugins from injecting types into your module.
+  It can also be a performance improvement, as it allows the engine to skip
+  checking for the possibility of new types or plugins when this import is
+  reached.
+
+  The performance benefit is primarily seen when registering application
+  specific types from within the application instead of through a plugin.
+  Using qmlProtectModule allows the engine to skip checking for a plugin when
+  that uri is imported, which can be noticeable with slow file systems.
+
+  After this function is called, any attempt to register C++ types into this
+  uri, major version combination will lead to a runtime error. Call this after
+  you have registered all of your types with the engine.
+
+  #include <QtQml> to use this function.
+
+  Returns true if the module was found and locked, otherwise returns false.
+  The module must contain exported types in order to be found.
+*/
+