1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SV_HELP_HXX
#define _SV_HELP_HXX
#include <tools/string.hxx>
#include <vcl/sv.h>
#include <vcl/dllapi.h>
class Point;
class Rectangle;
class Window;
// --------------
// - Help-Types -
// --------------
#define QUICKHELP_LEFT ((USHORT)0x0001)
#define QUICKHELP_CENTER ((USHORT)0x0002)
#define QUICKHELP_RIGHT ((USHORT)0x0004)
#define QUICKHELP_TOP ((USHORT)0x0008)
#define QUICKHELP_VCENTER ((USHORT)0x0010)
#define QUICKHELP_BOTTOM ((USHORT)0x0020)
#define QUICKHELP_NOAUTOPOS (QUICKHELP_LEFT | QUICKHELP_CENTER | QUICKHELP_RIGHT | QUICKHELP_TOP | QUICKHELP_VCENTER | QUICKHELP_BOTTOM)
#define QUICKHELP_CTRLTEXT ((USHORT)0x0040)
#define QUICKHELP_NOEVADEPOINTER ((USHORT)0x4000)
#define QUICKHELP_BIDI_RTL ((USHORT)0x8000)
// By changes you must also change: rsc/vclrsc.hxx
#define OOO_HELP_INDEX ((ULONG)0xFFFFFFFF)
#define OOO_HELP_HELPONHELP ((ULONG)0xFFFFFFFE)
// --------
// - Help -
// --------
class VCL_DLLPUBLIC Help
{
private:
String maHelpFile;
public:
Help();
virtual ~Help();
void SetHelpFile( const String& rFileName ) { maHelpFile = rFileName; }
const String& GetHelpFile() const { return maHelpFile; }
virtual BOOL Start( ULONG nHelpId, const Window* pWindow );
virtual BOOL Start( const XubString& rKeyWord, const Window* pWindow );
virtual void OpenHelpAgent( ULONG nHelpId );
virtual XubString GetHelpText( ULONG nHelpId, const Window* pWindow );
virtual XubString GetHelpText( const String& aHelpURL, const Window* pWindow );
static void EnableContextHelp();
static void DisableContextHelp();
static BOOL IsContextHelpEnabled();
static BOOL StartContextHelp();
static void EnableExtHelp();
static void DisableExtHelp();
static BOOL IsExtHelpEnabled();
static BOOL StartExtHelp();
static BOOL EndExtHelp();
static BOOL IsExtHelpActive();
static void EnableBalloonHelp();
static void DisableBalloonHelp();
static BOOL IsBalloonHelpEnabled();
static BOOL ShowBalloon( Window* pParent,
const Point& rScreenPos,
const XubString& rHelpText );
static BOOL ShowBalloon( Window* pParent,
const Point& rScreenPos,
const Rectangle&,
const XubString& rHelpText );
static void EnableQuickHelp();
static void DisableQuickHelp();
static BOOL IsQuickHelpEnabled();
static BOOL ShowQuickHelp( Window* pParent,
const Rectangle& rScreenRect,
const XubString& rHelpText,
const XubString& rLongHelpText,
USHORT nStyle = 0 );
static BOOL ShowQuickHelp( Window* pParent,
const Rectangle& rScreenRect,
const XubString& rHelpText,
USHORT nStyle = 0 )
{ return Help::ShowQuickHelp( pParent, rScreenRect, rHelpText, XubString(), nStyle ); }
static ULONG ShowTip( Window* pParent,
const Rectangle& rScreenRect,
const XubString& rText, USHORT nStyle = 0 );
static void HideTip( ULONG nId );
};
#endif // _SV_HELP_HXX
|
