xref: /aoo4110/main/sfx2/source/appl/newhelp.hxx (revision b1cdbd2c)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef INCLUDED_SFX_NEWHELP_HXX
#define INCLUDED_SFX_NEWHELP_HXX

#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/frame/XDispatchResultListener.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/XFrame.hpp>

namespace com { namespace sun { namespace star { namespace awt { class XWindow; } } } }
namespace com { namespace sun { namespace star { namespace frame { class XFrame; } } } }
namespace com { namespace sun { namespace star { namespace i18n { class XBreakIterator; } } } }
namespace com { namespace sun { namespace star { namespace text { class XTextRange; } } } }

#include <vcl/window.hxx>
#include <vcl/toolbox.hxx>
#include <vcl/tabpage.hxx>
#include <vcl/splitwin.hxx>
#include <vcl/tabctrl.hxx>
#include <vcl/combobox.hxx>
#include <vcl/fixed.hxx>
#include <vcl/button.hxx>
#include <vcl/lstbox.hxx>
#include <vcl/dialog.hxx>
#include <svtools/svtreebx.hxx>
#include <unotools/moduleoptions.hxx>

#include "srchdlg.hxx"

// class OpenStatusListener_Impl -----------------------------------------

class OpenStatusListener_Impl : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XDispatchResultListener >
{
private:
    sal_Bool	m_bFinished;
    sal_Bool	m_bSuccess;
	Link		m_aOpenLink;
	String		m_sURL;

public:
	OpenStatusListener_Impl() : m_bFinished( sal_False ), m_bSuccess( sal_False ) {}

    virtual void SAL_CALL   dispatchFinished( const ::com::sun::star::frame::DispatchResultEvent& Event ) throw(::com::sun::star::uno::RuntimeException);
    virtual void SAL_CALL	disposing( const ::com::sun::star::lang::EventObject& Source ) throw(::com::sun::star::uno::RuntimeException);

	inline sal_Bool			IsFinished() const { return m_bFinished; }
	inline sal_Bool			IsSuccessful() const { return m_bSuccess; }
	inline void				SetURL( const String& rURL ) { m_sURL = rURL; }
	inline String			GetURL() const  { return m_sURL; }
	inline void				SetOpenHdl( const Link& rLink ) { m_aOpenLink = rLink; }
};

// ContentListBox_Impl ---------------------------------------------------

class ContentListBox_Impl : public SvTreeListBox
{
private:
	Image 			aOpenBookImage;
	Image 			aClosedBookImage;
	Image 			aDocumentImage;

	void			InitRoot();
	void			ClearChildren( SvLBoxEntry* pParent );

public:
	ContentListBox_Impl( Window* pParent, const ResId& rResId );
	~ContentListBox_Impl();


	virtual void	RequestingChilds( SvLBoxEntry* pParent );
	virtual long    Notify( NotifyEvent& rNEvt );

	inline void		SetOpenHdl( const Link& rLink ) { SetDoubleClickHdl( rLink ); }
	String			GetSelectEntry() const;
};

// class HelpTabPage_Impl ------------------------------------------------

class SfxHelpIndexWindow_Impl;

class HelpTabPage_Impl : public TabPage
{
protected:
	SfxHelpIndexWindow_Impl*	m_pIdxWin;

public:
	HelpTabPage_Impl( Window* pParent, SfxHelpIndexWindow_Impl* _pIdxWin, const ResId& rResId );

	virtual Control*	GetLastFocusControl() = 0;
};

// class ContentTabPage_Impl ---------------------------------------------

class ContentTabPage_Impl : public HelpTabPage_Impl
{
private:
	ContentListBox_Impl	aContentBox;

public:
	ContentTabPage_Impl( Window* pParent, SfxHelpIndexWindow_Impl* _pIdxWin );

	virtual void		Resize();
	virtual void		ActivatePage();
	virtual Control*	GetLastFocusControl();

	inline void		SetOpenHdl( const Link& rLink ) { aContentBox.SetOpenHdl( rLink ); }
	inline String	GetSelectEntry() const { return aContentBox.GetSelectEntry(); }
	inline void		SetFocusOnBox() { aContentBox.GrabFocus(); }
};

// class IndexTabPage_Impl -----------------------------------------------

class IndexBox_Impl : public ComboBox
{
public:
	IndexBox_Impl( Window* pParent, const ResId& rResId );

	virtual void		UserDraw( const UserDrawEvent& rUDEvt );
	virtual long		Notify( NotifyEvent& rNEvt );

	void				SelectExecutableEntry();
};

class IndexTabPage_Impl : public HelpTabPage_Impl
{
private:
	FixedText			aExpressionFT;
	IndexBox_Impl		aIndexCB;
	PushButton			aOpenBtn;

	Timer				aFactoryTimer;
	Timer				aKeywordTimer;
	Link				aKeywordLink;

    String              sFactory;
	String				sKeyword;

	long				nMinWidth;
	sal_Bool			bIsActivated;

	void 				InitializeIndex();
	void				ClearIndex();

	DECL_LINK(			OpenHdl, PushButton* );
	DECL_LINK(			TimeoutHdl, Timer* );

public:
	IndexTabPage_Impl( Window* pParent, SfxHelpIndexWindow_Impl* _pIdxWin );
	~IndexTabPage_Impl();

	virtual void		Resize();
	virtual void		ActivatePage();
	virtual Control*	GetLastFocusControl();

	void				SetDoubleClickHdl( const Link& rLink );
	void				SetFactory( const String& rFactory );
	inline String		GetFactory() const { return sFactory; }
	String				GetSelectEntry() const;
	inline void			SetFocusOnBox() { aIndexCB.GrabFocus(); }
	inline sal_Bool		HasFocusOnEdit() const { return aIndexCB.HasChildPathFocus(); }

	inline void			SetKeywordHdl( const Link& rLink ) { aKeywordLink = rLink; }
	void				SetKeyword( const String& rKeyword );
	sal_Bool			HasKeyword() const;
	sal_Bool			HasKeywordIgnoreCase(); //added by BerryJia for fixing Bug98251, 2002-12-11
	void				OpenKeyword();

	inline void			SelectExecutableEntry() { aIndexCB.SelectExecutableEntry(); }
};

// class SearchTabPage_Impl ----------------------------------------------

class SearchBox_Impl : public ComboBox
{
private:
	Link				aSearchLink;

public:
	SearchBox_Impl( Window* pParent, const ResId& rResId ) :
		ComboBox( pParent, rResId ) { SetDropDownLineCount( 5 ); }

	virtual long		PreNotify( NotifyEvent& rNEvt );
	virtual void		Select();

	inline void			SetSearchLink( const Link& rLink ) { aSearchLink = rLink; }
};

class SearchResultsBox_Impl : public ListBox
{
public:
	SearchResultsBox_Impl( Window* pParent, const ResId& rResId ) : ListBox( pParent, rResId ) {}

	virtual long    Notify( NotifyEvent& rNEvt );
};

class SearchTabPage_Impl : public HelpTabPage_Impl
{
private:
	FixedText				aSearchFT;
	SearchBox_Impl			aSearchED;
	PushButton				aSearchBtn;
	CheckBox				aFullWordsCB;
	CheckBox				aScopeCB;
	SearchResultsBox_Impl	aResultsLB;
	PushButton				aOpenBtn;

	Size					aMinSize;
	String					aFactory;

	::com::sun::star::uno::Reference< ::com::sun::star::i18n::XBreakIterator >
							xBreakIterator;

	void				ClearSearchResults();
	void				RememberSearchText( const String& rSearchText );

	DECL_LINK(			SearchHdl, PushButton* );
	DECL_LINK(			OpenHdl, PushButton* );
	DECL_LINK(			ModifyHdl, Edit* );

public:
	SearchTabPage_Impl( Window* pParent, SfxHelpIndexWindow_Impl* _pIdxWin );
	~SearchTabPage_Impl();

	virtual void		Resize();
	virtual void		ActivatePage();
	virtual Control*	GetLastFocusControl();

	void				SetDoubleClickHdl( const Link& rLink );
	inline void			SetFactory( const String& rFactory ) { aFactory = rFactory; }
	String				GetSelectEntry() const;
	void				ClearPage();
	inline void			SetFocusOnBox() { aResultsLB.GrabFocus(); }
	inline sal_Bool		HasFocusOnEdit() const { return aSearchED.HasChildPathFocus(); }
	inline String		GetSearchText() const { return aSearchED.GetText(); }
	inline sal_Bool		IsFullWordSearch() const { return aFullWordsCB.IsChecked(); }
	sal_Bool			OpenKeyword( const String& rKeyword );
};

// class BookmarksTabPage_Impl -------------------------------------------

class BookmarksBox_Impl : public ListBox
{
private:
	void				DoAction( sal_uInt16 nAction );

public:
	BookmarksBox_Impl( Window* pParent, const ResId& rResId );
	~BookmarksBox_Impl();

	virtual long		Notify( NotifyEvent& rNEvt );
};

class BookmarksTabPage_Impl : public HelpTabPage_Impl
{
private:
	FixedText			aBookmarksFT;
	BookmarksBox_Impl	aBookmarksBox;
	PushButton			aBookmarksPB;

	long				nMinWidth;

	DECL_LINK(			OpenHdl, PushButton* );

public:
	BookmarksTabPage_Impl( Window* pParent, SfxHelpIndexWindow_Impl* _pIdxWin );

	virtual void		Resize();
	virtual void		ActivatePage();
	virtual Control*	GetLastFocusControl();

	void				SetDoubleClickHdl( const Link& rLink );
	String				GetSelectEntry() const;
	void				AddBookmarks( const String& rTitle, const String& rURL );
	inline void			SetFocusOnBox() { aBookmarksBox.GrabFocus(); }
};

// class SfxHelpIndexWindow_Impl -----------------------------------------

class SfxHelpWindow_Impl;

class SfxHelpIndexWindow_Impl : public Window
{
private:
	ListBox				aActiveLB;
	FixedLine			aActiveLine;

	TabControl			aTabCtrl;
	Timer				aTimer;

	Link				aSelectFactoryLink;
	Link				aPageDoubleClickLink;
	Link				aIndexKeywordLink;
	String				sKeyword;

	SfxHelpWindow_Impl*		pParentWin;

    ContentTabPage_Impl*    pCPage;
	IndexTabPage_Impl*		pIPage;
	SearchTabPage_Impl*		pSPage;
	BookmarksTabPage_Impl*	pBPage;

	long				nMinWidth;
	bool				bWasCursorLeftOrRight;
    bool                bIsInitDone;

	void				Initialize();
    void                SetActiveFactory();
	HelpTabPage_Impl*	GetCurrentPage( sal_uInt16& rCurId );

	inline ContentTabPage_Impl*		GetContentPage();
	inline IndexTabPage_Impl*		GetIndexPage();
	inline SearchTabPage_Impl*		GetSearchPage();
	inline BookmarksTabPage_Impl*	GetBookmarksPage();

	DECL_LINK(			ActivatePageHdl, TabControl* );
	DECL_LINK(			SelectHdl, ListBox* );
	DECL_LINK(			InitHdl, Timer* );
	DECL_LINK(			SelectFactoryHdl, Timer* );
	DECL_LINK(			KeywordHdl, IndexTabPage_Impl* );

public:
	SfxHelpIndexWindow_Impl( SfxHelpWindow_Impl* pParent );
	~SfxHelpIndexWindow_Impl();

	virtual void		Resize();
	virtual long		PreNotify( NotifyEvent& rNEvt );
	virtual void        DataChanged( const DataChangedEvent& rDCEvt );

	void				SetDoubleClickHdl( const Link& rLink );
	inline void			SetSelectFactoryHdl( const Link& rLink ) { aSelectFactoryLink = rLink; }
	void				SetFactory( const String& rFactory, sal_Bool bActive );
	inline String		GetFactory() const { return pIPage->GetFactory(); }
	String				GetSelectEntry() const;
	void				AddBookmarks( const String& rTitle, const String& rURL );
    bool                IsValidFactory( const String& _rFactory );
	inline String		GetActiveFactoryTitle() const { return aActiveLB.GetSelectEntry(); }
	inline void			UpdateTabControl() { aTabCtrl.Invalidate(); }
	void				ClearSearchPage();
	void				GrabFocusBack();
	sal_Bool			HasFocusOnEdit() const;
	String				GetSearchText() const;
	sal_Bool			IsFullWordSearch() const;
	void				OpenKeyword( const String& rKeyword );
	void				SelectExecutableEntry();
	inline bool			WasCursorLeftOrRight();
};

// inlines ---------------------------------------------------------------

ContentTabPage_Impl* SfxHelpIndexWindow_Impl::GetContentPage()
{
	if ( !pCPage )
	{
		pCPage = new ContentTabPage_Impl( &aTabCtrl, this );
		pCPage->SetOpenHdl( aPageDoubleClickLink );
	}
	return pCPage;
}
IndexTabPage_Impl* SfxHelpIndexWindow_Impl::GetIndexPage()
{
	if ( !pIPage )
	{
		pIPage = new IndexTabPage_Impl( &aTabCtrl, this );
		pIPage->SetDoubleClickHdl( aPageDoubleClickLink );
		pIPage->SetKeywordHdl( aIndexKeywordLink );
	}
	return pIPage;
}

SearchTabPage_Impl* SfxHelpIndexWindow_Impl::GetSearchPage()
{
	if ( !pSPage )
	{
		pSPage = new SearchTabPage_Impl( &aTabCtrl, this );
		pSPage->SetDoubleClickHdl( aPageDoubleClickLink );
	}
	return pSPage;
}

BookmarksTabPage_Impl* SfxHelpIndexWindow_Impl::GetBookmarksPage()
{
	if ( !pBPage )
	{
		pBPage = new BookmarksTabPage_Impl( &aTabCtrl, this );
		pBPage->SetDoubleClickHdl( aPageDoubleClickLink );
	}
	return pBPage;
}

bool SfxHelpIndexWindow_Impl::WasCursorLeftOrRight()
{
	bool bRet = bWasCursorLeftOrRight;
	bWasCursorLeftOrRight = false;
	return bRet;
}

// class TextWin_Impl ----------------------------------------------------

class TextWin_Impl : public DockingWindow
{
public:
							TextWin_Impl( Window* pParent );
	virtual					~TextWin_Impl();

	virtual long			Notify( NotifyEvent& rNEvt );
};

// class SfxHelpTextWindow_Impl ------------------------------------------

class SvtMiscOptions;
class SfxHelpWindow_Impl;

class SfxHelpTextWindow_Impl : public Window
{
private:
	ToolBox					aToolBox;
	CheckBox				aOnStartupCB;
	Timer					aSelectTimer;
	Image					aIndexOnImage;
	Image					aIndexOffImage;
	String					aIndexOnText;
	String					aIndexOffText;
	String					aSearchText;
	String					aOnStartupText;
    ::rtl::OUString         sCurrentFactory;

	SfxHelpWindow_Impl*		pHelpWin;
	Window*					pTextWin;
	sfx2::SearchDialog*		pSrchDlg;
    ::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >
							xFrame;
    ::com::sun::star::uno::Reference< ::com::sun::star::i18n::XBreakIterator >
                            xBreakIterator;
    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
                            xConfiguration;
	long					nMinPos;
	sal_Bool				bIsDebug;
	sal_Bool				bIsIndexOn;
	sal_Bool				bIsInClose;
	sal_Bool				bIsFullWordSearch;

	sal_Bool				HasSelection() const;
	void					InitToolBoxImages();
	void					InitOnStartupBox( bool bOnlyText );
	void					SetOnStartupBoxPosition();

	::com::sun::star::uno::Reference< ::com::sun::star::i18n::XBreakIterator >
							GetBreakIterator();
	::com::sun::star::uno::Reference< ::com::sun::star::text::XTextRange >
							getCursor() const;
	bool 					isHandledKey( const KeyCode& _rKeyCode );

	DECL_LINK(				SelectHdl, Timer* );
	DECL_LINK(				NotifyHdl, SvtMiscOptions* );
	DECL_LINK(				FindHdl, sfx2::SearchDialog* );
	DECL_LINK(				CloseHdl, sfx2::SearchDialog* );
	DECL_LINK(				CheckHdl, CheckBox* );

public:
	SfxHelpTextWindow_Impl( SfxHelpWindow_Impl* pParent );
	~SfxHelpTextWindow_Impl();

	virtual void			Resize();
	virtual long			PreNotify( NotifyEvent& rNEvt );
	virtual void			GetFocus();
	virtual void        	DataChanged( const DataChangedEvent& rDCEvt );

	inline ::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >
							getFrame() const { return xFrame; }

	inline void				SetSelectHdl( const Link& rLink ) { aToolBox.SetSelectHdl( rLink ); }
	void					ToggleIndex( sal_Bool bOn );
	void					SelectSearchText( const String& rSearchText, sal_Bool _bIsFullWordSearch );
	void					SetPageStyleHeaderOff() const;
	inline ToolBox&			GetToolBox() { return aToolBox; }
 	void					CloseFrame();
	void					DoSearch();
};

// class SfxHelpWindow_Impl ----------------------------------------------

class HelpInterceptor_Impl;
class HelpListener_Impl;
class SfxHelpWindow_Impl : public SplitWindow
{
private:
friend class SfxHelpIndexWindow_Impl;

    ::com::sun::star::uno::Reference < ::com::sun::star::awt::XWindow >
								xWindow;
	::com::sun::star::uno::Reference < ::com::sun::star::frame::XDispatchResultListener >
								xOpenListener;
    ::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >
								xFrame;

	SfxHelpIndexWindow_Impl*	pIndexWin;
	SfxHelpTextWindow_Impl*		pTextWin;
	HelpInterceptor_Impl*		pHelpInterceptor;
	HelpListener_Impl*			pHelpListener;

	sal_Int32			nExpandWidth;
	sal_Int32			nCollapseWidth;
	sal_Int32			nHeight;
	long				nIndexSize;
	long				nTextSize;
	sal_Bool			bIndex;
	sal_Bool			bGrabFocusToToolBox;
	Point				aWinPos;
	String				sTitle;
	String				sKeyword;

	virtual void		Resize();
	virtual void		Split();
	virtual void		GetFocus();

	void				MakeLayout();
	void				InitSizes();
	void				LoadConfig();
	void				SaveConfig();
	void				ShowStartPage();

	DECL_LINK(			SelectHdl, ToolBox* );
	DECL_LINK(			OpenHdl, SfxHelpIndexWindow_Impl* );
	DECL_LINK(			SelectFactoryHdl, SfxHelpIndexWindow_Impl* );
	DECL_LINK( 			ChangeHdl, HelpListener_Impl* );

public:
    SfxHelpWindow_Impl( const ::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >& rFrame,
						Window* pParent, WinBits nBits );
	~SfxHelpWindow_Impl();

	virtual long		PreNotify( NotifyEvent& rNEvt );

	void				setContainerWindow(
							::com::sun::star::uno::Reference < ::com::sun::star::awt::XWindow > xWin );
	inline ::com::sun::star::uno::Reference < ::com::sun::star::frame::XFrame >
						getTextFrame() const { return pTextWin->getFrame(); }
	inline ::com::sun::star::uno::Reference < ::com::sun::star::frame::XDispatchResultListener >
						getOpenListener() const { return xOpenListener; }

	void				SetFactory( const String& rFactory );
	void				SetHelpURL( const String& rURL );
	void				DoAction( sal_uInt16 nActionId );
	void				CloseWindow();

	void				UpdateToolbox();
	inline void			OpenKeyword( const String& rKeyword ) { pIndexWin->OpenKeyword( rKeyword ); }
	inline String		GetFactory() const { return pIndexWin->GetFactory(); }

	sal_Bool			HasHistoryPredecessor() const;		// forward to interceptor
	sal_Bool			HasHistorySuccessor() const;		// forward to interceptor

    void                openDone(const ::rtl::OUString& sURL    ,
                                       sal_Bool         bSuccess);

    static sal_Bool     splitHelpURL(const ::rtl::OUString& sHelpURL,
                                           ::rtl::OUString& sFactory,
                                           ::rtl::OUString& sContent,
                                           ::rtl::OUString& sAnchor );

    static ::rtl::OUString  buildHelpURL(const ::rtl::OUString& sFactory        ,
                                         const ::rtl::OUString& sContent        ,
                                         const ::rtl::OUString& sAnchor         ,
                                               sal_Bool         bUseQuestionMark);

    void                loadHelpContent(const ::rtl::OUString& sHelpURL                ,
                                              sal_Bool         bAddToHistory = sal_True);
};

class SfxAddHelpBookmarkDialog_Impl : public ModalDialog
{
private:
	FixedText		aTitleFT;
	Edit			aTitleED;
	OKButton		aOKBtn;
	CancelButton	aEscBtn;
	HelpButton		aHelpBtn;

public:
	SfxAddHelpBookmarkDialog_Impl( Window* pParent, sal_Bool bRename = sal_True );
	~SfxAddHelpBookmarkDialog_Impl();

	void			SetTitle( const String& rTitle );
	inline String	GetTitle() const { return aTitleED.GetText(); }
};

#endif // #ifndef INCLUDED_SFX_NEWHELP_HXX