xref: /AOO41X/main/svtools/source/uno/unowizard.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3*cdf0e10cSrcweir  *
4*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
5*cdf0e10cSrcweir  *
6*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
7*cdf0e10cSrcweir  *
8*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
9*cdf0e10cSrcweir  *
10*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
11*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
12*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
13*cdf0e10cSrcweir  *
14*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
15*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
18*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
19*cdf0e10cSrcweir  *
20*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
21*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
22*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
23*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
24*cdf0e10cSrcweir  *
25*cdf0e10cSrcweir  ************************************************************************/
26*cdf0e10cSrcweir 
27*cdf0e10cSrcweir #ifndef SVT_UNO_WIZARD_HXX
28*cdf0e10cSrcweir #define SVT_UNO_WIZARD_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include "svtools/genericunodialog.hxx"
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir /** === begin UNO includes === **/
33*cdf0e10cSrcweir #include <com/sun/star/ui/dialogs/XWizard.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
35*cdf0e10cSrcweir #include <com/sun/star/ui/dialogs/XWizardController.hpp>
36*cdf0e10cSrcweir /** === end UNO includes === **/
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir #include <cppuhelper/implbase1.hxx>
39*cdf0e10cSrcweir #include <comphelper/componentcontext.hxx>
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir //......................................................................................................................
42*cdf0e10cSrcweir namespace svt { namespace uno
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir //......................................................................................................................
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir 	//==================================================================================================================
47*cdf0e10cSrcweir 	//= Wizard - declaration
48*cdf0e10cSrcweir 	//==================================================================================================================
49*cdf0e10cSrcweir     typedef ::cppu::ImplInheritanceHelper1  <   ::svt::OGenericUnoDialog
50*cdf0e10cSrcweir                                             ,   ::com::sun::star::ui::dialogs::XWizard
51*cdf0e10cSrcweir                                             >   Wizard_Base;
52*cdf0e10cSrcweir     class Wizard;
53*cdf0e10cSrcweir     typedef ::comphelper::OPropertyArrayUsageHelper< Wizard >  Wizard_PBase;
54*cdf0e10cSrcweir     class Wizard    : public Wizard_Base
55*cdf0e10cSrcweir                     , public Wizard_PBase
56*cdf0e10cSrcweir     {
57*cdf0e10cSrcweir     public:
58*cdf0e10cSrcweir         Wizard( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& i_rContext );
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir 		// ::com::sun::star::lang::XServiceInfo - static version
61*cdf0e10cSrcweir 		static ::rtl::OUString SAL_CALL getImplementationName_static() throw(::com::sun::star::uno::RuntimeException);
62*cdf0e10cSrcweir         static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static() throw(::com::sun::star::uno::RuntimeException);
63*cdf0e10cSrcweir         static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL Create( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& i_rContext );
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir     protected:
66*cdf0e10cSrcweir         // ::com::sun::star::lang::XServiceInfo
67*cdf0e10cSrcweir 		virtual ::rtl::OUString SAL_CALL getImplementationName() throw(::com::sun::star::uno::RuntimeException);
68*cdf0e10cSrcweir         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames() throw(::com::sun::star::uno::RuntimeException);
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir         // ::com::sun::star::beans::XPropertySet
71*cdf0e10cSrcweir 	    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >  SAL_CALL getPropertySetInfo() throw(::com::sun::star::uno::RuntimeException);
72*cdf0e10cSrcweir 	    virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir 	    // OPropertyArrayUsageHelper
75*cdf0e10cSrcweir 	    virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir         // ::com::sun::star::ui::dialogs::XWizard
78*cdf0e10cSrcweir         virtual ::rtl::OUString SAL_CALL getHelpURL() throw (::com::sun::star::uno::RuntimeException);
79*cdf0e10cSrcweir         virtual void SAL_CALL setHelpURL( const ::rtl::OUString& _helpurl ) throw (::com::sun::star::uno::RuntimeException);
80*cdf0e10cSrcweir         virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow > SAL_CALL getDialogWindow() throw (::com::sun::star::uno::RuntimeException);
81*cdf0e10cSrcweir         virtual ::com::sun::star::uno::Reference< ::com::sun::star::ui::dialogs::XWizardPage > SAL_CALL getCurrentPage(  ) throw (::com::sun::star::uno::RuntimeException);
82*cdf0e10cSrcweir         virtual void SAL_CALL enableButton( ::sal_Int16 WizardButton, ::sal_Bool Enable ) throw (::com::sun::star::uno::RuntimeException);
83*cdf0e10cSrcweir         virtual void SAL_CALL setDefaultButton( ::sal_Int16 WizardButton ) throw (::com::sun::star::uno::RuntimeException);
84*cdf0e10cSrcweir         virtual ::sal_Bool SAL_CALL travelNext(  ) throw (::com::sun::star::uno::RuntimeException);
85*cdf0e10cSrcweir         virtual ::sal_Bool SAL_CALL travelPrevious(  ) throw (::com::sun::star::uno::RuntimeException);
86*cdf0e10cSrcweir         virtual void SAL_CALL enablePage( ::sal_Int16 PageID, ::sal_Bool Enable ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::util::InvalidStateException, ::com::sun::star::uno::RuntimeException);
87*cdf0e10cSrcweir         virtual void SAL_CALL updateTravelUI(  ) throw (::com::sun::star::uno::RuntimeException);
88*cdf0e10cSrcweir         virtual ::sal_Bool SAL_CALL advanceTo( ::sal_Int16 PageId ) throw (::com::sun::star::uno::RuntimeException);
89*cdf0e10cSrcweir         virtual ::sal_Bool SAL_CALL goBackTo( ::sal_Int16 PageId ) throw (::com::sun::star::uno::RuntimeException);
90*cdf0e10cSrcweir         virtual void SAL_CALL activatePath( ::sal_Int16 PathIndex, ::sal_Bool Final ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::util::InvalidStateException, ::com::sun::star::uno::RuntimeException);
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir         // ::com::sun::star::ui::dialogs::XExecutableDialog
93*cdf0e10cSrcweir         virtual void SAL_CALL setTitle( const ::rtl::OUString& aTitle ) throw (::com::sun::star::uno::RuntimeException);
94*cdf0e10cSrcweir         virtual ::sal_Int16 SAL_CALL execute(  ) throw (::com::sun::star::uno::RuntimeException);
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir         // ::com::sun::star::lang::XInitialization
97*cdf0e10cSrcweir         virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir    protected:
100*cdf0e10cSrcweir         ~Wizard();
101*cdf0e10cSrcweir 
102*cdf0e10cSrcweir     protected:
103*cdf0e10cSrcweir 		virtual Dialog*	createDialog( Window* _pParent );
104*cdf0e10cSrcweir 	    virtual void destroyDialog();
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir     private:
107*cdf0e10cSrcweir         ::comphelper::ComponentContext                                                          m_aContext;
108*cdf0e10cSrcweir         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< sal_Int16 > >         m_aWizardSteps;
109*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::ui::dialogs::XWizardController >    m_xController;
110*cdf0e10cSrcweir         ::rtl::OUString                                                                         m_sHelpURL;
111*cdf0e10cSrcweir     };
112*cdf0e10cSrcweir 
113*cdf0e10cSrcweir //......................................................................................................................
114*cdf0e10cSrcweir } } // namespace svt::uno
115*cdf0e10cSrcweir //......................................................................................................................
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir #endif // SVT_UNO_WIZARD_HXX
118