emailuis/uicomponents/inc/fstreenodevisualizer.h
changeset 0 8466d47a6819
equal deleted inserted replaced
-1:000000000000 0:8466d47a6819
       
     1 /*
       
     2 * Copyright (c) 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:  MFsNodeVisualizer is an interface for the node visualizer.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_FSTREENODEVISUALIZER_H
       
    20 #define M_FSTREENODEVISUALIZER_H
       
    21 
       
    22 
       
    23 #include "fstreeitemvisualizer.h"
       
    24 
       
    25 
       
    26 /**
       
    27  * MFsNodeVisualizer is an interface for the node visualizer.
       
    28  *
       
    29  * This is an interface for node visualization in the tree. This interface is 
       
    30  * based on item visualization interface. This interface adds functions to 
       
    31  * change node's visualization state between collapsed and unrolled.
       
    32  * @code
       
    33  *
       
    34  * @endcode
       
    35  *
       
    36  * @lib 
       
    37  */
       
    38 NONSHARABLE_CLASS ( MFsTreeNodeVisualizer ): public MFsTreeItemVisualizer
       
    39     {
       
    40 public:
       
    41 
       
    42     /**
       
    43      * C++ destructor
       
    44      */
       
    45     virtual ~MFsTreeNodeVisualizer() {};    
       
    46     
       
    47 public:
       
    48 
       
    49     /**
       
    50      * Sets visualized node's state to rolled/unrolled.
       
    51      * 
       
    52      * @param aFlag ETrue to visualize node as rolled (collapsed).
       
    53      */
       
    54     virtual void SetExpanded( TBool aFlag, const MFsTreeItemData* aData = 0 ) = 0;
       
    55     
       
    56     /**
       
    57      * Returns rolled/unrolled state of the node's visualization.
       
    58      * 
       
    59      * @return ETrue if node is visualized as rolled (collapsed).
       
    60      */
       
    61     virtual TBool IsExpanded() const = 0;
       
    62     
       
    63     };
       
    64         
       
    65 #endif // M_FSTREENODEVISUALIZER_H