epoc32/include/mw/eikbtgps.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  Button group stack class definition.
    15 *
    16 */
    17 
    18 
    19 #ifndef __EIKBTGPS_H__
    20 #define __EIKBTGPS_H__
    21 
    22 #include <coemain.h>
    23 #include <eikbtgpc.h>
    24 
    25 /**
    26  * A list of all button groups currently available within a thread. 
    27  * 
    28  * CEikButtonGroupStack maintains a list of all button groups currently 
    29  * available within a thread. Only button groups that are expected to be 
    30  * available to other controls will register here.
    31  *
    32  * @lib eikcoctl.lib
    33  * @since S60 0.9 
    34  */
    35 class CEikButtonGroupStack : public CCoeStatic
    36     {
    37 public:
    38     /**
    39      * Gets the minimum size required to display all the visible button 
    40      * groups on the button group stack.
    41      *
    42      * @return The minimum size required to display all the visible button
    43      *         groups currently on the stack. 
    44      */
    45     IMPORT_C static TSize MinimumSize();
    46 
    47     /**
    48      * Gets the button group currently displayed.
    49      *
    50      * @return The button group currently displayed.
    51      */
    52     static CEikButtonGroupContainer* Current();
    53     
    54     /**
    55      * Adds a button group to the button group stack.
    56      *
    57      * @param aGroup The button group to add to the button group stack. 
    58      */    
    59     static void AddL(CEikButtonGroupContainer& aGroup);
    60     
    61     /**
    62      * Removes the specified button group from the button group stack.
    63      *
    64      * @param aGroup The button group to remove.
    65      */    
    66     static void Remove(CEikButtonGroupContainer& aGroup);
    67     
    68 private:
    69     inline CEikButtonGroupStack();
    70     inline static CEikButtonGroupStack* Self();
    71     
    72 private: // data
    73     TDblQue<CEikButtonGroupContainer> iBtStack;
    74     };
    75 
    76 #endif // __EIKBTGPS_H__