summaryrefslogtreecommitdiffstats
path: root/doc/html/qaxbindable.html
blob: f49d34abf6f471e93c204be86a113a55dda4b1c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/extensions/activeqt/control/qaxbindable.cpp:36 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QAxBindable Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAxBindable Class Reference<br><small>[<a href="qaxserver.html">QAxServer module</a>]</small></h1>

<p>The QAxBindable class provides an interface between a
QWidget and an ActiveX client.
<a href="#details">More...</a>
<p>This class is part of the <b>Qt ActiveQt Extension</b>.
<p><tt>#include &lt;<a href="qaxbindable-h.html">qaxbindable.h</a>&gt;</tt>
<p><a href="qaxbindable-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QAxBindable"><b>QAxBindable</b></a> ()</li>
<li class=fn>virtual <a href="#~QAxBindable"><b>~QAxBindable</b></a> ()</li>
<li class=fn>virtual QAxAggregated * <a href="#createAggregate"><b>createAggregate</b></a> ()</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>void <a href="#reportError"><b>reportError</b></a> ( int&nbsp;code, const&nbsp;QString&nbsp;&amp;&nbsp;src, const&nbsp;QString&nbsp;&amp;&nbsp;desc, const&nbsp;QString&nbsp;&amp;&nbsp;context = QString::null )</li>
</ul>
<h2>Protected Members</h2>
<ul>
<li class=fn>bool <a href="#requestPropertyChange"><b>requestPropertyChange</b></a> ( const&nbsp;char&nbsp;*&nbsp;property )</li>
<li class=fn>void <a href="#propertyChanged"><b>propertyChanged</b></a> ( const&nbsp;char&nbsp;*&nbsp;property )</li>
<li class=fn>IUnknown * <a href="#clientSite"><b>clientSite</b></a> () const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
<p> This class is defined in the <b>Qt <a href="activeqt.html#ActiveQt">ActiveQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main Qt API.
<p>

The QAxBindable class provides an interface between a
<a href="qwidget.html">QWidget</a> and an ActiveX client.

<p> 

<p> 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 <a href="moc.html">meta object compiler</a> requires you to inherit from
QWidget <em>first</em>.
<p> <pre>
    class MyActiveX : public <a href="qwidget.html">QWidget</a>, public QAxBindable
    {
        <a href="metaobjects.html#Q_OBJECT">Q_OBJECT</a>
        Q_PROPERTY( int value READ value WRITE setValue )
    public:
        MyActiveX( <a href="qwidget.html">QWidget</a> *parent = 0, const char *name = 0 );
        ...

        int value() const;
        void setValue( int );
    };
    </pre>
 
<p> When implementing the property write function, use
<a href="#requestPropertyChange">requestPropertyChange</a>() to get permission from the ActiveX client
application to change this property. When the property changes,
call <a href="#propertyChanged">propertyChanged</a>() to notify the ActiveX client application
about the change. If a fatal error occurs in the control, use the
static <a href="#reportError">reportError</a>() function to notify the client.
<p> Use the interface returned by <a href="#clientSite">clientSite</a>() to call the ActiveX
client. To implement additional COM interfaces in your ActiveX
control, reimplement <a href="#createAggregate">createAggregate</a>() to return a new object of a
<a href="qaxaggregated.html">QAxAggregated</a> subclass.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QAxBindable"></a>QAxBindable::QAxBindable ()
</h3>
Constructs an empty QAxBindable object.

<h3 class=fn><a name="~QAxBindable"></a>QAxBindable::~QAxBindable ()<tt> [virtual]</tt>
</h3>
Destroys the QAxBindable object.

<h3 class=fn>IUnknown * <a name="clientSite"></a>QAxBindable::clientSite () const<tt> [protected]</tt>
</h3>
Returns a pointer to the client site interface for this ActiveX object,
or null if no client site has been set.
<p> Call QueryInterface() on the returned interface to get the interface you
want to call.

<h3 class=fn><a href="qaxaggregated.html">QAxAggregated</a>&nbsp;* <a name="createAggregate"></a>QAxBindable::createAggregate ()<tt> [virtual]</tt>
</h3>
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 <a href="qaxaggregated.html">QAxAggregated</a> subclass.
<p> The default implementation returns the null pointer.

<h3 class=fn>void <a name="propertyChanged"></a>QAxBindable::propertyChanged ( const&nbsp;char&nbsp;*&nbsp;property )<tt> [protected]</tt>
</h3>
Call this function to notify the client that is hosting this
ActiveX control that the property <em>property</em> has been changed.
<p> This function is usually called at the end of the property's write
function.
<p> <p>See also <a href="#requestPropertyChange">requestPropertyChange</a>().

<h3 class=fn>void <a name="reportError"></a>QAxBindable::reportError ( int&nbsp;code, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;src, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;desc, const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;context = QString::null )<tt> [static]</tt>
</h3>

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

<h3 class=fn>bool <a name="requestPropertyChange"></a>QAxBindable::requestPropertyChange ( const&nbsp;char&nbsp;*&nbsp;property )<tt> [protected]</tt>
</h3>
Call this function to request permission to change the property
<em>property</em> from the client that is hosting this ActiveX control.
Returns TRUE if the client allows the change; otherwise returns
FALSE.
<p> This function is usually called first in the write function for <em>property</em>, and writing is abandoned if the function returns FALSE.
<p> <pre>
    void MyActiveQt::setText( const <a href="qstring.html">QString</a> &amp;text )
    {
        if ( !requestPropertyChange( "text" ) )
            return;

        // update property

        <a href="#propertyChanged">propertyChanged</a>( "text" );
    }
    </pre>
 
<p> <p>See also <a href="#propertyChanged">propertyChanged</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>