include/sfx2/basedlgs.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SFX2_BASEDLGS_HXX
  20 #define INCLUDED_SFX2_BASEDLGS_HXX
  21
  22 #include <memory>
  23 #include <sal/config.h>
  24 #include <sfx2/dllapi.h>
  25 #include <sal/types.h>
  26 #include <vcl/floatwin.hxx>
  27 #include <vcl/weld.hxx>
  28
  29 class SfxTabPage;
  30 class SfxBindings;
  31 class SfxChildWindow;
  32 struct SfxChildWinInfo;
  33 class SfxItemSet;
  34 class Timer;
  35
  36 class SFX2_DLLPUBLIC SfxDialogController : public weld::GenericDialogController
  37 {
  38 private:
  39     DECL_DLLPRIVATE_STATIC_LINK(SfxDialogController, InstallLOKNotifierHdl, void*, vcl::ILibreOfficeKitNotifier*);
  40
  41     DECL_DLLPRIVATE_LINK(FocusChangeHdl, weld::Widget&, void);
  42
  43 public:
  44     SfxDialogController(weld::Widget* pParent, const OUString& rUIFile, const OString& rDialogId);
  45     // dialog gets focus
  46     virtual void Activate() {}
  47     // dialog loses focus
  48     virtual void Deactivate() {}
  49
  50     // when the dialog has an associated SfxChildWin, typically for Modeless interaction
  51     virtual void ChildWinDispose() {} // called from the associated SfxChildWin dtor
  52     virtual void Close() {} // called by the SfxChildWin when the dialog is closed
  53     virtual void EndDialog(); // called by the SfxChildWin to close the dialog
  54 };
  55
  56 class SfxModelessDialog_Impl;
  57
  58 class SFX2_DLLPUBLIC SfxModelessDialogController : public SfxDialogController
  59 {
  60     SfxBindings* m_pBindings;
  61     std::unique_ptr<SfxModelessDialog_Impl> m_xImpl;
  62
  63     SfxModelessDialogController(SfxModelessDialogController&) = delete;
  64     void operator =(SfxModelessDialogController&) = delete;
  65
  66     void Init(SfxBindings *pBindinx, SfxChildWindow *pCW);
  67
  68 protected:
  69     SfxModelessDialogController(SfxBindings*, SfxChildWindow* pChildWin,
  70         weld::Window* pParent, const OUString& rUIXMLDescription, const OString& rID);
  71
  72 public:
  73     virtual ~SfxModelessDialogController() override;
  74
  75     void                    Initialize (SfxChildWinInfo const * pInfo);
  76     bool                    IsClosing() const;
  77     virtual void            Close() override;
  78     virtual void            EndDialog() override;
  79     virtual void            Activate() override;
  80     virtual void            Deactivate() override;
  81     virtual void            ChildWinDispose() override;
  82     virtual void            FillInfo(SfxChildWinInfo&) const;
  83     SfxBindings&            GetBindings() const { return *m_pBindings; }
  84 };
  85
  86 // class SfxFloatingWindow --------------------------------------------------
  87 class SfxFloatingWindow_Impl;
  88 class SFX2_DLLPUBLIC SfxFloatingWindow: public FloatingWindow
  89 {
  90     SfxBindings*            pBindings;
  91     Size                    aSize;
  92     std::unique_ptr< SfxFloatingWindow_Impl > pImpl;
  93
  94     SfxFloatingWindow(SfxFloatingWindow const &) = delete;
  95     SfxFloatingWindow& operator =(SfxFloatingWindow const &) = delete;
  96
  97 protected:
  98                             SfxFloatingWindow( SfxBindings *pBindings,
  99                                               SfxChildWindow *pCW,
 100                                               vcl::Window* pParent,
 101                                               WinBits nWinBits);
 102                             virtual ~SfxFloatingWindow() override;
 103     virtual void            dispose() override;
 104
 105     virtual void            StateChanged( StateChangedType nStateChange ) override;
 106     virtual bool            Close() override;
 107     virtual void            Resize() override;
 108     virtual void            Move() override;
 109     virtual bool            EventNotify( NotifyEvent& rNEvt ) override;
 110     SfxBindings&            GetBindings()
 111                             { return *pBindings; }
 112
 113 public:
 114     virtual void            FillInfo(SfxChildWinInfo&) const;
 115     void                    Initialize (SfxChildWinInfo const * pInfo);
 116
 117     DECL_LINK(TimerHdl, Timer *, void);
 118
 119 };
 120
 121 // class SfxNoLayoutSingleTabDialog --------------------------------------------------
 122
 123 typedef const sal_uInt16* (*GetTabPageRanges)(); // provides international Which values
 124
 125 class SFX2_DLLPUBLIC SfxOkDialogController : public SfxDialogController
 126 {
 127 public:
 128     SfxOkDialogController(weld::Widget* pParent, const OUString& rUIXMLDescription,
 129                           const OString& rID)
 130         : SfxDialogController(pParent, rUIXMLDescription, rID)
 131     {
 132     }
 133
 134     virtual weld::Button&       GetOKButton() const = 0;
 135     virtual const SfxItemSet* GetExampleSet() const = 0;
 136 };
 137
 138 class SFX2_DLLPUBLIC SfxSingleTabDialogController : public SfxOkDialogController
 139 {
 140 private:
 141     std::unique_ptr<SfxItemSet> m_xOutputSet;
 142     const SfxItemSet* m_pInputSet;
 143
 144 public:
 145     SfxSingleTabDialogController(weld::Widget* pParent, const SfxItemSet* pOptionsSet,
 146         const OUString& rUIXMLDescription = OUString("sfx/ui/singletabdialog.ui"),
 147         const OString& rID = OString("SingleTabDialog"));
 148
 149     weld::Container* get_content_area() { return m_xContainer.get(); }
 150
 151     virtual             ~SfxSingleTabDialogController() override;
 152
 153     void                SetTabPage(std::unique_ptr<SfxTabPage> xTabPage);
 154     SfxTabPage*         GetTabPage() const { return m_xSfxPage.get(); }
 155
 156     virtual weld::Button& GetOKButton() const override { return *m_xOKBtn; }
 157     virtual const SfxItemSet* GetExampleSet() const override { return nullptr; }
 158
 159     const SfxItemSet*   GetOutputItemSet() const { return m_xOutputSet.get(); }
 160     const SfxItemSet*   GetInputItemSet() const { return m_pInputSet; }
 161
 162 protected:
 163     std::unique_ptr<SfxTabPage> m_xSfxPage;
 164     std::unique_ptr<weld::Container> m_xContainer;
 165     std::unique_ptr<weld::Button> m_xOKBtn;
 166     std::unique_ptr<weld::Button> m_xHelpBtn;
 167
 168     void                CreateOutputItemSet(const SfxItemSet& rInput);
 169     void                SetInputSet(const SfxItemSet* pInSet) { m_pInputSet = pInSet; }
 170     DECL_DLLPRIVATE_LINK(OKHdl_Impl, weld::Button&, void);
 171 };
 172
 173 #endif
 174
 175 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */