diff --git a/doc/help.htm b/doc/help.htm index 221bb7e..27c55b8 100644 --- a/doc/help.htm +++ b/doc/help.htm @@ -5,24 +5,8 @@
+LQML
-qload-c++ (library-name &optional unload)
-
- Loads a custom Qt/C++ plugin (see 'cpp-lib' in sources). The LIBRARY-NAME
- has to be passed as path to the plugin, without file ending. This offers
- a simple way to extend your application with your own Qt/C++ functions.
- The plugin will be reloaded (if supported by the OS) every time you call
- this function. If the UNLOAD argument is not NIL, the plugin will be
- unloaded (if supported by the OS).
- N.B: This works only for Qt6 functions with the following signature:
- "QVariant foo(QVariant, ...)" ; max 10 QVariant arguments
- Since a QVariant can also be of type QVariantList, this is a perfect fit
- for (nested) Lisp lists.
-
- (defparameter *c++* (qload-c++ "my-lib"))
- (qapropos nil *c++*) ; documentation
- (define-qt-wrappers *c++*) ; Lisp wrapper functions
-
define-qt-wrappers (qt-library &rest what)
@@ -74,7 +58,7 @@
given property of all items sharing the same 'objectName'.
-qapropos (name &optional qobject/name)
+qapropos (name &optional qt-object/name)
Searches properties, methods, signals, slots for NAME in QObject
(e.g. QQuickItem) passed as second argument. QQuickItems can also be passed
@@ -84,7 +68,7 @@
(qapropos "color")
-qapropos* (name &optional qobject/name)
+qapropos* (name &optional qt-object/name)
Similar to QAPROPOS, returning the results as nested list.
@@ -112,7 +96,7 @@
exited.
-qfind-child (qobject name)
+qfind-child (qt-object name)
Calls QObject::findChild().
@@ -123,7 +107,7 @@
QString::fromUtf8().
-qget (object name)
+qget (qt-object name)
Gets a Qt property. Enumerator values are returned as integer values.
Returns T as second return value for successful calls.
@@ -145,6 +129,24 @@
Calls FUNCTION as soon as the Qt event loop is idle.
+qload-c++ (library-name &optional unload)
+
+ Loads a custom Qt/C++ plugin (see 'cpp-lib' in sources). The LIBRARY-NAME
+ has to be passed as path to the plugin, without file ending. This offers
+ a simple way to extend your application with your own Qt/C++ functions.
+ The plugin will be reloaded (if supported by the OS) every time you call
+ this function. If the UNLOAD argument is not NIL, the plugin will be
+ unloaded (if supported by the OS).
+ N.B: This works only for Qt6 functions with the following signature:
+ "QVariant foo(QVariant, ...)" ; max 10 QVariant arguments
+ Since a QVariant can also be of type QVariantList, this is a perfect fit
+ for (nested) Lisp lists.
+
+ (defparameter *c++* (qload-c++ "my-lib"))
+ (qapropos nil *c++*) ; documentation
+ (define-qt-wrappers *c++*) ; Lisp wrapper functions
+
+
qlog (arg1 &optional arg2 arg3...)
For log messages on android.
@@ -154,14 +156,9 @@
(qlog "x ~A y ~A" x y)
-qobject-name (qobject)
+qobject-name (qt-object)
- Returns the QObject::objectName() of passed QOBJECT (FFI pointer).
-
-
-qobject-p (x)
-
- Tests if argument is of type QObject.
+ Returns the QObject::objectName() of passed QT-OBJECT.
qprocess-events ()
@@ -177,7 +174,7 @@
normal program exit.
-qset (object name1 value1 &optional name2 value2...)
+qset (qt-object name1 value1 &optional name2 value2...)
Sets a Qt property. Enumerators have to be passed as integer values.
Returns T as second return value for successful calls.
diff --git a/src/cpp/ecl_ext.cpp b/src/cpp/ecl_ext.cpp
index b6cc819..207a5d1 100644
--- a/src/cpp/ecl_ext.cpp
+++ b/src/cpp/ecl_ext.cpp
@@ -86,7 +86,7 @@ cl_object set_shutdown_p(cl_object l_obj) {
}
cl_object qget2(cl_object l_obj, cl_object l_name) {
- /// args: (object name)
+ /// args: (qt-object name)
/// Gets a Qt property. Enumerator values are returned as integer values.
/// Returns T as second return value for successful calls.
/// (qget *quick-view* |width|)
@@ -107,7 +107,7 @@ cl_object qget2(cl_object l_obj, cl_object l_name) {
}
cl_object qset2(cl_object l_obj, cl_object l_args) {
- /// args: (object name1 value1 &optional name2 value2...)
+ /// args: (qt-object name1 value1 &optional name2 value2...)
/// Sets a Qt property. Enumerators have to be passed as integer values.
/// Returns T as second return value for successful calls.
/// (qset *quick-view* |x| 100 |y| 100)
@@ -141,7 +141,7 @@ fail:
}
cl_object qfind_child(cl_object l_obj, cl_object l_name) {
- /// args: (qobject name)
+ /// args: (qt-object name)
/// Calls QObject::findChild().
ecl_process_env()->nvalues = 1;
QString name(toQString(l_name));
@@ -472,7 +472,7 @@ cl_object qml_set2(cl_object l_item, cl_object l_name, cl_object l_value) {
}
cl_object qobject_name(cl_object l_obj) {
- /// args: (qobject)
+ /// args: (qt-object)
/// Returns the QObject::objectName() of passed QT-OBJECT.
ecl_process_env()->nvalues = 1;
QObject* qobject = toQObjectPointer(l_obj);
diff --git a/src/lisp/ini.lisp b/src/lisp/ini.lisp
index 194141e..d53d9e5 100644
--- a/src/lisp/ini.lisp
+++ b/src/lisp/ini.lisp
@@ -22,12 +22,12 @@
"NULL"
(format nil "0x~X" address))))))
-(defmacro ! (fun qobject &rest args)
+(defmacro ! (fun qt-object &rest args)
;; legacy, should not be needed, use DEFINE-QT-WRAPPERS instead
;; usage:
;; (! "myFunction" *cpp* 1 2 3)
;; (! |myFunction| *cpp* 1 2 3)
- `(qfun ,qobject ,(if (stringp fun) fun (symbol-name fun)) ,@args))
+ `(qfun ,qt-object ,(if (stringp fun) fun (symbol-name fun)) ,@args))
(defun %reference-name ()
(format nil "%~A%" (gensym)))
diff --git a/src/lisp/qml.lisp b/src/lisp/qml.lisp
index a56ccc5..aadc3ae 100644
--- a/src/lisp/qml.lisp
+++ b/src/lisp/qml.lisp
@@ -20,7 +20,7 @@
;; if passed with 'this' as first argument to 'Lisp.call()' / 'Lisp.apply()'.
(let ((*caller* (if (zerop caller)
*caller*
- (qt-qobject caller))))
+ (qt-object caller))))
(apply (string-to-symbol function)
arguments)))
@@ -185,14 +185,14 @@
x
(quick-item x)))
-(defun qapropos (name &optional qobject/name offset)
- "args: (name &optional qobject/name)
+(defun qapropos (name &optional qt-object/name offset)
+ "args: (name &optional qt-object/name)
Searches properties, methods, signals, slots for NAME in QObject
(e.g. QQuickItem) passed as second argument. QQuickItems can also be passed
by their 'objectName'.
(qapropos nil *canvas*)
(qapropos \"color\")"
- (dolist (sub1 (%qapropos (%string-or-nil name) (%to-qt-object qobject/name) offset))
+ (dolist (sub1 (%qapropos (%string-or-nil name) (%to-qt-object qt-object/name) offset))
(format t "~%~%~A~%" (first sub1))
(dolist (sub2 (rest sub1))
(format t "~% ~A~%~%" (first sub2))
@@ -205,8 +205,8 @@
(terpri)
nil)
-(defun qapropos* (name &optional qobject/name offset)
- "args: (name &optional qobject/name)
+(defun qapropos* (name &optional qt-object/name offset)
+ "args: (name &optional qt-object/name)
Similar to QAPROPOS, returning the results as nested list."
- (%qapropos (%string-or-nil name) (%to-qt-object qobject/name) offset))
+ (%qapropos (%string-or-nil name) (%to-qt-object qt-object/name) offset))