textrendering/textformatting/inc/FRMCONST.H
changeset 32 8b9155204a54
parent 0 1fb32624e06b
equal deleted inserted replaced
31:b9ad20498fb4 32:8b9155204a54
       
     1 /*
       
     2 * Copyright (c) 1997-2009 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: 
       
    15 * FOR INFORMATION ONLY (CONTAINS PANIC NUMBERS, ETC.) - NOT PART OF INTERFACE
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __FRMCONST_H__
       
    21 #define __FRMCONST_H__
       
    22 
       
    23 #include <w32std.h>
       
    24 
       
    25 /**
       
    26 @publishedAll
       
    27 @released
       
    28 */
       
    29 enum TFormPanic
       
    30 	{
       
    31 	/** Not used 
       
    32 	*/
       
    33 	EFDummy = 0,				
       
    34 
       
    35 	// Used in ASSERT_ALWAYS
       
    36 
       
    37 	// Parameter errors
       
    38 	/** Document handle NULL has been passed in
       
    39 	*/
       
    40 	EFInvalidDocument = 200,	
       
    41 	/** A NULL layout handle has been passed in 
       
    42 	*/
       
    43 	EFInvalidLayout,			
       
    44 	/** The character edit type was unknown or incompatible with the format changed value 
       
    45 	*/
       
    46 	EFBadCharacterEditType,		
       
    47 	/** The horizontal scroll jump value has been set outside the allowable range (0,9999) 
       
    48 	*/
       
    49 	EFInvalidJumpValue,			
       
    50 
       
    51 	// Document
       
    52 	/** No or negative document position specified or greater than current document length 
       
    53 	*/
       
    54 	EFInvalidDocPos = 300,		
       
    55 
       
    56 	// Drawing
       
    57 	/** The function CTextView::SetLineCursorBitmap has not been called even though a line cursor is being used 
       
    58 	*/
       
    59 	EFLineCursorBitmapNotSet = 400,	
       
    60 
       
    61 	// Pagination
       
    62 	/** No document to paginate 
       
    63 	*/
       
    64 	EFDocumentToPaginateNotSet = 500, 
       
    65 	/** Appending zero or negative characters per page to page list 
       
    66 	*/
       
    67 	EFInvalidNumberCharsOnPage,	
       
    68 	/** Page list should not be empty at this point 
       
    69 	*/
       
    70 	EFPageListEmpty,			
       
    71 
       
    72 	// Printing
       
    73 	/** The array containing the number of characters per page has not been set or is defective 
       
    74 	*/
       
    75 	EFInvalidPageList = 600,	
       
    76 	/** A page requested that is outside the page list given 
       
    77 	*/
       
    78 	EFInvalidPageNumber,		 
       
    79 
       
    80 	// Used only in ASSERT_DEBUG
       
    81 
       
    82 	// Errors in internal format information
       
    83 	/** Format doesn't fill band but is not to end of document 
       
    84 	*/
       
    85 	EFNotEnoughFormat = 700,	
       
    86 	/** A lines says it has height zero 
       
    87 	*/
       
    88 	EFZeroHeightLine,			
       
    89 	/** The selected range flag is on but the selection has zero length 
       
    90 	*/
       
    91 	EFSelectedRangeZeroLen,		
       
    92 	/** The cursor is a document position that is outside the formatted range 
       
    93 	*/
       
    94 	EFCursorNotInCurrentFormat,	
       
    95 	/** GetLineRect pixel that was asked for 
       
    96 	*/
       
    97 	EFPixelNotInFormattedLine,	
       
    98 	/** The complete scroll should have been possible 
       
    99 	*/
       
   100  	EFScrollCurtailed,			
       
   101 
       
   102 	// Logic error during format process
       
   103 	/** Should not be calling HandleCharEdit when there is a selection 
       
   104 	*/
       
   105 	EFSelectionCannotCharEdit = 800,	
       
   106 	/** This function should not be called when the format is out of date 
       
   107 	*/
       
   108 	EFFormatOutOfDate,			
       
   109 	/** Background formatting should not be going on 
       
   110 	*/
       
   111 	EFBackgroundFormatting,		
       
   112 
       
   113 	// Scrolling errors
       
   114 	/** The request for a scroll returned zero as the ammount to scroll by 
       
   115 	*/
       
   116 	EFScrollByZero1 = 900,		
       
   117 	/** A routine that does the scrolling is called with a value of zero or one having wrong sign 
       
   118 	*/
       
   119 	EFScrollByZero2,			
       
   120 	/** Algorithmic or assumption error in the scroll routine 
       
   121 	*/
       
   122 	EFScrollError,				
       
   123 	/** Error when scrolling text down 
       
   124 	*/
       
   125 	EFScrollDownError,			
       
   126 	/** Error when scrolling text up 
       
   127 	*/
       
   128 	EFScrollUpError,			
       
   129 	/** A scrolling routine was expecting a certain type of scroll and got a different one 
       
   130 	*/
       
   131 	EFInvalidScrollingType,		
       
   132 
       
   133 	// Out of memory
       
   134 	/** Cannot do this when in no memory mode 
       
   135 	*/
       
   136 	EFNoMemory = 1000,			
       
   137 	/** Trying to recover from no_memory when no no_memory condition has occured 
       
   138 	*/
       
   139 	EFRecoverNoMemory,			
       
   140 
       
   141 	// Cursor
       
   142 	/** The cursor has been moved to a position off the screen 
       
   143 	*/
       
   144 	EFCursorOffDisplay = 1100,	
       
   145 	/** Attempt to access the cursor navigation policy object when its pointer is 0 
       
   146 	*/
       
   147 	EFNoCursorPositionPolicy,	
       
   148 	/** Invalid positioning hint value supplied to API 
       
   149 	*/
       
   150 	EFPosHintInvalid,			
       
   151 	/** Curosr APIs found formatting not available for position supplied. 
       
   152 	*/
       
   153 	EFPositionNotFormatted,		
       
   154 	/** The document position was out of range for the current source document. 
       
   155 	*/
       
   156 	EFPositionInvalid,			
       
   157 
       
   158 	// Drawing
       
   159 	/** Trying to toggle the highlight on part of the screen when the selection is not visible 
       
   160 	*/
       
   161 	EFSelectionNotVisible = 1200, 
       
   162 	/** Clearing bottom partial line when not needed
       
   163 	*/
       
   164  	EFPartialLineClearError,    
       
   165 	/** The routine that does the display has been passed a null pointer to a graphics context 
       
   166 	*/
       
   167 	EFGcNotSet,					
       
   168 
       
   169 	//Internal Coding Errors	   
       
   170 	/** SetViewL has put the text at the wrong vertical height 
       
   171 	*/
       
   172 	EFViewNotPositionedCorrectly = 1300, 
       
   173 	/** The function call should not leave in this situation 
       
   174 	*/
       
   175 	EFShouldNotLeave,			
       
   176 	/** Trying to move cursor using wrong function call 
       
   177 	*/
       
   178 	EFIncorrectCursorMovement,	
       
   179 	/** Should be current picture frame 
       
   180 	*/
       
   181 	EFNoPictureFrame,			
       
   182 	/** A value of a system constant has changed to a value that has broken this code 
       
   183 	*/
       
   184 	EFSystemConstantsChanged	
       
   185 	};
       
   186 
       
   187 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   188 #include <frmconst_internal.h>
       
   189 #include <frmconst_partner.h>
       
   190 #endif
       
   191 
       
   192 #endif // __FRMCONST_H__