remove the word "sticky" from everywhere, and replace with "all desktops". change...
[dana/openbox.git] / src / frame.cc
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2
3 #ifdef HAVE_CONFIG_H
4 # include "../config.h"
5 #endif
6
7 extern "C" {
8 #ifdef    SHAPE
9 #include <X11/extensions/shape.h>
10 #endif // SHAPE
11 }
12
13 #include "openbox.hh"
14 #include "frame.hh"
15 #include "client.hh"
16 #include "python.hh"
17 #include "bindings.hh"
18 #include "otk/display.hh"
19
20 #include <string>
21
22 namespace ob {
23
24 const long Frame::event_mask;
25
26 Frame::Frame(Client *client, otk::RenderStyle *style)
27   : otk::Widget(openbox, style, Horizontal, 0, 1, true),
28     WidgetBase(WidgetBase::Type_Frame),
29     _client(client),
30     _screen(otk::display->screenInfo(client->screen())),
31     _plate(this, WidgetBase::Type_Plate),
32     _titlebar(this, WidgetBase::Type_Titlebar),
33     _button_close(&_titlebar, WidgetBase::Type_CloseButton, client),
34     _button_iconify(&_titlebar, WidgetBase::Type_IconifyButton, client),
35     _button_max(&_titlebar, WidgetBase::Type_MaximizeButton, client),
36     _button_alldesk(&_titlebar, WidgetBase::Type_AllDesktopsButton, client),
37     _label(&_titlebar, WidgetBase::Type_Label),
38     _handle(this, WidgetBase::Type_Handle),
39     _grip_left(&_handle, WidgetBase::Type_LeftGrip, client),
40     _grip_right(&_handle, WidgetBase::Type_RightGrip, client),
41     _decorations(client->decorations())
42 {
43   assert(client);
44   assert(style);
45
46   XSelectInput(**otk::display, _window, Frame::event_mask);
47
48   _grip_left.setCursor(openbox->cursors().ll_angle);
49   _grip_right.setCursor(openbox->cursors().lr_angle);
50   
51   _label.setText(_client->title());
52
53   _style = 0;
54   setStyle(style);
55
56   otk::Widget::unfocus(); // stuff starts out appearing focused in otk
57   
58   _plate.show(); // the other stuff is shown based on decor settings
59 }
60
61
62 Frame::~Frame()
63 {
64 }
65
66
67 void Frame::setTitle(const otk::ustring &text)
68 {
69   _label.setText(text);
70   _label.update();
71 }
72
73
74 void Frame::setStyle(otk::RenderStyle *style)
75 {
76   assert(style);
77
78   // if a style was previously set, then 'replace' is true, cause we're
79   // replacing a style
80   bool replace = (_style);
81
82   otk::Widget::setStyle(style);
83
84   if (replace) {
85     // XXX: do shit here whatever
86   }
87   
88   _style = style;
89
90   setBorderColor(_style->frameBorderColor());
91
92   // if !replace, then adjust() will get called after the client is grabbed!
93   if (replace) {
94     // size/position everything
95     adjustSize();
96     adjustPosition();
97   }
98 }
99
100
101 void Frame::focus()
102 {
103   otk::Widget::focus();
104   update();
105 }
106
107
108 void Frame::unfocus()
109 {
110   otk::Widget::unfocus();
111   update();
112 }
113
114
115 void Frame::adjust()
116 {
117   // the party all happens in adjustSize
118 }
119
120
121 void Frame::adjustSize()
122 {
123   // XXX: only if not overridden or something!!! MORE LOGIC HERE!!
124   _decorations = _client->decorations();
125
126   // true/false for whether to show each element of the titlebar
127   bool tit_i = false, tit_m = false, tit_s = false, tit_c = false;
128   int width;   // the width of the client and its border
129   int bwidth;  // width to make borders
130   int cbwidth; // width of the inner client border
131   int butsize=0; // width and height of the titlebar buttons
132   const int bevel = _style->bevelWidth();
133   
134   if (_decorations & Client::Decor_Border) {
135     bwidth = _style->frameBorderWidth();
136     cbwidth = _style->clientBorderWidth();
137   } else
138     bwidth = cbwidth = 0;
139   _innersize.left = _innersize.top = _innersize.bottom = _innersize.right =
140     cbwidth;
141   width = _client->area().width() + cbwidth * 2;
142
143   _plate.setBorderWidth(cbwidth);
144
145   setBorderWidth(bwidth);
146   _titlebar.setBorderWidth(bwidth);
147   _grip_left.setBorderWidth(bwidth);
148   _grip_right.setBorderWidth(bwidth);
149   _handle.setBorderWidth(bwidth);
150   
151   if (_decorations & Client::Decor_Titlebar) {
152     // set the titlebar size
153     _titlebar.setGeometry(-bwidth,
154                           -bwidth,
155                           width,
156                           _style->labelFont()->height() + (bevel * 2));
157     _innersize.top += _titlebar.height() + bwidth;
158
159     // set the label size
160     _label.setGeometry(0, bevel, width, _style->labelFont()->height());
161     // set the buttons sizes
162     butsize = _label.height() - 2;
163     if (_decorations & Client::Decor_Iconify)
164       _button_iconify.setGeometry(0, bevel + 1, butsize, butsize);
165     if (_decorations & Client::Decor_Maximize)
166       _button_max.setGeometry(0, bevel + 1, butsize, butsize);
167     if (_decorations & Client::Decor_AllDesktops)
168       _button_alldesk.setGeometry(0, bevel + 1, butsize, butsize);
169     if (_decorations & Client::Decor_Close)
170       _button_close.setGeometry(0, bevel + 1, butsize, butsize);
171
172     // separation between titlebar elements
173     const int sep = bevel + 1;
174
175     otk::ustring layout;
176     if (!python_get_string("titlebar_layout", &layout))
177       layout = "ILMC";
178
179     // this code ensures that the string only has one of each possible
180     // letter, all of the letters are valid, and L exists somewhere in the
181     // string!
182     bool tit_l = false;
183   
184     for (std::string::size_type i = 0; i < layout.size(); ++i) {
185       switch (layout[i]) {
186       case 'i':
187       case 'I':
188         if (!tit_i && (_decorations & Client::Decor_Iconify)) {
189           tit_i = true;
190           continue;
191         }
192         break;
193       case 'l':
194       case 'L':
195         if (!tit_l) {
196           tit_l = true;
197           continue;
198         }
199         break;
200       case 'm':
201       case 'M':
202         if (!tit_m && (_decorations & Client::Decor_Maximize)) {
203           tit_m = true;
204           continue;
205         }
206         break;
207       case 'd':
208       case 'D':
209         if (!tit_s && (_decorations & Client::Decor_AllDesktops)) {
210           tit_s = true;
211           continue;
212         }
213         break;
214       case 'c':
215       case 'C':
216         if (!tit_c && (_decorations & Client::Decor_Close)) {
217           tit_c = true;
218           continue;
219         }
220         break;
221       }
222       // if we get here then we don't want the letter, kill it
223       layout.erase(i--, 1);
224     }
225     if (!tit_l)
226       layout += "L";
227     
228     // the size of the label. this ASSUMES the layout has only buttons other
229     // that the ONE LABEL!!
230     // adds an extra sep so that there's a space on either side of the
231     // titlebar.. note: x = sep, below.
232     int lwidth = width - sep * 2 -
233       (butsize + sep) * (layout.size() - 1);
234     // quick sanity check for really small windows. if this is needed, its
235     // obviously not going to be displayed right...
236     // XXX: maybe we should make this look better somehow? constraints?
237     if (lwidth <= 0) lwidth = 1;
238     _label.setWidth(lwidth);
239
240     int x = sep;
241     for (std::string::size_type i = 0, len = layout.size(); i < len; ++i) {
242       switch (layout[i]) {
243       case 'i':
244       case 'I':
245         _button_iconify.move(x, _button_iconify.rect().y());
246         x += _button_iconify.width();
247         break;
248       case 'l':
249       case 'L':
250         _label.move(x, _label.rect().y());
251         x += _label.width();
252         break;
253       case 'm':
254       case 'M':
255         _button_max.move(x, _button_max.rect().y());
256         x += _button_max.width();
257         break;
258       case 'd':
259       case 'D':
260         _button_alldesk.move(x, _button_alldesk.rect().y());
261         x += _button_alldesk.width();
262         break;
263       case 'c':
264       case 'C':
265         _button_close.move(x, _button_close.rect().y());
266         x += _button_close.width();
267         break;
268       default:
269         assert(false); // the layout string is invalid!
270       }
271       x += sep;
272     }
273   }
274
275   if (_decorations & Client::Decor_Handle) {
276     _handle.setGeometry(-bwidth,
277                         _innersize.top + _client->area().height() + cbwidth,
278                         width, _style->handleWidth());
279     _grip_left.setGeometry(-bwidth,
280                            -bwidth,
281                            butsize * 2,
282                            _handle.height());
283     _grip_right.setGeometry(((_handle.rect().right() + 1) -
284                              butsize * 2),
285                             -bwidth,
286                             butsize * 2,
287                             _handle.height());
288     _innersize.bottom += _handle.height() + bwidth;
289   }
290   
291
292   // position/size all the windows
293
294   if (_client->shaded())
295     resize(_innersize.left + _innersize.right + _client->area().width(),
296            _titlebar.height());
297   else
298     resize(_innersize.left + _innersize.right + _client->area().width(),
299            _innersize.top + _innersize.bottom + _client->area().height());
300
301   _plate.setGeometry(_innersize.left - cbwidth, _innersize.top - cbwidth,
302                      _client->area().width(), _client->area().height());
303
304   // map/unmap all the windows
305   if (_decorations & Client::Decor_Titlebar) {
306     _label.show();
307     if (tit_i)
308       _button_iconify.show();
309     else
310       _button_iconify.hide();
311     if (tit_m)
312       _button_max.show();
313     else
314       _button_max.hide();
315     if (tit_s)
316       _button_alldesk.show();
317     else
318       _button_alldesk.hide();
319     if (tit_c)
320       _button_close.show();
321     else
322       _button_close.hide();
323     _titlebar.show();
324   } else {
325     _titlebar.hide(true);
326   }
327
328   if (_decorations & Client::Decor_Handle)
329     _handle.show(true);
330   else
331     _handle.hide(true);
332   
333   _size.left   = _innersize.left + bwidth;
334   _size.right  = _innersize.right + bwidth;
335   _size.top    = _innersize.top + bwidth;
336   _size.bottom = _innersize.bottom + bwidth;
337
338   adjustShape();
339
340   update();
341 }
342
343
344 void Frame::adjustPosition()
345 {
346   int x, y;
347   clientGravity(x, y);
348   move(x, y);
349 }
350
351
352 void Frame::adjustShape()
353 {
354 #ifdef SHAPE
355   int bwidth = (_decorations & Client::Decor_Border) ?
356     _style->frameBorderWidth() : 0;
357   
358   if (!_client->shaped()) {
359     // clear the shape on the frame window
360     XShapeCombineMask(**otk::display, _window, ShapeBounding,
361                       _innersize.left,
362                       _innersize.top,
363                       None, ShapeSet);
364   } else {
365     // make the frame's shape match the clients
366     XShapeCombineShape(**otk::display, _window, ShapeBounding,
367                        _innersize.left,
368                        _innersize.top,
369                        _client->window(), ShapeBounding, ShapeSet);
370
371     int num = 0;
372     XRectangle xrect[2];
373
374     if (_decorations & Client::Decor_Titlebar) {
375       xrect[0].x = _titlebar.rect().x();
376       xrect[0].y = _titlebar.rect().y();
377       xrect[0].width = _titlebar.width() + bwidth * 2; // XXX: this is useless once the widget handles borders!
378       xrect[0].height = _titlebar.height() + bwidth * 2;
379       ++num;
380     }
381
382     if (_decorations & Client::Decor_Handle) {
383       xrect[1].x = _handle.rect().x();
384       xrect[1].y = _handle.rect().y();
385       xrect[1].width = _handle.width() + bwidth * 2; // XXX: this is useless once the widget handles borders!
386       xrect[1].height = _handle.height() + bwidth * 2;
387       ++num;
388     }
389
390     XShapeCombineRectangles(**otk::display, window(),
391                             ShapeBounding, 0, 0, xrect, num,
392                             ShapeUnion, Unsorted);
393   }
394 #endif // SHAPE
395 }
396
397
398 void Frame::adjustState()
399 {
400   _button_alldesk.update();
401   _button_max.update();
402 }
403
404
405 void Frame::grabClient()
406 {
407   // reparent the client to the frame
408   XReparentWindow(**otk::display, _client->window(),
409                   _plate.window(), 0, 0);
410   /*
411     When reparenting the client window, it is usually not mapped yet, since
412     this occurs from a MapRequest. However, in the case where Openbox is
413     starting up, the window is already mapped, so we'll see unmap events for
414     it. There are 2 unmap events generated that we see, one with the 'event'
415     member set the root window, and one set to the client, but both get handled
416     and need to be ignored.
417   */
418   if (openbox->state() == Openbox::State_Starting)
419     _client->ignore_unmaps += 2;
420
421   // select the event mask on the client's parent (to receive config req's)
422   XSelectInput(**otk::display, _plate.window(),
423                SubstructureRedirectMask);
424
425   // map the client so it maps when the frame does
426   XMapWindow(**otk::display, _client->window());
427
428   adjustSize();
429   adjustPosition();
430 }
431
432
433 void Frame::releaseClient()
434 {
435   XEvent ev;
436
437   // check if the app has already reparented its window away
438   if (XCheckTypedWindowEvent(**otk::display, _client->window(),
439                              ReparentNotify, &ev)) {
440     XPutBackEvent(**otk::display, &ev);
441     // re-map the window since the unmanaging process unmaps it
442     XMapWindow(**otk::display, _client->window());  
443   } else {
444     // according to the ICCCM - if the client doesn't reparent itself, then we
445     // will reparent the window to root for them
446     XReparentWindow(**otk::display, _client->window(),
447                     _screen->rootWindow(),
448                     _client->area().x(), _client->area().y());
449   }
450 }
451
452
453 void Frame::clientGravity(int &x, int &y)
454 {
455   x = _client->area().x();
456   y = _client->area().y();
457
458   // horizontal
459   switch (_client->gravity()) {
460   default:
461   case NorthWestGravity:
462   case SouthWestGravity:
463   case WestGravity:
464     break;
465
466   case NorthGravity:
467   case SouthGravity:
468   case CenterGravity:
469     x -= (_size.left + _size.right) / 2;
470     break;
471
472   case NorthEastGravity:
473   case SouthEastGravity:
474   case EastGravity:
475     x -= _size.left + _size.right;
476     break;
477
478   case ForgetGravity:
479   case StaticGravity:
480     x -= _size.left;
481     break;
482   }
483
484   // vertical
485   switch (_client->gravity()) {
486   default:
487   case NorthWestGravity:
488   case NorthEastGravity:
489   case NorthGravity:
490     break;
491
492   case CenterGravity:
493   case EastGravity:
494   case WestGravity:
495     y -= (_size.top + _size.bottom) / 2;
496     break;
497
498   case SouthWestGravity:
499   case SouthEastGravity:
500   case SouthGravity:
501     y -= _size.top + _size.bottom;
502     break;
503
504   case ForgetGravity:
505   case StaticGravity:
506     y -= _size.top;
507     break;
508   }
509 }
510
511
512 void Frame::frameGravity(int &x, int &y)
513 {
514   x = rect().x();
515   y = rect().y();
516   
517   // horizontal
518   switch (_client->gravity()) {
519   default:
520   case NorthWestGravity:
521   case WestGravity:
522   case SouthWestGravity:
523     break;
524   case NorthGravity:
525   case CenterGravity:
526   case SouthGravity:
527     x += (_size.left + _size.right) / 2;
528     break;
529   case NorthEastGravity:
530   case EastGravity:
531   case SouthEastGravity:
532     x += _size.left + _size.right;
533     break;
534   case StaticGravity:
535   case ForgetGravity:
536     x += _size.left;
537     break;
538   }
539
540   // vertical
541   switch (_client->gravity()) {
542   default:
543   case NorthWestGravity:
544   case WestGravity:
545   case SouthWestGravity:
546     break;
547   case NorthGravity:
548   case CenterGravity:
549   case SouthGravity:
550     y += (_size.top + _size.bottom) / 2;
551     break;
552   case NorthEastGravity:
553   case EastGravity:
554   case SouthEastGravity:
555     y += _size.top + _size.bottom;
556     break;
557   case StaticGravity:
558   case ForgetGravity:
559     y += _size.top;
560     break;
561   }
562 }
563
564
565 }