openbox/frame.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    frame.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #ifndef __frame_h
  21 #define __frame_h
  22
  23 #include "geom.h"
  24 #include "render/render.h"
  25
  26 typedef struct _ObFrame ObFrame;
  27
  28 struct _ObClient;
  29
  30 typedef void (*ObFrameIconifyAnimateFunc)(gpointer data);
  31
  32 typedef enum {
  33     OB_FRAME_CONTEXT_NONE,
  34     OB_FRAME_CONTEXT_DESKTOP,
  35     OB_FRAME_CONTEXT_ROOT,
  36     OB_FRAME_CONTEXT_CLIENT,
  37     OB_FRAME_CONTEXT_TITLEBAR,
  38     OB_FRAME_CONTEXT_FRAME,
  39     OB_FRAME_CONTEXT_BLCORNER,
  40     OB_FRAME_CONTEXT_BRCORNER,
  41     OB_FRAME_CONTEXT_TLCORNER,
  42     OB_FRAME_CONTEXT_TRCORNER,
  43     OB_FRAME_CONTEXT_TOP,
  44     OB_FRAME_CONTEXT_BOTTOM,
  45     OB_FRAME_CONTEXT_LEFT,
  46     OB_FRAME_CONTEXT_RIGHT,
  47     OB_FRAME_CONTEXT_MAXIMIZE,
  48     OB_FRAME_CONTEXT_ALLDESKTOPS,
  49     OB_FRAME_CONTEXT_SHADE,
  50     OB_FRAME_CONTEXT_ICONIFY,
  51     OB_FRAME_CONTEXT_ICON,
  52     OB_FRAME_CONTEXT_CLOSE,
  53     /*! This is a special context, which occurs while dragging a window in
  54       a move/resize */
  55     OB_FRAME_CONTEXT_MOVE_RESIZE,
  56     OB_FRAME_NUM_CONTEXTS
  57 } ObFrameContext;
  58
  59 /*! The decorations the client window wants to be displayed on it */
  60 typedef enum {
  61     OB_FRAME_DECOR_TITLEBAR    = 1 << 0, /*!< Display a titlebar */
  62     OB_FRAME_DECOR_HANDLE      = 1 << 1, /*!< Display a handle (bottom) */
  63     OB_FRAME_DECOR_GRIPS       = 1 << 2, /*!< Display grips in the handle */
  64     OB_FRAME_DECOR_BORDER      = 1 << 3, /*!< Display a border */
  65     OB_FRAME_DECOR_ICON        = 1 << 4, /*!< Display the window's icon */
  66     OB_FRAME_DECOR_ICONIFY     = 1 << 5, /*!< Display an iconify button */
  67     OB_FRAME_DECOR_MAXIMIZE    = 1 << 6, /*!< Display a maximize button */
  68     /*! Display a button to toggle the window's placement on
  69       all desktops */
  70     OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
  71     OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Displays a shade button */
  72     OB_FRAME_DECOR_CLOSE       = 1 << 9  /*!< Display a close button */
  73 } ObFrameDecorations;
  74
  75 struct _ObFrame
  76 {
  77     struct _ObClient *client;
  78
  79     Window    window;
  80
  81     Pixmap    pixmap;    /* Offscreen buffer of the frame window's contents
  82                             when Composite is enabled */
  83     gboolean  has_alpha;
  84
  85     Strut     size;
  86     Rect      area;
  87     gboolean  visible;
  88
  89     guint     functions;
  90     guint     decorations;
  91
  92     Window    title;
  93     Window    label;
  94     Window    max;
  95     Window    close;
  96     Window    desk;
  97     Window    shade;
  98     Window    icon;
  99     Window    iconify;
 100     Window    handle;
 101     Window    lgrip;
 102     Window    rgrip;
 103
 104     /* These are borders of the frame and its elements */
 105     Window    titleleft;
 106     Window    titletop;
 107     Window    titletopleft;
 108     Window    titletopright;
 109     Window    titleright;
 110     Window    titlebottom;
 111     Window    left;
 112     Window    right;
 113     Window    handleleft;
 114     Window    handletop;
 115     Window    handleright;
 116     Window    handlebottom;
 117     Window    lgriptop;
 118     Window    lgripleft;
 119     Window    lgripbottom;
 120     Window    rgriptop;
 121     Window    rgripright;
 122     Window    rgripbottom;
 123     Window    innerleft;    /*!< For drawing the inner client border */
 124     Window    innertop;     /*!< For drawing the inner client border */
 125     Window    innerright;   /*!< For drawing the inner client border */
 126     Window    innerbottom;  /*!< For drawing the inner client border */
 127     Window    backback;     /*!< A colored window shown while resizing */
 128     Window    backfront;    /*!< An undrawn-in window, to prevent flashing on
 129                                  unmap */
 130
 131     /* These are resize handles inside the titlebar */
 132     Window    topresize;
 133     Window    tltresize;
 134     Window    tllresize;
 135     Window    trtresize;
 136     Window    trrresize;
 137
 138     Colormap  colormap;
 139
 140     RrAppearance *a_unfocused_title;
 141     RrAppearance *a_focused_title;
 142     RrAppearance *a_unfocused_label;
 143     RrAppearance *a_focused_label;
 144     RrAppearance *a_icon;
 145     RrAppearance *a_unfocused_handle;
 146     RrAppearance *a_focused_handle;
 147
 148     GSList   *clients;
 149
 150     gint      icon_on;    /* if the window icon button is on */
 151     gint      label_on;   /* if the window title is on */
 152     gint      iconify_on; /* if the window iconify button is on */
 153     gint      desk_on;    /* if the window all-desktops button is on */
 154     gint      shade_on;   /* if the window shade button is on */
 155     gint      max_on;     /* if the window maximize button is on */
 156     gint      close_on;   /* if the window close button is on */
 157
 158     gint      width;         /* width of the titlebar and handle */
 159     gint      label_width;   /* width of the label in the titlebar */
 160     gint      icon_x;        /* x-position of the window icon button */
 161     gint      label_x;       /* x-position of the window title */
 162     gint      iconify_x;     /* x-position of the window iconify button */
 163     gint      desk_x;        /* x-position of the window all-desktops button */
 164     gint      shade_x;       /* x-position of the window shade button */
 165     gint      max_x;         /* x-position of the window maximize button */
 166     gint      close_x;       /* x-position of the window close button */
 167     gint      bwidth;        /* border width */
 168     gint      cbwidth_l;     /* client border width */
 169     gint      cbwidth_t;     /* client border width */
 170     gint      cbwidth_r;     /* client border width */
 171     gint      cbwidth_b;     /* client border width */
 172     gboolean  max_horz;      /* when maxed some decorations are hidden */
 173     gboolean  max_vert;      /* when maxed some decorations are hidden */
 174     gboolean  shaded;        /* decorations adjust when shaded */
 175
 176     /* the leftmost and rightmost elements in the titlebar */
 177     ObFrameContext leftmost;
 178     ObFrameContext rightmost;
 179
 180     gboolean  max_press;
 181     gboolean  close_press;
 182     gboolean  desk_press;
 183     gboolean  shade_press;
 184     gboolean  iconify_press;
 185     gboolean  max_hover;
 186     gboolean  close_hover;
 187     gboolean  desk_hover;
 188     gboolean  shade_hover;
 189     gboolean  iconify_hover;
 190
 191     gboolean  focused;
 192     gboolean  need_render;
 193
 194     gboolean  flashing;
 195     gboolean  flash_on;
 196     GTimeVal  flash_end;
 197
 198     /*! Is the frame currently in an animation for iconify or restore.
 199       0 means that it is not animating. > 0 means it is animating an iconify.
 200       < 0 means it is animating a restore.
 201     */
 202     gint iconify_animation_going;
 203     GTimeVal  iconify_animation_end;
 204 };
 205
 206 ObFrame *frame_new(struct _ObClient *c);
 207 void frame_free(ObFrame *self);
 208
 209 void frame_show(ObFrame *self);
 210 void frame_hide(ObFrame *self);
 211 void frame_adjust_theme(ObFrame *self);
 212 void frame_adjust_area(ObFrame *self, gboolean moved,
 213                        gboolean resized, gboolean fake);
 214 void frame_adjust_client_area(ObFrame *self);
 215 void frame_adjust_state(ObFrame *self);
 216 void frame_adjust_focus(ObFrame *self, gboolean hilite);
 217 void frame_adjust_title(ObFrame *self);
 218 void frame_adjust_icon(ObFrame *self);
 219 void frame_grab_client(ObFrame *self);
 220 void frame_release_client(ObFrame *self);
 221
 222 ObFrameContext frame_context_from_string(const gchar *name);
 223
 224 ObFrameContext frame_context(struct _ObClient *self, Window win,
 225                              gint x, gint y);
 226
 227 /*! Applies gravity to the client's position to find where the frame should
 228   be positioned.
 229   @return The proper coordinates for the frame, based on the client.
 230 */
 231 void frame_client_gravity(ObFrame *self, gint *x, gint *y);
 232
 233 /*! Reversly applies gravity to the frame's position to find where the client
 234   should be positioned.
 235     @return The proper coordinates for the client, based on the frame.
 236 */
 237 void frame_frame_gravity(ObFrame *self, gint *x, gint *y);
 238
 239 /*! Convert a rectangle in client coordinates/sizes to what it would be
 240   for the frame, given its current decorations sizes */
 241 void frame_rect_to_frame(ObFrame *self, Rect *r);
 242
 243 void frame_flash_start(ObFrame *self);
 244 void frame_flash_stop(ObFrame *self);
 245
 246 /*! Start an animation for iconifying or restoring a frame. The callback
 247   will be called when the animation finishes. But if another animation is
 248   started in the meantime, the callback will never get called. */
 249 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying);
 250 void frame_end_iconify_animation(ObFrame *self);
 251
 252 #define frame_iconify_animating(f) (f->iconify_animation_going != 0)
 253
 254 #endif