sfx2/source/appl/newhelp.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_SOURCE_APPL_NEWHELP_HXX
  20 #define INCLUDED_SFX2_SOURCE_APPL_NEWHELP_HXX
  21
  22 #include <com/sun/star/uno/Reference.h>
  23 #include <com/sun/star/frame/XFrame2.hpp>
  24
  25 #include <rtl/ustrbuf.hxx>
  26 #include <vcl/builderpage.hxx>
  27 #include <vcl/dockwin.hxx>
  28 #include <vcl/idle.hxx>
  29 #include <vcl/weld.hxx>
  30 #include <vcl/window.hxx>
  31
  32 #include <srchdlg.hxx>
  33
  34 // context menu ids
  35 #define MID_OPEN                                1
  36 #define MID_RENAME                              2
  37 #define MID_DELETE                              3
  38
  39 namespace com::sun::star::awt { class XWindow; }
  40 namespace com::sun::star::i18n { class XBreakIterator; }
  41 namespace com::sun::star::text { class XTextRange; }
  42
  43 // class HelpTabPage_Impl ------------------------------------------------
  44
  45 class SfxHelpIndexWindow_Impl;
  46
  47 class HelpTabPage_Impl : public BuilderPage
  48 {
  49 protected:
  50     SfxHelpIndexWindow_Impl*    m_pIdxWin;
  51
  52 public:
  53     HelpTabPage_Impl(weld::Widget* pParent, SfxHelpIndexWindow_Impl* _pIdxWin,
  54         const OString& rID, const OUString& rUIXMLDescription);
  55     virtual ~HelpTabPage_Impl() override;
  56 };
  57
  58 // class ContentTabPage_Impl ---------------------------------------------
  59
  60 class ContentTabPage_Impl : public HelpTabPage_Impl
  61 {
  62 private:
  63     std::unique_ptr<weld::TreeView> m_xContentBox;
  64     std::unique_ptr<weld::TreeIter> m_xScratchIter;
  65     OUString aOpenBookImage;
  66     OUString aClosedBookImage;
  67     OUString aDocumentImage;
  68
  69     Link<LinkParamNone*, void> aDoubleClickHdl;
  70
  71     DECL_LINK(DoubleClickHdl, weld::TreeView&, bool);
  72     DECL_LINK(ExpandingHdl, const weld::TreeIter&, bool);
  73     DECL_LINK(CollapsingHdl, const weld::TreeIter&, bool);
  74
  75     void            ClearChildren(const weld::TreeIter* pParent);
  76     void            InitRoot();
  77 public:
  78     ContentTabPage_Impl(weld::Widget* pParent, SfxHelpIndexWindow_Impl* _pIdxWin);
  79     virtual ~ContentTabPage_Impl() override;
  80
  81     void     SetDoubleClickHdl(const Link<LinkParamNone*, void>& rLink);
  82     OUString GetSelectedEntry() const;
  83     void     SetFocusOnBox() { m_xContentBox->grab_focus(); }
  84 };
  85
  86 class IndexTabPage_Impl : public HelpTabPage_Impl
  87 {
  88 private:
  89     std::unique_ptr<weld::Entry> m_xIndexEntry;
  90     std::unique_ptr<weld::TreeView> m_xIndexList;
  91     std::unique_ptr<weld::Button> m_xOpenBtn;
  92
  93     Idle                aFactoryIdle;
  94     Idle                aAutoCompleteIdle;
  95     Timer               aKeywordTimer;
  96     Link<IndexTabPage_Impl&,void> aKeywordLink;
  97
  98     OUString            sFactory;
  99     OUString            sKeyword;
 100
 101     bool                bIsActivated;
 102     int                 nRowHeight;
 103     int                 nAllHeight;
 104
 105     void                InitializeIndex();
 106     void                ClearIndex();
 107
 108     Link<LinkParamNone*, void> aDoubleClickHdl;
 109
 110     DECL_LINK(OpenHdl, weld::Button&, void);
 111     DECL_LINK(IdleHdl, Timer*, void);
 112     DECL_LINK(AutoCompleteHdl, Timer*, void);
 113     DECL_LINK(TimeoutHdl, Timer*, void);
 114     DECL_LINK(TreeChangeHdl, weld::TreeView&, void);
 115     DECL_LINK(EntryChangeHdl, weld::Entry&, void);
 116     DECL_LINK(ActivateHdl, weld::Entry&, bool);
 117     DECL_LINK(DoubleClickHdl, weld::TreeView&, bool);
 118     DECL_LINK(KeyInputHdl, const KeyEvent&, bool);
 119     DECL_LINK(CustomGetSizeHdl, weld::TreeView::get_size_args, Size);
 120     DECL_LINK(CustomRenderHdl, weld::TreeView::render_args, void);
 121     DECL_LINK(ResizeHdl, const Size&, void);
 122
 123     int starts_with(const OUString& rStr, int nStartRow, bool bCaseSensitive);
 124
 125 public:
 126     IndexTabPage_Impl(weld::Widget* pParent, SfxHelpIndexWindow_Impl* pIdxWin);
 127     virtual ~IndexTabPage_Impl() override;
 128
 129     virtual void        Activate() override;
 130
 131     void                SetDoubleClickHdl(const Link<LinkParamNone*, void>& rLink);
 132     void                SetFactory( const OUString& rFactory );
 133     const OUString&     GetFactory() const { return sFactory; }
 134     OUString            GetSelectedEntry() const;
 135     void                SetFocusOnBox() { m_xIndexEntry->grab_focus(); }
 136     bool                HasFocusOnEdit() const { return m_xIndexEntry->has_focus(); }
 137
 138     void                SetKeywordHdl( const Link<IndexTabPage_Impl&,void>& rLink ) { aKeywordLink = rLink; }
 139     void                SetKeyword( const OUString& rKeyword );
 140     bool                HasKeyword() const;
 141     bool                HasKeywordIgnoreCase();
 142     void                OpenKeyword();
 143
 144     void         SelectExecutableEntry();
 145 };
 146
 147 class SearchTabPage_Impl : public HelpTabPage_Impl
 148 {
 149 private:
 150     std::unique_ptr<weld::ComboBox> m_xSearchED;
 151     std::unique_ptr<weld::Button> m_xSearchBtn;
 152     std::unique_ptr<weld::CheckButton> m_xFullWordsCB;
 153     std::unique_ptr<weld::CheckButton> m_xScopeCB;
 154     std::unique_ptr<weld::TreeView> m_xResultsLB;
 155     std::unique_ptr<weld::Button> m_xOpenBtn;
 156
 157     Link<LinkParamNone*, void> aDoubleClickHdl;
 158
 159     OUString                       aFactory;
 160
 161     css::uno::Reference< css::i18n::XBreakIterator >
 162                                    xBreakIterator;
 163
 164     void ClearSearchResults();
 165     void RememberSearchText( const OUString& rSearchText );
 166     void Search();
 167
 168     DECL_LINK(ClickHdl, weld::Button&, void);
 169     DECL_LINK(OpenHdl, weld::Button&, void);
 170     DECL_LINK(ModifyHdl, weld::ComboBox&, void);
 171     DECL_LINK(DoubleClickHdl, weld::TreeView&, bool);
 172     DECL_LINK(ActivateHdl, weld::ComboBox&, bool);
 173
 174 public:
 175     SearchTabPage_Impl(weld::Widget* pParent, SfxHelpIndexWindow_Impl* pIdxWin);
 176     virtual ~SearchTabPage_Impl() override;
 177
 178     void         SetDoubleClickHdl(const Link<LinkParamNone*, void>& rLink);
 179     void         SetFactory( const OUString& rFactory ) { aFactory = rFactory; }
 180     OUString     GetSelectedEntry() const;
 181     void         ClearPage();
 182     void         SetFocusOnBox() { m_xResultsLB->grab_focus(); }
 183     bool         HasFocusOnEdit() const { return m_xSearchED->has_focus(); }
 184     OUString     GetSearchText() const { return m_xSearchED->get_active_text(); }
 185     bool         IsFullWordSearch() const { return m_xFullWordsCB->get_active(); }
 186     bool         OpenKeyword( const OUString& rKeyword );
 187 };
 188
 189 class BookmarksTabPage_Impl : public HelpTabPage_Impl
 190 {
 191 private:
 192     std::unique_ptr<weld::TreeView> m_xBookmarksBox;
 193     std::unique_ptr<weld::Button> m_xBookmarksPB;
 194
 195     Link<LinkParamNone*, void> aDoubleClickHdl;
 196
 197     DECL_LINK(OpenHdl, weld::Button&, void);
 198     DECL_LINK(DoubleClickHdl, weld::TreeView&, bool);
 199     DECL_LINK(CommandHdl, const CommandEvent&, bool);
 200     DECL_LINK(KeyInputHdl, const KeyEvent&, bool);
 201
 202     void DoAction(const OString& rAction);
 203
 204 public:
 205     BookmarksTabPage_Impl(weld::Widget* pParent, SfxHelpIndexWindow_Impl* pIdxWin);
 206     virtual ~BookmarksTabPage_Impl() override;
 207
 208     void                SetDoubleClickHdl(const Link<LinkParamNone*, void>& rLink);
 209     OUString            GetSelectedEntry() const;
 210     void                AddBookmarks( const OUString& rTitle, const OUString& rURL );
 211     void                SetFocusOnBox() { m_xBookmarksBox->grab_focus(); }
 212 };
 213
 214 // class SfxHelpIndexWindow_Impl -----------------------------------------
 215
 216 class SfxHelpWindow_Impl;
 217
 218 class SfxHelpIndexWindow_Impl
 219 {
 220 private:
 221     std::unique_ptr<weld::Builder> m_xBuilder;
 222     std::unique_ptr<weld::Container> m_xContainer;
 223     std::unique_ptr<weld::ComboBox> m_xActiveLB;
 224     std::unique_ptr<weld::Notebook> m_xTabCtrl;
 225
 226     Idle                aIdle;
 227
 228     Link<SfxHelpIndexWindow_Impl*,void> aSelectFactoryLink;
 229     Link<LinkParamNone*,void>           aPageDoubleClickLink;
 230     Link<IndexTabPage_Impl&,void>       aIndexKeywordLink;
 231     OUString                            sKeyword;
 232
 233     VclPtr<SfxHelpWindow_Impl>     pParentWin;
 234
 235     std::unique_ptr<ContentTabPage_Impl> xCPage;
 236     std::unique_ptr<IndexTabPage_Impl> xIPage;
 237     std::unique_ptr<SearchTabPage_Impl> xSPage;
 238     std::unique_ptr<BookmarksTabPage_Impl> xBPage;
 239
 240     bool                bIsInitDone;
 241
 242     void                Initialize();
 243     void                SetActiveFactory();
 244     HelpTabPage_Impl*   GetPage(const OString&);
 245
 246     inline ContentTabPage_Impl*     GetContentPage();
 247     inline IndexTabPage_Impl*       GetIndexPage();
 248     inline SearchTabPage_Impl*      GetSearchPage();
 249     inline BookmarksTabPage_Impl*   GetBookmarksPage();
 250
 251     DECL_LINK(ActivatePageHdl, const OString&, void);
 252     DECL_LINK(SelectHdl, weld::ComboBox&, void);
 253     DECL_LINK(InitHdl, Timer *, void);
 254     DECL_LINK(SelectFactoryHdl, Timer *, void);
 255     DECL_LINK(KeywordHdl, IndexTabPage_Impl&, void);
 256     DECL_LINK(ContentTabPageDoubleClickHdl, LinkParamNone*, void);
 257     DECL_LINK(TabPageDoubleClickHdl, LinkParamNone*, void);
 258     DECL_LINK(IndexTabPageDoubleClickHdl, LinkParamNone*, void);
 259
 260 public:
 261     explicit SfxHelpIndexWindow_Impl(SfxHelpWindow_Impl* pParent, weld::Container* pContainer);
 262     ~SfxHelpIndexWindow_Impl();
 263
 264     void                SetDoubleClickHdl(const Link<LinkParamNone*, void>& rLink);
 265     void                SetSelectFactoryHdl( const Link<SfxHelpIndexWindow_Impl*,void>& rLink ) { aSelectFactoryLink = rLink; }
 266     void                SetFactory( const OUString& rFactory, bool bActive );
 267     OUString const &    GetFactory() const { return xIPage->GetFactory(); }
 268     OUString            GetSelectedEntry() const;
 269     void                AddBookmarks( const OUString& rTitle, const OUString& rURL );
 270     bool                IsValidFactory( const OUString& _rFactory );
 271     OUString            GetActiveFactoryTitle() const { return m_xActiveLB->get_active_text(); }
 272     void                ClearSearchPage();
 273     void                GrabFocusBack();
 274     bool                HasFocusOnEdit() const;
 275     OUString            GetSearchText() const;
 276     bool                IsFullWordSearch() const;
 277     void                OpenKeyword( const OUString& rKeyword );
 278     void                SelectExecutableEntry();
 279
 280     weld::Window*       GetFrameWeld() const;
 281 };
 282
 283 // inlines ---------------------------------------------------------------
 284
 285 ContentTabPage_Impl* SfxHelpIndexWindow_Impl::GetContentPage()
 286 {
 287     if (!xCPage)
 288     {
 289         xCPage.reset(new ContentTabPage_Impl(m_xTabCtrl->get_page("contents"), this));
 290         xCPage->SetDoubleClickHdl(LINK(this, SfxHelpIndexWindow_Impl, ContentTabPageDoubleClickHdl));
 291     }
 292     return xCPage.get();
 293 }
 294
 295 IndexTabPage_Impl* SfxHelpIndexWindow_Impl::GetIndexPage()
 296 {
 297     if (!xIPage)
 298     {
 299         xIPage.reset(new IndexTabPage_Impl(m_xTabCtrl->get_page("index"), this));
 300         xIPage->SetDoubleClickHdl( LINK(this, SfxHelpIndexWindow_Impl, IndexTabPageDoubleClickHdl) );
 301         xIPage->SetKeywordHdl( aIndexKeywordLink );
 302     }
 303     return xIPage.get();
 304 }
 305
 306 SearchTabPage_Impl* SfxHelpIndexWindow_Impl::GetSearchPage()
 307 {
 308     if (!xSPage)
 309     {
 310         xSPage.reset(new SearchTabPage_Impl(m_xTabCtrl->get_page("find"), this));
 311         xSPage->SetDoubleClickHdl( LINK(this, SfxHelpIndexWindow_Impl, TabPageDoubleClickHdl) );
 312     }
 313     return xSPage.get();
 314 }
 315
 316 BookmarksTabPage_Impl* SfxHelpIndexWindow_Impl::GetBookmarksPage()
 317 {
 318     if (!xBPage)
 319     {
 320         xBPage.reset(new BookmarksTabPage_Impl(m_xTabCtrl->get_page("bookmarks"), this));
 321         xBPage->SetDoubleClickHdl( LINK(this, SfxHelpIndexWindow_Impl, TabPageDoubleClickHdl) );
 322     }
 323     return xBPage.get();
 324 }
 325
 326 // class TextWin_Impl ----------------------------------------------------
 327 class TextWin_Impl : public DockingWindow
 328 {
 329 public:
 330     explicit                TextWin_Impl( vcl::Window* pParent );
 331
 332     virtual bool            EventNotify( NotifyEvent& rNEvt ) override;
 333 };
 334
 335 // class SfxHelpTextWindow_Impl ------------------------------------------
 336
 337 class SvtMiscOptions;
 338 class SfxHelpWindow_Impl;
 339
 340 class SfxHelpTextWindow_Impl : public vcl::Window
 341 {
 342 private:
 343     std::unique_ptr<weld::Toolbar> xToolBox;
 344     std::unique_ptr<weld::CheckButton>  xOnStartupCB;
 345     std::unique_ptr<weld::Menu>  xMenu;
 346     Idle                    aSelectIdle;
 347     OUString                aIndexOnImage;
 348     OUString                aIndexOffImage;
 349     OUString                aIndexOnText;
 350     OUString                aIndexOffText;
 351     OUString                aSearchText;
 352     OUString                aOnStartupText;
 353     OUString                sCurrentFactory;
 354
 355     VclPtr<SfxHelpWindow_Impl>     xHelpWin;
 356     VclPtr<vcl::Window>            pTextWin;
 357     std::shared_ptr<sfx2::SearchDialog> m_xSrchDlg;
 358     css::uno::Reference < css::frame::XFrame2 >
 359                             xFrame;
 360     css::uno::Reference< css::i18n::XBreakIterator >
 361                             xBreakIterator;
 362     css::uno::Reference< css::uno::XInterface >
 363                             xConfiguration;
 364     bool                    bIsDebug;
 365     bool                    bIsIndexOn;
 366     bool                    bIsInClose;
 367     bool                    bIsFullWordSearch;
 368
 369     bool                    HasSelection() const;
 370     void                    InitToolBoxImages();
 371     void                    InitOnStartupBox();
 372
 373     css::uno::Reference< css::i18n::XBreakIterator > const &
 374                             GetBreakIterator();
 375     css::uno::Reference< css::text::XTextRange >
 376                             getCursor() const;
 377     bool                    isHandledKey( const vcl::KeyCode& _rKeyCode );
 378
 379     DECL_LINK(        SelectHdl, Timer *, void);
 380     DECL_LINK(        NotifyHdl, LinkParamNone*, void );
 381     DECL_LINK(        FindHdl, sfx2::SearchDialog&, void );
 382     DECL_LINK(        CloseHdl, LinkParamNone*, void );
 383     DECL_LINK(        CheckHdl, weld::Button&, void );
 384     void                    FindHdl(sfx2::SearchDialog*);
 385
 386 public:
 387     explicit SfxHelpTextWindow_Impl(SfxHelpWindow_Impl* pHelpWin, weld::Builder& rBuilder, vcl::Window* pParent);
 388     virtual ~SfxHelpTextWindow_Impl() override;
 389     virtual void dispose() override;
 390
 391     virtual void            Resize() override;
 392     virtual bool            PreNotify( NotifyEvent& rNEvt ) override;
 393     virtual void            GetFocus() override;
 394     virtual void            DataChanged( const DataChangedEvent& rDCEvt ) override;
 395
 396     const css::uno::Reference < css::frame::XFrame2 >&
 397                             getFrame() const { return xFrame; }
 398
 399     void                    SetSelectHdl(const Link<const OString&, void>& rLink) { xToolBox->connect_clicked(rLink); }
 400     void                    ToggleIndex( bool bOn );
 401     void                    SelectSearchText( const OUString& rSearchText, bool _bIsFullWordSearch );
 402     void                    SetPageStyleHeaderOff() const;
 403     weld::Toolbar&          GetToolBox() { return *xToolBox; }
 404     void                    CloseFrame();
 405     void                    DoSearch();
 406 };
 407
 408 // class SfxHelpWindow_Impl ----------------------------------------------
 409
 410 class HelpInterceptor_Impl;
 411 class HelpListener_Impl;
 412 class SfxHelpWindow_Impl : public DockingWindow
 413 {
 414 private:
 415 friend class SfxHelpIndexWindow_Impl;
 416
 417     std::unique_ptr<weld::Builder> m_xBuilder;
 418     VclPtr<vcl::Window> m_xVclContentArea;
 419     std::unique_ptr<weld::Paned> m_xContainer;
 420     std::unique_ptr<weld::Container> m_xHelpPaneWindow;
 421     std::unique_ptr<weld::Container> m_xHelpTextWindow;
 422     css::uno::Reference<css::awt::XWindow> m_xHelpTextXWindow;
 423
 424     css::uno::Reference < css::awt::XWindow >
 425                                 xWindow;
 426     css::uno::Reference < css::frame::XFrame2 >
 427                                 xFrame;
 428
 429     std::unique_ptr<SfxHelpIndexWindow_Impl> xIndexWin;
 430     VclPtr<SfxHelpTextWindow_Impl>     pTextWin;
 431     HelpInterceptor_Impl*       pHelpInterceptor;
 432     rtl::Reference<HelpListener_Impl> pHelpListener;
 433
 434     bool                bIndex;
 435     bool                bGrabFocusToToolBox;
 436     bool                bSplit;
 437     int                 nWidth;
 438     int                 nIndexSize;
 439     Point               aWinPos;
 440     Size                aWinSize;
 441     OUString            sTitle;
 442
 443     virtual void        GetFocus() override;
 444
 445     void                MakeLayout();
 446     void                LoadConfig();
 447     void                SaveConfig();
 448     void                ShowStartPage();
 449     void                Split();
 450
 451     DECL_LINK(SelectHdl, const OString&, void);
 452     DECL_LINK(OpenHdl, LinkParamNone*, void);
 453     DECL_LINK(SelectFactoryHdl, SfxHelpIndexWindow_Impl*, void);
 454     DECL_LINK(ChangeHdl, HelpListener_Impl&, void);
 455     DECL_LINK(ResizeHdl, const Size&, void);
 456
 457 public:
 458     SfxHelpWindow_Impl( const css::uno::Reference < css::frame::XFrame2 >& rFrame,
 459                         vcl::Window* pParent );
 460     virtual ~SfxHelpWindow_Impl() override;
 461     virtual void dispose() override;
 462
 463     virtual bool        PreNotify( NotifyEvent& rNEvt ) override;
 464
 465     void                setContainerWindow( const css::uno::Reference < css::awt::XWindow >& xWin );
 466     css::uno::Reference < css::frame::XFrame2 > const &
 467                         getTextFrame() const { return pTextWin->getFrame(); }
 468
 469     void                SetFactory( const OUString& rFactory );
 470     void                SetHelpURL( const OUString& rURL );
 471     void                DoAction(const OString& rAction);
 472     void                CloseWindow();
 473
 474     weld::Container*    GetContainer() { return m_xHelpTextWindow.get(); }
 475
 476     void                UpdateToolbox();
 477     void                OpenKeyword( const OUString& rKeyword ) { xIndexWin->OpenKeyword( rKeyword ); }
 478
 479     bool                HasHistoryPredecessor() const;      // forward to interceptor
 480     bool                HasHistorySuccessor() const;        // forward to interceptor
 481
 482     void                openDone(const OUString& sURL    ,
 483                                        bool         bSuccess);
 484
 485     static OUString     buildHelpURL(const OUString& sFactory        ,
 486                                      const OUString& sContent        ,
 487                                      const OUString& sAnchor);
 488
 489     void                loadHelpContent(const OUString& sHelpURL                ,
 490                                               bool         bAddToHistory = true);
 491 };
 492
 493 class SfxAddHelpBookmarkDialog_Impl : public weld::GenericDialogController
 494 {
 495 private:
 496     std::unique_ptr<weld::Entry> m_xTitleED;
 497     std::unique_ptr<weld::Label> m_xAltTitle;
 498 public:
 499     SfxAddHelpBookmarkDialog_Impl(weld::Widget* pParent, bool bRename);
 500
 501     void SetTitle( const OUString& rTitle );
 502     OUString GetTitle() const { return m_xTitleED->get_text(); }
 503 };
 504
 505 /// Appends ?Language=xy&System=abc to the help URL in rURL
 506 void AppendConfigToken(OUStringBuffer& rURL, bool bQuestionMark);
 507
 508 #endif // INCLUDED_SFX2_SOURCE_APPL_NEWHELP_HXX
 509
 510 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */