Back to index

lightning-sunbird  0.9+nobinonly
gfxTextRun.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  * ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Oracle Corporation code.
00016  *
00017  * The Initial Developer of the Original Code is Oracle Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2005
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Stuart Parmenter <pavlov@pavlov.net>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef GFX_TEXTRUN_H
00039 #define GFX_TEXTRUN_H
00040 
00041 #include "prtypes.h"
00042 #include "gfxTypes.h"
00043 
00044 class nsIFontMetrics;
00045 class nsIAtom;
00046 
00047 class gfxTextRun {
00048     // these do not copy the text
00049     gfxTextRun(const char* ASCII, int length, nsIFontMetrics* font, nsIAtom* language);
00050     gfxTextRun(const PRUnichar* unicode, int length, nsIFontMetrics* font, nsIAtom* language);
00051  
00052     enum { ClusterStart = 0x1 } CharFlags;
00053     // ClusterStart: character is the first character of a cluster/glyph
00054     void GetCharacterFlags(int pos, int len, CharFlags* flags);
00055 
00056     struct Dimensions {
00057         gfxFloat ascent, descent, width, leftBearing, rightBearing;
00058     };
00059     Dimensions MeasureText(int pos, int len);
00060 
00061     // Compute how many characters from this string starting at
00062     // character 'pos' and up to length 'len' fit
00063     // into the given width. 'breakflags' indicates our
00064     // preferences about where we allow breaks.
00065     // We will usually want to call MeasureText right afterwards,
00066     // the implementor could optimize for that.
00067     int GetCharsFit(int pos, int len, gfxFloat width, int breakflags);
00068 
00069     int GetPositionInString(gfxPoint& pt);
00070 };
00071 
00072 #endif