<?xml version="1.0" encoding="utf-8"?>

<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

<!-- This component and the accompanying materials are made available under the terms of the License 

"Eclipse Public License v1.0" which accompanies this distribution, 

and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

<!-- Initial Contributors:

    Nokia Corporation - initial contribution.

Contributors: 

-->

<!DOCTYPE concept

  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

<concept id="GUID-BE5BE7AB-D0EE-530D-B2D9-97F7E4CFD9EA" xml:lang="en"><title>txtshell

Example Code</title><prolog><metadata><keywords/></metadata></prolog><conbody>

<section><title>Download</title> <p>Click on the following link to download

the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-65437f13-caa9-499f-b721-985c7e8e96ce.zip" scope="external">Txtshell.zip</xref></p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-65437f13-caa9-499f-b721-985c7e8e96ce.html" scope="peer">browse</xref> to view the example code. </p> </section>

<section><title>Description</title> <p> <filepath>txtshell</filepath> is

an application that provides a shell for the text example code to run in.

It provides four concrete text example controls, <codeph>CGlobalControl</codeph>, <codeph>CRichControl</codeph>, <codeph>CStyleControl</codeph> and <codeph>CViewControl</codeph>, all derived from the abstract base class <codeph>CGraphicExampleControl</codeph>.

Each of these controls implements an <codeph>UpdateModelL()</codeph> function

that is called each time the current step in the example is advanced. Each

step modifies the content, formatting, or display of the text in a different

way. For details, see the appropriate control example. </p> <p>Each of these

controls illustrates a different set of operations which can be performed

on a text object or a text view. </p> <p> <b>Note:</b> This example is designed

to work properly with Techview and there is no guarantee that it will work

with other interfaces. </p> </section>

<section><title>Use Cases: </title><p><b>Global text control (CGlobalControl)</b><ul>

<li id="GUID-987CD017-6304-50A9-81C7-E1E129E35A7B"><p>Adding and deleting

global text </p> </li>

<li id="GUID-76D336FC-9FE8-5C35-89E5-54757AC3C9AC"><p>Getting information

about the text object, e.g. the number of words and paragraphs. </p> </li>

<li id="GUID-1C2C2136-C268-5494-BD47-E2FAEC0FCC70"><p>Applying formatting </p> </li>

<li id="GUID-BBB7AA01-5EC8-53B0-82D5-1D3798AF4037"><p>Inserting fields </p> </li>

<li id="GUID-5ECF20C1-1C76-5D28-8B5D-27691343C74A"><p>Storing and restoring

text </p> </li>

</ul></p><p><b>Rich text control (CRichControl)</b></p><ul>

<li id="GUID-9AA4FB6E-DFE9-5CAA-815E-043A57845EE3"><p>Adding and deleting

rich text </p> </li>

<li id="GUID-5A792F89-7E52-577A-BC10-EB4A34AAD030"><p>Applying paragraph formatting

to individual paragraphs </p> </li>

<li id="GUID-D2BA1840-DA87-50B0-A75C-B2B983D74331"><p>Applying character formatting

to individual characters </p> </li>

<li id="GUID-78CA5DC8-A2F6-5985-B99B-154D6317B2D0"><p>Storing and restoring

rich text </p> </li>

</ul><p><b>Rich text control with style list (CStyleControl)</b> </p> <p>Illustrates

the following: </p> <ul>

<li id="GUID-EB4E3549-CE3B-58C4-A949-DA20B7EECF38"><p>Creating paragraph styles </p> </li>

<li id="GUID-1199C104-8040-5A83-A449-008ED4C5DB8C"><p>Applying paragraph styles

to individual paragraphs </p> </li>

<li id="GUID-423AA289-9343-5B21-BB07-364A0EE0D90D"><p>Applying specific formatting

to styled paragraphs </p> </li>

<li id="GUID-0980A95D-79E4-549D-B969-83AB383DD0CA"><p>Applying a style to

text with specific formatting </p> </li>

</ul><p/><p><b>Advanced text view (CViewControl)</b> </p> <p>illustrates

the following text view and layout operations: </p> <ul>

<li id="GUID-A55E49A7-6643-5778-8D76-C03D737E6C03"><p>Banded layout </p> </li>

<li id="GUID-BE3D7C63-F428-59B7-97DE-4BBCFCEDBC6D"><p>Reformatting the text

view </p> </li>

<li id="GUID-AD9ED0D7-1ABE-5862-8B2B-65B7410E9B64"><p>Wrapping </p> </li>

<li id="GUID-81085ED3-3536-51DD-B78E-886BDA87A617"><p>Using an I-beam cursor </p> </li>

<li id="GUID-B30501DC-1C68-5FDA-93F5-1DA18E1C4030"><p>Using a line cursor </p> </li>

<li id="GUID-9358AB91-AFB6-5B45-9384-85A3D2123AAB"><p>Text selection </p> </li>

<li id="GUID-EAED1A9B-6AB3-5116-A58E-ED11C5F7BD7B"><p>Resizing the viewing

rectangle </p> </li>

<li id="GUID-2FC0CF53-BFCA-59AC-9C63-4321B06F43C4"><p>Scrolling </p> </li>

</ul></section>

<section><title>Usage</title> <p>Press <userinput>F1</userinput> to get the

menu which lists the examples. Select the appropriate example, and then press <userinput>space</userinput> to

advance through a set of steps that illustrate features of that example. </p> </section>

<section><title>Class Summary</title><p> <xref href="GUID-101762DC-E498-3325-88AB-B0FF17DC62B6.dita"><apiname>TRect</apiname></xref></p><p>  <xref href="GUID-7BEFAAD5-15C3-35A0-BDEF-BC56380D6CE5.dita"><apiname>CCharFormatLayer</apiname></xref></p><p>  <xref href="GUID-3518B92C-D1BD-36D1-B447-728A1052292F.dita"><apiname>TCharFormat</apiname></xref></p><p>  <xref href="GUID-4FD3211A-DFF8-3487-8DFF-5C7F2EF3997D.dita"><apiname>TCharFormatMask</apiname></xref></p><p>  <xref href="GUID-C5A6B3D4-1BDE-35B4-AC6B-DF517A4D4147.dita"><apiname>CParaFormatLayer</apiname></xref></p><p>  <xref href="GUID-2F795E02-0704-39AE-8EC6-06CB5D5D670F.dita"><apiname>CParaFormat</apiname></xref></p><p>  <xref href="GUID-C4220B5C-1037-342E-A409-B62F0429E7F2.dita"><apiname>TParaFormatMask</apiname></xref></p><p>  <xref href="GUID-FEE7C848-2E93-3848-A3DA-7EAA533615AF.dita"><apiname>CTextLayout</apiname></xref></p><p>  <xref href="GUID-CF377A98-F11F-380F-AD10-7F3E261D4421.dita"><apiname>CTextView</apiname></xref></p><p>  <xref href="GUID-4F502FE5-44D4-3947-9D73-67EF4886059A.dita"><apiname>CGlobalText</apiname></xref></p><p>  <xref href="GUID-ED1FFBC5-23C3-3C9E-B5D1-04B72B9369E6.dita"><apiname>CPlainText</apiname></xref></p><p> <xref href="GUID-39945DA4-B362-3DF6-BF9E-DD079EEA7934.dita"><apiname>CRichText</apiname></xref></p><p>  <xref href="GUID-37304E7C-A6B0-3766-B4C3-0A40EEF40018.dita"><apiname>CParagraphStyle</apiname></xref></p><p>  <xref href="GUID-BC8CFDE5-403A-3D78-AEFB-3E78775ED90A.dita"><apiname>CStyleList</apiname></xref></p><p>  <xref href="GUID-DD726512-BCE4-3C4F-88AF-9947FC1CE07B.dita"><apiname>TCursorPosition</apiname></xref></p><p>  <xref href="GUID-E2ED2E4B-C428-355D-84CC-A4FA0ED50B74.dita"><apiname>TCursorSelection</apiname></xref></p><p> <xref href="GUID-F1C52CB4-116D-3915-8F9B-9AF27E31600E.dita"><apiname>TViewYPosQualifier</apiname></xref>  </p></section>