include/vcl/help.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
  20 #ifndef _SV_HELP_HXX
  21 #define _SV_HELP_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <tools/solar.h>
  25 #include <vcl/dllapi.h>
  26
  27 class Point;
  28 class Rectangle;
  29 class Window;
  30
  31 // --------------
  32 // - Help-Types -
  33 // --------------
  34
  35 #define QUICKHELP_LEFT              ((sal_uInt16)0x0001)
  36 #define QUICKHELP_CENTER            ((sal_uInt16)0x0002)
  37 #define QUICKHELP_RIGHT             ((sal_uInt16)0x0004)
  38 #define QUICKHELP_TOP               ((sal_uInt16)0x0008)
  39 #define QUICKHELP_VCENTER           ((sal_uInt16)0x0010)
  40 #define QUICKHELP_BOTTOM            ((sal_uInt16)0x0020)
  41 #define QUICKHELP_NOAUTOPOS         (QUICKHELP_LEFT | QUICKHELP_CENTER | QUICKHELP_RIGHT | QUICKHELP_TOP | QUICKHELP_VCENTER | QUICKHELP_BOTTOM)
  42 #define QUICKHELP_CTRLTEXT          ((sal_uInt16)0x0040)
  43 /// force the existent tip window to be re-positioned, even if the previous incarnation has the same text. Applies to ShowBallon and ShowQuickHelp.
  44 #define QUICKHELP_FORCE_REPOSITION  ((sal_uInt16)0x0080)
  45 /// no delay when opening the quick help. Applies to ShowBallon and ShowQuickHelp
  46 #define QUICKHELP_NO_DELAY          ((sal_uInt16)0x0100)
  47 /// force balloon-style in ShowTip
  48 #define QUICKHELP_TIP_STYLE_BALLOON ((sal_uInt16)0x0200)
  49 #define QUICKHELP_NOEVADEPOINTER    ((sal_uInt16)0x4000)
  50 #define QUICKHELP_BIDI_RTL          ((sal_uInt16)0x8000)
  51
  52 // By changes you must also change: rsc/vclrsc.hxx
  53 #define OOO_HELP_INDEX          ".help:index"
  54 #define OOO_HELP_HELPONHELP     ".help:helponhelp"
  55
  56 // --------
  57 // - Help -
  58 // --------
  59
  60 class VCL_DLLPUBLIC Help
  61 {
  62 public:
  63                         Help();
  64     virtual             ~Help();
  65
  66     virtual sal_Bool    Start( const OUString& rHelpId, const Window* pWindow );
  67     virtual sal_Bool    SearchKeyword( const OUString& rKeyWord );
  68     virtual OUString    GetHelpText( const OUString& aHelpURL, const Window* pWindow );
  69
  70     static void         EnableContextHelp();
  71     static void         DisableContextHelp();
  72     static sal_Bool     IsContextHelpEnabled();
  73
  74     static void         EnableExtHelp();
  75     static void         DisableExtHelp();
  76     static sal_Bool     IsExtHelpEnabled();
  77     static sal_Bool     StartExtHelp();
  78     static sal_Bool     EndExtHelp();
  79
  80     static void         EnableBalloonHelp();
  81     static void         DisableBalloonHelp();
  82     static sal_Bool     IsBalloonHelpEnabled();
  83     static sal_Bool     ShowBalloon( Window* pParent,
  84                                      const Point& rScreenPos,
  85                                      const OUString& rHelpText );
  86     static sal_Bool     ShowBalloon( Window* pParent,
  87                                      const Point& rScreenPos,
  88                                      const Rectangle&,
  89                                      const OUString& rHelpText );
  90
  91     static void         EnableQuickHelp();
  92     static void         DisableQuickHelp();
  93     static sal_Bool     IsQuickHelpEnabled();
  94     static sal_Bool     ShowQuickHelp( Window* pParent,
  95                                        const Rectangle& rScreenRect,
  96                                        const OUString& rHelpText,
  97                                        const OUString& rLongHelpText,
  98                                        sal_uInt16 nStyle = 0 );
  99     static sal_Bool     ShowQuickHelp( Window* pParent,
 100                                        const Rectangle& rScreenRect,
 101                                        const OUString& rHelpText,
 102                                        sal_uInt16 nStyle = 0 )
 103                             { return Help::ShowQuickHelp( pParent, rScreenRect, rHelpText, OUString(), nStyle ); }
 104
 105     static void         HideBalloonAndQuickHelp();
 106
 107     static sal_uLong    ShowTip( Window* pParent,
 108                                  const Rectangle& rScreenRect,
 109                                  const OUString& rText, sal_uInt16 nStyle = 0 );
 110     static void         UpdateTip( sal_uLong nId,
 111                                    Window* pParent,
 112                                    const Rectangle& rScreenRect,
 113                                    const OUString& rText );
 114     static void         HideTip( sal_uLong nId );
 115 };
 116
 117 #endif  // _SV_HELP_HXX
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */