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