openbox/popup.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    popup.h for the Openbox window manager
   4    Copyright (c) 2003-2007   Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __popup_h
  20 #define __popup_h
  21
  22 #include "window.h"
  23 #include "obrender/render.h"
  24 #include <glib.h>
  25
  26 struct _ObClientIcon;
  27
  28 #define POPUP_WIDTH 320
  29 #define POPUP_HEIGHT 48
  30
  31 typedef struct _ObPopup      ObPopup;
  32 typedef struct _ObIconPopup  ObIconPopup;
  33 typedef struct _ObPagerPopup ObPagerPopup;
  34
  35 struct _ObPopup
  36 {
  37     ObWindow super;
  38     Window bg;
  39     ObStackingLayer layer;
  40     gint depth;
  41
  42     Window text;
  43
  44     gboolean hasicon;
  45     RrAppearance *a_bg;
  46     RrAppearance *a_text;
  47     gint gravity;
  48     gint x;
  49     gint y;
  50     gint textw;
  51     gint h;
  52     gint minw;
  53     gint maxw;
  54     guint iconwm; /* icon width multiplier. multiplied by the normal width */
  55     guint iconhm; /* icon height multiplier. multipled by the normal height */
  56     gboolean mapped;
  57     gboolean delay_mapped;
  58     guint delay_timer;
  59
  60     void (*draw_icon)(gint x, gint y, gint w, gint h, gpointer data);
  61     gpointer draw_icon_data;
  62 };
  63
  64 struct _ObIconPopup
  65 {
  66     ObPopup *popup;
  67
  68     Window icon;
  69     RrAppearance *a_icon;
  70 };
  71
  72 struct _ObPagerPopup
  73 {
  74     ObPopup *popup;
  75
  76     guint desks;
  77     guint curdesk;
  78     Window *wins;
  79     RrAppearance *hilight;
  80     RrAppearance *unhilight;
  81 };
  82
  83 ObPopup *popup_new(void);
  84 void popup_free(ObPopup *self);
  85
  86 /*! Position the popup. The gravity rules are not the same X uses for windows,
  87   instead of the position being the top-left of the window, the gravity
  88   specifies which corner of the popup will be placed at the given coords.
  89   Static and Forget gravity are equivilent to NorthWest.
  90 */
  91 void popup_position(ObPopup *self, gint gravity, gint x, gint y);
  92 /*! Set the sizes for the popup. When set to 0, the size will be based on
  93   the text size. */
  94 void popup_height(ObPopup *self, gint w);
  95 void popup_min_width(ObPopup *self, gint minw);
  96 void popup_max_width(ObPopup *self, gint maxw);
  97 void popup_text_width(ObPopup *self, gint w);
  98 void popup_text_width_to_string(ObPopup *self, gchar *text);
  99 void popup_height_to_string(ObPopup *self, gchar *text);
 100 void popup_text_width_to_strings(ObPopup *self, gchar **strings, gint num);
 101
 102 void popup_set_text_align(ObPopup *self, RrJustify align);
 103
 104 #define popup_show(s, t) popup_delay_show((s),0,(t))
 105 void popup_delay_show(ObPopup *self, gulong msec, gchar *text);
 106 void popup_hide(ObPopup *self);
 107
 108 RrAppearance *popup_icon_appearance(ObPopup *self);
 109
 110
 111 ObIconPopup *icon_popup_new(void);
 112 void icon_popup_free(ObIconPopup *self);
 113
 114 #define icon_popup_show(s, t, i) icon_popup_delay_show((s),0,(t),(i))
 115 void icon_popup_delay_show(ObIconPopup *self, gulong msec,
 116                            gchar *text, RrImage *icon);
 117 #define icon_popup_hide(p) popup_hide((p)->popup)
 118 #define icon_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
 119 #define icon_popup_text_width(p, w) popup_text_width((p)->popup,(w))
 120 #define icon_popup_height(p, h) popup_height((p)->popup,(h))
 121 #define icon_popup_min_width(p, m) popup_min_width((p)->popup,(m))
 122 #define icon_popup_max_width(p, m) popup_max_width((p)->popup,(m))
 123 #define icon_popup_text_width_to_string(p, s) \
 124     popup_text_width_to_string((p)->popup,(s))
 125 #define icon_popup_text_width_to_strings(p, s, n) \
 126     popup_text_width_to_strings((p)->popup,(s),(n))
 127 #define icon_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
 128 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm);
 129
 130 ObPagerPopup *pager_popup_new(void);
 131 void pager_popup_free(ObPagerPopup *self);
 132
 133 #define pager_popup_show(s, t, d) pager_popup_delay_show((s),0,(t),(d))
 134 void pager_popup_delay_show(ObPagerPopup *self, gulong msec,
 135                             gchar *text, guint desk);
 136 #define pager_popup_hide(p) popup_hide((p)->popup)
 137 #define pager_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
 138 #define pager_popup_text_width(p, w) popup_text_width((p)->popup,(w))
 139 #define pager_popup_height(p, h) popup_height((p)->popup,(h))
 140 #define pager_popup_min_width(p, m) popup_min_width((p)->popup,(m))
 141 #define pager_popup_max_width(p, m) popup_max_width((p)->popup,(m))
 142 #define pager_popup_text_width_to_string(p, s) \
 143     popup_text_width_to_string((p)->popup,(s))
 144 #define pager_popup_text_width_to_strings(p, s, n) \
 145     popup_text_width_to_strings((p)->popup,(s),(n))
 146 #define pager_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
 147 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm);
 148
 149 #endif