graphicsdeviceinterface/gdi/inc/GDI.INL
changeset 183 6a1564a2f3e6
parent 0 5d03bc08d59c
equal deleted inserted replaced
168:2bd88482bfe5 183:6a1564a2f3e6
   571 inline const MGraphicsDeviceMap* TZoomFactor::GraphicsDeviceMap() const
   571 inline const MGraphicsDeviceMap* TZoomFactor::GraphicsDeviceMap() const
   572 /** Gets the graphics device map of this zoom factor object.
   572 /** Gets the graphics device map of this zoom factor object.
   573 
   573 
   574 @return The graphics device map of the TZoomFactor. */
   574 @return The graphics device map of the TZoomFactor. */
   575 	{return(iDevice);}
   575 	{return(iDevice);}
   576 
       
   577 
       
   578 
       
   579 /** Gets the ascent of an ANSI capital letter in the font whether or not
       
   580 there are any ANSI capitals in the font.
       
   581 @return The positive distance from the font baseline to the top of a
       
   582 standard ANSI capital letter
       
   583 @publishedAll
       
   584 @released
       
   585 */
       
   586 inline TInt CFont::FontCapitalAscent() const
       
   587 	{
       
   588 	return ExtendedFunction(KFontCapitalAscent);
       
   589 	}
       
   590 
       
   591 /** Gets the max ascent of any pre-composed glyph in the font. This will
       
   592 include accents or diacritics that form part of pre-composed glyphs. It is
       
   593 not guaranteed to cover the max ascent of composite glyphs that have to be
       
   594 created by a layout engine. This is also the recommended distance between
       
   595 the top of a text box and the baseline of the first line of text. 
       
   596 @return The positive distance from the font baseline to the top of the
       
   597 highest pre-composed glyph (including accents) above the baseline
       
   598 @publishedAll
       
   599 @released
       
   600 */
       
   601 inline TInt CFont::FontMaxAscent() const
       
   602 	{
       
   603 	return ExtendedFunction(KFontMaxAscent);
       
   604 	}
       
   605 
       
   606 /** Gets the descent of an ANSI descending character in the font.
       
   607 Whether or not there are any ANSI descenders in the font.
       
   608 @return The positive distance from the font baseline to the bottom of the
       
   609 lowest ANSI descender
       
   610 @publishedAll
       
   611 @released
       
   612 */
       
   613 inline TInt CFont::FontStandardDescent() const
       
   614 	{
       
   615 	return ExtendedFunction(KFontStandardDescent);
       
   616 	}
       
   617 
       
   618 /** Gets the max descent of any pre-composed glyph in the font. This will
       
   619 include accents or diacritics that form part of pre-composed glyphs. It is
       
   620 not guaranteed to cover the max descent of composite glyphs that have to be
       
   621 created by a layout engine.
       
   622 @return The positive distance from the font baseline to the bottom of the
       
   623 lowest pre-composed glyph (including accents) below the baseline
       
   624 @publishedAll
       
   625 @released
       
   626 */
       
   627 inline TInt CFont::FontMaxDescent() const
       
   628 	{
       
   629 	return ExtendedFunction(KFontMaxDescent);
       
   630 	}
       
   631 
       
   632 /** Gets the suggested line gap for the font. This is the recommended
       
   633 baseline to baseline distance between successive lines of text in the font.
       
   634 @return The positive recommended gap between successive lines
       
   635 @publishedAll
       
   636 @released
       
   637 */
       
   638 inline TInt CFont::FontLineGap() const
       
   639 	{
       
   640 	return ExtendedFunction(KFontLineGap);
       
   641 	}
       
   642 
       
   643 /**
       
   644 Gets the (positive) maximum height in pixels of the font.
       
   645 This may differ from the design height.
       
   646 
       
   647 @return The maximum height of the font.
       
   648 @publishedAll
       
   649 @released
       
   650 */
       
   651 inline TInt CFont::FontMaxHeight() const
       
   652 	{
       
   653 	return FontMaxAscent() + FontMaxDescent();
       
   654 	}
       
   655