widgetmodel/alfwidgetmodel/inc/alfgridlayoutmanagerimpl.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:23:18 +0100
branchRCL_3
changeset 26 0e9bb658ef58
parent 0 e83bab7cf002
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  grid layoutmanager private implementation header.
*
*/


#ifndef ALFGRIDLAYOUTMANAGERIMPL_H
#define ALFGRIDLAYOUTMANAGERIMPL_H

#include <osn/osndefines.h>
#include <alf/alfgridlayoutmanager.h>
#include <alf/ialflayoutpreferences.h>

using std::auto_ptr;
using Alf::AlfGridLayoutManager;

class CAlfControl;
class CAlfGridLayout;

namespace Alf
    {
    
class CAlfWidgetControl;
class AlfWidget;
class IAlfLayoutPreferences;
    
/**
 * layoutmanager implementation class
 *
 * @lib alfwidgetmodel.lib
 * @since S60 ?S60_version
 */
class AlfGridLayoutManagerImpl : public IAlfLayoutPreferences
    {
public:
    /**
     * layout manager constructor
     *
     * @param aLayoutType type of layout used by the manager.
     */
    AlfGridLayoutManagerImpl(AlfGridLayoutManager& aGridLayoutManager);
    
    /**
     * destructor
     */
    ~AlfGridLayoutManagerImpl();
    
public:
// from base class IAlfLayoutPreferences

	/**
	 * Returns the minimum size of the layout by combining the minimum sizes of the
	 * layed out visuals.
	 * 
	 * @param aMinSize The minimum size that the object would like to be laid out to
	 * @return false iff none of the layed out UI elements do not care about minimum size
	 */
	virtual bool getMinimumSize( TAlfXYMetric& aMinSize ) const;
	
	/**
	 * Returns the maximum size of the layout by combining the maximum sizes of the
	 * layed out visuals.
	 *  
	 * @param aMaxSize The maximum size that the object would like to be laid out to
	 * @return false iff none of the layed out UI elements do not care about maximum size
	 */
	virtual bool getMaximumSize( TAlfXYMetric& aMaxSize ) const;
	
    /**
     * Returns the size combined by all preferred sizes of child UI elements in this layout 
     * when they are being layed out according to the layout manager rules.
     * 
     * @param aPreferredSize Filled with the referred area occupied by child elements when
     * 						 layed out by layouting rules in this layout manager.
     * @return False if none of the child components report their preferred size. True
     * 		   otherwise.
     */
    virtual bool getPreferredSize(TAlfXYMetric& aPreferredSize) const;
	 
	/**
	 * Set the preferred size into a presentation object.
	 * 
	 * This is not supported on the layout manager. Users should set preferred sizes of the
	 * contained UI elements.
	 */
	virtual void setPreferredSize( const TAlfXYMetric& aPreferredSize );    

public:
// from base class IAlfInterfaceBase
    
    /**
     * Interface getter. 
     * @see IAlfInterfaceBase::MakeInterface
     *
     * @since S60 ?S60_version
     * @param aType The type id of the queried interface.
     * @return The queried interface, or NULL if the interface is not
     *         supported or available.
     */    
    virtual IAlfInterfaceBase* makeInterface( const IfId& aType );	
	
private:
    /**
     * returns the gridlayout used by the layoutmanager.
     */    
    CAlfGridLayout& layout() const;
private:

    AlfGridLayoutManager &mGridLayoutManager;

    };

    } // namespace Alf

#endif // ALFGRIDLAYOUTMANAGERIMPL_H