roadmapwizard.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_VCL_ROADMAPWIZARD_HXX
#define INCLUDED_VCL_ROADMAPWIZARD_HXX

#include <memory>
#include <vcl/dllapi.h>
#include <vcl/wizardmachine.hxx>

namespace vcl
{
    struct RoadmapWizardImpl;

    namespace RoadmapWizardTypes
    {
        typedef sal_Int16                                   PathId;
        typedef ::std::vector< WizardTypes::WizardState >   WizardPath;
    };

    //= RoadmapWizard

    class VCL_DLLPUBLIC RoadmapWizardMachine : public vcl::WizardMachine
    {
    private:
        std::unique_ptr<RoadmapWizardImpl>  m_pImpl;

    public:
        RoadmapWizardMachine(weld::Window* _pParent);
        virtual ~RoadmapWizardMachine( ) override;

        void            SetRoadmapHelpId( const OString& _rId );

        // returns whether a given state is enabled
        bool            isStateEnabled(WizardTypes::WizardState nState) const;

        // WizardDialog overridables
        virtual bool    canAdvance() const override;
        virtual void    updateTravelUI() override;

    protected:
        void    declarePath( RoadmapWizardTypes::PathId _nPathId, const RoadmapWizardTypes::WizardPath& _lWizardStates);

        void    activatePath( RoadmapWizardTypes::PathId _nPathId, bool _bDecideForIt = false );

        virtual WizardTypes::WizardState determineNextState(WizardTypes::WizardState nCurrentState) const override;

        void    enableState(WizardTypes::WizardState nState, bool _bEnable = true);

        bool    knowsState(WizardTypes::WizardState nState) const;

        // WizardMachine overriables
        virtual void            enterState(WizardTypes::WizardState nState) override;

        virtual OUString  getStateDisplayName(WizardTypes::WizardState nState) const;

    private:
        DECL_DLLPRIVATE_LINK( OnRoadmapItemSelected, const OString&, bool );

        VCL_DLLPRIVATE void implUpdateRoadmap( );
    };
} // namespace vcl


#endif // OOO_ INCLUDED_VCL_ROADMAPWIZARD_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */