epoc32/include/app/msgeditor.hrh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  MsgEditor  declaration
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef INC_MSGEDITOR_HRH
    21 #define INC_MSGEDITOR_HRH
    22 
    23 enum TMsgFormComponent
    24     {
    25     EMsgHeader = 0,
    26     EMsgBody
    27     };
    28 
    29 enum TMsgControlType
    30     {
    31     EMsgExpandableControl = 1,
    32     EMsgAddressControl,
    33     EMsgAttachmentControl,
    34     EMsgBodyControl,
    35     EMsgImageControl,
    36     EMsgVideoControl,
    37     EMsgAudioControl,
    38     EMsgSvgControl,
    39     EMsgXhtmlBodyControl,
    40     EMsgFirstFreeCustomControlType
    41     };
    42 
    43 enum TMsgControlId
    44     {
    45     EMsgComponentIdNull = 0,
    46     EMsgComponentIdTo = 1,
    47     EMsgComponentIdFrom,
    48     EMsgComponentIdCc,
    49     EMsgComponentIdBcc,
    50     EMsgComponentIdSubject, 
    51     EMsgComponentIdBody,
    52     EMsgComponentIdDateTime,
    53     EMsgComponentIdAttachment,    
    54     EMsgComponentIdImage,
    55     EMsgComponentIdVideo,
    56     EMsgComponentIdAudio,
    57     EMsgComponentIdSvg,
    58     EMsgComponentIdFirstFreeEditorSpecificId
    59     };
    60 
    61 enum TMsgFocusDirection
    62     {
    63     EMsgFocusUp = -1,
    64     EMsgFocusDown = 1
    65     };
    66 
    67 enum TMsgControlIndex
    68     {
    69     EMsgAppendControl = -1,
    70     EMsgFirstControl = 0
    71     };
    72 
    73 enum TMsgClipboardFunc
    74     {
    75     EMsgNoClipboard = 0,
    76     EMsgCopy,
    77     EMsgCut,
    78     EMsgPaste,
    79     EMsgPasteSpecial
    80     };
    81 
    82 enum TMsgEditFunc
    83     {
    84     EMsgUndo = 0,
    85     EMsgSelectAll
    86     };
    87 
    88 enum TMsgCursorLocation
    89     {
    90     EMsgTop = 0,
    91     EMsgBottom
    92     };
    93 
    94 enum TMsgStateFlags
    95     {
    96     EMsgStateNormal                            = 0x0000,
    97     EMsgStateInitializing                      = 0x0001,
    98     EMsgStateInitialized                       = 0x0002,
    99     EMsgStateRefreshing                        = 0x0004,
   100     EMsgEnsureCorrectFormPositionRequestIssued = 0x0008
   101     };
   102 
   103 enum TMsgControlModeFlags
   104     {
   105     EMsgControlModeNone                = 0x000000,
   106     EMsgControlModeReadOnly            = 0x000001,    // Indicates read only state
   107     EMsgControlModePlainTextMode       = 0x000002,    // Indicates plain text mode
   108     EMsgControlModeSizeFixedToOneLine  = 0x000004,    // Forces control to one line heigh
   109     EMsgControlModeUseSystemFont       = 0x000008,    // Forces control to use system font
   110     EMsgControlModeSizeChanging        = 0x000010,    // Indicates control's size change
   111     EMsgControlModeBodyMaxHeight       = 0x000020,    // Forces body control to max height
   112     EMsgControlModeModified            = 0x000040,    // Indicates if control has been modified
   113     EMsgControlModeInitialized         = 0x000080,    // Indicates if control has been initialized
   114     EMsgControlModeShiftPressed        = 0x000100,    // Indicated if shift key is pressed
   115     EMsgControlModeForceFocusStop      = 0x000200,    // Indicated if focus must stop on this
   116                                                       // control (in read-only mode)
   117     EMsgControlModeDoNotDrawFrameBgContext  = 0x000400,   // Do not draw frame around the edwin
   118                                                         // valid only in ExpandableControls
   119     EMsgControlModeForceSizeUpdate     = 0x000800,    // Indicated if size must be updated always                                                    
   120     EMsgControlModeFirstReservedFlag   = 0x001000,    // Reserved for standard controls
   121     EMsgControlModeFirstFreeFlag       = 0x100000
   122     };
   123 
   124 enum TMsgViewEvent
   125     {
   126     EMsgViewEventPrepareFocusTransitionUp,
   127     EMsgViewEventPrepareFocusTransitionDown,
   128     EMsgViewEventPrepareForViewing,
   129     EMsgViewEventPrepareForZooming,
   130     EMsgViewEventFormHeightChanged,
   131     EMsgViewEventFormScrolled,
   132     EMsgViewEventSetCursorFirstPos,
   133     EMsgViewEventSetCursorLastPos,
   134     EMsgViewEventFocusMoveStarting,
   135     EMsgViewEventFocusMoveFinished,
   136     EMsgViewEventViewFocusLost,
   137     EMsgViewEventViewFocusGain
   138     };
   139 
   140 enum TMsgIndicatorFlags
   141     {
   142     // TODO: check avkon.hrh if they add more indicators there.
   143     EMsgIndicatorT9              = 0x0001,
   144     EMsgIndicatorUpperCase       = 0x0002,
   145     EMsgIndicatorLowerCase       = 0x0004,
   146     EMsgIndicatorTextCase        = 0x0008,
   147     EMsgIndicatorNumberCase      = 0x0010,
   148     EMsgIndicatorQuery           = 0x0020,
   149     EMsgIndicatorPinyin          = 0x0040,
   150     EMsgIndicatorZhuyin          = 0x0080,
   151     EMsgIndicatorStroke          = 0x0100,
   152     EMsgIndicatorAudioAttached   = 0x0200,
   153     EMsgIndicatorImageAttached   = 0x0400,
   154     EMsgIndicatorObjects         = 0x0800,
   155     EMsgIndicatorAttachment      = 0x1000,
   156     EMsgIndicatorMessageLength   = 0x2000
   157     };
   158 
   159 /**
   160 * Enumeration for scroll directions.
   161 */
   162 enum TMsgScrollDirection
   163     {
   164     EMsgScrollUp,
   165     EMsgScrollDown
   166     };
   167 
   168 enum TMsgCommonCommands
   169     {
   170     EMsgDispSizeAutomatic = 1,
   171     EMsgDispSizeLarge,
   172     EMsgDispSizeNormal,
   173     EMsgDispSizeSmall,
   174     EMsgFirstFreeComponentSpecificCommand = 2000
   175     };
   176 
   177 #endif
   178 
   179 // End of File