<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="copyright" content="(C) Copyright 2010" />
  <meta name="DC.rights.owner" content="(C) Copyright 2010" />
  <meta name="DC.Type" content="cxxClass" />
  <meta name="DC.Title" content="CSatelliteInfoUI" />
  <meta name="DC.Format" content="XHTML" />
  <meta name="DC.Identifier" content="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA" />
  <title>
   CSatelliteInfoUI
  </title>
   <link type="text/css" rel="stylesheet" href="css/common.css" media="screen"/>
<link type="text/css" rel="stylesheet" href="css/sdl.css" media="screen"/>

<!--[if IE]>
<link href="css/iefix.css" rel="stylesheet" type="text/css" media="screen" />
<![endif]-->
  <meta name="keywords" content="api" />
  <link rel="stylesheet" type="text/css" href="cxxref.css" />
 </head>
 <body class="cxxref" id="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA">
  <a name="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA">
   <!-- -->
  </a>
  <?php include_once (CURRENT_SKIN_PATH.'/sdl_header.html'); ?>
  <div id="sdl_container">
   <div id="leftMenu">
    <div id="expandcontractdiv">
     <a id="collapseTree" href="javascript:tree.collapseAll()">
      Collapse all
     </a>
     <a id="index" href="index.html">
      Symbian^3 Application Developer Library
     </a>
    </div>
    <iframe style="border:none" height="800" width="300" src="index-toc.html"></iframe>
<div id="treeDiv1">
     &#160;
    </div>
    <script type="text/javascript">
     var currentIconMode = 0; window.name="id2518338 id2518347 id2420140 id2374166 id2362038 id2362043 ";
	YAHOO.util.Event.onDOMReady(buildTree, this,true);
    </script>
   </div>
   <div id="sdl_content">
    <div class="breadcrumb">
     <a href="index.html" title="Symbian^3 Application Developer Library">
      Symbian^3 Application Developer Library
     </a>
     &gt;
    </div>
    <h1 class="topictitle1">
     CSatelliteInfoUI Class Reference
    </h1>
    <table class="signature">
     <tr>
      <td>
       class CSatelliteInfoUI : public CBase
      </td>
     </tr>
    </table>
    <div class="section">
     <div>
      <p>
       Implements entry point class to Satellite Info UI
      </p>
     </div>
    </div>
    <div class="section derivation">
     <h2 class="sectiontitle">
      Inherits from
     </h2>
     <ul class="derivation derivation-root">
      <li class="derivation-depth-0 ">
       CSatelliteInfoUI
       <ul class="derivation">
        <li class="derivation-depth-1 ">
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase
         </a>
        </li>
       </ul>
      </li>
     </ul>
    </div>
    <div class="section member-index">
     <table border="0" class="member-index">
      <thead>
       <tr>
        <th colspan="2">
         Public Member Functions
        </th>
       </tr>
      </thead>
      <tbody>
       <tr>
        <td align="right" class="code">
        </td>
        <td>
         <a href="#GUID-93A99578-A735-3F5A-A355-73E54FC03D4D">
          ~CSatelliteInfoUI
         </a>
         ()
        </td>
       </tr>
       <tr class="bg">
        <td align="right" class="code">
         IMPORT_C
         <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
          TInt
         </a>
        </td>
        <td>
         <a href="#GUID-0952B6DA-56C1-3D73-881F-13B0B61189BC">
          ExecuteLD
         </a>
         (const
         <a href="GUID-440FF2B4-353B-3097-A2BA-5887D10B8B23.html">
          TDesC
         </a>
         &amp;)
        </td>
       </tr>
       <tr>
        <td align="right" class="code">
         IMPORT_C void
        </td>
        <td>
         <a href="#GUID-701C4261-F095-3690-9E66-6866C00EF918">
          HandleForegroundEventL
         </a>
         (
         <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
          TBool
         </a>
         )
        </td>
       </tr>
       <tr class="bg">
        <td align="right" class="code">
         IMPORT_C
         <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html">
          CSatelliteInfoUI
         </a>
         *
        </td>
        <td>
         <a href="#GUID-B2D49139-004F-3CDA-8D1C-C44C6E16BDA1">
          NewL
         </a>
         ()
        </td>
       </tr>
       <tr>
        <td align="right" class="code">
         IMPORT_C void
        </td>
        <td>
         <a href="#GUID-1FABF8E8-FFE9-373B-90A4-ABE7A2290B1B">
          SetLaunchView
         </a>
         (
         <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html">
          TSatelliteView
         </a>
         )
        </td>
       </tr>
      </tbody>
     </table>
     <table border="0" class="member-index">
      <thead>
       <tr>
        <th colspan="2">
         Private Member Functions
        </th>
       </tr>
      </thead>
      <tbody>
       <tr>
        <td align="right" class="code">
        </td>
        <td>
         <a href="#GUID-670D1DFA-9DBF-32A7-BDEB-E165D7336286">
          CSatelliteInfoUI
         </a>
         ()
        </td>
       </tr>
       <tr class="bg">
        <td align="right" class="code">
         void
        </td>
        <td>
         <a href="#GUID-4E54AE35-8E26-3D97-B67E-1270F69CF2B8">
          ConstructL
         </a>
         ()
        </td>
       </tr>
      </tbody>
     </table>
     <table border="0" class="member-index">
      <thead>
       <tr>
        <th colspan="2">
         Inherited Functions
        </th>
       </tr>
      </thead>
      <tbody>
       <tr>
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::CBase()
         </a>
        </td>
       </tr>
       <tr class="bg">
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::Delete(CBase *)
         </a>
        </td>
       </tr>
       <tr>
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::Extension_(TUint,TAny *&amp;,TAny *)
         </a>
        </td>
       </tr>
       <tr class="bg">
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::operator new(TUint)
         </a>
        </td>
       </tr>
       <tr>
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::operator new(TUint,TAny *)
         </a>
        </td>
       </tr>
       <tr class="bg">
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::operator new(TUint,TLeave)
         </a>
        </td>
       </tr>
       <tr>
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::operator new(TUint,TLeave,TUint)
         </a>
        </td>
       </tr>
       <tr class="bg">
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::operator new(TUint,TUint)
         </a>
        </td>
       </tr>
       <tr>
        <td>
        </td>
        <td>
         <a href="GUID-8F6FE089-E2A8-30F4-B67E-10F286347681.html">
          CBase::~CBase()
         </a>
        </td>
       </tr>
      </tbody>
     </table>
     <table border="0" class="member-index">
      <thead>
       <tr>
        <th colspan="2">
         Public Member Enumerations
        </th>
       </tr>
      </thead>
      <tbody>
       <tr>
        <td align="right" valign="top">
         enum
        </td>
        <td>
         <a href="#GUID-CB34AEA2-3200-36E2-B794-9A637EF844E7">
          TSatelliteView
         </a>
         {
         <a href="#GUID-F6D6E7B8-5DEA-3D20-8D05-C41D3E2C32F3">
          ESatelliteFirmamentView
         </a>
          = 0x0001,
         <a href="#GUID-48850147-3943-3AD1-AE32-2D916E4118CE">
          ESatelliteSignalStrengthView
         </a>
          = 0x0002,
         <a href="#GUID-34BF2F16-AD94-3E9D-AF6E-F50156411C5A">
          ESatelliteCompassView
         </a>
          = 0x0003 }
        </td>
       </tr>
      </tbody>
     </table>
     <table border="0" class="member-index">
      <thead>
       <tr>
        <th colspan="2">
         Private Attributes
        </th>
       </tr>
      </thead>
      <tbody>
       <tr>
        <td align="right" valign="top">
         <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
          TBool
         </a>
         *
        </td>
        <td>
         <a href="#GUID-D5ECE435-475B-37E7-A6D8-2C499F65937F">
          iDestroyedPtr
         </a>
        </td>
       </tr>
       <tr class="bg">
        <td align="right" valign="top">
         CSatellite *
        </td>
        <td>
         <a href="#GUID-8912768F-47F8-31B9-90EF-CD3681D43EA9">
          iSatellite
         </a>
        </td>
       </tr>
      </tbody>
     </table>
    </div>
    <h1 class="pageHeading topictitle1">
     Constructor &amp; Destructor Documentation
    </h1>
    <div class="nested1" id="GUID-670D1DFA-9DBF-32A7-BDEB-E165D7336286">
     <a name="GUID-670D1DFA-9DBF-32A7-BDEB-E165D7336286">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      CSatelliteInfoUI()
     </h2>
     <table class="signature">
      <tr>
       <td>
        CSatelliteInfoUI
       </td>
       <td>
        (
       </td>
       <td>
        )
       </td>
       <td>
        [private]
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        C++ default constructor.
       </p>
      </div>
     </div>
    </div>
    <div class="nested1" id="GUID-93A99578-A735-3F5A-A355-73E54FC03D4D">
     <a name="GUID-93A99578-A735-3F5A-A355-73E54FC03D4D">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      ~CSatelliteInfoUI()
     </h2>
     <table class="signature">
      <tr>
       <td>
        IMPORT_C
       </td>
       <td>
        ~CSatelliteInfoUI
       </td>
       <td>
        (
       </td>
       <td>
        )
       </td>
       <td>
        [virtual]
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Destructor.
       </p>
      </div>
     </div>
    </div>
    <h1 class="pageHeading topictitle1">
     Member Functions Documentation
    </h1>
    <div class="nested1" id="GUID-4E54AE35-8E26-3D97-B67E-1270F69CF2B8">
     <a name="GUID-4E54AE35-8E26-3D97-B67E-1270F69CF2B8">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      ConstructL()
     </h2>
     <table class="signature">
      <tr>
       <td>
        void
       </td>
       <td>
        ConstructL
       </td>
       <td>
        (
       </td>
       <td>
        )
       </td>
       <td>
        [private]
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        By default Symbian 2nd phase constructor is private.
       </p>
      </div>
     </div>
    </div>
    <div class="nested1" id="GUID-0952B6DA-56C1-3D73-881F-13B0B61189BC">
     <a name="GUID-0952B6DA-56C1-3D73-881F-13B0B61189BC">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      ExecuteLD(const TDesC &amp;)
     </h2>
     <table class="signature">
      <tr>
       <td>
        IMPORT_C
        <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
         TInt
        </a>
       </td>
       <td>
        ExecuteLD
       </td>
       <td>
        (
       </td>
       <td>
        const
        <a href="GUID-440FF2B4-353B-3097-A2BA-5887D10B8B23.html">
         TDesC
        </a>
        &amp;
       </td>
       <td>
        aNameOfRule
       </td>
       <td>
        )
       </td>
       <td>
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Display satellite's information dialog.
       </p>
       <p>
        This library uses the services provided by Location Framework. Once the dialog is launched satellite information is continuously requested via Location Acquisition API. The Location Acquisition API is offered by Location Framework. The user can switch between the two views once the dialog is launched.
       </p>
       <div class="p">
        <dl class="user">
         <dt class="dlterm">
          <strong>
           leave
          </strong>
         </dt>
         <dd>
          KErrArgument if requestor data (aNameOfRule argument) length exceeds 255 characters or if it is empty. This function may also leave with any one of the standard error codes such as out of memory (e.g. KErrNoMemory)
         </dd>
        </dl>
       </div>
      </div>
     </div>
     <div class="section parameters">
      <h3 class="sectiontitle">
       Parameters
      </h3>
      <table border="0" class="parameters">
       <tr>
        <td class="parameter">
         const
         <a href="GUID-440FF2B4-353B-3097-A2BA-5887D10B8B23.html">
          TDesC
         </a>
         &amp; aNameOfRule
        </td>
        <td>
         is requestor data for Location FW which will be used for privacy verification in the future. Application name should be used to specify the requestor. The string should not be empty.
        </td>
       </tr>
      </table>
     </div>
    </div>
    <div class="nested1" id="GUID-701C4261-F095-3690-9E66-6866C00EF918">
     <a name="GUID-701C4261-F095-3690-9E66-6866C00EF918">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      HandleForegroundEventL(TBool)
     </h2>
     <table class="signature">
      <tr>
       <td>
        IMPORT_C void
       </td>
       <td>
        HandleForegroundEventL
       </td>
       <td>
        (
       </td>
       <td>
        <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
         TBool
        </a>
       </td>
       <td>
        aForeground
       </td>
       <td>
        )
       </td>
       <td>
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Dialog switched to foreground or background
       </p>
      </div>
     </div>
     <div class="section parameters">
      <h3 class="sectiontitle">
       Parameters
      </h3>
      <table border="0" class="parameters">
       <tr>
        <td class="parameter">
         <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
          TBool
         </a>
         aForeground
        </td>
        <td>
         ETrue to switch to the foreground. EFalse to switch to background.
        </td>
       </tr>
      </table>
     </div>
    </div>
    <div class="nested1" id="GUID-B2D49139-004F-3CDA-8D1C-C44C6E16BDA1">
     <a name="GUID-B2D49139-004F-3CDA-8D1C-C44C6E16BDA1">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      NewL()
     </h2>
     <table class="signature">
      <tr>
       <td>
        IMPORT_C
        <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html">
         CSatelliteInfoUI
        </a>
        *
       </td>
       <td>
        NewL
       </td>
       <td>
        (
       </td>
       <td>
        )
       </td>
       <td>
        [static]
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Two-phased constructor.
       </p>
       <p>
       </p>
      </div>
     </div>
    </div>
    <div class="nested1" id="GUID-1FABF8E8-FFE9-373B-90A4-ABE7A2290B1B">
     <a name="GUID-1FABF8E8-FFE9-373B-90A4-ABE7A2290B1B">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      SetLaunchView(TSatelliteView)
     </h2>
     <table class="signature">
      <tr>
       <td>
        IMPORT_C void
       </td>
       <td>
        SetLaunchView
       </td>
       <td>
        (
       </td>
       <td>
        <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html">
         TSatelliteView
        </a>
       </td>
       <td>
        aLaunchView
       </td>
       <td>
        )
       </td>
       <td>
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Used to set the dialog's launch view
       </p>
       <p>
        This method is used to set the view in which the dialog should be launched. The two available views are signal strength and firmament view. Constants for settings default view specified in enum
        <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html#GUID-CB34AEA2-3200-36E2-B794-9A637EF844E7">
         TSatelliteView
        </a>
        . This method should be called before the method
        <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html#GUID-0952B6DA-56C1-3D73-881F-13B0B61189BC">
         ExecuteLD
        </a>
        is invoked.
       </p>
       <div class="p">
        <dl class="user">
         <dt class="dlterm">
          <strong>
           panic
          </strong>
         </dt>
         <dd>
          EAknPanicOutOfRange if the method is invoked with an invalid parameter. Values provided apart from those specified in
          <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html#GUID-CB34AEA2-3200-36E2-B794-9A637EF844E7">
           TSatelliteView
          </a>
          are invalid and will cause the method to panic.
         </dd>
        </dl>
       </div>
      </div>
     </div>
     <div class="section parameters">
      <h3 class="sectiontitle">
       Parameters
      </h3>
      <table border="0" class="parameters">
       <tr>
        <td class="parameter">
         <a href="GUID-DD9674C9-445A-36D8-A4EF-5384D3EF74BA.html">
          TSatelliteView
         </a>
         aLaunchView
        </td>
        <td>
         ESatelliteFirmamentView for firmament view and ESatelliteSignalStrengthView for signal strength view. ESatelliteCompassView for compass ciew ESatelliteCompassView Visibility will be variated depending on the product configuration/regional variation. if it is disabled to show compass view then function will ignore the ESatelliteCompassView and show firmament view instead.
        </td>
       </tr>
      </table>
     </div>
    </div>
    <h1 class="pageHeading topictitle1">
     Member Enumerations Documentation
    </h1>
    <div class="nested1" id="GUID-CB34AEA2-3200-36E2-B794-9A637EF844E7">
     <a name="GUID-CB34AEA2-3200-36E2-B794-9A637EF844E7">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      Enum TSatelliteView
     </h2>
     <div class="section">
      <div>
       <p>
        Enumeration to specify the default launch view of the dialog.
       </p>
      </div>
     </div>
     <div class="section enumerators">
      <h3 class="sectiontitle">
       Enumerators
      </h3>
      <table border="0" class="enumerators">
       <tr>
        <td valign="top">
         ESatelliteFirmamentView = 0x0001
        </td>
        <td>
         <p>
          Launch option for firmament view. Firmament view displays all the satellites in view with the satellite's number on a firmament.
         </p>
        </td>
       </tr>
       <tr class="bg">
        <td valign="top">
         ESatelliteSignalStrengthView = 0x0002
        </td>
        <td>
         <p>
          Launch option for signal strength view. Signal strength view displays all the satellite with their correspoinding signal strength represented by bars.
         </p>
        </td>
       </tr>
       <tr>
        <td valign="top">
         ESatelliteCompassView = 0x0003
        </td>
        <td>
         <p>
          Launch option for compass view. Compass view displays latitude, longitude, speed and direction along with 2D/3D type of Fix.
         </p>
        </td>
       </tr>
      </table>
     </div>
    </div>
    <h1 class="pageHeading topictitle1">
     Member Data Documentation
    </h1>
    <div class="nested1" id="GUID-D5ECE435-475B-37E7-A6D8-2C499F65937F">
     <a name="GUID-D5ECE435-475B-37E7-A6D8-2C499F65937F">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      TBool * iDestroyedPtr
     </h2>
     <table class="signature">
      <tr>
       <td>
        <a href="GUID-FC2F2B93-3D18-3BCC-9FD6-6BC6B240B667.html">
         TBool
        </a>
        *
       </td>
       <td>
        iDestroyedPtr
       </td>
       <td>
        [private]
       </td>
      </tr>
     </table>
     <div class="section">
     </div>
    </div>
    <div class="nested1" id="GUID-8912768F-47F8-31B9-90EF-CD3681D43EA9">
     <a name="GUID-8912768F-47F8-31B9-90EF-CD3681D43EA9">
      <!-- -->
     </a>
     <h2 class="topictitle2">
      CSatellite * iSatellite
     </h2>
     <table class="signature">
      <tr>
       <td>
        CSatellite *
       </td>
       <td>
        iSatellite
       </td>
       <td>
        [private]
       </td>
      </tr>
     </table>
     <div class="section">
      <div>
       <p>
        Own: A pointer to CSatellite. Contains the engine and the dialog implementation.
       </p>
      </div>
     </div>
    </div>
    <p class="copyright">Copyright &#169;2010 Nokia Corporation and/or its subsidiary(-ies).<br /> All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the <a href=" http://www.eclipse.org/legal/epl-v10.html"> Eclipse Public License
v1.0</a>.</p> 
   </div>
  </div>
  <?php include_once (CURRENT_SKIN_PATH.'/sdl_footer.html'); ?>
 </body>
</html>