YLayoutBox.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YLayoutBox.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YLayoutBox_h
#define YLayoutBox_h

#include <vector>
#include "YWidget.h"


class YLayoutBoxPrivate;

class YLayoutBox : public YWidget
{
public:
    typedef std::vector<int> sizeVector;
    typedef std::vector<int> posVector;

protected:
    YLayoutBox( YWidget * parent, YUIDimension dim );

public:
    virtual ~YLayoutBox();

    virtual const char * widgetClass() const;

    YUIDimension primary() const;

    YUIDimension secondary() const;

    bool debugLayout() const;

    void setDebugLayout( bool deb = true );

    virtual int preferredSize( YUIDimension dim );

    virtual int preferredWidth();

    virtual int preferredHeight();

    virtual void setSize( int newWidth, int newHeight );

    virtual bool stretchable( YUIDimension dimension ) const;

    virtual void moveChild( YWidget * child, int newX, int newY ) = 0;

    static bool isLayoutStretch( YWidget * child, YUIDimension dimension );

protected:

    int childrenTotalWeight( YUIDimension dimension );

    int childrenMaxPreferredSize( YUIDimension dimension );

    int totalNonWeightedChildrenPreferredSize( YUIDimension dimension );

    int countNonWeightedChildren( YUIDimension dimension );

    int countStretchableChildren( YUIDimension dimension );

    int countLayoutStretchChildren( YUIDimension dimension );

    YWidget * findDominatingChild();

    void calcPrimaryGeometry    ( int       newSize,
                  sizeVector &  childSize,
                  posVector  &  childPos );

    void calcSecondaryGeometry  ( int       newSize,
                  sizeVector &  childSize,
                  posVector  &  childPos );

    void doResize( sizeVector & width,
           sizeVector & height,
           posVector  & x_pos,
           posVector  & y_pos  );


private:

    ImplPtr<YLayoutBoxPrivate>  priv;
};


typedef YLayoutBox YVBox;
typedef YLayoutBox YHBox;


#endif // YLayoutBox_h