1.1 --- a/epoc32/include/frmconst.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/frmconst.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,247 @@
1.4 -frmconst.h
1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +// FOR INFORMATION ONLY (CONTAINS PANIC NUMBERS, ETC.) - NOT PART OF INTERFACE
1.19 +//
1.20 +//
1.21 +
1.22 +#ifndef __FRMCONST_H__
1.23 +#define __FRMCONST_H__
1.24 +
1.25 +#include <w32std.h>
1.26 +
1.27 +/**
1.28 +Visible versions of control characters.
1.29 +@internalComponent
1.30 +*/
1.31 +const TText KVisibleParagraphBreak = 0x00B6; // paragraph sign (pilcrow)
1.32 +const TText KVisibleLineBreak = 0x2193; // down arrow
1.33 +const TText KVisibleNonBreakSpace = 0x00B0; // degree sign
1.34 +const TText KVisiblePotentialHyphen = 0x00AC; // not sign
1.35 +const TText KVisibleNonBreakHyphen = 0x007E; // spacing tilde
1.36 +const TText KVisibleSpace = 0x00B7; // middle dot
1.37 +const TText KVisibleTab = 0x2192; // right arrow
1.38 +const TText KVisiblePicture = 0x25A3; // white square containing small black square
1.39 +
1.40 +/**
1.41 +Control characters to allow or inhibit line breaks.
1.42 +@internalComponent
1.43 +*/
1.44 +const TText KZeroWidthSpace = 0x200B;
1.45 +const TText KZeroWidthNoBreakSpace = 0xFEFF;
1.46 +
1.47 +/**
1.48 +@publishedAll
1.49 +@released
1.50 +*/
1.51 +enum TFormPanic
1.52 + {
1.53 + /** Not used
1.54 + */
1.55 + EFDummy = 0,
1.56 +
1.57 + // Used in ASSERT_ALWAYS
1.58 +
1.59 + // Parameter errors
1.60 + /** Document handle NULL has been passed in
1.61 + */
1.62 + EFInvalidDocument = 200,
1.63 + /** A NULL layout handle has been passed in
1.64 + */
1.65 + EFInvalidLayout,
1.66 + /** The character edit type was unknown or incompatible with the format changed value
1.67 + */
1.68 + EFBadCharacterEditType,
1.69 + /** The horizontal scroll jump value has been set outside the allowable range (0,9999)
1.70 + */
1.71 + EFInvalidJumpValue,
1.72 +
1.73 + // Document
1.74 + /** No or negative document position specified or greater than current document length
1.75 + */
1.76 + EFInvalidDocPos = 300,
1.77 +
1.78 + // Drawing
1.79 + /** The function CTextView::SetLineCursorBitmap has not been called even though a line cursor is being used
1.80 + */
1.81 + EFLineCursorBitmapNotSet = 400,
1.82 +
1.83 + // Pagination
1.84 + /** No document to paginate
1.85 + */
1.86 + EFDocumentToPaginateNotSet = 500,
1.87 + /** Appending zero or negative characters per page to page list
1.88 + */
1.89 + EFInvalidNumberCharsOnPage,
1.90 + /** Page list should not be empty at this point
1.91 + */
1.92 + EFPageListEmpty,
1.93 +
1.94 + // Printing
1.95 + /** The array containing the number of characters per page has not been set or is defective
1.96 + */
1.97 + EFInvalidPageList = 600,
1.98 + /** A page requested that is outside the page list given
1.99 + */
1.100 + EFInvalidPageNumber,
1.101 +
1.102 + // Used only in ASSERT_DEBUG
1.103 +
1.104 + // Errors in internal format information
1.105 + /** Format doesn't fill band but is not to end of document
1.106 + */
1.107 + EFNotEnoughFormat = 700,
1.108 + /** A lines says it has height zero
1.109 + */
1.110 + EFZeroHeightLine,
1.111 + /** The selected range flag is on but the selection has zero length
1.112 + */
1.113 + EFSelectedRangeZeroLen,
1.114 + /** The cursor is a document position that is outside the formatted range
1.115 + */
1.116 + EFCursorNotInCurrentFormat,
1.117 + /** GetLineRect pixel that was asked for
1.118 + */
1.119 + EFPixelNotInFormattedLine,
1.120 + /** The complete scroll should have been possible
1.121 + */
1.122 + EFScrollCurtailed,
1.123 +
1.124 + // Logic error during format process
1.125 + /** Should not be calling HandleCharEdit when there is a selection
1.126 + */
1.127 + EFSelectionCannotCharEdit = 800,
1.128 + /** This function should not be called when the format is out of date
1.129 + */
1.130 + EFFormatOutOfDate,
1.131 + /** Background formatting should not be going on
1.132 + */
1.133 + EFBackgroundFormatting,
1.134 +
1.135 + // Scrolling errors
1.136 + /** The request for a scroll returned zero as the ammount to scroll by
1.137 + */
1.138 + EFScrollByZero1 = 900,
1.139 + /** A routine that does the scrolling is called with a value of zero or one having wrong sign
1.140 + */
1.141 + EFScrollByZero2,
1.142 + /** Algorithmic or assumption error in the scroll routine
1.143 + */
1.144 + EFScrollError,
1.145 + /** Error when scrolling text down
1.146 + */
1.147 + EFScrollDownError,
1.148 + /** Error when scrolling text up
1.149 + */
1.150 + EFScrollUpError,
1.151 + /** A scrolling routine was expecting a certain type of scroll and got a different one
1.152 + */
1.153 + EFInvalidScrollingType,
1.154 +
1.155 + // Out of memory
1.156 + /** Cannot do this when in no memory mode
1.157 + */
1.158 + EFNoMemory = 1000,
1.159 + /** Trying to recover from no_memory when no no_memory condition has occured
1.160 + */
1.161 + EFRecoverNoMemory,
1.162 +
1.163 + // Cursor
1.164 + /** The cursor has been moved to a position off the screen
1.165 + */
1.166 + EFCursorOffDisplay = 1100,
1.167 + /** Attempt to access the cursor navigation policy object when its pointer is 0
1.168 + */
1.169 + EFNoCursorPositionPolicy,
1.170 + /** Invalid positioning hint value supplied to API
1.171 + */
1.172 + EFPosHintInvalid,
1.173 + /** Curosr APIs found formatting not available for position supplied.
1.174 + */
1.175 + EFPositionNotFormatted,
1.176 + /** The document position was out of range for the current source document.
1.177 + */
1.178 + EFPositionInvalid,
1.179 +
1.180 + // Drawing
1.181 + /** Trying to toggle the highlight on part of the screen when the selection is not visible
1.182 + */
1.183 + EFSelectionNotVisible = 1200,
1.184 + /** Clearing bottom partial line when not needed
1.185 + */
1.186 + EFPartialLineClearError,
1.187 + /** The routine that does the display has been passed a null pointer to a graphics context
1.188 + */
1.189 + EFGcNotSet,
1.190 +
1.191 + //Internal Coding Errors
1.192 + /** SetViewL has put the text at the wrong vertical height
1.193 + */
1.194 + EFViewNotPositionedCorrectly = 1300,
1.195 + /** The function call should not leave in this situation
1.196 + */
1.197 + EFShouldNotLeave,
1.198 + /** Trying to move cursor using wrong function call
1.199 + */
1.200 + EFIncorrectCursorMovement,
1.201 + /** Should be current picture frame
1.202 + */
1.203 + EFNoPictureFrame,
1.204 + /** A value of a system constant has changed to a value that has broken this code
1.205 + */
1.206 + EFSystemConstantsChanged
1.207 + };
1.208 +
1.209 +/**
1.210 +@internalComponent
1.211 +*/
1.212 +void FormPanic(TFormPanic aPanic);
1.213 +
1.214 +
1.215 +enum TCursorMove
1.216 +/**
1.217 +This enum holds all the allowed movements of the document cursor by this
1.218 +cursor positioning framework.
1.219 +@publishedPartner
1.220 +@released
1.221 +*/
1.222 + {
1.223 + /** No cursor movement
1.224 + */
1.225 + ECursNoMovement,
1.226 + /** Single character cursor movement to the left
1.227 + */
1.228 + ECursLeft,
1.229 + /** Single character cursor movement to the right
1.230 + */
1.231 + ECursRight,
1.232 + /** Line up cursor movement
1.233 + */
1.234 + ECursLineUp,
1.235 + /** Line down cursor movement
1.236 + */
1.237 + ECursLineDown,
1.238 + /** Not used, present for backwards compatibility for page movement
1.239 + */
1.240 + ECursReserved1,
1.241 + ECursReserved2,
1.242 + /** Cursor movement to line start
1.243 + */
1.244 + ECursLineBegin,
1.245 + /** Cursor movement to line end
1.246 + */
1.247 + ECursLineEnd
1.248 + };
1.249 +
1.250 +
1.251 +#endif // __FRMCONST_H__