openbox/frame.h

   1 #ifndef __frame_h
   2 #define __frame_h
   3
   4 #include "geom.h"
   5 #include "render/render.h"
   6
   7 typedef struct _ObFrame ObFrame;
   8
   9 struct _ObClient;
  10
  11 typedef enum {
  12     OB_FRAME_CONTEXT_NONE,
  13     OB_FRAME_CONTEXT_DESKTOP,
  14     OB_FRAME_CONTEXT_CLIENT,
  15     OB_FRAME_CONTEXT_TITLEBAR,
  16     OB_FRAME_CONTEXT_HANDLE,
  17     OB_FRAME_CONTEXT_FRAME,
  18     OB_FRAME_CONTEXT_BLCORNER,
  19     OB_FRAME_CONTEXT_BRCORNER,
  20     OB_FRAME_CONTEXT_TLCORNER,
  21     OB_FRAME_CONTEXT_TRCORNER,
  22     OB_FRAME_CONTEXT_MAXIMIZE,
  23     OB_FRAME_CONTEXT_ALLDESKTOPS,
  24     OB_FRAME_CONTEXT_SHADE,
  25     OB_FRAME_CONTEXT_ICONIFY,
  26     OB_FRAME_CONTEXT_ICON,
  27     OB_FRAME_CONTEXT_CLOSE,
  28     OB_FRAME_NUM_CONTEXTS
  29 } ObFrameContext;
  30
  31 /*! The decorations the client window wants to be displayed on it */
  32 typedef enum {
  33     OB_FRAME_DECOR_TITLEBAR    = 1 << 0, /*!< Display a titlebar */
  34     OB_FRAME_DECOR_HANDLE      = 1 << 1, /*!< Display a handle (bottom) */
  35     OB_FRAME_DECOR_GRIPS       = 1 << 2, /*!< Display grips in the handle */
  36     OB_FRAME_DECOR_BORDER      = 1 << 3, /*!< Display a border */
  37     OB_FRAME_DECOR_ICON        = 1 << 4, /*!< Display the window's icon */
  38     OB_FRAME_DECOR_ICONIFY     = 1 << 5, /*!< Display an iconify button */
  39     OB_FRAME_DECOR_MAXIMIZE    = 1 << 6, /*!< Display a maximize button */
  40     /*! Display a button to toggle the window's placement on
  41       all desktops */
  42     OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
  43     OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Displays a shade button */
  44     OB_FRAME_DECOR_CLOSE       = 1 << 9  /*!< Display a close button */
  45 } ObFrameDecorations;
  46
  47 struct _ObFrame
  48 {
  49     struct _ObClient *client;
  50
  51     Window    window;
  52     Window    plate;
  53
  54     Strut     size;
  55     Rect      area;
  56     gboolean  visible;
  57
  58     /*! Whether the window is obscured at all or fully visible. */
  59     gboolean obscured;
  60
  61     guint     decorations;
  62     gboolean  max_horz;
  63
  64     Window    title;
  65     Window    label;
  66     Window    max;
  67     Window    close;
  68     Window    desk;
  69     Window    shade;
  70     Window    icon;
  71     Window    iconify;
  72     Window    handle;
  73     Window    lgrip;
  74     Window    rgrip;
  75
  76     Window    tlresize;
  77     Window    trresize;
  78
  79     RrAppearance *a_unfocused_title;
  80     RrAppearance *a_focused_title;
  81     RrAppearance *a_unfocused_label;
  82     RrAppearance *a_focused_label;
  83     RrAppearance *a_icon;
  84     RrAppearance *a_unfocused_handle;
  85     RrAppearance *a_focused_handle;
  86
  87     Strut     innersize;
  88
  89     GSList   *clients;
  90
  91     gint      width;         /* title and handle */
  92     gint      label_width;
  93     gint      icon_x;        /* x-position of the window icon button */
  94     gint      label_x;       /* x-position of the window title */
  95     gint      iconify_x;     /* x-position of the window iconify button */
  96     gint      desk_x;        /* x-position of the window all-desktops button */
  97     gint      shade_x;       /* x-position of the window shade button */
  98     gint      max_x;         /* x-position of the window maximize button */
  99     gint      close_x;       /* x-position of the window close button */
 100     gint      bwidth;        /* border width */
 101     gint      rbwidth;       /* title border width */
 102     gint      cbwidth_x;     /* client border width */
 103     gint      cbwidth_y;     /* client border width */
 104
 105     gboolean  max_press;
 106     gboolean  close_press;
 107     gboolean  desk_press;
 108     gboolean  shade_press;
 109     gboolean  iconify_press;
 110     gboolean  max_hover;
 111     gboolean  close_hover;
 112     gboolean  desk_hover;
 113     gboolean  shade_hover;
 114     gboolean  iconify_hover;
 115
 116     gboolean  focused;
 117
 118     gboolean  flashing;
 119     gboolean  flash_on;
 120     GTimeVal  flash_end;
 121 };
 122
 123 ObFrame *frame_new();
 124 void frame_show(ObFrame *self);
 125 void frame_hide(ObFrame *self);
 126 void frame_adjust_shape(ObFrame *self);
 127 void frame_adjust_area(ObFrame *self, gboolean moved,
 128                        gboolean resized, gboolean fake);
 129 void frame_adjust_state(ObFrame *self);
 130 void frame_adjust_focus(ObFrame *self, gboolean hilite);
 131 void frame_adjust_title(ObFrame *self);
 132 void frame_adjust_icon(ObFrame *self);
 133 void frame_grab_client(ObFrame *self, struct _ObClient *client);
 134 void frame_release_client(ObFrame *self, struct _ObClient *client);
 135
 136 ObFrameContext frame_context_from_string(char *name);
 137
 138 ObFrameContext frame_context(struct _ObClient *self, Window win);
 139
 140 /*! Applies gravity to the client's position to find where the frame should
 141   be positioned.
 142   @return The proper coordinates for the frame, based on the client.
 143 */
 144 void frame_client_gravity(ObFrame *self, int *x, int *y);
 145
 146 /*! Reversly applies gravity to the frame's position to find where the client
 147   should be positioned.
 148     @return The proper coordinates for the client, based on the frame.
 149 */
 150 void frame_frame_gravity(ObFrame *self, int *x, int *y);
 151
 152 void frame_flash_start(ObFrame *self);
 153 void frame_flash_stop(ObFrame *self);
 154
 155 #endif