/data/gitorious.org/libyui/libyui-master/src/YWizard.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:         YWizard.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YWizard_h
#define YWizard_h

#include "YWidget.h"

class YMacroRecorder;
class YWizardPrivate;
class YPushButton;
class YReplacePoint;

#define YWizardID                       "wizard"
#define YWizardContentsReplacePointID   "contents"


enum YWizardMode
{
    YWizardMode_Standard,       // Normal wizard (help panel or nothing)
    YWizardMode_Steps,          // Steps visible in left side panel
    YWizardMode_Tree            // Tree in left side panel
};


class YWizard: public YWidget
{
protected:
    YWizard( YWidget *          parent,
             const string &     backButtonLabel,
             const string &     abortButtonLabel,
             const string &     nextButtonLabel,
             YWizardMode        wizardMode = YWizardMode_Standard );

public:

    virtual ~YWizard();

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

    
    //
    // Wizard basics
    //

    YWizardMode wizardMode() const;
    
    virtual YPushButton * backButton()  const = 0;
    virtual YPushButton * abortButton() const = 0;
    virtual YPushButton * nextButton()  const = 0;

    virtual YReplacePoint * contentsReplacePoint() const = 0;

    void protectNextButton( bool protect );

    bool nextButtonIsProtected() const;

    virtual void setButtonLabel( YPushButton * button, const string & newLabel );
    
    virtual void setHelpText( const string & helpText ) = 0;

    virtual void setDialogIcon( const string & iconName ) = 0;

    virtual void setDialogTitle( const string & titleText ) = 0;

    virtual void setDialogHeading( const string & headingText ) = 0;

    
    //
    // Steps handling
    //
    
    virtual void addStep( const string & text, const string & id ) = 0;

    virtual void addStepHeading( const string & text ) = 0;

    virtual void deleteSteps() = 0;

    virtual void setCurrentStep( const string & id ) = 0;

    virtual void updateSteps() = 0;

    
    //
    // Tree handling
    //
    
    virtual void addTreeItem( const string & parentID,
                              const string & text,
                              const string & id ) = 0;

    virtual void selectTreeItem( const string & id ) = 0;

    virtual string currentTreeSelection() = 0;

    virtual void deleteTreeItems() = 0;

    
    //
    // Menu handling
    //
    
    virtual void addMenu( const string & text,
                          const string & id ) = 0;

    virtual void addSubMenu( const string & parentMenuID,
                             const string & text,
                             const string & id ) = 0;

    virtual void addMenuEntry( const string & parentMenuID,
                               const string & text,
                               const string & id ) = 0;

    virtual void addMenuSeparator( const string & parentMenuID ) = 0;

    virtual void deleteMenus() = 0;

    virtual void showReleaseNotesButton( const string & label,
                                         const string & id ) = 0;

    //
    // Misc
    //
    
    virtual void hideReleaseNotesButton() = 0;

    virtual void retranslateInternalButtons() = 0;

    void ping();


    //
    // Property handling
    //
    
    virtual YPropertyValue getProperty( const string & propertyName );

    virtual const YPropertySet & propertySet();


private:

    ImplPtr<YWizardPrivate> priv;
};


#endif // YWizard_h