1 /*

     2 * Copyright (c) 2004-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:  Statuspane related utilities.

    15 *

    16 */

    17 

    18 

    19 #ifndef __AKNSTATUSPANEUTILS_H__

    20 #define __AKNSTATUSPANEUTILS_H__

    21 

    22 #include <e32base.h>

    23 

    24 /**

    25  * This class contains statuspane related utility methods.

    26  */

    27 class AknStatuspaneUtils

    28     {

    29 public:

    30 

    31    /**

    32     * This method checks if statuspane layout is currently a stacon layout.

    33     * (stacon = combined status & control pane, side softkeys).

    34     *

    35     * @return ETrue if one of stacon layouts is active, otherwise EFalse.

    36     *

    37     */

    38     IMPORT_C static TBool StaconPaneActive();

    39 

    40    /**

    41     * This method checks if statuspane layout is currently a stacon layout 

    42     * which has softkeylabels at the left side of the screen.

    43     *

    44     * @return ETrue if one of stacon layout with left softkeys is active, 

    45     *         otherwise EFalse.

    46     *

    47     */

    48     IMPORT_C static TBool StaconSoftKeysLeft();

    49 

    50    /**

    51     * This method checks if statuspane layout is currently a stacon layout 

    52     * which has softkeylabels at the right side of the screen.

    53     *

    54     * @return ETrue if one of stacon layout with right softkeys is active, 

    55     *         otherwise EFalse.

    56     *

    57     */

    58     IMPORT_C static TBool StaconSoftKeysRight();

    59 

    60    /**

    61     * This method checks if any of "idle" statuspane layouts is

    62     * active. Also video telephony statuspane is considered as

    63     * idle layout.

    64     *

    65     * @return ETrue if one of "idle" layouts is active, otherwise EFalse.

    66     *

    67     */

    68     IMPORT_C static TBool IdleLayoutActive();

    69 

    70    /**

    71     * This method checks if any of flat statuspane layouts is

    72     * active. 

    73     *

    74     * @return ETrue if one of flat layouts is active, otherwise EFalse.

    75     *

    76     */

    77     IMPORT_C static TBool FlatLayoutActive();    

    78 

    79    /**

    80     * This method checks if any of "usual" statuspane layouts is

    81     * active. 

    82     *

    83     * @return ETrue if one of "usual" layouts is active, otherwise EFalse.

    84     *

    85     */

    86     IMPORT_C static TBool UsualLayoutActive();

    87     

    88    /**

    89     * This method checks if any of small statuspane layouts is

    90     * active. 

    91     *

    92     * @return ETrue if one of small layouts is active, otherwise EFalse.

    93     *

    94     */

    95     IMPORT_C static TBool SmallLayoutActive();

    96 

    97     /**

    98      * This method checks if the active statuspane layout is compatible with

    99      * the touch pane.

   100      *

   101      * @return ETrue if the active layout is compatible with touch pane,

   102      *      otherwise EFalse.

   103      */

   104      IMPORT_C static TBool TouchPaneCompatibleLayoutActive();

   105 

   106    /**

   107     * This method checks if any of extended status pane portrait mode layouts is

   108     * active. 

   109     *

   110     * @return ETrue if any extended portrait layout is active, otherwise EFalse.

   111     *

   112     */

   113     IMPORT_C static TBool ExtendedLayoutActive();

   114     

   115     /**

   116      * This method checks if an nHD status pane layout is active.

   117      *

   118      * @return  @c ETrue if an nHD status pane layout is active,

   119      *          otherwise @c EFalse.

   120      */

   121     static TBool HDLayoutActive();

   122     

   123    /**

   124     * This method checks if statuspane layout is currently any of extended stacon layouts.

   125     * (stacon = combined status & control pane, side softkeys).

   126     *

   127     * @return ETrue if one of extended stacon layouts is active, otherwise EFalse.

   128     *

   129     */

   130     IMPORT_C static TBool ExtendedStaconPaneActive();    

   131 

   132    /**

   133     * This method checks if statuspane layout is currently any of extended flat layouts.

   134     *

   135     * @return ETrue if one of extended flat layouts is active, otherwise EFalse.

   136     *

   137     */

   138     IMPORT_C static TBool ExtendedFlatLayoutActive();

   139     

   140     /**

   141      * This method can be used the check the status pane layout resource ID

   142      * of the current application. If the application has no status pane the

   143      * resource ID is checked from AknCapServer.

   144      *

   145      * @return The layout resource ID of the status pane.

   146      * @see @c R_AVKON_STATUS_PANE in avkon.rss

   147      *

   148      */

   149     IMPORT_C static TInt CurrentStatusPaneLayoutResId();

   150     

   151      /**

   152      * This method checks if the status pane belongs to active idle.

   153      *

   154      * @return  @c ETrue if the status pane belongs to active idle,

   155      *          otherwise @c EFalse.

   156      */

   157     static TBool IsActiveIdle();

   158     };

   159 

   160 #endif //  __AKNSTATUSPANEUTILS_H__