summaryrefslogtreecommitdiff
path: root/sfx2/inc
diff options
context:
space:
mode:
authorMathias Bauer <mba@openoffice.org>2000-11-27 07:56:56 +0000
committerMathias Bauer <mba@openoffice.org>2000-11-27 07:56:56 +0000
commite04c93ba1ae876f078c2c5ed67fda40b00a330c1 (patch)
tree67a3fde662d5807e6f9c3c594ef0c4010671ca9b /sfx2/inc
parent1db915c33cce33eb141ce074b38405df330caf78 (diff)
#80231#: new help browser
Diffstat (limited to 'sfx2/inc')
-rw-r--r--sfx2/inc/sfxhelp.hxx243
1 files changed, 8 insertions, 235 deletions
diff --git a/sfx2/inc/sfxhelp.hxx b/sfx2/inc/sfxhelp.hxx
index 7cee3c69e6a3..2a61bd327dbb 100644
--- a/sfx2/inc/sfxhelp.hxx
+++ b/sfx2/inc/sfxhelp.hxx
@@ -2,9 +2,9 @@
*
* $RCSfile: sfxhelp.hxx,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: as $ $Date: 2000-11-08 14:25:40 $
+ * last change: $Author: mba $ $Date: 2000-11-27 08:56:56 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -61,253 +61,26 @@
#ifndef _SFX_HELP_HXX
#define _SFX_HELP_HXX
-#ifndef _BUTTON_HXX //autogen
-#include <vcl/button.hxx>
-#endif
#ifndef _HELP_HXX //autogen
#include <vcl/help.hxx>
#endif
-#ifndef _SV_CONFIG_HXX
-#include <vcl/config.hxx>
-#endif
-#include <childwin.hxx>
-#include <dockwin.hxx>
-
-#include <docfac.hxx>
-#include <viewfac.hxx>
-#include <objsh.hxx>
-#include <viewsh.hxx>
-
-class HelpPI;
-class SHelpInfo;
-struct SpecialLinkInfo;
-class Library;
-class SfxPrinter;
-class DirEntry;
-class SvStringsDtor;
-
-struct HelpFileInfo
-{
- String aFileName;
- String aTitle;
-};
-
-
-class SfxHelpPIWrapper : public SfxChildWindow
-{
-public:
- SfxHelpPIWrapper(Window *pParent, USHORT nId,
- SfxBindings *pBindings, SfxChildWinInfo *pInfo);
-
- SFX_DECL_CHILDWINDOW(SfxHelpPIWrapper);
-
- virtual BOOL QueryClose();
-};
-
-class SfxHelpTipsWrapper : public SfxChildWindow
-{
-public:
- SfxHelpTipsWrapper(Window *pParent, USHORT nId,
- SfxBindings *pBindings, SfxChildWinInfo *pInfo);
-
- SFX_DECL_CHILDWINDOW(SfxHelpTipsWrapper);
-};
-
-
-
-class SfxHelpTipsWindow : public SfxDockingWindow
-{
-private:
- HelpPI* mpHelpPI;
- PushButton maCloseButton;
- Window maTipWindow;
- CheckBox maCheckBox;
-
-protected:
- DECL_LINK( CloseButtonHdl, Button* );
- DECL_LINK( ShowTip, void* );
- DECL_LINK( CheckBoxHdl, CheckBox* );
-
-public:
- SfxHelpTipsWindow( SfxBindings* pBindimgs, SfxChildWindow* pChildWin, Window* pParent );
- ~SfxHelpTipsWindow();
-
- virtual void FillInfo( SfxChildWinInfo& ) const;
- virtual void Resize();
-};
-
-
-
-class SfxHelpPI : public SfxDockingWindow
-{
- HelpPI* pHelpPI;
- Window* pInnerWindow;
-
- Timer aTopicJustRequestedTimer;
-
- ULONG nTip;
- CheckBox aTipBox;
-
- BOOL bInShowMe;
-
-protected:
- virtual void Resize();
- virtual void Paint( const Rectangle& );
-
-public:
- SfxHelpPI( SfxBindings* pBindimgs, SfxChildWindow* pChildWin,
- Window* pParent, USHORT nScale );
- ~SfxHelpPI();
-
- void LoadTopic( const String& rFileName, ULONG nId );
- void LoadTopic( ULONG nId );
- void LoadTopic( const String& rKeyword );
- void ResetTopic();
-
- BOOL Close();
-
- BOOL IsConstructed() const { return ( pHelpPI != 0 ); }
- String GetExtraInfo() const;
-
- HelpPI* GetHelpPI() const { return pHelpPI; }
-
- virtual void FillInfo( SfxChildWinInfo& ) const;
-
- void SetTip( ULONG nId );
- ULONG GetTip() const { return nTip; }
- void SetTipText( const String& rText );
-
- BOOL IsInShowMe() const { return bInShowMe; }
-
- // Nach F1 fuer einige ms nicht aufgrund von FocusChanged ein anderes Topic laden...
- BOOL IsTopicJustRequested() const { return aTopicJustRequestedTimer.IsActive(); }
- void SetTopicJustRequested( BOOL bOn ) { if( bOn )
- aTopicJustRequestedTimer.Start();
- else
- aTopicJustRequestedTimer.Stop(); }
-
-#if __PRIVATE
- DECL_LINK( TopicChangedHdl_Impl, void* );
- DECL_LINK( SpecialLinkHdl, SpecialLinkInfo* );
- DECL_LINK( TipBoxHdl, CheckBox* );
- DECL_LINK( PIToolboxHdl, ToolBox* );
-#endif
-};
-
-
-
-class SfxHelp
-{
-public:
- static BOOL ShowHelp( ULONG nId, BOOL bShowInHelpAgent, const char* pFileName = 0, BOOL bQuiet = FALSE );
- static BOOL ShowHelp( const String& rKeyword, BOOL bShowInHelpAgent, const char* pFileName = 0 );
- static void ShowHint( ULONG nId );
- static void SetCustomHelpFile( const String& rName );
- static USHORT GetHelpFileInfoCount();
- static HelpFileInfo* GetHelpFileInfo( USHORT n );
-};
-
-USHORT ImplSetLanguageGroup( Config& rConfig, const String& rGroupName, BOOL bSearchLanguage );
-
+#include <tools/string.hxx>
#if __PRIVATE
-
-SV_DECL_VARARR_SORT( SortedULONGs, ULONG, 0, 4 );
-//SV_DECL_PTRARR_DEL( HelpTextCaches, HelpTextCache*, 0, 4 );
-
-
-class SfxHelp_Impl : public Help, public SfxListener
+class SfxHelp_Impl : public Help
{
- friend class SfxHelp;
-
- String aCustomHelpFile;
- String aCurHelpFile; // Kurzer Name ohne Pfad
-
- SHelpInfo* pHelpInfo; // Fr GetHelpText()
-
-// HelpTextCache* pHelpCache;
-// HelpTextCaches aHelpCaches;
-
- Timer aDialogDetector;
-
- SortedULONGs* pPIStarterList;
-
- ULONG nLastDialog;
- BOOL bForcedFloatingPI;
-
- List* pHelpFileInfos;
+ String aTicket; // for Plugins
private:
- BOOL ImplStart( ULONG nHelpId, BOOL bCheckHelpFile, BOOL bChangeHelpFile, BOOL bHelpAgent );
virtual BOOL Start( ULONG nHelpId );
-#ifndef ENABLEUNICODE
- virtual BOOL Start( const String& rKeyWord );
-#else
- virtual BOOL Start( const UniString& rKeyWord );
-#endif
- void SetCurrentHelpFile( ULONG nId );
- String GetCurrentHelpFile() const { return aCurHelpFile; }
-
- virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
-
-
- inline SortedULONGs* GetPIStarterList();
- void CreatePIStarterList();
-
-
- DECL_LINK( DialogDetectHdl, Timer* );
-
-protected:
- void AssertValidHelpDocInfo();
-
+ String GetHelpModuleName( ULONG nHelpId );
public:
-
SfxHelp_Impl();
~SfxHelp_Impl();
-
- static String GetHelpPath();
- static String GetHelpFileName( ULONG nId );
- BOOL CheckHelpFile( BOOL bPrompt ) const;
- static BOOL CheckHelpFile( const String& rFilename, BOOL bPrompt );
-
- static Window* SearchFocusWindowParent();
- void CheckPIPosition();
-
- void SetHelpFile( const String &rHelpFileName, BOOL bAdjustExt = TRUE );
- const String& GetCurHelpFile() const { return aCurHelpFile; }
-
- XubString GetHelpText( ULONG nHelpId );
-
- void GetHelpURLs( const String& rRootURL, SvStringsDtor& rLst );
- void GetBookmarks( SvStringsDtor& rLst );
- void AddBookmark( const String& rName, const String& rURL );
- void RemoveBookmark( const String& rName );
- void RenameBookmark( const String& rOldTitle, const String& rNewTitle );
-
- void SlotExecutedOrFocusChanged( ULONG nId, BOOL bSlot, BOOL bAutoStart );
- void EnableTip( ULONG nTip, BOOL bEnable );
-
- void ResetPIStarterList();
-
- void HelpAgentClosed();
-
- void StartHelpPI( ULONG nHelpId, BOOL bSlot, BOOL bTip = FALSE );
-
- USHORT GetHelpFileInfoCount();
- HelpFileInfo* GetHelpFileInfo( USHORT n );
-
- static String GetConfigDir( BOOL bGetSharedConfig );
- static String GetHelpAgentConfig();
+ void SetTicket( const String& rTicket )
+ { aTicket = rTicket;}
};
-
-inline SortedULONGs* SfxHelp_Impl::GetPIStarterList()
-{
- if ( !pPIStarterList )
- CreatePIStarterList();
- return pPIStarterList;
-}
-
#endif // _PRIVATE
#endif // #ifndef _SFX_HELP_HXX