libs/FTips.h

   1 /* -*-c-*- */
   2 /* Copyright (C) 2004  Olivier Chapuis */
   3
   4 #ifndef FVWMLIB_FTIPS_H
   5 #define FVWMLIB_FTIPS_H
   6
   7 /* ---------------------------- included header files ---------------------- */
   8
   9 /* ---------------------------- global definitions ------------------------- */
  10
  11 /* ---------------------------- global macros ------------------------------ */
  12
  13 /* ---------------------------- type definitions --------------------------- */
  14
  15 typedef enum
  16 {
  17         FTIPS_PLACEMENT_UP,
  18         FTIPS_PLACEMENT_DOWN,
  19         FTIPS_PLACEMENT_LEFT,
  20         FTIPS_PLACEMENT_RIGHT,
  21         FTIPS_PLACEMENT_AUTO_UPDOWN,
  22         FTIPS_PLACEMENT_AUTO_LEFTRIGHT
  23 } ftips_placement_t;
  24
  25 typedef enum
  26 {
  27         FTIPS_JUSTIFICATION_CENTER,
  28         FTIPS_JUSTIFICATION_LEFT_UP,
  29         FTIPS_JUSTIFICATION_RIGHT_DOWN
  30 } ftips_position_t;
  31
  32 typedef struct
  33 {
  34         int colorset;
  35         Pixel fg;
  36         Pixel bg;
  37         Pixel border_pixel;
  38         int border_width;
  39         FlocaleFont *Ffont;
  40         ftips_placement_t placement;
  41         ftips_position_t justification;
  42         unsigned int placement_offset; /* pixel */
  43         unsigned int justification_offset; /* pixel */
  44         unsigned long delay; /* ms */
  45         unsigned long mapped_delay; /* ms */
  46 } ftips_config;
  47
  48 /* ---------------------------- exported variables (globals) --------------- */
  49
  50 /* ---------------------------- interface functions ------------------------ */
  51
  52 Bool FTipsInit(Display *dpy);
  53
  54 ftips_config *FTipsNewConfig(void);
  55
  56 void FTipsOn(
  57         Display *dpy, Window win_f, ftips_config *fc, void *id, char *str,
  58         int x, int y, int w, int h);
  59
  60 void FTipsCancel(Display *dpy);
  61
  62 unsigned long FTipsCheck(Display *dpy);
  63
  64 Bool FTipsExpose(Display *dpy, XEvent *ev);
  65
  66 Bool FTipsHandleEvents(Display *dpy, XEvent *ev);
  67
  68 void FTipsUpdateLabel(Display *dpy, char *str);
  69
  70 void FTipsColorsetChanged(Display *dpy, int cs);
  71
  72 #endif