epoc32/include/mw/eikbtgps.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/eikbtgps.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/eikbtgps.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,76 @@
     1.4 -eikbtgps.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Button group stack class definition.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef __EIKBTGPS_H__
    1.24 +#define __EIKBTGPS_H__
    1.25 +
    1.26 +#include <coemain.h>
    1.27 +#include <eikbtgpc.h>
    1.28 +
    1.29 +/**
    1.30 + * A list of all button groups currently available within a thread. 
    1.31 + * 
    1.32 + * CEikButtonGroupStack maintains a list of all button groups currently 
    1.33 + * available within a thread. Only button groups that are expected to be 
    1.34 + * available to other controls will register here.
    1.35 + *
    1.36 + * @lib eikcoctl.lib
    1.37 + * @since S60 0.9 
    1.38 + */
    1.39 +class CEikButtonGroupStack : public CCoeStatic
    1.40 +    {
    1.41 +public:
    1.42 +    /**
    1.43 +     * Gets the minimum size required to display all the visible button 
    1.44 +     * groups on the button group stack.
    1.45 +     *
    1.46 +     * @return The minimum size required to display all the visible button
    1.47 +     *         groups currently on the stack. 
    1.48 +     */
    1.49 +    IMPORT_C static TSize MinimumSize();
    1.50 +
    1.51 +    /**
    1.52 +     * Gets the button group currently displayed.
    1.53 +     *
    1.54 +     * @return The button group currently displayed.
    1.55 +     */
    1.56 +    static CEikButtonGroupContainer* Current();
    1.57 +    
    1.58 +    /**
    1.59 +     * Adds a button group to the button group stack.
    1.60 +     *
    1.61 +     * @param aGroup The button group to add to the button group stack. 
    1.62 +     */    
    1.63 +    static void AddL(CEikButtonGroupContainer& aGroup);
    1.64 +    
    1.65 +    /**
    1.66 +     * Removes the specified button group from the button group stack.
    1.67 +     *
    1.68 +     * @param aGroup The button group to remove.
    1.69 +     */    
    1.70 +    static void Remove(CEikButtonGroupContainer& aGroup);
    1.71 +    
    1.72 +private:
    1.73 +    inline CEikButtonGroupStack();
    1.74 +    inline static CEikButtonGroupStack* Self();
    1.75 +    
    1.76 +private: // data
    1.77 +    TDblQue<CEikButtonGroupContainer> iBtStack;
    1.78 +    };
    1.79 +
    1.80 +#endif // __EIKBTGPS_H__