YWizard.h

Go to the documentation of this file.

/*
  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
*/


#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,   
    YWizardMode_Steps,      
    YWizardMode_Tree,       
    YWizardMode_TitleOnLeft     
};


class YWizard: public YWidget
{
protected:
    YWizard( YWidget *          parent,
         const std::string &    backButtonLabel,
         const std::string &    abortButtonLabel,
         const std::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 std::string & newLabel );

    virtual void setHelpText( const std::string & helpText ) = 0;

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

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

    virtual std::string getDialogTitle() = 0;

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

    virtual std::string getDialogHeading() = 0;

    //
    // Steps handling
    //

    virtual void addStep( const std::string & text, const std::string & id ) = 0;

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

    virtual void deleteSteps() = 0;

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

    virtual void updateSteps() = 0;


    //
    // Tree handling
    //

    virtual void addTreeItem( const std::string & parentID,
                  const std::string & text,
                  const std::string & id    ) = 0;

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

    virtual std::string currentTreeSelection() = 0;

    virtual void deleteTreeItems() = 0;


    //
    // Menu handling
    //

    virtual void addMenu( const std::string & text,
              const std::string & id ) = 0;

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

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

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

    virtual void deleteMenus() = 0;

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

    //
    // Misc
    //

    virtual void hideReleaseNotesButton() = 0;

    virtual void retranslateInternalButtons() = 0;

    void ping();


    //
    // Property handling
    //

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();


private:

    ImplPtr<YWizardPrivate> priv;
};


#endif // YWizard_h