slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: fix qml links and standalone build for Multimedia

Browse Source 
Change-Id: Ia3f1e49aef203911bb5cf1ee062c9100be213b38
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Peter Yard
2012-02-21 15:58:01 +10:00
committed by Qt by Nokia
parent e791e4f0e9
commit cd5a8fc69d
35 changed files with 828 additions and 1367 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
src/imports/multimedia/qdeclarativeradio.cpp
View File

@@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Radio QDeclarativeRadio
\inqmlmodule QtMultimedia 5
\brief The Radio element allows you to access radio functionality from a QML application.
\ingroup multimedia_qml
\inherits Item
@@ -119,7 +120,7 @@ QDeclarativeRadio::~QDeclarativeRadio()
}
/*!
\qmlproperty enumeration Radio::state
\qmlproperty enumeration QtMultimedia5::Radio::state
This property holds the current state of the Radio element.
@@ -141,7 +142,7 @@ QDeclarativeRadio::State QDeclarativeRadio::state() const
}
/*!
\qmlproperty enumeration Radio::band
\qmlproperty enumeration QtMultimedia5::Radio::band
This property holds the frequency band used for the radio, which can be specified as
any one of the values in the table below.
@@ -171,7 +172,7 @@ QDeclarativeRadio::Band QDeclarativeRadio::band() const
}
/*!
\qmlproperty int Radio::frequency
\qmlproperty int QtMultimedia5::Radio::frequency
Sets the frequency in Hertz that the radio is tuned to. The frequency must be within the frequency
range for the current band, otherwise it will be changed to be within the frequency range.
@@ -184,7 +185,7 @@ int QDeclarativeRadio::frequency() const
}
/*!
\qmlproperty enumeration Radio::stereoMode
\qmlproperty enumeration QtMultimedia5::Radio::stereoMode
This property holds the stereo mode of the radio, which can be set to any one of the
values in the table below.
@@ -208,7 +209,7 @@ QDeclarativeRadio::StereoMode QDeclarativeRadio::stereoMode() const
}
/*!
\qmlproperty int Radio::volume
\qmlproperty int QtMultimedia5::Radio::volume
Set this property to control the volume of the radio. The valid range of the volume is from 0 to 100.
*/
@@ -218,7 +219,7 @@ int QDeclarativeRadio::volume() const
}
/*!
\qmlproperty bool Radio::muted
\qmlproperty bool QtMultimedia5::Radio::muted
This property reflects whether the radio is muted or not.
*/
@@ -228,7 +229,7 @@ bool QDeclarativeRadio::muted() const
}
/*!
\qmlproperty bool Radio::stereo
\qmlproperty bool QtMultimedia5::Radio::stereo
This property holds whether the radio is receiving a stereo signal or not. If \l stereoMode is
set to ForceMono the value will always be false. Likewise, it will always be true if stereoMode
@@ -242,7 +243,7 @@ bool QDeclarativeRadio::stereo() const
}
/*!
\qmlproperty int Radio::signalStrength
\qmlproperty int QtMultimedia5::Radio::signalStrength
The strength of the current radio signal as a percentage where 0% equals no signal, and 100% is a
very good signal.
@@ -253,7 +254,7 @@ int QDeclarativeRadio::signalStrength() const
}
/*!
\qmlproperty bool Radio::searching
\qmlproperty bool QtMultimedia5::Radio::searching
This property is true if the radio is currently searching for radio stations, for instance using the \l scanUp,
\l scanDown, and \l searchAllStations methods. Once the search completes, or if it is cancelled using
@@ -265,7 +266,7 @@ bool QDeclarativeRadio::searching() const
}
/*!
\qmlproperty int Radio::frequencyStep
\qmlproperty int QtMultimedia5::Radio::frequencyStep
The number of Hertz for each step when tuning the radio manually. The value is for the current \l band.
*/
@@ -275,7 +276,7 @@ int QDeclarativeRadio::frequencyStep() const
}
/*!
\qmlproperty int Radio::minimumFrequency
\qmlproperty int QtMultimedia5::Radio::minimumFrequency
The minimum frequency for the current \l band.
*/
@@ -285,7 +286,7 @@ int QDeclarativeRadio::minimumFrequency() const
}
/*!
\qmlproperty int Radio::maximumFrequency
\qmlproperty int QtMultimedia5::Radio::maximumFrequency
The maximum frequency for the current \l band.
*/
@@ -295,7 +296,7 @@ int QDeclarativeRadio::maximumFrequency() const
}
/*!
\qmlproperty int Radio::antennaConnected
\qmlproperty int QtMultimedia5::Radio::antennaConnected
This property is true if there is an antenna connected. Otherwise it will be false.
*/
@@ -305,7 +306,7 @@ bool QDeclarativeRadio::isAntennaConnected() const
}
/*!
\qmlmethod bool Radio::isAvailable()
\qmlmethod bool QtMultimedia5::Radio::isAvailable()
Returns whether the radio is ready to use.
*/
@@ -340,7 +341,7 @@ void QDeclarativeRadio::setMuted(bool muted)
}
/*!
\qmlmethod Radio::cancelScan()
\qmlmethod QtMultimedia5::Radio::cancelScan()
Cancel the current scan. Will also cancel a search started with \l searchAllStations.
*/
@@ -350,7 +351,7 @@ void QDeclarativeRadio::cancelScan()
}
/*!
\qmlmethod Radio::scanDown()
\qmlmethod QtMultimedia5::Radio::scanDown()
Searches backward in the frequency range for the current band.
*/
@@ -360,7 +361,7 @@ void QDeclarativeRadio::scanDown()
}
/*!
\qmlmethod Radio::scanUp()
\qmlmethod QtMultimedia5::Radio::scanUp()
Searches forward in the frequency range for the current band.
*/
@@ -370,7 +371,7 @@ void QDeclarativeRadio::scanUp()
}
/*!
\qmlmethod Radio::searchAllStations(enumeration searchMode)
\qmlmethod QtMultimedia5::Radio::searchAllStations(enumeration searchMode)
Start searching the complete frequency range for the current band, and save all the
radio stations found. The search mode can be either of the values described in the
@@ -429,7 +430,7 @@ void QDeclarativeRadio::searchAllStations(QDeclarativeRadio::SearchMode searchMo
}
/*!
\qmlmethod Radio::tuneDown()
\qmlmethod QtMultimedia5::Radio::tuneDown()
Decrements the frequency by the frequency step for the current band. If the frequency is already set
to the minimum frequency, calling this function has no effect.
@@ -444,7 +445,7 @@ void QDeclarativeRadio::tuneDown()
}
/*!
\qmlmethod Radio::tuneUp()
\qmlmethod QtMultimedia5::Radio::tuneUp()
Increments the frequency by the frequency step for the current band. If the frequency is already set
to the maximum frequency, calling this function has no effect.
@@ -459,7 +460,7 @@ void QDeclarativeRadio::tuneUp()
}
/*!
\qmlmethod Radio::start()
\qmlmethod QtMultimedia5::Radio::start()
Starts the radio. If the radio is available, as determined by the \l isAvailable method,
this will result in the \l state becoming \c ActiveState.
@@ -470,7 +471,7 @@ void QDeclarativeRadio::start()
}
/*!
\qmlmethod Radio::stop()
\qmlmethod QtMultimedia5::Radio::stop()
Stops the radio. After calling this method the \l state will be \c StoppedState.
*/
@@ -496,7 +497,7 @@ void QDeclarativeRadio::_q_error(QRadioTuner::Error errorCode)
}
/*!
\qmlsignal Radio::stationFound(int frequency, string stationId)
\qmlsignal QtMultimedia5::Radio::stationFound(int frequency, string stationId)
This signal is emitted when a new radio station is found. This signal is only emitted
if \l searchAllStations is called with \c SearchGetStationId.