| class CLinkedTypefaceSpecification : public CBase |
This class contains the specification of a linked typeface. It is made up of groups and typefaces.
Groups (CLinkedTypefaceGroup) must contain one or more typeface; the attributes of the group control how the rasterizer draws the typefaces within the group.
Typefaces (CLinkedTypefaceElementSpec) specify which individual typefaces make up the linked typeface. These are referred to as "elements" of the linked typeface.
Once the linked typeface has been created users can use it as if it were any other typeface assuming there is a rasteriser that supports this feature available. When selecting a character the rasterize searches each typeface in turn from the lowest index to the highest. When drawing text, the first typeface to contain the required character is used.
KMaxLinkedTypefaces and KMaxLinkedTypefaceGroups define the maximum number of typefaces and groups that can be added to the specification.
This class is not thread safe.
WARNING: Class for internal and partner use ONLY. Compatibility is not guaranteed in future releases.
KLinkedMaxTypefaces
| Public Member Functions | |
|---|---|
| ~CLinkedTypefaceSpecification() | |
| IMPORT_C void | AddLinkedTypefaceGroupL(CLinkedTypefaceGroup &) |
| IMPORT_C void | AddTypefaceAtBackL(CLinkedTypefaceElementSpec &) |
| IMPORT_C void | AddTypefaceAtIndexL(CLinkedTypefaceElementSpec &, TInt) |
| IMPORT_C TInt | CanonicalIndex() |
| IMPORT_C void | Clear() |
| IMPORT_C void | FetchLinkedTypefaceSpecificationL(CFbsTypefaceStore &) |
| IMPORT_C CLinkedTypefaceGroup * | Group(TInt) |
| IMPORT_C CLinkedTypefaceGroup * | GroupById(TInt) |
| IMPORT_C TInt | GroupCount() |
| IMPORT_C TPtrC | Name() |
| IMPORT_C CLinkedTypefaceSpecification * | NewLC(const TDesC &) |
| IMPORT_C void | RegisterLinkedTypefaceL(CFbsTypefaceStore &) |
| IMPORT_C TInt | RemoveLinkedTypefaceGroup(TInt) |
| IMPORT_C TInt | RemoveTypeface(TInt) |
| IMPORT_C CLinkedTypefaceElementSpec * | Typeface(TInt) |
| IMPORT_C TInt | TypefaceCount() |
| IMPORT_C void | UpdateLinkedTypefaceL(CFbsTypefaceStore &) |
| Private Member Functions | |
|---|---|
| CLinkedTypefaceSpecification() | |
| void | ConstructL(const TDesC &) |
| void | DoAddTypefaceL(CLinkedTypefaceElementSpec &, TInt) |
| Private Attributes | |
|---|---|
| CLinkedTypefaceSpecificationBody * | iBody |
| IMPORT_C void | AddLinkedTypefaceGroupL | ( | CLinkedTypefaceGroup & | aGroup | ) |
Adds the group specified to this specification. The specification takes ownership of the group if addition is successful.
CLinkedTypefaceSpecification::RemoveLinkedTypefaceGroup()
leave
KErrAlreadyExists A group with the same ID is already present in the specification
| CLinkedTypefaceGroup & aGroup | The group to be added |
| IMPORT_C void | AddTypefaceAtBackL | ( | CLinkedTypefaceElementSpec & | aElementSpec | ) |
Adds the supplied CLinkedTypefaceElementSpec to the Linked Typeface specification. The element is placed at the back of the specification. Adding a canonical element will only be successful if one has not already been added. The specification takes ownership of the element specification if adding is successful.
CLinkedTypefaceSpecification::AddTypefaceAtIndexL()
CLinkedTypefaceSpecification::RemoveTypeface()
leave
KErrArgument If the element is canonical and a canonical element already exists or if the group ID doesn't exist
leave
KErrNoMemory There was not enough memory available to perform this operation
leave
KErrOverflow The typeface specification is full; adding would exceed KMaxLinkedTypefaces
| CLinkedTypefaceElementSpec & aElementSpec |
| IMPORT_C void | AddTypefaceAtIndexL | ( | CLinkedTypefaceElementSpec & | aElementSpec, |
| TInt | aIndex | |||
| ) | ||||
Adds the supplied CLinkedTypefaceElementSpec to the Linked Typeface specification. The element is placed at the specified index. Adding a canonical element will only be successful if one has not already been added. The specification takes ownership of the element specification if adding is successful.
CLinkedTypefaceSpecification::AddTypefaceAtBackL()
CLinkedTypefaceSpecification::RemoveTypeface()
leave
KErrArgument If the element is canonical and a canonical element already exists or if the group ID doesn't exist
leave
KErrNoMemory There was not enough memory available to perform this operation
leave
KErrOverflow The typeface specification is full; adding would exceed KMaxLinkedTypefaces
| CLinkedTypefaceElementSpec & aElementSpec | The specification to be added. |
| TInt aIndex | The position at which the element spec will be added. |
| IMPORT_C TInt | CanonicalIndex | ( | ) |
Function to return the index of the canonical (metrics) typeface. The typeface can be retrieved by passing the index to Typeface().
TInt The index to the canonical typeface
KErrNotFound No canonical typeface exists
KErrOverFlow There is more than one canonical typeface
| IMPORT_C void | Clear | ( | ) |
Removes and destroys all groups and elements from the specification.
WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.
| void | ConstructL | ( | const TDesC & | aTypefaceName | ) | [private] |
| const TDesC & aTypefaceName |
| void | DoAddTypefaceL | ( | CLinkedTypefaceElementSpec & | aElementSpec, |
| TInt | aPos | |||
| ) | [private] | |||
| CLinkedTypefaceElementSpec & aElementSpec | |
| TInt aPos |
| IMPORT_C void | FetchLinkedTypefaceSpecificationL | ( | CFbsTypefaceStore & | aStore | ) |
Retrieves the linked typeface specification from the server; the name of the typeface to retrieve should be specified at construction. All typefaces and groups contained in the specification are removed before retrieval of the new data.
CLinkedTypefaceSpecification::NewLC()
leave
KErrNotSupported There is not a rasterizer available that supports linked typefaces
leave
KErrArgument The font specified does not exist or is not a linked typeface
| CFbsTypefaceStore & aStore | A pointer to the FontStore |
| IMPORT_C CLinkedTypefaceGroup * | Group | ( | TInt | aGroupIndex | ) | const |
Returns the linked typeface group at the specified index within the specification. The Index ranges from 0 to the value returned by NumberOfGroups()-1.
The linked typeface group specified or NULL if it doesn't exist
| TInt aGroupIndex | The linked typeface groups index within the specification |
| IMPORT_C CLinkedTypefaceGroup * | GroupById | ( | TInt | aGroupId | ) | const |
Returns the linked typeface group with the specified group ID.
The linked typeface group specified or NULL if it doesn't exist
| TInt aGroupId | The linked typeface group ID |
| IMPORT_C TInt | GroupCount | ( | ) | const |
Returns the number of groups that this linked typeface specification contains.
CLinkedTypefaceSpecification::Group()
TInt Number of groups
| IMPORT_C CLinkedTypefaceSpecification * | NewLC | ( | const TDesC & | aTypefaceName | ) | [static] |
This function constructs the linked typeface specification and places it on the CleanupStack.
The specification must contain at least one group and one typeface in order for registration to be successful.
A linked typeface specification object
| const TDesC & aTypefaceName |
| IMPORT_C void | RegisterLinkedTypefaceL | ( | CFbsTypefaceStore & | aStore | ) |
Creates the linked typeface so that it is available to use a normal typeface.
panic
EFbsPanicNoConnection There is no connection to the Font & Bitmap Server
leave
KErrNotFound One or more of the typeface elements do not exist
leave
KErrOverflow The linked typeface contains too many or 0 elements
leave
KErrArgument The typeface has no or more than one canonical element
leave
KErrAlreadyExists A typeface with the same name already exists
leave
KErrNotSupported There is not a rasterizer available that supports linked typefaces
| CFbsTypefaceStore & aStore | The Typeface Store the linked typeface should be registered with |
| IMPORT_C TInt | RemoveLinkedTypefaceGroup | ( | TInt | aGroupId | ) |
This will remove the group and all the elements associated with it.
| TInt aGroupId | The Id of the group to be removed |
| IMPORT_C TInt | RemoveTypeface | ( | TInt | aIndex | ) |
Removes the element spec at the specified index from this specification. This function deletes the element spec. If the element is the only one within its group the group is also removed and deleted from the specification.
TInt KErrNone if Removal was successful; KErrNotFound If the index is negative or larger than the number of typeface elements or the element doesn't exist
| TInt aIndex | the index of the element spec to be removed |
| IMPORT_C CLinkedTypefaceElementSpec * | Typeface | ( | TInt | aIndex | ) | const |
Returns the linked typeface at the specified index. The first typeface is at index 0, the last at TypefaceCount()-1. The linked typeface. Null is returned on error.
CLinkedTypefaceSpecification::NumberOfTypefaces()
| TInt aIndex |
| IMPORT_C TInt | TypefaceCount | ( | ) | const |
The number of typeface that have been added to this object TInt The number of typeface that have been added to this object
| IMPORT_C void | UpdateLinkedTypefaceL | ( | CFbsTypefaceStore & | aStore | ) |
Update the specification of an existing linked typeface.
| CFbsTypefaceStore & aStore | A typeface store |