src/stc/scintilla/src/CallTip.h

   1 // Scintilla source code edit control
   2 /** @file CallTip.h
   3  ** Interface to the call tip control.
   4  **/
   5 // Copyright 1998-2001 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #ifndef CALLTIP_H
   9 #define CALLTIP_H
  10
  11 /**
  12  */
  13 class CallTip {
  14         int startHighlight;
  15         int endHighlight;
  16         char *val;
  17         Font font;
  18         // Private so CallTip objects can not be copied
  19         CallTip(const CallTip &) {}
  20         CallTip &operator=(const CallTip &) { return *this; }
  21
  22 public:
  23         Window wCallTip;
  24         Window wDraw;
  25         bool inCallTipMode;
  26         int posStartCallTip;
  27         ColourPair colourBG;
  28         ColourPair colourUnSel;
  29         ColourPair colourSel;
  30         ColourPair colourShade;
  31         ColourPair colourLight;
  32         bool unicodeMode;
  33
  34         CallTip();
  35         ~CallTip();
  36
  37         /// Claim or accept palette entries for the colours required to paint a calltip.
  38         void RefreshColourPalette(Palette &pal, bool want);
  39
  40         void PaintCT(Surface *surfaceWindow);
  41
  42         /// Setup the calltip and return a rectangle of the area required.
  43         PRectangle CallTipStart(int pos, Point pt, const char *defn,
  44                 const char *faceName, int size, bool unicodeMode_);
  45
  46         void CallTipCancel();
  47
  48         /// Set a range of characters to be displayed in a highlight style.
  49         /// Commonly used to highlight the current parameter.
  50         void SetHighlight(int start, int end);
  51 };
  52
  53 #endif