YButtonBox.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:     YButtonBox.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YButtonBox_h
#define YButtonBox_h

#include <vector>

#include "YWidget.h"
#include "YPushButton.h"

class YButtonBoxPrivate;
class YPushButton;


struct YButtonBoxLayoutPolicy
{
    YButtonBoxLayoutPolicy()
    : buttonOrder( YKDEButtonOrder )
    , equalSizeButtons( false )
    , addExcessSpaceToHelpButtonExtraMargin( false )
    {
    alignment[ YD_HORIZ ] = YAlignCenter;
    alignment[ YD_VERT  ] = YAlignBegin;    // Align top
    }

    YButtonOrder    buttonOrder;      // YKDEButtonOrder / YGnomeButtonOrder
    bool        equalSizeButtons; // Make all buttons the same size?
    bool        addExcessSpaceToHelpButtonExtraMargin;

    // Alignment for the YButtonBox itself
    YAlignmentType  alignment[ YUIAllDimensions ];
};


struct YButtonBoxMargins
{
    YButtonBoxMargins()
    : left( 0 )
    , right( 0 )
    , top( 0 )
    , bottom( 0 )
    , spacing( 0 )
    , helpButtonExtraSpacing( 0 )
    {}

    int left;           // Left of the leftmost button
    int right;          // Right of the rightmost button
    int top;            // Above the hightest button
    int bottom;         // Below the hightest button

    int spacing;        // Between buttons
    int helpButtonExtraSpacing; // Between [Help] and the next button
};              // (additionally to "spacing"!)


class YButtonBox : public YWidget
{
    friend class YButtonBoxPrivate;

protected:
    YButtonBox( YWidget * parent );

public:

    virtual ~YButtonBox();

    virtual const char * widgetClass() const { return "YButtonBox"; }

    static void setLayoutPolicy( const YButtonBoxLayoutPolicy & layoutPolicy );

    static YButtonBoxLayoutPolicy layoutPolicy();

    static YButtonBoxLayoutPolicy kdeLayoutPolicy();

    static YButtonBoxLayoutPolicy gnomeLayoutPolicy();

    static void setDefaultMargins( const YButtonBoxMargins & margins );

    static YButtonBoxMargins defaultMargins();

    virtual void setMargins( const YButtonBoxMargins & margins );

    YButtonBoxMargins margins() const;

    virtual void doLayout( int width, int height );

    YPushButton * findButton( YButtonRole role );

    void sanityCheck();

    void setSanityCheckRelaxed( bool relax = true );

    bool sanityCheckRelaxed() const;

    virtual int preferredWidth();

    virtual int preferredHeight();

    virtual void setSize( int newWidth, int newHeight );

    virtual bool stretchable( YUIDimension dimension ) const;


protected:

    virtual std::vector<YPushButton *> buttonsByButtonOrder();

    int maxChildSize( YUIDimension dim ) const;

    int totalChildrenWidth() const;

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

    int preferredWidth( bool equalSizeButtons );


private:

    ImplPtr<YButtonBoxPrivate> priv;

    static YButtonBoxLayoutPolicy   _layoutPolicy;
    static YButtonBoxMargins        _defaultMargins;
};


#endif // YButtonBox_h