Back to Qt.io
Contact Us Blog Download Qt

QAxBindable Class

The QAxBindable class provides an interface between a QWidget and an ActiveX client. More...

Header: #include <QAxBindable>
CMake: find_package(Qt6 REQUIRED COMPONENTS AxServer)
target_link_libraries(mytarget PRIVATE Qt6::AxServer)
qmake: QT += axserver

Public Functions

virtual ~QAxBindable()
virtual QAxAggregated *createAggregate()
virtual bool readData(QIODevice *source, const int &format)
void reportError(int code, const int &src, const int &desc, const int &context = QString())
virtual bool writeData(QIODevice *sink)

Protected Functions

IUnknown *clientSite() const
void propertyChanged(const char *property)
bool requestPropertyChange(const char *property)

Detailed Description

The functions provided by this class allow an ActiveX control to communicate property changes to a client application. Inherit your control class from both QWidget (directly or indirectly) and this class to get access to this class's functions. The meta-object compiler requires you to inherit from QWidget first.

class MyActiveX : public QWidget, public QAxBindable
{
    Q_OBJECT
    Q_PROPERTY(int value READ value WRITE setValue)

public:
    MyActiveX(QWidget *parent = 0);
    ...

    int value() const;
    void setValue(int);
};

When implementing the property write function, use requestPropertyChange() to get permission from the ActiveX client application to change this property. When the property changes, call propertyChanged() to notify the ActiveX client application about the change. If a fatal error occurs in the control, use the static reportError() function to notify the client.

Use the interface returned by clientSite() to call the ActiveX client. To implement additional COM interfaces in your ActiveX control, reimplement createAggregate() to return a new object of a QAxAggregated subclass.

See also QAxAggregated, QAxFactory, and ActiveQt Framework.

Member Function Documentation

[virtual noexcept] QAxBindable::~QAxBindable()

Destroys the QAxBindable object.

[protected] IUnknown *QAxBindable::clientSite() const

Returns a pointer to the client site interface for this ActiveX object, or null if no client site has been set.

Call QueryInterface() on the returned interface to get the interface you want to call.

[virtual] QAxAggregated *QAxBindable::createAggregate()

Reimplement this function when you want to implement additional COM interfaces in the ActiveX control, or when you want to provide alternative implementations of COM interfaces. Return a new object of a QAxAggregated subclass.

The default implementation returns the null pointer.

[protected] void QAxBindable::propertyChanged(const char *property)

Call this function to notify the client that is hosting this ActiveX control that the property property has been changed.

This function is usually called at the end of the property's write function.

See also requestPropertyChange().

[virtual] bool QAxBindable::readData(QIODevice *source, const int &format)

If the COM object supports a MIME type then this function is called to initialize the COM object from the data source in format. You have to open source for reading before you can read from it.

Returns true to indicate success. If the function returns false, then ActiveQt will process the data by setting the properties through the meta object system.

If you reimplement this function you also have to implement writeData(). The default implementation does nothing and returns false.

Warning: ActiveX controls embedded in HTML can use either the type and data attribute of the object tag to read data, or use a list of param tags to initialize properties. If param tags are used, then Internet Explorer will ignore the data attribute, and readData will not be called.

See also writeData().

void QAxBindable::reportError(int code, const int &src, const int &desc, const int &context = QString())

Reports an error to the client application. code is a control-defined error code. desc is a human-readable description of the error intended for the application user. src is the name of the source for the error, typically the ActiveX server name. context can be the location of a help file with more information about the error. If context ends with a number in brackets, e.g. [12], this number will be interpreted as the context ID in the help file.

[protected] bool QAxBindable::requestPropertyChange(const char *property)

Call this function to request permission to change the property property from the client that is hosting this ActiveX control. Returns true if the client allows the change; otherwise returns false.

This function is usually called first in the write function for property, and writing is abandoned if the function returns false.

void MyActiveQt::setText(const QString &text)
{
    if (!requestPropertyChange("text"))
        return;

    // update property

    propertyChanged("text");
}

See also propertyChanged().

[virtual] bool QAxBindable::writeData(QIODevice *sink)

If the COM object supports a MIME type then this function is called to store the COM object into sink. You have to open sink for writing before you can write to it.

Returns true to indicate success. If the function returns false, then ActiveQt will serialize the object by storing the property values.

If you reimplement this function you also have to implement readData(). The default implementation does nothing and returns false.

See also readData().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.