Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 1135

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmetadatawritercontrol.cpp -->
  <title>Qt Mobility 1.2: QMetaDataWriterControl Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmultimediakit.html">QtMultimediaKit</a></li>
<li>QMetaDataWriterControl</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QMetaDataWriterControl Class Reference</h1>
<!-- $$$QMetaDataWriterControl-brief -->
<p>The QMetaDataWriterControl class provides write access to the meta-data of a <a href="qmediaservice.html">QMediaService</a>'s media. <a href="#details">More...</a></p>
<!-- @@@QMetaDataWriterControl -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QMetaDataWriterControl&gt;</span></pre><p><b>Inherits: </b><a href="qmediacontrol.html">QMediaControl</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qmetadatawritercontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#dtor.QMetaDataWriterControl">~QMetaDataWriterControl</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#availableExtendedMetaData">availableExtendedMetaData</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList&lt;QtMultimediaKit::MetaData&gt; </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#availableMetaData">availableMetaData</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#extendedMetaData">extendedMetaData</a></b> ( const QString &amp; <i>key</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#isMetaDataAvailable">isMetaDataAvailable</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#isWritable">isWritable</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#metaData">metaData</a></b> ( QtMultimediaKit::MetaData <i>key</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#setExtendedMetaData">setExtendedMetaData</a></b> ( const QString &amp; <i>key</i>, const QVariant &amp; <i>value</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#setMetaData">setMetaData</a></b> ( QtMultimediaKit::MetaData <i>key</i>, const QVariant &amp; <i>value</i> ) = 0</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#metaDataAvailableChanged">metaDataAvailableChanged</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#metaDataChanged">metaDataChanged</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#writableChanged">writableChanged</a></b> ( bool <i>writable</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#QMetaDataWriterControl">QMetaDataWriterControl</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmetadatawritercontrol.html#QMetaDataWriterControl_iid">QMetaDataWriterControl_iid</a></b></td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QMetaDataWriterControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMetaDataWriterControl class provides write access to the meta-data of a <a href="qmediaservice.html">QMediaService</a>'s media.</p>
<p>If a <a href="qmediaservice.html">QMediaService</a> can provide write access to the meta-data of its current media it will implement QMetaDataWriterControl. This control provides functions for both retrieving and setting meta-data values. Meta-data may be addressed by the well defined keys in the <a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a> enumeration using the <a href="qmetadatawritercontrol.html#metaData">metaData</a>() functions, or by string keys using the <a href="qmetadatawritercontrol.html#extendedMetaData">extendedMetaData</a>() functions.</p>
<p>The functionality provided by this control is exposed to application code by the meta-data members of <a href="qmediaobject.html">QMediaObject</a>, and so meta-data access is potentially available in any of the media object classes. Any media service may implement QMetaDataControl.</p>
<p>The interface name of QMetaDataWriterControl is <tt>com.nokia.Qt.QMetaDataWriterControl/1.0</tt> as defined in <a href="qmetadatawritercontrol.html#QMetaDataWriterControl_iid">QMetaDataWriterControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>() and <a href="qmediaobject.html">QMediaObject</a>.</p>
<!-- @@@QMetaDataWriterControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMetaDataWriterControl[overload1]$$$QMetaDataWriterControlQObject* -->
<h3 class="fn"><a name="QMetaDataWriterControl"></a>QMetaDataWriterControl::<span class="name">QMetaDataWriterControl</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )<tt> [protected]</tt></h3>
<p>Construct a <a href="qmetadatawritercontrol.html">QMetaDataWriterControl</a> with <i>parent</i>. This class is meant as a base class for service specific meta data providers so this constructor is protected.</p>
<!-- @@@QMetaDataWriterControl -->
<!-- $$$~QMetaDataWriterControl[overload1]$$$~QMetaDataWriterControl -->
<h3 class="fn"><a name="dtor.QMetaDataWriterControl"></a>QMetaDataWriterControl::<span class="name">~QMetaDataWriterControl</span> ()</h3>
<p>Destroy the meta-data writer control.</p>
<!-- @@@~QMetaDataWriterControl -->
<!-- $$$availableExtendedMetaData[overload1]$$$availableExtendedMetaData -->
<h3 class="fn"><a name="availableExtendedMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QMetaDataWriterControl::<span class="name">availableExtendedMetaData</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns a list of keys there is extended meta-data available for.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availableExtendedMetaData -->
<!-- $$$availableMetaData[overload1]$$$availableMetaData -->
<h3 class="fn"><a name="availableMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span>&gt; QMetaDataWriterControl::<span class="name">availableMetaData</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns a list of keys there is meta-data available for.</p>
<!-- @@@availableMetaData -->
<!-- $$$extendedMetaData[overload1]$$$extendedMetaDataconstQString& -->
<h3 class="fn"><a name="extendedMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QMetaDataWriterControl::<span class="name">extendedMetaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>key</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the meta-data for an abitrary string <i>key</i>.</p>
<p>The valid selection of keys for extended meta-data is determined by the provider and the meaning and type may differ between providers.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmetadatawritercontrol.html#setExtendedMetaData">setExtendedMetaData</a>().</p>
<!-- @@@extendedMetaData -->
<!-- $$$isMetaDataAvailable[overload1]$$$isMetaDataAvailable -->
<h3 class="fn"><a name="isMetaDataAvailable"></a><span class="type">bool</span> QMetaDataWriterControl::<span class="name">isMetaDataAvailable</span> () const<tt> [pure virtual]</tt></h3>
<p>Identifies if meta-data is available from a media service.</p>
<p>Returns true if the meta-data is available and false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isMetaDataAvailable -->
<!-- $$$isWritable[overload1]$$$isWritable -->
<h3 class="fn"><a name="isWritable"></a><span class="type">bool</span> QMetaDataWriterControl::<span class="name">isWritable</span> () const<tt> [pure virtual]</tt></h3>
<p>Identifies if a media service's meta-data can be edited.</p>
<p>Returns true if the meta-data is writable and false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isWritable -->
<!-- $$$metaData[overload1]$$$metaDataQtMultimediaKit::MetaData -->
<h3 class="fn"><a name="metaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QMetaDataWriterControl::<span class="name">metaData</span> ( <span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span> <i>key</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the meta-data for the given <i>key</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmetadatawritercontrol.html#setMetaData">setMetaData</a>().</p>
<!-- @@@metaData -->
<!-- $$$metaDataAvailableChanged[overload1]$$$metaDataAvailableChangedbool -->
<h3 class="fn"><a name="metaDataAvailableChanged"></a><span class="type">void</span> QMetaDataWriterControl::<span class="name">metaDataAvailableChanged</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>Signal the availability of meta-data has changed, <i>available</i> will be true if the multimedia object has meta-data.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@metaDataAvailableChanged -->
<!-- $$$metaDataChanged[overload1]$$$metaDataChanged -->
<h3 class="fn"><a name="metaDataChanged"></a><span class="type">void</span> QMetaDataWriterControl::<span class="name">metaDataChanged</span> ()<tt> [signal]</tt></h3>
<p>Signal the changes of meta-data.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@metaDataChanged -->
<!-- $$$setExtendedMetaData[overload1]$$$setExtendedMetaDataconstQString&constQVariant& -->
<h3 class="fn"><a name="setExtendedMetaData"></a><span class="type">void</span> QMetaDataWriterControl::<span class="name">setExtendedMetaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>Change the value of the meta-data element with an abitrary string <i>key</i> to <i>value</i>.</p>
<p>The valid selection of keys for extended meta-data is determined by the provider and the meaning and type may differ between providers.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmetadatawritercontrol.html#extendedMetaData">extendedMetaData</a>().</p>
<!-- @@@setExtendedMetaData -->
<!-- $$$setMetaData[overload1]$$$setMetaDataQtMultimediaKit::MetaDataconstQVariant& -->
<h3 class="fn"><a name="setMetaData"></a><span class="type">void</span> QMetaDataWriterControl::<span class="name">setMetaData</span> ( <span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span> <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>Sets the <i>value</i> of the meta-data element with the given <i>key</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmetadatawritercontrol.html#metaData">metaData</a>().</p>
<!-- @@@setMetaData -->
<!-- $$$writableChanged[overload1]$$$writableChangedbool -->
<h3 class="fn"><a name="writableChanged"></a><span class="type">void</span> QMetaDataWriterControl::<span class="name">writableChanged</span> ( <span class="type">bool</span> <i>writable</i> )<tt> [signal]</tt></h3>
<p>Signal a change in the writable status of meta-data, <i>writable</i> will be true if meta-data elements can be added or adjusted.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@writableChanged -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QMetaDataWriterControl_iid[overload1]$$$QMetaDataWriterControl_iid -->
<h3 class="fn"><a name="QMetaDataWriterControl_iid"></a><span class="name">QMetaDataWriterControl_iid</span></h3>
<p><tt>com.nokia.Qt.QMetaDataWriterControl/1.0</tt></p>
<p>Defines the interface name of the <a href="qmetadatawritercontrol.html">QMetaDataWriterControl</a> class.</p>
<!-- @@@QMetaDataWriterControl_iid -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>