gstreamer_test_apps/gstplayer/inc/RichTextEditor.h
author hgs
Tue, 21 Sep 2010 11:28:48 -0500
changeset 34 1b8125c02661
parent 18 5824eee55f42
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
18
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
hgs
parents:
diff changeset
     3
*
hgs
parents:
diff changeset
     4
* This library is free software; you can redistribute it and/or
hgs
parents:
diff changeset
     5
* modify it under the terms of the GNU Lesser General Public
hgs
parents:
diff changeset
     6
* License as published by the Free Software Foundation; either
hgs
parents:
diff changeset
     7
* version 2 of the License, or (at your option) any later version.
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* This library is distributed in the hope that it will be useful,
hgs
parents:
diff changeset
    10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
hgs
parents:
diff changeset
    11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
hgs
parents:
diff changeset
    12
* Lesser General Public License for more details.
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* You should have received a copy of the GNU Lesser General Public
hgs
parents:
diff changeset
    15
* License along with this library; if not, write to the
hgs
parents:
diff changeset
    16
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
hgs
parents:
diff changeset
    17
* Boston, MA 02111-1307, USA.
hgs
parents:
diff changeset
    18
*
hgs
parents:
diff changeset
    19
* Description:
hgs
parents:
diff changeset
    20
*
hgs
parents:
diff changeset
    21
*/
hgs
parents:
diff changeset
    22
/*
hgs
parents:
diff changeset
    23
* ============================================================================
hgs
parents:
diff changeset
    24
*  Name        : RichTextEditor.h
hgs
parents:
diff changeset
    25
*  Part of     : VoIP test application.
hgs
parents:
diff changeset
    26
*  Description : Utility printing formatted text to the display.
hgs
parents:
diff changeset
    27
*  Version     : %version: 1 %
hgs
parents:
diff changeset
    28
*
hgs
parents:
diff changeset
    29
* ============================================================================
hgs
parents:
diff changeset
    30
*/
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
#ifndef CRICHTEXTEDITOR_H
hgs
parents:
diff changeset
    33
#define CRICHTEXTEDITOR_H
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
// INCLUDES
hgs
parents:
diff changeset
    36
#include <eikrted.h>  // CCEikRichTextEditor
hgs
parents:
diff changeset
    37
#include <txtfrmat.h> // TCharFormatMask
hgs
parents:
diff changeset
    38
#include <gdi.h>
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
// CLASS DECLARATION
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*  CRichTextEditorRTE
hgs
parents:
diff changeset
    44
*  Editor that outputs formatted text to the display.
hgs
parents:
diff changeset
    45
*/
hgs
parents:
diff changeset
    46
class CRichTextEditorRTE : public CEikRichTextEditor
hgs
parents:
diff changeset
    47
    {
hgs
parents:
diff changeset
    48
public:
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
    /**
hgs
parents:
diff changeset
    51
    * NewL()
hgs
parents:
diff changeset
    52
    *
hgs
parents:
diff changeset
    53
    * Create a CRichTextEditorRTE object, which will draw
hgs
parents:
diff changeset
    54
    * itself to aRect
hgs
parents:
diff changeset
    55
    */
hgs
parents:
diff changeset
    56
    static CRichTextEditorRTE* NewL(const CCoeControl& aView);
hgs
parents:
diff changeset
    57
hgs
parents:
diff changeset
    58
    /**
hgs
parents:
diff changeset
    59
    * NewLC()
hgs
parents:
diff changeset
    60
    *
hgs
parents:
diff changeset
    61
    */
hgs
parents:
diff changeset
    62
    static CRichTextEditorRTE* NewLC(const CCoeControl& aView);
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
public: // from CoeControl
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
    TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent, TEventCode aType);
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
public: // members
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
    /**
hgs
parents:
diff changeset
    72
    * AddCarriageReturnL ()
hgs
parents:
diff changeset
    73
    *
hgs
parents:
diff changeset
    74
    * discussion Add one carriage return
hgs
parents:
diff changeset
    75
    *
hgs
parents:
diff changeset
    76
    */
hgs
parents:
diff changeset
    77
    void AddCarriageReturnL ();
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
    * AddTextL (const TDesC& aText)
hgs
parents:
diff changeset
    81
    *
hgs
parents:
diff changeset
    82
    * discussion Print text on the screen.
hgs
parents:
diff changeset
    83
    * param aText text to be displayed
hgs
parents:
diff changeset
    84
    *
hgs
parents:
diff changeset
    85
    */
hgs
parents:
diff changeset
    86
    void AddTextL (const TDesC& aText, TRgb aRgb = KRgbBlack);
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
private: // Basic two-phase EPOC constructors
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    void ConstructL(const CCoeControl& aView);
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
    * CRichTextEditorRTE()
hgs
parents:
diff changeset
    94
    *
hgs
parents:
diff changeset
    95
    * Default contructor.
hgs
parents:
diff changeset
    96
    *
hgs
parents:
diff changeset
    97
    */
hgs
parents:
diff changeset
    98
    CRichTextEditorRTE();
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
private: //data
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    // formatting options for the RichText that will be displayed
hgs
parents:
diff changeset
   103
    TCharFormatMask iCharacterFormatMask;
hgs
parents:
diff changeset
   104
    TCharFormat iCharacterFormat;
hgs
parents:
diff changeset
   105
    };
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
#endif  // #ifndef CRICHTEXTEDITOR_H
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
// End of file
hgs
parents:
diff changeset
   110