diff options
| -rw-r--r-- | doc/src/graphicsview.qdoc | 2 | ||||
| -rw-r--r-- | doc/src/phonon-api.qdoc | 31 | ||||
| -rw-r--r-- | doc/src/phonon.qdoc | 24 | ||||
| -rw-r--r-- | doc/src/properties.qdoc | 2 | ||||
| -rw-r--r-- | doc/src/statemachine.qdoc | 170 |
5 files changed, 113 insertions, 116 deletions
diff --git a/doc/src/graphicsview.qdoc b/doc/src/graphicsview.qdoc index c88efdbd4a..4c408cda8e 100644 --- a/doc/src/graphicsview.qdoc +++ b/doc/src/graphicsview.qdoc @@ -540,5 +540,5 @@ When transforming an embedded widget, Graphics View makes sure that the widget is transformed resolution independently, allowing the fonts and style to stay crisp when zoomed in. (Note that the effect - of resolution independence depends on the style.) + of resolution independence depends on the style.) */ diff --git a/doc/src/phonon-api.qdoc b/doc/src/phonon-api.qdoc index e683b2969c..0743bab4d4 100644 --- a/doc/src/phonon-api.qdoc +++ b/doc/src/phonon-api.qdoc @@ -60,7 +60,7 @@ through a function call, e.g., through \l{Phonon::MediaObject::}{play()}, you cannot be sure that the change has taken place before you receive the - \l{Phonon::MediaObject::}{stateChanged()} signal. + \l{Phonon::MediaObject::}{stateChanged()} signal. A media object can at any time change into any state, regardless of the state it previously had. \omit In the @@ -192,14 +192,14 @@ computer on the network. \value EffectType An audio effect (\l{Phonon::}{EffectDescription}). - \omitvalue SubtitleType - \omitvalue AudioCaptureDeviceType - \omitvalue AudioChannelType + \omitvalue SubtitleType + \omitvalue AudioCaptureDeviceType + \omitvalue AudioChannelType */ /*! \typedef Phonon::AudioOutputDevice - \relates Phonon::ObjectDescription + \relates Phonon::ObjectDescription This typedef of \l{Phonon::}{ObjectDescription} describes an audio output device, such as soundcards (with different drivers), sound servers, or other @@ -223,7 +223,7 @@ \fn Phonon::phononVersion() \inmodule Phonon \since 4.5 - + Returns the Phonon version. */ @@ -362,7 +362,7 @@ property() is called. Currently, Qt backends do not use properties for their object - descriptions. + descriptions. \sa property() */ @@ -370,7 +370,7 @@ /*! \fn inline bool Phonon::ObjectDescription::isValid() const - Returns true if the device or effect described exists. + Returns true if the device or effect described exists. An ObjectDescription that is invalid, will also have an index() of -1. @@ -1932,7 +1932,7 @@ \fn void Phonon::MediaObject::clearQueue() Clears the queue of media sources. - + \sa queue(), enqueue() */ @@ -2096,7 +2096,7 @@ /*! \fn void Phonon::MediaObject::hasVideoChanged(bool hasVideo) - Emitted whenever the return value of hasVideo() changes, i.e., + Emitted whenever the return value of hasVideo() changes, i.e., the media source being played back contains video. Normally you'll check hasVideo() first and then let this signal @@ -4110,15 +4110,13 @@ /*! \enum Phonon::VideoWidget::ScaleMode - + The ScaleMode enum describes how to treat aspect ratio during - resizing of video. + resizing of video. \value FitInView The video will be fitted to fill the view keeping aspect ratio. - \value ScaleAndCrop The video is scaled - - + \value ScaleAndCrop The video is scaled */ /*! @@ -4136,7 +4134,6 @@ top-level window. Key event forwarding is handled by VideoWidget, but if you need to handle other events, e.g., mouse events, you should handle fullscreen mode yourself. - */ /*! @@ -4583,7 +4580,7 @@ \class Phonon::AddonInterface \inmodule Phonon \since 4.4 - \internal + \internal \brief Interface for Menu, Chapter, Angle and Title/Track control. */ diff --git a/doc/src/phonon.qdoc b/doc/src/phonon.qdoc index 27b43b9d28..b36c142f79 100644 --- a/doc/src/phonon.qdoc +++ b/doc/src/phonon.qdoc @@ -71,7 +71,7 @@ As an example, we show a media graph for an audio stream: - \image conceptaudio.png + \image conceptaudio.png The playback is started and managed by the media object, which send the media stream to any sinks connected to it by a path. The @@ -119,7 +119,7 @@ The input of sinks in a Phonon media graph comes from a \l{Phonon::}{MediaObject}, though it might have been processed - through other nodes on the way. + through other nodes on the way. While the \l{Phonon::}{MediaObject} controls the playback, the sink has basic controls for manipulation of the media. With an @@ -222,9 +222,9 @@ The setting of a Category, Phonon::MusicCategory in this case, does not affect the actual playback; the category can be used by KDE to control the playback through, for instance, the control - panel. + panel. - \omit Not sure about this + \omit Not sure about this Users of KDE can often also choose to send sound with the CommunicationCategory, e.g., given to VoIP, to their headset, while sound with MusicCategory is sent to the sound card. @@ -238,7 +238,7 @@ The AudioOutput node will work with all audio formats supported by the back end, so you don't need to know what format a specific - media source has. + media source has. For a an extensive example of audio playback, see the \l{Music Player Example}{Phonon Music Player}. @@ -313,7 +313,7 @@ <code> - <code walkthrough> + <code walkthrough> \endomit @@ -325,7 +325,7 @@ hardware or intermediate technology. For the programmer, this implies that the media nodes, e.g., media objects, processors, and sinks, are produced by the back end. Also, it is responsible for - building the graph, i.e., connecting the nodes. + building the graph, i.e., connecting the nodes. The backends of Qt use the media systems DirectShow (which requires DirectX) on Windows, QuickTime on Mac, and GStreamer on @@ -335,12 +335,12 @@ Backends expose information about the underlying system. It can tell which media formats are supported, e.g., \c AVI, \c mp3, or - \c OGG. + \c OGG. A user can often add support for new formats and filters to the underlying system, by, for instance, installing the DivX codex. We can therefore not give an exact overview of which formats are - available with the Qt backends. + available with the Qt backends. \omit Not sure I want a separate section for this \section2 Communication with the Backends @@ -366,7 +366,7 @@ \endomit - \section2 Querying Backends for Support + \section2 Querying Backends for Support As mentioned, Phonon depends on the backend to provide its functionality. Depending on the individual backend, full support @@ -379,7 +379,7 @@ \l{Phonon::BackendCapabilities::}{isMimeTypeAvailable()} functions to query which MIME types the backend can produce nodes for. The types are listed as strings, which for any type is equal for any - backend or platform. + backend or platform. The backend will emit a signal - \l{Phonon::BackendCapabilities::}{Notifier::capabilitiesChanged()} @@ -611,7 +611,7 @@ Qt Commercial Edition licensees that wish to distribute applications that use the Phonon module need to be aware of their obligations under the - GNU Lesser General Public License (LGPL). + GNU Lesser General Public License (LGPL). Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL; version 2.1 diff --git a/doc/src/properties.qdoc b/doc/src/properties.qdoc index ae441a28ac..5490dd07f4 100644 --- a/doc/src/properties.qdoc +++ b/doc/src/properties.qdoc @@ -56,7 +56,7 @@ \section1 Requirements for Declaring Properties To declare a property, use the \l {Q_PROPERTY()} {Q_PROPERTY()} - macro in a class that inherits QObject. + macro in a class that inherits QObject. \snippet doc/src/snippets/code/doc_src_properties.qdoc 0 diff --git a/doc/src/statemachine.qdoc b/doc/src/statemachine.qdoc index 5a89f4d211..940f8810eb 100644 --- a/doc/src/statemachine.qdoc +++ b/doc/src/statemachine.qdoc @@ -462,184 +462,184 @@ the level of granularity that's most appropriate. \section1 Using Restore Policy To Automatically Restore Properties - + In some state machines it can be useful to focus the attention on assigning properties in states, not on restoring them when the state is no longer active. If you know that a property should - always be restored to its initial value when the machine enters a state that does not explicitly - give the property a value, you can set the global restore policy to - QStateMachine::RestoreProperties. - + always be restored to its initial value when the machine enters a state that does not explicitly + give the property a value, you can set the global restore policy to + QStateMachine::RestoreProperties. + \code QStateMachine machine; machine.setGlobalRestorePolicy(QStateMachine::RestoreProperties); \endcode - + When this restore policy is set, the machine will automatically restore all properties. If it enters a state where a given property is not set, it will first search the hierarchy of ancestors to see if the property is defined there. If it is, the property will be restored to the value - defined by the closest ancestor. If not, it will be restored to its initial value (i.e. the + defined by the closest ancestor. If not, it will be restored to its initial value (i.e. the value of the property before any property assignments in states were executed.) - + Take the following code: \code QStateMachine machine; machine.setGlobalRestorePolicy(QStateMachine::RestoreProperties); - + QState *s1 = new QState(); s1->assignProperty(object, "fooBar", 1.0); machine.addState(s1); machine.setInitialState(s1); - - QState *s2 = new QState(); + + QState *s2 = new QState(); machine.addState(s2); \endcode - - Lets say the property \c fooBar is 0.0 when the machine starts. When the machine is in state + + Lets say the property \c fooBar is 0.0 when the machine starts. When the machine is in state \c s1, the property will be 1.0, since the state explicitly assigns this value to it. When the machine is in state \c s2, no value is explicitly defined for the property, so it will implicitly be restored to 0.0. - - If we are using nested states, the parent defines a value for the property which is inherited by + + If we are using nested states, the parent defines a value for the property which is inherited by all descendants that do not explicitly assign a value to the property. \code QStateMachine machine; machine.setGlobalRestorePolicy(QStateMachine::RestoreProperties); - + QState *s1 = new QState(); s1->assignProperty(object, "fooBar", 1.0); machine.addState(s1); machine.setInitialState(s1); - - QState *s2 = new QState(s1); + + QState *s2 = new QState(s1); s2->assignProperty(object, "fooBar", 2.0); s1->setInitialState(s2); - + QState *s3 = new QState(s1); \endcode - - Here \c s1 has two children: \c s2 and \c s3. When \c s2 is entered, the property \c fooBar + + Here \c s1 has two children: \c s2 and \c s3. When \c s2 is entered, the property \c fooBar will have the value 2.0, since this is explicitly defined for the state. When the machine is in state \c s3, no value is defined for the state, but \c s1 defines the property to be 1.0, so this - is the value that will be assigned to \c fooBar. - + is the value that will be assigned to \c fooBar. + \section1 Animating Property Assignments - - The State Machine API connects with the Animation API in Qt to allow automatically animating - properties as they are assigned in states. - + + The State Machine API connects with the Animation API in Qt to allow automatically animating + properties as they are assigned in states. + Say we have the following code: - \code + \code QState *s1 = new QState(); - QState *s2 = new QState(); - + QState *s2 = new QState(); + s1->assignProperty(button, "geometry", QRectF(0, 0, 50, 50)); s2->assignProperty(button, "geometry", QRectF(0, 0, 100, 100)); - + s1->addTransition(button, SIGNAL(clicked()), s2); \endcode - + Here we define two states of a user interface. In \c s1 the \c button is small, and in \c s2 - it is bigger. If we click the button to transition from \c s1 to \c s2, the geometry of the button - will be set immediately when a given state has been entered. If we want the transition to be + it is bigger. If we click the button to transition from \c s1 to \c s2, the geometry of the button + will be set immediately when a given state has been entered. If we want the transition to be smooth, however, all we need to do is make a QPropertyAnimation and add this to the transition object. - - \code + + \code QState *s1 = new QState(); - QState *s2 = new QState(); - + QState *s2 = new QState(); + s1->assignProperty(button, "geometry", QRectF(0, 0, 50, 50)); s2->assignProperty(button, "geometry", QRectF(0, 0, 100, 100)); - + QSignalTransition *transition = s1->addTransition(button, SIGNAL(clicked()), s2); transition->addAnimation(new QPropertyAnimation(button, "geometry")); \endcode - + Adding an animation for the property in question means that the property assignment will no longer take immediate effect when the state has been entered. Instead, the animation will start playing when the state has been entered and smoothly animate the property assignment. Since we - do not set the start value or end value of the animation, these will be set implicitly. The + do not set the start value or end value of the animation, these will be set implicitly. The start value of the animation will be the property's current value when the animation starts, and the end value will be set based on the property assignments defined for the state. - + If the global restore policy of the state machine is set to QStateMachine::RestoreProperties, it is possible to also add animations for the property restorations. - + \section1 Detecting That All Properties Have Been Set In A State - - When animations are used to assign properties, a state no longer defines the exact values that a + + When animations are used to assign properties, a state no longer defines the exact values that a property will have when the machine is in the given state. While the animation is running, the - property can potentially have any value, depending on the animation. - + property can potentially have any value, depending on the animation. + In some cases, it can be useful to be able to detect when the property has actually been assigned the value defined by a state. For this, we can use the state's polished() signal. \code QState *s1 = new QState(); s1->assignProperty(button, "geometry", QRectF(0, 0, 50, 50)); - + QState *s2 = new QState(); - + s1->addTransition(s1, SIGNAL(polished()), s2); \endcode - - The machine will be in state \c s1 until the \c geometry property has been set. Then it will + + The machine will be in state \c s1 until the \c geometry property has been set. Then it will immediately transition into \c s2. If the transition into \c s1 has an animation for the \c geometry property, then the machine will stay in \c s1 until the animation has finished. If there is no animation, it will simply set the property and immediately enter state \c s2. - - Either way, when the machine is in state \c s2, the property \c geometry has been assigned the + + Either way, when the machine is in state \c s2, the property \c geometry has been assigned the defined value. - + If the global restore policy is set to QStateMachine::RestoreProperties, the state will not emit the polished() signal until these have been executed as well. - + \section1 What happens if a state is exited before the animation has finished - - If a state has property assignments, and the transition into the state has animations for the - properties, the state can potentially be exited before the properties have been assigned to the - values defines by the state. This is true in particular when there are transitions out from the + + If a state has property assignments, and the transition into the state has animations for the + properties, the state can potentially be exited before the properties have been assigned to the + values defines by the state. This is true in particular when there are transitions out from the state that do not depend on the state being polished, as described in the previous section. - - The State Machine API guarantees that a property assigned by the state machine either: + + The State Machine API guarantees that a property assigned by the state machine either: \list \o Has a value explicitly assigned to the property. \o Is currently being animated into a value explicitly assigned to the property. \endlist - + When a state is exited prior to the animation finishing, the behavior of the state machine depends - on the target state of the transition. If the target state explicitly assigns a value to the + on the target state of the transition. If the target state explicitly assigns a value to the property, no additional action will be taken. The property will be assigned the value defined by - the target state. - + the target state. + If the target state does not assign any value to the property, there are two options: By default, the property will be assigned the value defined by the state it is leaving - (the value it would have been assigned if the animation had been permitted to finish playing.) If - a global restore policy is set, however, this will take precedence, and the property will be + (the value it would have been assigned if the animation had been permitted to finish playing.) If + a global restore policy is set, however, this will take precedence, and the property will be restored as usual. - + \section1 Default Animations - + As described earlier, you can add animations to transitions to make sure property assignments in the target state are animated. If you want a specific animation to be used for a given property - regardless of which transition is taken, you can add it as a default animation to the state - machine. This is in particular useful when the properties assigned (or restored) by specific - states is not known when the machine is constructed. - - \code + regardless of which transition is taken, you can add it as a default animation to the state + machine. This is in particular useful when the properties assigned (or restored) by specific + states is not known when the machine is constructed. + + \code QState *s1 = new QState(); QState *s2 = new QState(); - + s2->assignProperty(object, "fooBar", 2.0); - s1->addTransition(s2); - + s1->addTransition(s2); + QStateMachine machine; machine.setInitialState(s1); - machine.addDefaultAnimation(new QPropertyAnimation(object, "fooBar")); - \endcode - - When the machine is in state \c s2, the machine will play the default animation for the - property \c fooBar since this property is assigned by \c s2. - - Note that animations explicitly set on transitions will take precedence over any default - animation for the given property. + machine.addDefaultAnimation(new QPropertyAnimation(object, "fooBar")); + \endcode + + When the machine is in state \c s2, the machine will play the default animation for the + property \c fooBar since this property is assigned by \c s2. + + Note that animations explicitly set on transitions will take precedence over any default + animation for the given property. */ |