epoc32/include/mw/aknconsts.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-2007 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 *     The file contains some avkon constants (mainly for internal use).
    16 *
    17 *
    18 */
    19 
    20 
    21 #ifndef AKNCONSTS_H
    22 #define AKNCONSTS_H
    23 
    24 #include <avkon.hrh>
    25 
    26 // Status pane constants
    27 
    28 /**
    29  * @deprecated
    30  */
    31 const TInt KStatusPaneBackgroundGraphicsColorIdle = 215;
    32 
    33 /**
    34  * @deprecated
    35  */
    36 const TInt KStatusPaneBackgroundGraphicsColorUsual = 237;
    37 
    38 /**
    39  * @deprecated
    40  */
    41 const TInt KStatusPaneBackgroundColor = 0;
    42 
    43 /**
    44  * @deprecated
    45  */
    46 const TInt Kqpn_height_status_pane_idle = 56;
    47 
    48 /**
    49  * @deprecated
    50  */
    51 const TInt Kqpn_height_status_pane_usual = 44;
    52 
    53 /**
    54  * @deprecated
    55  */
    56 struct SLafIconLayout
    57     {
    58     TInt left;
    59     TInt top;
    60     TInt right;
    61     TInt bottom;
    62     TInt width;
    63     TInt height;
    64     };
    65 
    66 /**
    67  * @deprecated
    68  */
    69 struct SLafTextCharasteristics
    70     {
    71     TInt color;
    72     TInt left;
    73     TInt right;
    74     TInt baseline;
    75     TInt width;
    76     TInt justification;
    77     };
    78 
    79 /** Navi pane constants */
    80 /**
    81  * @deprecated
    82  */
    83 const TInt KNoValue = -1000;
    84 
    85 /**
    86  * @deprecated
    87  */
    88 const TInt KUseOtherValue = -1001;
    89 
    90 /**
    91  * @deprecated
    92  */
    93 const TInt KUseBaseValue = 0;
    94 
    95 
    96 /**
    97  * @deprecated
    98  */
    99 const struct SLafIconLayout KStatusPaneBackgroundGraphics =
   100     {1,29,KNoValue,KNoValue,174,15};
   101 
   102 /**
   103  * @deprecated
   104  */
   105 const struct SLafIconLayout KStatusPaneNaviPaneWipeGraphics =
   106     {0, 1, KNoValue, KNoValue, 174, 15};
   107 
   108 /**
   109  * @deprecated
   110  */
   111 const struct SLafIconLayout KStatusPaneNaviPaneWipeBitmapOffset =
   112     {55, 0, KNoValue, KNoValue, 174, 15};
   113 
   114 /**
   115  * @deprecated
   116  */
   117 const struct SLafIconLayout KNaviQgnNaviArrowLeft =
   118     {0,0,KNoValue,KNoValue,4,16};
   119 
   120 /**
   121  * @deprecated
   122  */
   123 const struct SLafIconLayout KNaviQgnNaviArrowRight[2] =
   124     {
   125         {KNoValue,0,5,KNoValue,4,16},
   126         {KNoValue,0,1,KNoValue,4,16}
   127     };
   128 
   129 
   130 /**
   131  * @deprecated
   132  */
   133 const struct SLafIconLayout KNaviQgnNaviTabBitmap =
   134     {4,0,KNoValue,KNoValue,107,16};
   135 
   136 /**
   137  * @deprecated
   138  */
   139 const struct SLafIconLayout KNaviQgnNaviTabIcon2[2] =
   140     {
   141         {17,3,KNoValue,KNoValue,35,11},
   142         {63,3,KNoValue,KNoValue,35,11}
   143     };
   144 
   145 /**
   146  * @deprecated
   147  */
   148 const struct SLafIconLayout KNaviQgnNaviTabIconLong2[2] =
   149     {
   150         {17,3,KNoValue,KNoValue,74,11},
   151         {24,3,KNoValue,KNoValue,74,11}
   152     };
   153 
   154 /**
   155  * @deprecated
   156  */
   157 const struct SLafIconLayout KNaviQgnNaviTabIcon3[3] =
   158     {
   159         {16,3,KNoValue,KNoValue,22,11},
   160         {47,3,KNoValue,KNoValue,22,11},
   161         {78,3,KNoValue,KNoValue,22,11}
   162     };
   163 
   164 
   165 /**
   166  * @deprecated
   167  */
   168 const struct SLafIconLayout KNaviQgnNaviTabIcon4[4] =
   169     {
   170         {14,3,KNoValue,KNoValue,18,11},
   171         {37,3,KNoValue,KNoValue,18,11},
   172         {60,3,KNoValue,KNoValue,18,11},
   173         {83,3,KNoValue,KNoValue,18,11}
   174     };
   175 
   176 /**
   177  * @deprecated
   178  */
   179 const struct SLafIconLayout KNaviQgnNaviTabIconLong3[3] =
   180     {
   181         {17,3,KNoValue,KNoValue,67,11},
   182         {24,3,KNoValue,KNoValue,67,11},
   183         {31,3,KNoValue,KNoValue,67,11}
   184     };
   185 
   186 /**
   187  * @deprecated
   188  */
   189 const struct SLafTextCharasteristics KNaviQgnNaviTabText2[2] =
   190     {
   191         {215,17,66,12,36,ECenter},
   192         {215,63,20,12,36,ECenter}
   193     };
   194 
   195 /**
   196  * @deprecated
   197  */
   198 const struct SLafTextCharasteristics KNaviQgnNaviTabTextLong2[2] =
   199     {
   200         {215,17,29,12,74,ECenter},
   201         {215,24,22,12,74,ECenter}
   202     };
   203 
   204 /**
   205  * @deprecated
   206  */
   207 const struct SLafTextCharasteristics KNaviQgnNaviTabText3[3] =
   208     {
   209         {215,17,81,12,21,ECenter},
   210         {215,48,50,12,21,ECenter},
   211         {215,79,19,12,21,ECenter}
   212     };
   213 
   214 /**
   215  * @deprecated
   216  */
   217 const struct SLafTextCharasteristics KNaviQgnNaviTabText4[4] =
   218     {
   219         {215,17,89,12,13,ECenter},
   220         {215,40,66,12,13,ECenter},
   221         {215,63,43,12,13,ECenter},
   222         {215,86,20,12,13,ECenter}
   223     };
   224 
   225 
   226 /**
   227  * @deprecated
   228  */
   229 const struct SLafTextCharasteristics KNaviQgnNaviTabTextLong3[3] =
   230     {
   231         {215,17,36,12,67,ECenter},
   232         {215,24,29,12,67,ECenter},
   233         {215,31,22,12,67,ECenter}
   234     };
   235 
   236 /**
   237  * @deprecated
   238  */
   239 const struct SLafIconLayout KNaviQgnNaviTabIcon1 =
   240     {20,3,KNoValue,KNoValue,35,11};
   241 
   242 /**
   243  * @deprecated
   244  */
   245 const struct SLafTextCharasteristics KNaviQgnNaviTabText1 =
   246     {0,62,25,13,33,ECenter};
   247 
   248 
   249 /**
   250  * @deprecated
   251  */
   252 const struct SLafTextCharasteristics KNaviQgnNaviInformation[2] =
   253     {
   254         {0, 8, 12, 12, 100, ECenter},
   255         {0, 8, 8, 12, 85, ECenter}
   256     };
   257 
   258 /**
   259  * @deprecated
   260  */
   261 const struct SLafTextCharasteristics KNaviQgnAdditionalInformation =
   262     {0, 6, 3, 12, 92, ELeft};
   263 
   264 /**
   265  * @deprecated
   266  */
   267 const struct SLafTextCharasteristics KNaviQgnHelpHints =
   268     {0, 6, 4, 12, 110, ELeft};
   269 
   270 /**
   271  * @deprecated
   272  */
   273 const struct SLafIconLayout KNaviQgnNaviIcon =
   274     {20, 3, KNoValue, KNoValue, 35, 11};
   275 
   276 /**
   277  * @deprecated
   278  */
   279 const struct SLafTextCharasteristics KNaviQgnNaviIconText =
   280     {0, 62, 25, 13, 33, ECenter};
   281 
   282 /**
   283  * @deprecated
   284  */
   285 const struct SLafIconLayout KNaviQgnNaviEditingStatusIcon =
   286     {75, 4, KNoValue, KNoValue, 110, 9};
   287 
   288 /**
   289  * Following constants determine the layout of tabs in the navigation pane.
   290  * Constants are used with CAknTabGroup::SetTabFixedWidthL(TInt aWidth) method.
   291  */
   292 
   293 /** Constant for two tabs layout */
   294 const TInt KTabWidthWithTwoTabs = EAknTabWidthWithTwoTabs;
   295 /** Constant for two long tabs layout */
   296 const TInt KTabWidthWithTwoLongTabs = EAknTabWidthWithTwoLongTabs;
   297 /** Constant for three tabs layout */
   298 const TInt KTabWidthWithThreeTabs = EAknTabWidthWithThreeTabs;
   299 /** Constant for three long tabs layout */
   300 const TInt KTabWidthWithThreeLongTabs = EAknTabWidthWithThreeLongTabs;
   301 /** Constant for four tabs layout */
   302 const TInt KTabWidthWithFourTabs = EAknTabWidthWithFourTabs;
   303 /** Constant for one tab layout */
   304 const TInt KTabWidthWithOneTab = EAknTabWidthWithOneTab;
   305 
   306 /** @deprecated */
   307 const TInt KNaviTabMargins=0;
   308 /** @deprecated */
   309 const TInt KNaviTabActiveTextColor = 215;
   310 /** @deprecated */
   311 const TInt KNaviTabInactiveTextColor = 129;
   312 /** @deprecated */
   313 const TInt KNaviTabOneTabTextColor = 0;
   314 
   315 
   316 /** @internal */
   317 const TInt KTabNumberOfTabBitmaps = 14;
   318 /** @internal */
   319 const TInt KTabIndexOfFirstTabBitmapInTwoTabsSet = 0;
   320 /** @internal */
   321 const TInt KTabIndexOfLastTabBitmapInTwoTabsSet = 1;
   322 /** @internal */
   323 const TInt KTabIndexOfFirstTabBitmapInTwoLongTabsSet = 2;
   324 /** @internal */
   325 const TInt KTabIndexOfLastTabBitmapInTwoLongTabsSet = 3;
   326 /** @internal */
   327 const TInt KTabIndexOfFirstTabBitmapInThreeTabsSet = 7;
   328 /** @internal */
   329 const TInt KTabIndexOfLastTabBitmapInThreeTabsSet = 9;
   330 /** @internal */
   331 const TInt KTabIndexOfFirstTabBitmapInThreeLongTabsSet = 4;
   332 /** @internal */
   333 const TInt KTabIndexOfLastTabBitmapInThreeLongTabsSet = 6;
   334 /** @internal */
   335 const TInt KTabIndexOfFirstTabBitmapInFourTabsSet = 10;
   336 /** @internal */
   337 const TInt KTabIndexOfLastTabBitmapInFourTabsSet = 13;
   338 
   339 
   340 /** Title pane constants */
   341 /**
   342  * @deprecated
   343  */
   344 const struct SLafTextCharasteristics KTitleQgnOneLineLabel[2] =
   345     {
   346         { 215, 1, 3, 22, 104, ELeft},
   347         { KUseOtherValue, KUseOtherValue, KUseOtherValue, KUseOtherValue, 97, KUseOtherValue}
   348     };
   349 
   350 /**
   351  * @deprecated
   352  */
   353 const struct SLafTextCharasteristics KTitleQgnTwoLineLabel[2] =
   354     {
   355         { 215, 1, 3, 11, 104, ELeft},
   356         { KUseOtherValue, KUseOtherValue, KUseOtherValue, 25, 97, KUseOtherValue}
   357     };
   358 
   359 /**
   360  * @deprecated
   361  */
   362 const struct SLafIconLayout KTitleQgnLogoImage = { 2, 2, 2, 1, 97, 25};
   363 
   364 /**
   365  * Title pane default text if not any other default text is avilable
   366  * @internal
   367  */
   368 _LIT(KTitlePaneDefaultText, " ");
   369 
   370 #ifndef __GMXMLCONSTANTS_H__
   371 /**
   372  * @deprecated
   373  *
   374  * Notice that GMXMLConstants.h contains same constant with different value. 
   375  */
   376 _LIT(KNewLine, "\n");
   377 #endif
   378 
   379 
   380 /** Context pane constants */
   381 
   382 /**
   383  * @deprecated
   384  */
   385 const struct SLafIconLayout KContextQgnBitmap =
   386     { 0, 0, KNoValue, KNoValue, 44, 44};
   387 
   388 /** Battery pane constants */
   389 
   390 /** 
   391  * Constant for battery level minimum value
   392  * @deprecated
   393  */
   394 const TInt KBatteryLevelMin = 0;
   395 /** 
   396  * Constant for battery level maximum value
   397  * @deprecated
   398  */
   399 const TInt KBatteryLevelMax = 7;
   400 
   401 /**
   402  * @deprecated
   403  */
   404 const TInt KBatteryBitmapOffsets[KBatteryLevelMax] =
   405     {25,21,17,13,9,5,1}; // Levels 1,2,3,4,5,6,7
   406 
   407 /**
   408  * @deprecated
   409  */
   410 const struct SLafIconLayout KBatteryQgnIndiBatteryStrength =
   411     {KNoValue,0,0,KNoValue,12,29};
   412 
   413 /**
   414  * @deprecated
   415  */
   416 const struct SLafIconLayout KBatteryQgnIndiBatteryIcon =
   417     {KNoValue,29,0,KNoValue,12,15};
   418 
   419 
   420 /** Signal pane constants */
   421 
   422 /** 
   423  * Constant for signal level minimum value
   424  * @deprecated
   425  */
   426 const TInt KSignalLevelMin = 0;
   427 /** 
   428  * Constant for signal level maximum value
   429  * @deprecated
   430  */
   431 const TInt KSignalLevelMax = 7;
   432 
   433 /**
   434  * @deprecated
   435  */
   436 const TInt KSignalBitmapOffsets[KSignalLevelMax] =
   437     {25,21,17,13,9,5,1}; // Levels 1,2,3,4,5,6,7
   438 
   439 /**
   440  * @deprecated
   441  */
   442 const struct SLafIconLayout KSignalQgnIndiSignalStrength =
   443     {0,0,KNoValue,KNoValue,12,29};
   444 
   445 /**
   446  * @deprecated
   447  */
   448 const struct SLafIconLayout KSignalQgnIndiSignalIcon =
   449     {0,29,KNoValue,KNoValue,12,15};
   450 
   451 
   452 // Common
   453 
   454 /**
   455  * Location of the common dialogs bitmap file
   456  */
   457 _LIT(KCommonDialogsBitmapFile,  "z:\\resource\\apps\\commondialogs.mbm");
   458 
   459 /**
   460  * Location of the call status bitmap file
   461  */
   462 _LIT(KCallStatusBitmapFile,     "z:\\resource\\apps\\callstatus.mbm");
   463 
   464 /**
   465  * Location of the memory card ui bitmap file
   466  */
   467 _LIT(KMemoryCardUiBitmapFile,   "z:\\resource\\apps\\aknmemorycardui.mbm");
   468 
   469 /**
   470  * Location of the avkon bitmap file
   471  */
   472 _LIT(KAvkonBitmapFile,          "z:\\resource\\apps\\avkon2.mbm");
   473 
   474 /**
   475  * Location of the variated bitmaps bitmap file
   476  */
   477 _LIT(KAvkonVariatedBitmapsFile, "z:\\resource\\apps\\variatedbitmaps.mbm");
   478 
   479 
   480 /**
   481  * @deprecated
   482  */
   483 const TInt KAknSoftkeyPaneHeight = 20;
   484 
   485 /**
   486  * Default size of the window server buffer.
   487  */
   488 const TInt KAknDefaultWsBufferSize = 7000;
   489 /**
   490  * Maximum size of the window server buffer.
   491  * UI components and applications may request window server buffer size up to
   492  * this size with CAknEnv::Static()->RequestWsBuffer() method.
   493  */
   494 const TInt KAknMaxWsBufferSize = 16000;
   495 
   496 
   497 // Small status pane
   498 /**
   499  * @deprecated
   500  */
   501 const TInt KMinSpaceBetweenIconsInPixels = 3;
   502 
   503 /**
   504  * @deprecated
   505  */
   506 const struct SLafIconLayout KSmallStatusPaneIndicator =
   507     {0,3,KNoValue,KNoValue,171,15};
   508 /**
   509  * @deprecated
   510  */
   511 const struct SLafIconLayout KSmallStatusPaneTextIndicator =
   512     {2,2,KNoValue,KNoValue,171,11};
   513 /**
   514  * @deprecated
   515  */
   516 const struct SLafIconLayout KSmallStatusPaneSecureStateIndicator =
   517     {0,4,KNoValue,KNoValue,10,9};
   518 /**
   519  * @deprecated
   520  */
   521 const struct SLafIconLayout KSmallStatusPaneWmlWaitGlobeIndicator =
   522     {82,1,80,KNoValue,13,13};
   523 /**
   524  * @deprecated
   525  */
   526 const struct SLafIconLayout KSmallStatusPaneWaitBarIndicator =
   527     {3,3,KNoValue,KNoValue,77,9};
   528 /**
   529  * @deprecated
   530  */
   531 const struct SLafIconLayout KSmallStatusPaneProgressBarIndicator =
   532     {3,3,KNoValue,KNoValue,77,9};
   533 /**
   534  * @deprecated
   535  */
   536 const struct SLafIconLayout KSmallStatusPaneGprsIndicator =
   537     {KNoValue,KNoValue,KNoValue,KNoValue,12,15};
   538 
   539 // Mirrored statuspane for A&H
   540 /**
   541  * @deprecated
   542  */
   543 const struct SLafIconLayout KMirroredStatusPaneNaviPaneWipeBitmapOffset =
   544     {0, 0, 55, KNoValue, 174, 15};
   545 
   546 /**
   547  * @deprecated
   548  */
   549 const struct SLafIconLayout KMirroredNaviQgnNaviArrowLeft[2] =
   550     {
   551         {5,0,KNoValue,KNoValue,4,16},
   552         {1,0,KNoValue,KNoValue,4,16}
   553     };
   554 
   555 /**
   556  * @deprecated
   557  */
   558 const struct SLafIconLayout KMirroredNaviQgnNaviArrowRight =
   559     {0,0,KNoValue,KNoValue,4,16};
   560 
   561 /**
   562  * @deprecated
   563  */
   564 const struct SLafIconLayout KMirroredNaviQgnNaviTabBitmap =
   565     {9,0,KNoValue,KNoValue,107,16};
   566 
   567 
   568 // Naviwipe related constants
   569 /**
   570  * @deprecated
   571  */
   572 struct SNaviWipePart
   573     {
   574     TInt start;
   575     TInt end;
   576     };
   577 
   578 // Note that values are for skin navi wipes (176x15). Not for
   579 // default avkon LAF navi wipes (174x15).
   580 /**
   581  * @deprecated
   582  */
   583 const struct SNaviWipePart KNaviWipeSignalPanePart =
   584     {0,12};
   585 /**
   586  * @deprecated
   587  */
   588 const struct SNaviWipePart KNaviWipeContextPanePart =
   589     {12,56};
   590 /**
   591  * @deprecated
   592  */
   593 const struct SNaviWipePart KNaviWipeNaviPanePart =
   594     {56,176};
   595 
   596 /**
   597  * @deprecated
   598  */
   599 const struct SNaviWipePart KNaviWipeSignalPanePartMirrored =
   600     {164,176};
   601 /**
   602  * @deprecated
   603  */
   604 const struct SNaviWipePart KNaviWipeContextPanePartMirrored =
   605     {120,164};
   606 /**
   607  * @deprecated
   608  */
   609 const struct SNaviWipePart KNaviWipeNaviPanePartMirrored =
   610     {0,120};
   611 
   612 
   613 // Keyboard delays and repeat periods
   614 /**
   615  * Constant for the delay in microseconds before the key repeating starts
   616  * when the key is pressed down.
   617  */
   618 const TInt KAknKeyboardRepeatInitialDelay = 600000;
   619 
   620 /** 
   621  * Keyboard repeat rate in microseconds. Key events are repeated
   622  * at this rate when the key is pressed down. 
   623  *
   624  * Editor repeat rate is set in KAknEditorKeyboardRepeatRate constant
   625  */
   626 const TInt KAknStandardKeyboardRepeatRate = (1000000/6);
   627 
   628 /** 
   629  * Keyboard repeat rate in editors in microseconds. Key events are repeated
   630  * at this rate in editors when the key is pressed down.
   631  */
   632 const TInt KAknEditorKeyboardRepeatRate = (1000000/10);
   633 
   634 
   635 
   636 /**
   637  * Value for unset screen mode. 
   638  */
   639 const TInt KAknScreenModeUnset = -1;
   640 
   641 #endif // AKNCONSTS_H
   642