YQWizard.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                    (c) SuSE Linux AG |
\----------------------------------------------------------------------/

  File:       YQWizard.h

  Author:     Stefan Hundhammer <sh@suse.de>

/-*/

// -*- c++ -*-

#ifndef YQWizard_h
#define YQWizard_h

#include "YWizard.h"
#include <qvbox.h>
#include <qpixmap.h>
#include <qptrlist.h>
#include <qstringlist.h>
#include <qdict.h>
#include "QY2ListView.h"

#include <string>
#include <vector>

class QGridLayout;
class QHBox;
class QLabel;
class QMenuBar;
class QPopupMenu;
class QPushButton;
class QSpacerItem;
class QTextBrowser;
class QToolButton;
class QWidgetStack;

class YQAlignment;
class YQReplacePoint;
class YQWizardButton;
class QY2ListView;


class YQWizard : public QVBox, public YWizard
{
    Q_OBJECT

    class Step;
    class TreeItem;

public:
    YQWizard( QWidget *                 parent,
              const YWidgetOpt &        opt,
              const YCPValue &  backButtonId,   const YCPString & backButtonLabel,
              const YCPValue &  abortButtonId,  const YCPString & abortButtonLabel,
              const YCPValue &  nextButtonId,   const YCPString & nextButtonLabel  );

    virtual ~YQWizard();


    enum Direction { Forward, Backward };

    Direction direction() const { return _direction; }

    virtual YCPValue command( const YCPTerm & command );

    virtual std::string debugLabel();

    void addChild( YWidget * child );

    long nicesize( YUIDimension dim );

    void setSize( long newWidth, long newHeight );

    bool eventFilter( QObject * obj, QEvent * ev );

    void setDialogIcon( const char * iconName );

    void setDialogHeading( const QString & headingText );

    bool stepsEnabled() const { return _stepsEnabled; }

    void addStep( const QString & text, const QString & id );

    void addStepHeading( const QString & text );

    void deleteSteps();

    void setCurrentStep( const QString & id );

    void updateSteps();

    bool treeEnabled() const { return _treeEnabled; }

    YQWizardButton * nextButton() const  { return _nextButton; }

    YQWizardButton * backButton() const  { return _backButton; }

    YQWizardButton * abortButton() const { return _abortButton; }


    void setVerboseCommands( bool verbose ) { _verboseCommands = verbose; }

    void addTreeItem( const QString & parentID,
                      const QString & text,
                      const QString & id        );

    void selectTreeItem( const QString & id );

    void deleteTreeItems();


    void addMenu( const QString & text,
                  const QString & id );

    void addSubMenu( const QString & parentMenuID,
                     const QString & text,
                     const QString & id );

    void addMenuEntry( const QString & parentMenuID,
                       const QString & text,
                       const QString & id );

    void addMenuSeparator( const QString & parentMenuID );

    void deleteMenus();


public slots:


    void setHelpText( QString helpText );

    void resizeClientArea();

    void showHelp();

    void showSteps();

    void showTree();

    static void setGradient( QWidget * widget, const QPixmap & pixmap );

    static void setBottomCroppedGradient( QWidget * widget,
                                          const QPixmap & pixmap,
                                          int croppedHeight );

    static QPixmap bottomCropPixmap( const QPixmap & pixmap, int croppedHeight );

    static QColor pixelColor( const QPixmap & pixmap, int x, int y );


protected slots:

    void backClicked();

    void abortClicked();

    void nextClicked();

    void releaseNotesClicked();

    void sendTreeEvent( QListViewItem * item );

    void treeSelectionChanged();

    void sendMenuEvent( int numID );


    void retranslateInternalButtons();

protected:

    // Layout functions

    void layoutTitleBar         ( QWidget * parent );
    void layoutSideBar          ( QWidget * parent );
    void layoutSideBarButtonBox ( QWidget * parent, QPushButton * button );
    void layoutStepsPanel();
    void layoutHelpPanel();
    void layoutTreePanel();
    void layoutWorkArea ( QHBox * parentHBox );
    void layoutClientArea( QWidget * parent );
    void layoutButtonBox( QWidget * parent );


    void loadGradientPixmaps();

    void loadStepsIcons();

    void destroyButtons();

    void updateStepStates();

    QWidget * addGradientColumn( QWidget * parent, int width = 8 );

    void sendEvent( YCPValue id );


    bool runningEmbedded() const { return _runningEmbedded; }

    bool YQWizard::highColorDisplay() const;


    //
    // Wizard command mini-parser
    //

    bool isCommand( QString declaration, const YCPTerm & term );

    QString YQWizard::qStringArg( const YCPTerm & term, int argNo );

    std::string stringArg( const YCPTerm & term, int argNo );

    bool boolArg( const YCPTerm & term, int argNo );

    YCPValue YQWizard::anyArg( const YCPTerm & term, int argNo );

    void setButtonLabel( YQWizardButton * button, const QString & newLabel );

    void setButtonID( YQWizardButton * button, const YCPValue & id );

    void enableButton( YQWizardButton * button, bool enabled );

    void setButtonFocus( YQWizardButton * button );

    void setStepStatus( YQWizard::Step * step, const QPixmap & icon, const QColor & color );

    YQWizard::Step * findStep( const QString & id );

    YQWizard::TreeItem * findTreeItem( const QString & id );

    YCPString currentTreeSelection();

    void showReleaseNotesButton( string label, const YCPValue & id );

    void hideReleaseNotesButton();


    //
    // Data members
    //

    bool        _stepsEnabled;
    bool        _treeEnabled;
    bool        _verboseCommands;
    bool        _protectNextButton;
    bool        _stepsDirty;
    bool        _runningEmbedded;
    Direction   _direction;

    QPixmap     _titleBarGradientPixmap;
    QPixmap     _topGradientPixmap;
    QColor      _gradientCenterColor;
    QPixmap     _bottomGradientPixmap;

    QPixmap     _stepCurrentIcon;
    QPixmap     _stepToDoIcon;
    QPixmap     _stepDoneIcon;

    QColor      _stepCurrentColor;
    QColor      _stepToDoColor;
    QColor      _stepDoneColor;

    QString     _currentStepID;


    QWidgetStack *      _sideBar;
    QVBox *                 _stepsPanel;
    QVBox *                     _stepsBox;
    QGridLayout *                   _stepsGrid;
    QPushButton *               _releaseNotesButton;
    YCPValue                    _releaseNotesButtonId;
    QPushButton *               _helpButton;
    QHBox *                 _helpPanel;
    QTextBrowser *              _helpBrowser;
    QPushButton *               _stepsButton;
    QPushButton *               _treeButton;
    QHBox *                 _treePanel;
    QY2ListView *               _tree;

    QVBox *             _clientArea;
    QWidget *               _menuBarBox;
    QMenuBar *                  _menuBar;
    QLabel *                _dialogIcon;
    QLabel *                _dialogHeading;
    YQAlignment *           _contents;
    YQWizardButton *        _backButton;
    QSpacerItem *           _backButtonSpacer;
    YQWizardButton *        _abortButton;
    YQWizardButton *        _nextButton;

    QPtrList<YQWizard::Step>    _stepsList;
    QDict<YQWizard::Step>       _stepsIDs;
    QDict<YQWizard::TreeItem>   _treeIDs;
    QDict<QPopupMenu>           _menuIDs;
    vector<QString>             _menuEntryIDs;


protected:

    class Step
    {
    public:

        Step( const QString & name = "", const QString & id = "" )
            : _name( name )
            , _statusLabel( 0 )
            , _nameLabel(0)
            , _enabled( true )
            , _idList( id )
        {}

        virtual ~Step() {}

        virtual bool isHeading() const { return false; }

        QString  name()         const { return _name;           }
        QLabel * statusLabel()  const { return _statusLabel;    }
        QLabel * nameLabel()    const { return _nameLabel;      }
        bool     isEnabled()    const { return _enabled;        }
        const QStringList & id() const { return _idList;        }
        void addID( const QString & id ) { _idList.append( id ); }
        virtual bool hasID( const QString & id ) { return _idList.find( id ) != _idList.end(); }

        void setStatusLabel( QLabel * label )   { _statusLabel = label; }
        void setNameLabel  ( QLabel * label )   { _nameLabel   = label; }
        void setEnabled( bool enabled )         { _enabled = enabled; }

    protected:

        QString         _name;
        QLabel *        _statusLabel;
        QLabel *        _nameLabel;
        bool            _enabled;
        QStringList     _idList;
    };


    class StepHeading: public Step
    {
    public:

        StepHeading( const QString & name = "" )
            : Step( name, "" )
            {}

        virtual ~StepHeading() {}
        virtual bool isHeading() const { return true; }
        virtual bool hasID( const QString & id ) { return false; }
    };


    class TreeItem: public QY2ListViewItem
    {
    public:
        TreeItem( QY2ListView *         parent,
                  const QString &       text,
                  const QString &       id )
            : QY2ListViewItem( parent, text, true )
            , _id( id )
            {}

        TreeItem( YQWizard::TreeItem *  parent,
                  const QString &       text,
                  const QString &       id )
            : QY2ListViewItem( parent, text, true )
            , _id( id )
            {}

        QString text() const { return QListViewItem::text(0); }
        QString id()   const { return _id; }

    private:
        QString _id;
    };

}; // class YQWizard



#endif // YQWizard_h

---