include/svx/svxdlg.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_SVX_SVXDLG_HXX
  20 #define INCLUDED_SVX_SVXDLG_HXX
  21
  22 #include <sfx2/sfxdlg.hxx>
  23 #include <svx/anchorid.hxx>
  24 #include <svx/zoom_def.hxx>
  25 #include <editeng/edtdlg.hxx>
  26
  27 #include <com/sun/star/container/XIndexContainer.hpp>
  28 #include <com/sun/star/container/XNameReplace.hpp>
  29 #include <svx/svxdllapi.h>
  30 #include <vector>
  31
  32 namespace sd {
  33     class View;
  34 }
  35
  36 namespace com::sun::star::linguistic2 {
  37     class XDictionary;
  38     class XSpellChecker1;
  39     class XSpellChecker;
  40     class XThesaurus;
  41     class XHyphenator;
  42 }
  43 class SdrModel;
  44 class SdrView;
  45 class SvxSpellWrapper;
  46 enum class TransliterationFlags;
  47 struct ExchangeData;
  48 class INetURLObject;
  49 class GalleryTheme;
  50 class SvxHyperlinkTabPageBase;
  51 class SearchAttrItemList;
  52 class FmFormShell;
  53 class Graphic;
  54 class SdrObject;
  55 class SvxSpellWrapper;
  56 struct FmSearchContext;
  57
  58 typedef WhichRangesContainer (*DialogGetRanges)();
  59
  60 typedef ::std::vector< OUString > TargetList;
  61
  62 namespace svx{ class SpellDialogChildWindow;}
  63 namespace weld{
  64     class Dialog;
  65     class Window;
  66 }
  67
  68 class AbstractFmShowColsDialog : public VclAbstractDialog
  69 {
  70 protected:
  71     virtual ~AbstractFmShowColsDialog() override = default;
  72 public:
  73      virtual void SetColumns(const css::uno::Reference< css::container::XIndexContainer>& xCols)= 0;
  74 };
  75
  76 class AbstractSvxZoomDialog : public VclAbstractDialog
  77 {
  78 protected:
  79     virtual ~AbstractSvxZoomDialog() override = default;
  80 public:
  81     virtual void    SetLimits( sal_uInt16 nMin, sal_uInt16 nMax ) = 0;
  82     virtual void    HideButton( ZoomButtonId nBtnId )= 0;
  83     virtual const SfxItemSet*   GetOutputItemSet() const = 0 ;
  84 };
  85
  86 class AbstractSpellDialog : public VclAbstractDialog
  87 {
  88 protected:
  89     virtual ~AbstractSpellDialog() override = default;
  90 public:
  91     virtual void InvalidateDialog() = 0;
  92     virtual std::shared_ptr<SfxDialogController> GetController() = 0;
  93     virtual SfxBindings& GetBindings() = 0;
  94 };
  95
  96 class AbstractTitleDialog :public VclAbstractDialog
  97 {
  98 protected:
  99     virtual ~AbstractTitleDialog() override = default;
 100 public:
 101     virtual OUString  GetTitle() const =0;
 102 };
 103
 104 class AbstractGalleryIdDialog :public VclAbstractDialog
 105 {
 106 protected:
 107     virtual ~AbstractGalleryIdDialog() override = default;
 108 public:
 109     virtual sal_uInt32 GetId() const =0;
 110 };
 111
 112 class AbstractURLDlg :public VclAbstractDialog
 113 {
 114 protected:
 115     virtual ~AbstractURLDlg() override = default;
 116 public:
 117     virtual OUString      GetURL() const = 0;
 118     virtual OUString      GetAltText() const = 0;
 119     virtual OUString      GetDesc() const = 0;
 120     virtual OUString      GetTarget() const = 0;
 121     virtual OUString      GetName() const = 0;
 122 };
 123
 124 class AbstractSvxSearchSimilarityDialog :public VclAbstractDialog
 125 {
 126 protected:
 127     virtual ~AbstractSvxSearchSimilarityDialog() override = default;
 128 public:
 129     virtual sal_uInt16  GetOther() =0 ;
 130     virtual sal_uInt16  GetShorter() =0 ;
 131     virtual sal_uInt16  GetLonger() =0 ;
 132     virtual bool        IsRelaxed() =0 ;
 133 };
 134
 135 class AbstractSvxJSearchOptionsDialog :public VclAbstractDialog
 136 {
 137 protected:
 138     virtual ~AbstractSvxJSearchOptionsDialog() override = default;
 139 public:
 140     virtual TransliterationFlags GetTransliterationFlags() const = 0;
 141 };
 142
 143 class AbstractFmInputRecordNoDialog :public VclAbstractDialog
 144 {
 145 protected:
 146     virtual ~AbstractFmInputRecordNoDialog() override = default;
 147 public:
 148     virtual void SetValue(tools::Long dNew) = 0;
 149     virtual tools::Long GetValue() const = 0;
 150 };
 151
 152 class AbstractSvxNewDictionaryDialog :public VclAbstractDialog
 153 {
 154 protected:
 155     virtual ~AbstractSvxNewDictionaryDialog() override = default;
 156 public:
 157     virtual css::uno::Reference< css::linguistic2::XDictionary >  GetNewDictionary() = 0;
 158 };
 159
 160 class AbstractSvxNameDialog : public VclAbstractDialog
 161 {
 162 protected:
 163     virtual ~AbstractSvxNameDialog() override = default;
 164 public:
 165     virtual void    GetName( OUString& rName ) = 0;
 166     virtual void    SetCheckNameHdl( const Link<AbstractSvxNameDialog&,bool>& rLink, bool bCheckImmediately = false ) = 0;
 167     virtual void    SetCheckNameTooltipHdl( const Link<AbstractSvxNameDialog&,OUString>& rLink ) = 0;
 168     virtual void    SetEditHelpId(const OString&) = 0;
 169     virtual void    SetHelpId( const OString& ) = 0;
 170     virtual void    SetText( const OUString& rStr ) = 0;
 171 };
 172
 173 class AbstractSvxObjectNameDialog :public VclAbstractDialog
 174 {
 175 protected:
 176     virtual ~AbstractSvxObjectNameDialog() override = default;
 177 public:
 178     virtual void GetName(OUString& rName) = 0;
 179     virtual void SetCheckNameHdl(const Link<AbstractSvxObjectNameDialog&,bool>& rLink) = 0;
 180 };
 181
 182 class AbstractSvxObjectTitleDescDialog :public VclAbstractDialog
 183 {
 184 protected:
 185     virtual ~AbstractSvxObjectTitleDescDialog() override = default;
 186 public:
 187     virtual void GetTitle(OUString& rTitle) = 0;
 188     virtual void GetDescription(OUString& rDescription) = 0;
 189 };
 190
 191 /// Abstract class provides the get information from the numbering and position dialog.
 192 class AbstractSvxBulletAndPositionDlg :public VclAbstractDialog
 193 {
 194 protected:
 195     virtual ~AbstractSvxBulletAndPositionDlg() override = default;
 196 public:
 197     virtual const SfxItemSet*   GetOutputItemSet( SfxItemSet* pSet) const = 0 ;
 198     virtual bool IsApplyToMaster() = 0;
 199     virtual bool IsSlideScope() = 0;
 200 };
 201
 202 class AbstractSvxMultiPathDialog : public VclAbstractDialog
 203 {
 204 protected:
 205     virtual ~AbstractSvxMultiPathDialog() override = default;
 206 public:
 207     virtual OUString        GetPath() const = 0;
 208     virtual void            SetPath( const OUString& rPath ) = 0;
 209     virtual void            SetTitle( const OUString& rNewTitle ) = 0;
 210 };
 211
 212 class AbstractSvxHpLinkDlg : public VclAbstractDialog
 213 {
 214 protected:
 215     virtual ~AbstractSvxHpLinkDlg() override = default;
 216 public:
 217     virtual std::shared_ptr<SfxDialogController> GetController()  = 0;
 218     virtual bool       QueryClose() = 0;
 219 };
 220
 221 struct FmFoundRecordInformation;
 222 class AbstractFmSearchDialog :public VclAbstractDialog
 223 {
 224 protected:
 225     virtual ~AbstractFmSearchDialog() override = default;
 226 public:
 227     virtual void SetFoundHandler(const Link<FmFoundRecordInformation&,void>& lnk) = 0;
 228     virtual void SetCanceledNotFoundHdl(const Link<FmFoundRecordInformation&,void>& lnk)=0;
 229     virtual void SetActiveField(const OUString& strField)=0;
 230 };
 231
 232 class AbstractGraphicFilterDialog :public VclAbstractDialog
 233 {
 234 protected:
 235     virtual ~AbstractGraphicFilterDialog() override = default;
 236 public:
 237     virtual Graphic GetFilteredGraphic( const Graphic& rGraphic, double fScaleX, double fScaleY ) = 0;
 238 };
 239
 240 class AbstractSvxAreaTabDialog :public SfxAbstractTabDialog
 241 {
 242 protected:
 243     virtual ~AbstractSvxAreaTabDialog() override = default;
 244 };
 245
 246 struct SvxSwFrameValidation;
 247 class AbstractSvxTransformTabDialog : public SfxAbstractTabDialog
 248 {
 249 protected:
 250     virtual ~AbstractSvxTransformTabDialog() override = default;
 251 public:
 252     virtual void SetValidateFramePosLink( const Link<SvxSwFrameValidation&,void>& rLink ) = 0;
 253 };
 254
 255 class AbstractSvxCaptionDialog : public SfxAbstractTabDialog
 256 {
 257 protected:
 258     virtual ~AbstractSvxCaptionDialog() override = default;
 259 public:
 260     virtual void SetValidateFramePosLink( const Link<SvxSwFrameValidation&,void>& rLink ) = 0;
 261 };
 262
 263 class AbstractSvxPostItDialog : public VclAbstractDialog
 264 {
 265 protected:
 266     virtual ~AbstractSvxPostItDialog() override = default;
 267 public:
 268     virtual void                SetText( const OUString& rStr ) = 0;
 269     virtual const SfxItemSet*   GetOutputItemSet() const = 0;
 270     virtual void                SetPrevHdl( const Link<AbstractSvxPostItDialog&,void>& rLink ) = 0;
 271     virtual void                SetNextHdl( const Link<AbstractSvxPostItDialog&,void>& rLink ) = 0;
 272     virtual void                EnableTravel(bool bNext, bool bPrev) = 0;
 273     virtual OUString            GetNote()  = 0;
 274     virtual void                SetNote(const OUString& rTxt)  = 0;
 275     virtual void                ShowLastAuthor(const OUString& rAuthor, const OUString& rDate) = 0;
 276     virtual void                DontChangeAuthor() = 0;
 277     virtual void                HideAuthor() = 0;
 278     virtual std::shared_ptr<weld::Dialog> GetDialog() = 0;
 279 };
 280
 281 class SvxAbstractSplitTableDialog : public VclAbstractDialog
 282 {
 283 protected:
 284     virtual ~SvxAbstractSplitTableDialog() override = default;
 285 public:
 286     virtual bool IsHorizontal() const = 0;
 287     virtual bool IsProportional() const = 0;
 288     virtual tools::Long GetCount() const = 0;
 289     virtual void SetSplitVerticalByDefault() = 0;
 290 };
 291
 292 class SvxAbstractNewTableDialog
 293 {
 294 protected:
 295     virtual ~SvxAbstractNewTableDialog() = default;
 296 public:
 297     virtual sal_Int32 getRows() const = 0;
 298     virtual sal_Int32 getColumns() const = 0;
 299     virtual std::shared_ptr<weld::DialogController> getDialogController() = 0;
 300 };
 301
 302 class SvxAbstractInsRowColDlg : public VclAbstractDialog
 303 {
 304 protected:
 305     virtual ~SvxAbstractInsRowColDlg() override = default;
 306 public:
 307     virtual bool isInsertBefore() const = 0;
 308     virtual sal_uInt16 getInsertCount() const = 0;
 309 };
 310
 311 class SVXCORE_DLLPUBLIC SvxAbstractDialogFactory : public SfxAbstractDialogFactory, public EditAbstractDialogFactory
 312 {
 313 public:
 314     static SvxAbstractDialogFactory* Create();
 315
 316     virtual                             ~SvxAbstractDialogFactory() override;
 317
 318     virtual VclPtr<SfxAbstractTabDialog>      CreateTextTabDialog( weld::Window* pParent,
 319                                             const SfxItemSet* pAttrSet,
 320                                             SdrView* pView ) = 0 ;
 321
 322     virtual VclPtr<AbstractSvxCaptionDialog> CreateCaptionDialog(weld::Window* pParent,
 323                                                                  const SdrView* pView,
 324                                                                  SvxAnchorIds nAnchorTypes = SvxAnchorIds::NONE) = 0;
 325
 326     virtual VclPtr<AbstractFmShowColsDialog> CreateFmShowColsDialog(weld::Window* pParent) = 0;
 327
 328     virtual VclPtr<AbstractSvxZoomDialog> CreateSvxZoomDialog(weld::Window* pParent, const SfxItemSet& rCoreSet) = 0;
 329
 330     virtual VclPtr<AbstractSpellDialog>   CreateSvxSpellDialog(weld::Window* pParent,
 331                                             SfxBindings* pBindings,
 332                                             svx::SpellDialogChildWindow* pSpellChildWindow )=0;
 333
 334     virtual VclPtr<VclAbstractDialog> CreateActualizeProgressDialog(weld::Widget* pParent,
 335                                             GalleryTheme* pThm) = 0;
 336     virtual VclPtr<AbstractTitleDialog> CreateTitleDialog(weld::Widget* pParent,
 337                                              const OUString& rOldText) = 0;
 338     virtual VclPtr<AbstractGalleryIdDialog> CreateGalleryIdDialog(weld::Widget* pParent,
 339                                             GalleryTheme* pThm) = 0;
 340     virtual VclPtr<VclAbstractDialog> CreateGalleryThemePropertiesDialog(weld::Widget* pParent,
 341                                             ExchangeData* pData,
 342                                             SfxItemSet* pItemSet ) = 0;
 343
 344     virtual VclPtr<AbstractURLDlg> CreateURLDialog(weld::Widget* pParent,
 345                                             const OUString& rURL, const OUString& rAltText, const OUString& rDescription,
 346                                             const OUString& rTarget, const OUString& rName,
 347                                             TargetList& rTargetList ) = 0;
 348
 349     virtual VclPtr<SfxAbstractTabDialog> CreateTabItemDialog(weld::Window* pParent, const SfxItemSet& rSet) = 0;
 350     virtual VclPtr<VclAbstractDialog>      CreateSvxSearchAttributeDialog(weld::Window* pParent,
 351                                             SearchAttrItemList& rLst,
 352                                             const WhichRangesContainer& pWhRanges)=0;
 353     virtual VclPtr<AbstractSvxSearchSimilarityDialog> CreateSvxSearchSimilarityDialog( weld::Window* pParent,
 354                                                             bool bRelax,
 355                                                             sal_uInt16 nOther,
 356                                                             sal_uInt16 nShorter,
 357                                                             sal_uInt16 nLonger ) = 0;
 358     // add for SvxBorderBackgroundDlg
 359     virtual VclPtr<SfxAbstractTabDialog> CreateSvxBorderBackgroundDlg(
 360         weld::Window* pParent,
 361         const SfxItemSet& rCoreSet,
 362         bool bEnableDrawingLayerFillStyles) = 0;
 363
 364     virtual VclPtr<AbstractSvxTransformTabDialog> CreateSvxTransformTabDialog(weld::Window* pParent,
 365                                                                               const SfxItemSet* pAttr,
 366                                                                               const SdrView* pView,
 367                                                                               SvxAnchorIds nAnchorTypes = SvxAnchorIds::NONE) = 0;
 368     virtual VclPtr<SfxAbstractTabDialog> CreateSchTransformTabDialog(weld::Window* pParent,
 369                                                                      const SfxItemSet* pAttr,
 370                                                                      const SdrView* pSdrView,
 371                                                                      bool bSizeTabPage) = 0;
 372     virtual VclPtr<AbstractSvxJSearchOptionsDialog> CreateSvxJSearchOptionsDialog(weld::Window* pParent,
 373                                                                                   const SfxItemSet& rOptionsSet,
 374                                                                                   TransliterationFlags nInitialFlags) = 0;
 375     virtual VclPtr<AbstractFmInputRecordNoDialog> CreateFmInputRecordNoDialog(weld::Window* pParent) = 0;
 376     virtual VclPtr<AbstractSvxNewDictionaryDialog> CreateSvxNewDictionaryDialog(weld::Window* pParent) = 0;
 377     virtual VclPtr<VclAbstractDialog>     CreateSvxEditDictionaryDialog(weld::Window* pParent, const OUString& rName) = 0;
 378     virtual VclPtr<AbstractSvxNameDialog> CreateSvxNameDialog(weld::Window* pParent,
 379                                             const OUString& rName, const OUString& rDesc ) = 0;
 380
 381     // #i68101#
 382     virtual VclPtr<AbstractSvxObjectNameDialog> CreateSvxObjectNameDialog(weld::Window* pParent, const OUString& rName) = 0;
 383     virtual VclPtr<AbstractSvxObjectTitleDescDialog> CreateSvxObjectTitleDescDialog(weld::Window* pParent, const OUString& rTitle, const OUString& rDescription) = 0;
 384     virtual VclPtr<AbstractSvxMultiPathDialog>    CreateSvxMultiPathDialog(weld::Window* pParent) = 0 ;
 385     virtual VclPtr<AbstractSvxMultiPathDialog>    CreateSvxPathSelectDialog(weld::Window* pParent) = 0 ;
 386     virtual VclPtr<AbstractSvxHpLinkDlg>  CreateSvxHpLinkDlg(SfxChildWindow* pChild, SfxBindings* pBindings, weld::Window* pParent) = 0;
 387     virtual VclPtr<AbstractFmSearchDialog> CreateFmSearchDialog(weld::Window* pParent,
 388                                                         const OUString& strInitialText,
 389                                                         const ::std::vector< OUString >& _rContexts,
 390                                                         sal_Int16 nInitialContext,
 391                                                         const Link<FmSearchContext&,sal_uInt32>& lnkContextSupplier)=0;
 392     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterEmboss(weld::Window* pParent,
 393                                                 const Graphic& rGraphic)=0;
 394     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterPoster(weld::Window* pParent,
 395                                                 const Graphic& rGraphic)=0;
 396     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterSepia(weld::Window* pParent,
 397                                                 const Graphic& rGraphic)=0;
 398     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterSmooth(weld::Window* pParent,
 399                                                 const Graphic& rGraphic,
 400                                                 double nRadius)=0;
 401     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterSolarize(weld::Window* pParent,
 402                                                 const Graphic& rGraphic)=0;
 403     virtual VclPtr<AbstractGraphicFilterDialog>   CreateGraphicFilterMosaic(weld::Window* pParent,
 404                                                 const Graphic& rGraphic)=0;
 405     virtual VclPtr<AbstractSvxAreaTabDialog>       CreateSvxAreaTabDialog(weld::Window* pParent,
 406                                                                           const SfxItemSet* pAttr,
 407                                                                           SdrModel* pModel,
 408                                                                           bool bShadow) = 0 ;
 409     virtual VclPtr<SfxAbstractTabDialog>           CreateSvxLineTabDialog(weld::Window* pParent, const SfxItemSet* pAttr, //add forSvxLineTabDialog
 410                                                                  SdrModel* pModel,
 411                                                                  const SdrObject* pObj,
 412                                                                  bool bHasObj )=0;
 413     virtual VclPtr<SfxAbstractDialog>       CreateSfxDialog( weld::Window* pParent,
 414                                                                         const SfxItemSet& rAttr,
 415                                                                         const SdrView* pView,
 416                                                                         sal_uInt32 nResId )=0;
 417     virtual VclPtr<SfxAbstractDialog>       CreateCharMapDialog(weld::Window* pParent, const SfxItemSet& rAttr,
 418                                                                 const css::uno::Reference<css::frame::XFrame>& rFrame) = 0;
 419     virtual VclPtr<SfxAbstractDialog>       CreateEventConfigDialog(weld::Widget* pParent, const SfxItemSet& rAttr,
 420                                                                     const css::uno::Reference< css::frame::XFrame >& rFrame) = 0;
 421     virtual VclPtr<AbstractSvxPostItDialog>    CreateSvxPostItDialog(weld::Widget* pParent, const SfxItemSet& rCoreSet, bool bPrevNext = false) = 0;
 422     virtual VclPtr<VclAbstractDialog>          CreateSvxScriptOrgDialog(weld::Window* pParent, const OUString& rLanguage) override = 0;
 423
 424     virtual DialogGetRanges                    GetDialogGetRangesFunc() = 0;
 425
 426     virtual VclPtr<AbstractScriptSelectorDialog> CreateScriptSelectorDialog(weld::Window* pParent,
 427             const css::uno::Reference< css::frame::XFrame >& rxFrame) override = 0;
 428
 429     virtual void ShowAsyncScriptErrorDialog(weld::Window* pParent, const css::uno::Any& rException) override = 0;
 430
 431     virtual VclPtr<VclAbstractDialog> CreateSvxMacroAssignDlg(
 432                 weld::Window* _pParent,
 433                 const css::uno::Reference< css::frame::XFrame >& _rxDocumentFrame,
 434                 const bool _bUnoDialogMode,
 435                 const css::uno::Reference< css::container::XNameReplace >& _rxEvents,
 436                 const sal_uInt16 _nInitiallySelectedEvent
 437             ) = 0;
 438
 439     virtual VclPtr<SfxAbstractTabDialog> CreateSvxFormatCellsDialog(weld::Window* pParent, const SfxItemSet* pAttr, const SdrModel& rModel )=0;
 440
 441     virtual VclPtr<SvxAbstractSplitTableDialog> CreateSvxSplitTableDialog(weld::Window* pParent, bool bIsTableVertical, tools::Long nMaxVertical) = 0;
 442
 443     virtual std::shared_ptr<SvxAbstractNewTableDialog> CreateSvxNewTableDialog(weld::Window* pParent) = 0;
 444
 445     virtual VclPtr<SvxAbstractInsRowColDlg> CreateSvxInsRowColDlg(weld::Window* pParent, bool bCol, const OString& rHelpId) = 0;
 446 };
 447
 448 #endif
 449
 450 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */