2 Copyright (C) 2016 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <gdkmm/cursor.h>
21 #include "gtkmm2ext/pane.h"
27 using namespace Gtkmm2ext;
39 set_has_window (false);
42 drag_cursor = Cursor (SB_H_DOUBLE_ARROW);
44 drag_cursor = Cursor (SB_V_DOUBLE_ARROW);
50 for (Children::iterator c = children.begin(); c != children.end(); ++c) {
51 c->w->remove_destroy_notify_callback (&(*c));
57 Pane::set_child_minsize (Gtk::Widget const& w, int32_t minsize)
59 for (Children::iterator c = children.begin(); c != children.end(); ++c) {
68 Pane::set_drag_cursor (Gdk::Cursor c)
74 Pane::on_size_request (GtkRequisition* req)
76 GtkRequisition largest;
78 /* iterate over all children, get their size requests */
80 /* horizontal pane is as high as its tallest child, including the dividers.
81 * Its width is the sum of the children plus the dividers.
83 * vertical pane is as wide as its widest child, including the dividers.
84 * Its height is the sum of the children plus the dividers.
88 largest.width = (children.size() - 1) * divider_width;
91 largest.height = (children.size() - 1) * divider_width;
95 for (Children::iterator child = children.begin(); child != children.end(); ++child) {
98 child->w->size_request (r);
101 largest.height = max (largest.height, r.height);
102 largest.width += r.width;
104 largest.width = max (largest.width, r.width);
105 largest.height += r.height;
113 Pane::child_type_vfunc() const
115 /* We accept any number of any types of widgets */
116 return Gtk::Widget::get_type();
122 Divider* d = new Divider;
123 d->set_name (X_("Divider"));
124 d->signal_button_press_event().connect (sigc::bind (sigc::mem_fun (*this, &Pane::handle_press_event), d), false);
125 d->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &Pane::handle_release_event), d), false);
126 d->signal_motion_notify_event().connect (sigc::bind (sigc::mem_fun (*this, &Pane::handle_motion_event), d), false);
127 d->signal_enter_notify_event().connect (sigc::bind (sigc::mem_fun (*this, &Pane::handle_enter_event), d), false);
128 d->signal_leave_notify_event().connect (sigc::bind (sigc::mem_fun (*this, &Pane::handle_leave_event), d), false);
129 d->set_parent (*this);
132 dividers.push_back (d);
136 Pane::handle_child_visibility ()
138 reallocate (get_allocation());
142 Pane::on_add (Widget* w)
144 children.push_back (Child (this, w, 0));
146 w->set_parent (*this);
147 /* Gtkmm 2.4 does not correctly arrange for ::on_remove() to be called
148 for custom containers that derive from Gtk::Container. So ... we need
149 to ensure that we hear about child destruction ourselves.
151 w->add_destroy_notify_callback (&children.back(), &Pane::notify_child_destroyed);
153 w->signal_show().connect (sigc::mem_fun (*this, &Pane::handle_child_visibility));
154 w->signal_hide().connect (sigc::mem_fun (*this, &Pane::handle_child_visibility));
156 while (dividers.size() < (children.size() - 1)) {
162 Pane::notify_child_destroyed (void* data)
164 Child* child = reinterpret_cast<Child*> (data);
165 return child->pane->child_destroyed (child->w);
169 Pane::child_destroyed (Gtk::Widget* w)
171 for (Children::iterator c = children.begin(); c != children.end(); ++c) {
181 Pane::on_remove (Widget* w)
183 for (Children::iterator c = children.begin(); c != children.end(); ++c) {
185 w->remove_destroy_notify_callback (&(*c));
194 Pane::on_size_allocate (Gtk::Allocation& alloc)
197 Container::on_size_allocate (alloc);
201 Pane::reallocate (Gtk::Allocation const & alloc)
204 int xpos = alloc.get_x();
205 int ypos = alloc.get_y();
208 if (children.empty()) {
212 if (children.size() == 1) {
213 /* only child gets the full allocation */
214 children.front().w->size_allocate (alloc);
219 remaining = alloc.get_width ();
221 remaining = alloc.get_height ();
224 Children::iterator child;
225 Children::iterator next;
226 Dividers::iterator div;
228 child = children.begin();
230 /* skip initial hidden children */
232 while (child != children.end()) {
233 if (child->w->is_visible()) {
239 for (div = dividers.begin(); child != children.end(); ) {
241 Gtk::Allocation child_alloc;
245 /* Move on to next *visible* child */
247 while (++next != children.end()) {
248 if (next->w->is_visible()) {
253 child_alloc.set_x (xpos);
254 child_alloc.set_y (ypos);
256 if (next == children.end()) {
257 /* last child gets all the remaining space */
260 /* child gets the fraction of the remaining space given by the divider that follows it */
261 fract = (*div)->fract;
265 child->w->size_request (cr);
268 child_alloc.set_width ((gint) floor (remaining * fract));
269 child_alloc.set_height (alloc.get_height());
270 remaining = max (0, (remaining - child_alloc.get_width()));
271 xpos += child_alloc.get_width();
273 child_alloc.set_width (alloc.get_width());
274 child_alloc.set_height ((gint) floor (remaining * fract));
275 remaining = max (0, (remaining - child_alloc.get_height()));
276 ypos += child_alloc.get_height ();
279 if (child->minsize) {
281 child_alloc.set_width (max (child_alloc.get_width(), child->minsize));
283 child_alloc.set_height (max (child_alloc.get_height(), child->minsize));
287 child->w->size_allocate (child_alloc);
289 if (next == children.end()) {
290 /* done, no more children, no need for a divider */
296 /* add a divider between children */
298 Gtk::Allocation divider_allocation;
300 divider_allocation.set_x (xpos);
301 divider_allocation.set_y (ypos);
304 divider_allocation.set_width (divider_width);
305 divider_allocation.set_height (alloc.get_height());
306 remaining = max (0, remaining - divider_width);
307 xpos += divider_width;
309 divider_allocation.set_width (alloc.get_width());
310 divider_allocation.set_height (divider_width);
311 remaining = max (0, remaining - divider_width);
312 ypos += divider_width;
315 (*div)->size_allocate (divider_allocation);
320 /* hide all remaining dividers */
322 while (div != dividers.end()) {
329 Pane::on_expose_event (GdkEventExpose* ev)
331 Children::iterator child;
332 Dividers::iterator div;
334 for (child = children.begin(), div = dividers.begin(); child != children.end(); ++child) {
336 if (child->w->is_visible()) {
337 propagate_expose (*(child->w), ev);
340 if (div != dividers.end()) {
341 if ((*div)->is_visible()) {
342 propagate_expose (**div, ev);
352 Pane::handle_press_event (GdkEventButton* ev, Divider* d)
361 Pane::handle_release_event (GdkEventButton* ev, Divider* d)
365 if (did_move && !children.empty()) {
366 children.front().w->queue_resize ();
373 Pane::set_check_divider_position (bool yn)
379 Pane::fract_is_ok (Dividers::size_type div, float fract)
387 if (get_allocation().get_width() == 1 && get_allocation().get_height() == 1) {
388 /* space not * allocated - * divider being set from startup code. Let it pass,
389 since our goal is mostly to catch drags to a position that will interfere with window
395 /* On Quartz, if the pane handle (divider) gets to
396 be adjacent to the window edge, you can no longer grab it:
397 any attempt to do so is interpreted by the Quartz window
398 manager ("Finder") as a resize drag on the window edge.
402 if (div == dividers.size() - 1) {
403 if (get_allocation().get_width() * (1.0 - fract) < (divider_width*2)) {
404 /* too close to right edge */
410 if (get_allocation().get_width() * fract < (divider_width*2)) {
411 /* too close to left edge */
416 if (div == dividers.size() - 1) {
417 if (get_allocation().get_height() * (1.0 - fract) < (divider_width*2)) {
418 /* too close to bottom */
424 if (get_allocation().get_width() * fract < (divider_width*2)) {
425 /* too close to top */
435 Pane::handle_motion_event (GdkEventMotion* ev, Divider* d)
443 /* determine new position for handle */
448 d->translate_coordinates (*this, ev->x, ev->y, px, py);
450 Dividers::iterator prev = dividers.end();
451 Dividers::size_type div = 0;
453 for (Dividers::iterator di = dividers.begin(); di != dividers.end(); ++di, ++div) {
464 if (prev != dividers.end()) {
465 prev_edge = (*prev)->get_allocation().get_x() + (*prev)->get_allocation().get_width();
469 space_remaining = get_allocation().get_width() - prev_edge;
470 new_fract = (float) (px - prev_edge) / space_remaining;
472 if (prev != dividers.end()) {
473 prev_edge = (*prev)->get_allocation().get_y() + (*prev)->get_allocation().get_height();
477 space_remaining = get_allocation().get_height() - prev_edge;
478 new_fract = (float) (py - prev_edge) / space_remaining;
481 new_fract = min (1.0f, max (0.0f, new_fract));
483 if (!fract_is_ok (div, new_fract)) {
487 if (new_fract != d->fract) {
488 d->fract = new_fract;
489 reallocate (get_allocation ());
497 Pane::set_divider (Dividers::size_type div, float fract)
499 Dividers::iterator d = dividers.begin();
501 for (d = dividers.begin(); d != dividers.end() && div != 0; ++d, --div) {
505 if (d == dividers.end()) {
506 /* caller is trying to set divider that does not exist
512 fract = max (0.0f, min (1.0f, fract));
514 if (!fract_is_ok (div, fract)) {
518 if (fract != (*d)->fract) {
520 /* our size hasn't changed, but our internal allocations have */
521 reallocate (get_allocation());
527 Pane::get_divider (Dividers::size_type div)
529 Dividers::iterator d = dividers.begin();
531 for (d = dividers.begin(); d != dividers.end() && div != 0; ++d, --div) {
535 if (d == dividers.end()) {
536 /* caller is trying to set divider that does not exist
546 Pane::forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
548 /* since the callback could modify the child list(s), make sure we keep
549 * the iterators safe;
552 for (Children::iterator c = children.begin(); c != children.end(); ) {
553 Children::iterator next = c;
555 callback (c->w->gobj(), callback_data);
559 if (include_internals) {
560 for (Dividers::iterator d = dividers.begin(); d != dividers.end(); ) {
561 Dividers::iterator next = d;
563 callback (GTK_WIDGET((*d)->gobj()), callback_data);
569 Pane::Divider::Divider ()
573 set_events (Gdk::EventMask (Gdk::BUTTON_PRESS|
581 Pane::Divider::on_expose_event (GdkEventExpose* ev)
583 Gdk::Color c = (dragging ? get_style()->get_fg (Gtk::STATE_ACTIVE) :
584 get_style()->get_fg (get_state()));
586 Cairo::RefPtr<Cairo::Context> draw_context = get_window()->create_cairo_context ();
587 draw_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height);
588 draw_context->clip_preserve ();
589 draw_context->set_source_rgba (c.get_red_p(), c.get_green_p(), c.get_blue_p(), 1.0);
590 draw_context->fill ();
596 Pane::handle_enter_event (GdkEventCrossing*, Divider* d)
598 d->get_window()->set_cursor (drag_cursor);
599 d->set_state (Gtk::STATE_SELECTED);
604 Pane::handle_leave_event (GdkEventCrossing*, Divider* d)
606 d->get_window()->set_cursor ();
607 d->set_state (Gtk::STATE_NORMAL);