summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/examples/battery-charge.qdoc24
-rw-r--r--doc/src/examples/publish-subscribe.qdoc52
-rw-r--r--doc/src/images/battery-publisher.png (renamed from doc/src/images/battery-provider.png)bin20679 -> 20679 bytes
-rw-r--r--doc/src/images/battery-subscriber.png (renamed from doc/src/images/battery-consumer.png)bin8229 -> 8229 bytes
-rw-r--r--doc/src/images/publish-subscribe-publisher.png (renamed from doc/src/images/publish-subscribe-provider.png)bin15641 -> 15641 bytes
-rw-r--r--doc/src/images/publish-subscribe-subscriber.png (renamed from doc/src/images/publish-subscribe-consumer.png)bin16174 -> 16174 bytes
-rw-r--r--doc/src/publ-subs.qdoc16
-rw-r--r--doc/src/qtmobility.qdocconf2
8 files changed, 48 insertions, 46 deletions
diff --git a/doc/src/examples/battery-charge.qdoc b/doc/src/examples/battery-charge.qdoc
index 1fe82409b1..d673464aa4 100644
--- a/doc/src/examples/battery-charge.qdoc
+++ b/doc/src/examples/battery-charge.qdoc
@@ -44,7 +44,7 @@
\title Accessing Publish and Subscribe from QML
This examples shows how to access published context values from within QML. The example
- consists of two programs. The first, battery-provider, is a standard Qt GUI application that
+ consists of two programs. The first, battery-publisher, is a standard Qt GUI application that
is used to emulate a battery for the sole purpose of demonstrating the second program. It
publishes the keys
@@ -55,26 +55,26 @@
and provides controls for modifying their values.
- \image battery-provider.png
+ \image battery-publisher.png
- The second program, battery-consumer, is implemented in QML with some C++ code to display the
+ The second program, battery-subscriber, is implemented in QML with some C++ code to display the
QML and make QValueSpaceSubscriber available from within QML.
- The user interface of the battery consumer program is described in QML. It has the following
+ The user interface of the battery subscriber program is described in QML. It has the following
features: A rectangular area representing the percent charge of the battery. It indicates a
low battery state by changing the color to red, it is green otherwise. An animation is shown
to indicate that the battery is being recharged.
- \image battery-consumer.png
+ \image battery-subscriber.png
- \section2 Battery Consumer
+ \section2 Battery Subscriber
The first step is to make QValueSpaceSubscriber available from within QML so that our QML code
- can access the keys published by the battery-provider. This is achieved by using the
+ can access the keys published by the battery-publisher. This is achieved by using the
QML_DECLARE_TYPE() and QML_DEFINE_TYPE() macros. The following code makes
QValueSpaceSubscriber available from within QML as ValueSpaceSubscriber.
- \snippet battery-charge/battery-consumer/main.cpp 0
+ \snippet battery-charge/battery-subscriber/main.cpp 0
\section3 QML
@@ -83,12 +83,12 @@
\i path properties to the Value Space path of the keys. Finally we set the \i notify
properties to true to enable the emission of change notification signals.
- \snippet battery-charge/battery-consumer/battery-meter.qml 0
+ \snippet battery-charge/battery-subscriber/battery-meter.qml 0
The default state of the rectangle used to visualize the battery charge uses the \i charge
property of our BatteryCharge class in the expression for its height.
- \snippet battery-charge/battery-consumer/battery-meter.qml 1
+ \snippet battery-charge/battery-subscriber/battery-meter.qml 1
When the battery charge changes the height of the rectangle will automatically change.
@@ -96,10 +96,10 @@
drops below 25% and the battery is not being recharged. When in this state the color is set to
red.
- \snippet battery-charge/battery-consumer/battery-meter.qml 2
+ \snippet battery-charge/battery-subscriber/battery-meter.qml 2
The \i charging state is entered when the battery is being recharged. When in this state a
particle effect animation is enabled.
- \snippet battery-charge/battery-consumer/battery-meter.qml 3
+ \snippet battery-charge/battery-subscriber/battery-meter.qml 3
*/
diff --git a/doc/src/examples/publish-subscribe.qdoc b/doc/src/examples/publish-subscribe.qdoc
index d546602f36..46e88582ce 100644
--- a/doc/src/examples/publish-subscribe.qdoc
+++ b/doc/src/examples/publish-subscribe.qdoc
@@ -46,11 +46,11 @@
The Publish and Subscribe example shows how to use the Qt Publish and Subscribe API to
publish and retrieve values from the platforms Publish and Subscribe system.
- This example program can act either a provider of Value Space content, a consumer of a Value
+ This example program can act either a publisher of Value Space content, a subscriber of a Value
Space content or both. It can also optionally act as the Value Space Manager. The behavior
is selected by passing a combination of three optional command line parameters when starting
- the program. If no parameters are supplied the program defaults to acting as both a provider
- and consumer.
+ the program. If no parameters are supplied the program defaults to acting as both a publisher
+ and subscriber.
\table
\header
@@ -63,67 +63,67 @@
has a client-server architecture and a server needs to be started.
\row
- \o -provider
+ \o -publisher
\o Publish values in the Value Space and create a dialog to control those values
directly.
\row
- \o -consumer
+ \o -subscriber
\o Create a dialog to view Value Space items.
\endtable
- \section2 Provider
+ \section2 Publisher
- When acting as a provider of Value Space content the program creates a ProviderDialog. This
- dialog contains a widget for setting the base path of the QValueSpaceProvider and
+ When acting as a publisher of Value Space content the program creates a PublisherDialog. This
+ dialog contains a widget for setting the base path of the QValueSpacePublisher and
widgets for setting the value of the two fixed attributes 'intValue' and 'stringValue'.
- \image publish-subscribe-provider.png
+ \image publish-subscribe-publisher.png
We declare three slots which we will use to respond to user input in the dialog.
- \snippet publish-subscribe/providerdialog.h 0
+ \snippet publish-subscribe/publisherdialog.h 0
And connect them to signals from the widgets in the constructor.
- \snippet publish-subscribe/providerdialog.cpp 1
+ \snippet publish-subscribe/publisherdialog.cpp 1
- To publish values in the Value Space we first need to create a QValueSpaceProvider. We do this
- in the \c {createNewObject()} slot, which is also used to handle changes in the base path.
+ To publish values in the Value Space we first need to create a QValueSpacePublisher. We do
+ this in the \c {createNewObject()} slot, which is also used to handle changes in the base path.
After the object is constructed we publish the initial values by explicitly calling the other
two slots.
- \snippet publish-subscribe/providerdialog.cpp 2
+ \snippet publish-subscribe/publisherdialog.cpp 2
- We use QValueSpaceProvider::setAttribute() to set the values in response to dialog input.
+ We use QValueSpacePublisher::setValue() to set the values in response to dialog input.
- \snippet publish-subscribe/providerdialog.cpp 0
+ \snippet publish-subscribe/publisherdialog.cpp 0
As a final step in the constructor we explicitly call the \c {createNewObject()} slot to create
- an initial QValueSpaceProvider.
+ an initial QValueSpacePublisher.
- \snippet publish-subscribe/providerdialog.cpp 3
+ \snippet publish-subscribe/publisherdialog.cpp 3
- \section2 Consumer
+ \section2 Subscriber
- When acting as a consumer of Value Space content the program creates a ConsumerDialog. This
- dialog contains a widget for setting the base path of the QValueSpaceSubscriber and a table for
- displaying all of the values directly under base path in the Value Space.
+ When acting as a subscriber of Value Space content the program creates a SubscriberDialog.
+ This dialog contains a widget for setting the base path of the QValueSpaceSubscriber and a
+ table for displaying all of the values directly under base path in the Value Space.
- \image publish-subscribe-consumer.png
+ \image publish-subscribe-subscriber.png
We declare two slots to propagate values from the Value Space to the dialog in response to
change notifications from QValueSpaceSubscriber.
- \snippet publish-subscribe/consumerdialog.h 0
+ \snippet publish-subscribe/subscriberdialog.h 0
To read values from the Value Space we first create a QValueSpaceSubscriber and connect to the
\c {contentsChanged()} signal.
We explicitly call our \c {itemChanged()} slot to populate the table with the initial values.
- \snippet publish-subscribe/consumerdialog.cpp 0
+ \snippet publish-subscribe/subscriberdialog.cpp 0
In response to the \c {contentsChanged()} signal we update all the values in the table.
- \snippet publish-subscribe/consumerdialog.cpp 1
+ \snippet publish-subscribe/subscriberdialog.cpp 1
*/
diff --git a/doc/src/images/battery-provider.png b/doc/src/images/battery-publisher.png
index 7923c9c4f5..7923c9c4f5 100644
--- a/doc/src/images/battery-provider.png
+++ b/doc/src/images/battery-publisher.png
Binary files differ
diff --git a/doc/src/images/battery-consumer.png b/doc/src/images/battery-subscriber.png
index 6a8304cc3f..6a8304cc3f 100644
--- a/doc/src/images/battery-consumer.png
+++ b/doc/src/images/battery-subscriber.png
Binary files differ
diff --git a/doc/src/images/publish-subscribe-provider.png b/doc/src/images/publish-subscribe-publisher.png
index 2f6e193b84..2f6e193b84 100644
--- a/doc/src/images/publish-subscribe-provider.png
+++ b/doc/src/images/publish-subscribe-publisher.png
Binary files differ
diff --git a/doc/src/images/publish-subscribe-consumer.png b/doc/src/images/publish-subscribe-subscriber.png
index ed4eb432dd..ed4eb432dd 100644
--- a/doc/src/images/publish-subscribe-consumer.png
+++ b/doc/src/images/publish-subscribe-subscriber.png
Binary files differ
diff --git a/doc/src/publ-subs.qdoc b/doc/src/publ-subs.qdoc
index 25fa6901ed..a71b57ba7e 100644
--- a/doc/src/publ-subs.qdoc
+++ b/doc/src/publ-subs.qdoc
@@ -76,7 +76,7 @@ Existing values within the Value Space are accessed through the QValueSpaceSubsc
class provides a means to read values, receive change notifications for a given path and navigate
through the Value Space.
-New values are added to the Value Space via the QValueSpaceProvider class. This class allows
+New values are added to the Value Space via the QValueSpacePublisher class. This class allows
applications to publish values and receive interest notifications when applications connect to a
path. Interest notifications can be used to refrain from updating values in the Value Space when
there are no interested parties.
@@ -134,7 +134,7 @@ The Shared Memory layer has an order of 0x10000000.
\row
\o ContextKit Layer
\o The ContextKit layer provides a non-permanent Value Space backing store using
- ContextKit. Publishing values to this layer via QValueSpaceProvider is currently not
+ ContextKit. Publishing values to this layer via QValueSpacePublisher is currently not
supported.
The ContextKit layer has an order of 0.
\endtable
@@ -163,8 +163,8 @@ items to the layer, their changes are transmitted via a QLocalSocket (e.g.
\c {/tmp/qt/valuespace_shmlayer} domain socket on Unix systems) to the server where the update is
performed. Updates are batched in-process and sent when the process re-enters the Qt event loop.
Transmission and synchronization of changes can be forced manually by the
-QValueSpaceProvider::sync() function, although as this requires a round trip between the client and
-server, doing so frequently may significantly degrade performance.
+QValueSpacePublisher::sync() function, although as this requires a round trip between the client
+and server, doing so frequently may significantly degrade performance.
Change notifications are transmitted to clients in the form of "something has changed" messages.
Nodes within the shared memory region are versioned, which allows clients to quickly determine
@@ -175,14 +175,14 @@ exactly what has changed without the need for a bulkier change notification prot
\section2 Publish and Subscribe
In the example \l {publish-subscribe}{Publish and Subscribe} the Value Space is used as a method of
-communicating changes in one dialog (the provider) to another dialog (the consumer).
+communicating changes in one dialog (the publisher) to another dialog (the subscriber).
\section2 Battery Charging - Accessing Publish and Subscribe from QML
In the example \l {battery-charge}{Accessing Publish and Subscribe from QML} the Publish and
-Subscribe concept is now extended to make the provider an input of the level of charge in a
-battery. A slider on the provider dialog represents the modifiable level of charge. The Value
-Space acts as a communications medium between the provider dialog and the consumer graphical
+Subscribe concept is now extended to make the publisher an input of the level of charge in a
+battery. A slider on the publisher dialog represents the modifiable level of charge. The Value
+Space acts as a communications medium between the publisher dialog and the subscriber graphical
battery animation. The battery is implemented in QML and C++ with Value Space supplying the
charge level for the animation to represent.
diff --git a/doc/src/qtmobility.qdocconf b/doc/src/qtmobility.qdocconf
index d8fa1137e3..08f3c6e0fd 100644
--- a/doc/src/qtmobility.qdocconf
+++ b/doc/src/qtmobility.qdocconf
@@ -31,6 +31,8 @@ exampledirs = ../../examples \
../.. \
.
+excludedirs = ../../src/publishsubscribe/symbian
+
indexes = qt.index
sources.fileextensions = "*.qdoc *.cpp"