Sophie

Sophie

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

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" />
<!-- qdeclarativegeomaptextobject.cpp -->
  <title>Qt Mobility 1.2: QML MapText Element</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="http://qt.nokia.com/doc/4.7/qdeclarativeelements.html">QML Elements</a></li>
<li>QML MapText Element</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<p class="naviNextPrevious headerNavi">
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QML MapText Element</h1>
<span class="subtitle"></span>
<!-- $$$MapText-brief -->
<p>The MapText element displays text on a map. <a href="#details">More...</a></p>
<!-- @@@MapText -->
<p>This element was introduced in  Mobility 1.2.</p>
<ul>
<li><a href="qml-maptext-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-maptext.html#color-prop">color</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-maptext.html#coordinate-prop">coordinate</a></b></b> : Coordinate</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.bold-prop">font.bold</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.capitalization-prop">font.capitalization</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.family-prop">font.family</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.italic-prop">font.italic</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.letterSpacing-prop">font.letterSpacing</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.pixelSize-prop">font.pixelSize</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.pointSize-prop">font.pointSize</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.strikeout-prop">font.strikeout</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.underline-prop">font.underline</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.weight-prop">font.weight</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-maptext.html#font.wordSpacing-prop">font.wordSpacing</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-maptext.html#horizontalAlignment-prop">horizontalAlignment</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-maptext.html#offset.x-prop">offset.x</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-maptext.html#offset.y-prop">offset.y</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-maptext.html#text-prop">text</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-maptext.html#verticalAlignment-prop">verticalAlignment</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-maptext.html#visible-prop">visible</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-maptext.html#z-prop">z</a></b></b> : int</li>
</ul>
<!-- $$$MapText-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>The string <a href="qml-maptext.html#text-prop">text</a> will be drawn <a href="qml-maptext.html#offset.x-prop">offset.x</a> and <a href="qml-maptext.html#offset.y-prop">offset.y</a> pixels away from the on-screen position of <a href="qml-maptext.html#coordinate-prop">coordinate</a>.</p>
<p>The text will be rendered with font <a href="http://qt.nokia.com/doc/4.7/qml-font.html">font</a> and color <a href="qml-maptext.html#color-prop">color</a>, and will be aligned according to <a href="qml-maptext.html#horizontalAlignment-prop">horizontalAlignment</a> and <a href="qml-maptext.html#verticalAlignment-prop">verticalAlignment</a>.</p>
<p>If <a href="qml-maptext.html#text-prop">text</a> is empty or <a href="qml-maptext.html#coordinate-prop">coordinate</a> is invalid nothing will be displayed.</p>
<p>An example of text item:</p>
<pre class="qml"> <span class="type">MapText</span> {
     <span class="name">color</span>: <span class="string">&quot;blue&quot;</span>
     <span class="name">coordinate</span>: <span class="name">landmark</span>.<span class="name">coordinate</span>
     <span class="name">text</span>: <span class="name">landmark</span>.<span class="name">name</span>
     <span class="name">font</span>.pointSize: <span class="number">8</span>
 }</pre>
<p>The MapText element is part of the <b>QtMobility.location 1.2</b> module.</p>
<!-- @@@MapText -->
<h2>Property Documentation</h2>
<!-- $$$color -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="color-prop"></a><span class="name">color</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-color.html">color</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the color used to draw the text.</p>
<p>The default value is black.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@color -->
<br/>
<!-- $$$coordinate -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="coordinate-prop"></a><span class="name">coordinate</span> : <span class="type"><a href="qml-coordinate.html">Coordinate</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the coordinate at which to anchor the text.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@coordinate -->
<br/>
<!-- $$$font.bold -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.bold-prop"></a><span class="name">font.bold</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets whether the font weight is bold.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.bold -->
<br/>
<!-- $$$font.capitalization -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.capitalization-prop"></a><span class="name">font.capitalization</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the capitalization for the text.</p>
<ul>
<li>Font.MixedCase - This is the normal text rendering option where no capitalization change is applied.</li>
<li>Font.AllUppercase - This alters the text to be rendered in all uppercase type.</li>
<li>Font.AllLowercase - This alters the text to be rendered in all lowercase type.</li>
<li>Font.SmallCaps - This alters the text to be rendered in small-caps type.</li>
<li>Font.Capitalize - This alters the text to be rendered with the first character of each word as an uppercase character.</li>
</ul>
<pre class="qml"> <span class="type"><a href="qml-maptext.html">MapText</a></span> { <span class="name">text</span>: <span class="string">&quot;Hello&quot;</span>; <span class="name">font</span>.capitalization: <span class="name">Font</span>.<span class="name">AllLowercase</span> }</pre>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.capitalization -->
<br/>
<!-- $$$font.family -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.family-prop"></a><span class="name">font.family</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the family name of the font.</p>
<p>The family name is case insensitive and may optionally include a foundry name, e.g&#x2e; &quot;Helvetica [Cronyx]&quot;. If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.family -->
<br/>
<!-- $$$font.italic -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.italic-prop"></a><span class="name">font.italic</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets whether the font has an italic style.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.italic -->
<br/>
<!-- $$$font.letterSpacing -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.letterSpacing-prop"></a><span class="name">font.letterSpacing</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-real.html">real</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the letter spacing for the font.</p>
<p>Letter spacing changes the default spacing between individual letters in the font. A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.letterSpacing -->
<br/>
<!-- $$$font.pixelSize -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.pixelSize-prop"></a><span class="name">font.pixelSize</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the font size in pixels.</p>
<p>Using this function makes the font device dependent. Use <tt>pointSize</tt> to set the size of the font in a device independent manner.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.pixelSize -->
<br/>
<!-- $$$font.pointSize -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.pointSize-prop"></a><span class="name">font.pointSize</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-real.html">real</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the font size in points. The point size must be greater than zero.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.pointSize -->
<br/>
<!-- $$$font.strikeout -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.strikeout-prop"></a><span class="name">font.strikeout</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets whether the font has a strikeout style.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.strikeout -->
<br/>
<!-- $$$font.underline -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.underline-prop"></a><span class="name">font.underline</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets whether the text is underlined.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.underline -->
<br/>
<!-- $$$font.weight -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.weight-prop"></a><span class="name">font.weight</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the font's weight.</p>
<p>The weight can be one of:</p>
<ul>
<li>Font.Light</li>
<li>Font.Normal - the default</li>
<li>Font.DemiBold</li>
<li>Font.Bold</li>
<li>Font.Black</li>
</ul>
<pre class="qml"> <span class="type"><a href="qml-maptext.html">MapText</a></span> { <span class="name">text</span>: <span class="string">&quot;Hello&quot;</span>; <span class="name">font</span>.weight: <span class="name">Font</span>.<span class="name">DemiBold</span> }</pre>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.weight -->
<br/>
<!-- $$$font.wordSpacing -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="font.wordSpacing-prop"></a><span class="name">font.wordSpacing</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-real.html">real</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the word spacing for the font.</p>
<p>Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@font.wordSpacing -->
<br/>
<!-- $$$horizontalAlignment -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="horizontalAlignment-prop"></a><span class="name">horizontalAlignment</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="verticalAlignment-prop"></a><span class="name">verticalAlignment</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>Sets the horizontal and vertical alignment of the text.</p>
<p>The alignment is relative to the point <a href="qml-maptext.html#offset.x-prop">offset.x</a> and <a href="qml-maptext.html#offset.y-prop">offset.y</a> pixels away from the on-screen position of <a href="qml-maptext.html#coordinate-prop">coordinate</a>.</p>
<p>The valid values for <tt>horizontalAlignment</tt> are <tt>MapText.AlignLeft</tt>, <tt>MapText.AlignRight</tt> and <tt>MapText.AlignHCenter</tt>. The valid values for <tt>verticalAlignment</tt> are <tt>MapText.AlignTop</tt>, <tt>MapText.AlignBottom</tt> and <tt>MapText.AlignVCenter</tt>.</p>
<p>The default values are <tt>MapText.AlignHCenter</tt> and <tt>MapText.AlignVCenter</tt> respectively.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@horizontalAlignment -->
<br/>
<!-- $$$offset.x -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="offset.x-prop"></a><span class="name">offset.x</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-int.html">int</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="offset.y-prop"></a><span class="name">offset.y</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties hold the offset from the on-screen position of <a href="qml-maptext.html#coordinate-prop">coordinate</a> at which the text should be displayed.</p>
<p>They both default to 0.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@offset.x -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="text-prop"></a><span class="name">text</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the text to display.</p>
<p>The default value is an empty string.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@text -->
<br/>
<!-- $$$visible -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="visible-prop"></a><span class="name">visible</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds a boolean corresponding to whether or not the text is visible.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@visible -->
<br/>
<!-- $$$z -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="z-prop"></a><span class="name">z</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the z-value of the text.</p>
<p>Map objects are drawn in z-value order, and objects with the same z-value will be drawn in insertion order.</p>
<p>This property group was introduced in  Mobility 1.2.</p>
</div></div><!-- @@@z -->
<br/>
<p class="naviNextPrevious footerNavi">
</p>
  <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>