aknutils.h File Reference

API published in: S60 1st Ed

Link against: avkon.lib eikcore.lib

Capability Information

Required Capabilities

None


#include <eiktxlbm.h>
#include <avkon.hrh>
#include <avkon.rsg>
#include <coedef.h>
#include <coecobs.h>
#include <w32std.h>
#include <gulalign.h>
#include <gulutil.h>
#include <eikenv.h>
#include <biditext.h>
#include <eiksbfrm.h>
#include <AknsConstants.h>
#include <aknenv.h>
#include <aknlayout.lag>

Go to the source code of this file.


Namespaces

namespace   AknDateTimeUtils
namespace   AknLangUtils

Data Structures

class   AknTextUtils
  Text utilities. More...
class   AknSelectionService
  These are part of Selection service and they should be called by application's HandleCommandL() to get menus and cba's handled automatically for selection service. More...
class   AknFind
  This class implements find requirements from component specifications. More...
class   AknEditUtils
  Utility class to initialize editor control. More...
struct   AknEditUtils::SAknEditorParameters
  Basic elements that are needed for the basic editing functions. More...
class   CListBoxNumbers
  Automatic numbering for list items. More...
class   CAknFilteredTextListBoxModel
  This class shows how application should build its model for filtered items. More...
class   CAknListBoxFilterItems
  Listbox item filtering. More...
class   NoOptimizationView< T >
  Removing optimization that breaks listbox views A view which removes optimization from CListBoxView which breaks with lists where all items are not the same layout. More...
class   AknLAFUtils
  This is private class, do not use it except for drawing controls! More...
struct   SAknLayoutPos
class   CAknGenericReader
class   AknLayoutUtils
  Utility classes to build layout based on European LAF from resource files. More...
struct   AknLayoutUtils::SAknLayoutText
struct   AknLayoutUtils::SAknLayoutTextMultiline
struct   AknLayoutUtils::SAknLayoutRect
class   TAknLayoutText
  Low level drawing based on European LAF document (can be used by application's custom controls). More...
class   TAknLayoutRect
  Low level rectangle management based on European LAF document (can be used by application's custom controls). More...
class   AknDraw
  Helper functions for drawing empty lists and window shadows. More...
class   AknDrawWithSkins
  Helper functions for drawing empty lists and window shadows. More...

Functions

  _LIT (KAknStripTabs,"\t")
  _LIT (KAknStripListControlChars,"\t\n")
  _LIT (KAknReplaceTabs,"\t")
  _LIT (KAknReplaceListControlChars,"\t\n")
  _LIT (KAknCommonWhiteSpaceCharacters," \n\t\r")
IMPORT_C const CFont *  LatinPlain12 ()
IMPORT_C const CFont *  LatinBold12 ()
IMPORT_C const CFont *  LatinBold13 ()
IMPORT_C const CFont *  LatinBold16 ()
IMPORT_C const CFont *  LatinBold17 ()
IMPORT_C const CFont *  LatinBold19 ()
IMPORT_C const CFont *  NumberPlain5 ()
IMPORT_C const CFont *  ClockBold30 ()
IMPORT_C const CFont *  LatinClock14 ()
const CFont *  CalcBold21 ()
const CFont *  CalcOperBold21 ()
const CFont *  CalcOperBold13 ()
IMPORT_C const CFont *  ApacPlain12 ()
IMPORT_C const CFont *  ApacPlain16 ()
IMPORT_C TInt  CompleteWithAppPath (TDes &aFileName)
  CompletePathWithAppPath All the components that are specified in the given descriptor (drive letter, path and file name, including extension) are put into the result; any missing components (path and drive letter) are taken from the app's path.
TBool  IsParentRelative (TInt aVal)
  Test whether the value falls within the parent relative range as defined in AknLayout2Def.h.
IMPORT_C TInt  DefaultInputLanguageFromUILanguage (const TInt aUiLanguage)
  Returns default input language that corresponds to the UI language.
IMPORT_C void  SetKeyblockMode (TAknKeyBlockMode aMode)
  Sets the key block mode.
IMPORT_C void  AknDateTimeUtils::ConvertUtcTimeToHomeTime (TTime &aTime)
  Converts given UTC time to home time.
IMPORT_C HBufC *  AknLangUtils::DisplayLanguageTagL ()
  Returns the RFC 3066 tag of the current display language.

Variables

const TInt  KMaxColumnDataLength = 80
const TInt  KMaxTotalDataLength = 8*KMaxColumnDataLength
const TInt  KDefaultClipWidth = -1
  Egul library had methods to clip text from right side, this class includes methods to clip from both sides.
const TUint  KDefaultClipChar = TUint(0x2026)
const TInt  KAknLayoutUtilsDoNotOverride = -1
const TInt  AknLayoutUtilsNoValue = (-16380)

Function Documentation

_LIT KAknCommonWhiteSpaceCharacters  ,
" \n\t\r" 
 
_LIT KAknReplaceListControlChars  ,
"\t\n" 
 
_LIT KAknReplaceTabs  ,
"\t" 
 
_LIT KAknStripListControlChars  ,
"\t\n" 
 
_LIT KAknStripTabs  ,
"\t" 
 
IMPORT_C const CFont* ApacPlain12  ) 
 
IMPORT_C const CFont* ApacPlain16  ) 
 
const CFont* CalcBold21  ) 
 
const CFont* CalcOperBold13  ) 
 
const CFont* CalcOperBold21  ) 
 
IMPORT_C const CFont* ClockBold30  ) 
 
IMPORT_C TInt CompleteWithAppPath TDes &  aFileName  ) 
 

CompletePathWithAppPath All the components that are specified in the given descriptor (drive letter, path and file name, including extension) are put into the result; any missing components (path and drive letter) are taken from the app's path.

Can be used e.g. to load a bitmap file when an application don't know where it has been installed.

Example1: TFilename fname = _L("\testdir\pics.mbm"); // Use _LIT instead CompletePathWithAppPath( fname ); Result: fname == "c:\testdir\pics.mbm" if application was installed to c:

Example2: TFilename fname = _L("pics.mbm"); // Use _LIT instead CompletePathWithAppPath( fname ); Result: fname == "c:\system\apps\myapp\pics.mbm" if application was installed to c:

Parameters:
aFileName  FileName which will be completed with application's path
Returns:
Error code if an error occured. In case of an error aFileName will not be changed
IMPORT_C TInt DefaultInputLanguageFromUILanguage const TInt  aUiLanguage  ) 
 

Returns default input language that corresponds to the UI language.

Parameters:
aUiLanguage  Language code of the UI language
Returns:
Language code of the default input language
TBool IsParentRelative TInt  aVal  ) 
 

Test whether the value falls within the parent relative range as defined in AknLayout2Def.h.

Parameters:
aVal  value
Returns:
ETrue if value is within the parent relative range, EFalse otherwise
IMPORT_C const CFont* LatinBold12  ) 
 
IMPORT_C const CFont* LatinBold13  ) 
 
IMPORT_C const CFont* LatinBold16  ) 
 
IMPORT_C const CFont* LatinBold17  ) 
 
IMPORT_C const CFont* LatinBold19  ) 
 
IMPORT_C const CFont* LatinClock14  ) 
 
IMPORT_C const CFont* LatinPlain12  ) 
 
IMPORT_C const CFont* NumberPlain5  ) 
 
IMPORT_C void SetKeyblockMode TAknKeyBlockMode  aMode  ) 
 

Sets the key block mode.

Has the same functionality as SetKeyBlockMode in AknAppUi, but this can be used from a non app-framework application. The default mode blocks simultaneous key presses.

Parameters:
aMode  ENoKeyBlock if no key block, otherwise EDefaultBlockMode

Variable Documentation

const TInt AknLayoutUtilsNoValue = (-16380)
 
const TInt KAknLayoutUtilsDoNotOverride = -1
 
const TUint KDefaultClipChar = TUint(0x2026)
 
const TInt KDefaultClipWidth = -1
 

Egul library had methods to clip text from right side, this class includes methods to clip from both sides.

It does add 3 dots to the end of the text.

const TInt KMaxColumnDataLength = 80
 
const TInt KMaxTotalDataLength = 8*KMaxColumnDataLength
 

Copyright © Nokia Corporation 2001-2008
Back to top