DC/UI/Dockbar.pm

package DC::UI::Dockbar;

use DC::UI::Dockable;

use strict;
use utf8;

our @ISA = DC::UI::Toplevel::;

sub new {
   my $class = shift;

   my $self = $class->SUPER::new (
      border_bg => [1, 1, 1, 1],
      x         => "max",
      y         => 0,
      force_w   => $::WIDTH  * 0.4,
      force_h   => $::HEIGHT * 0.5,
      has_close_button => 1,
      child     => (my $nb = DC::UI::Notebook->new (expand => 1)),
      @_,
   );

   $self->{notebook} = $nb;

   $nb->connect (page_changed => sub {
      my ($nb, $page) = @_;
      $self->update_active ($page);
      0
   });

   $self
}

# This method is which you want to call to add a Dockable
sub add_dock {
   my ($self, $dockable) = @_;
   $self->{docks}->{"$dockable"} = $dockable;
   delete $self->{dock_windows}->{"$dockable"};

   $dockable->set_dockbar ($self);

   # TODO: capture the guards to remove these connections
   $dockable->connect (dock => sub {
      my ($dockable) = @_;
      #d# warn "DOCKABLE DOCK";
      $self->dock ($dockable);
      0
   });

   $dockable->connect (undock => sub {
      my ($dockable) = @_;
      #d# warn "DOCKABLE UNDOCK";
      $self->undock ($dockable);
      0
   });

   $dockable->connect (close_dock => sub {
      my ($dockable) = @_;
      $self->remove_dock ($dockable);
      0
   });

   $self->dock ($dockable);
}

# This method will remove the dockable from the Dockbar. Which means that the
# window for this dockable is also removed (if it was undocked).
sub remove_dock {
   my ($self, $dockable) = @_;

   $self->undock_window ($dockable);
   $self->undock_notebook ($dockable);
   delete $self->{docks}->{"$dockable"};
   $dockable->set_dockbar (undef);
}

# This method makes sure the dockable is 'docked' into the Dockbar
# and eg. removes the free floating window it maybe has.
sub dock {
   my ($self, $dockable) = @_;
   $self->undock_window ($dockable);

   # here the assumption is done that $dockable is inserted at the end of the
   # notebook tabs, so that the other tabs dont have to be updated
   $self->{notebook}->add ($dockable);
   $dockable->set_dockbar_pos ($self->{notebook}->page_index ($dockable));
   $self->update_active;
}

# (private) This method updates all docked tabs and tells them whether their
# tab is 'active'.
sub update_active {
   my ($self, $page) = @_;

   unless ($page) {
      $page = $self->{notebook}->get_current_page;
   }

   for ($self->{notebook}->pages) {
      $_->set_dockbar_tab_active ($_ eq $page);
   }
}

# This method undocks the dockable (if it isn't already undocked) and
# creates a floating window for it.
sub undock {
   my ($self, $dockable) = @_;
   return if $self->{dock_windows}->{"$dockable"};

   $self->undock_notebook ($dockable);
   my $win =
      $self->{dock_windows}->{"$dockable"} =
          DC::UI::Toplevel->new (
             title => $dockable->get_title,
             child => $dockable,
             force_w => 100, force_h => 100,
             x => 100, y => 100,
             has_close_button => 1,
          );

   $win->connect (delete => sub {
      $self->dock ($dockable);
      0
   });

   $win->show;
}

# (private) This method does the cleanup stuff when the dockable is docked
# into the dockbar and had a floating window.
sub undock_window {
   my ($self, $dockable) = @_;
   my $win =
      $self->{dock_windows}->{"$dockable"}
         or return;

   $win->remove ($dockable);
   delete $self->{dock_windows}->{"$dockable"};
   $win->hide; # XXX: neccessary?
}

# (private) This method does the cleanup stuff which is neccessary when the
# dockable is removed from the notebook.
sub undock_notebook {
   my ($self, $dockable) = @_;
   $self->{notebook}->remove ($dockable);
   my $nextpage = ($self->{notebook}->pages)[0];
   $self->{notebook}->set_current_page ($nextpage)
      if $nextpage;
   $dockable->set_dockbar_pos (undef);
   $dockable->set_dockbar_tab_active (undef);
   $self->update_dockbar_positions;
}

# (private) This method updates the position of the dockables in the dockbar.
sub update_dockbar_positions {
   my ($self) = @_;
   my $i = 0;
   for ($self->{notebook}->pages) {
      $_->set_dockbar_pos ($i++);
   }
}

# Returns all Dockables of this Dockbar
sub dockables {
   my ($self) = @_;
   values %{$self->{docks}}
}

# Returns whether the dockable is currently docked. (and not
# a floating window).
sub is_docked {
   my ($self, $dockable) = @_;
   return not exists $self->{dock_windows}->{"$dockable"};
}

# switching to a page
sub user_switch_to_page {
   my ($self, $page) = @_;
   $page = $page eq '0' ? 10 : $page;

   my @tabs = $self->{notebook}->pages;

   for (my $i = 0; $i < ($page - 1); $i++) {
      shift @tabs;
   }

   my $page = shift @tabs;
   return unless $page;

   $self->{notebook}->set_current_page ($page);
}

# This method activates the tab of the dockable if it is docked.
sub select_dockable {
   my ($self, $dockable) = @_;
   return unless exists $self->{docks}->{"$dockable"};
   $self->{notebook}->set_current_page ($dockable);
}

# close current tab
sub close_current_tab {
   my ($self) = @_;
   $self->remove_dock ($self->{notebook}->get_current_page);
}

# "activates" the current page
sub activate_current {
   my ($self) = @_;
   $self->{notebook}->get_current_page->activate
}

1
Revision:	1.4
Committed:	Sun Jan 13 10:37:42 2008 UTC (16 years, 6 months ago) by elmex
Branch:	MAIN
CVS Tags:	rel-0_9965, rel-0_9964, rel-0_9968, rel-0_9967, rel-0_9966
Changes since 1.3:	+0 -2 lines
Log Message:	removed redundant names
#	User	Rev	Content
1	elmex	1.1	package DC::UI::Dockbar;
2	root	1.3
3	elmex	1.1	use DC::UI::Dockable;
4
5			use strict;
6			use utf8;
7
8			our @ISA = DC::UI::Toplevel::;
9
10			sub new {
11			my $class = shift;
12
13			my $self = $class->SUPER::new (
14	elmex	1.2	border_bg => [1, 1, 1, 1],
15			x => "max",
16			y => 0,
17			force_w => $::WIDTH * 0.4,
18			force_h => $::HEIGHT * 0.5,
19			has_close_button => 1,
20	elmex	1.1	child => (my $nb = DC::UI::Notebook->new (expand => 1)),
21			@_,
22			);
23
24			$self->{notebook} = $nb;
25
26			$nb->connect (page_changed => sub {
27			my ($nb, $page) = @_;
28			$self->update_active ($page);
29			0
30			});
31
32			$self
33			}
34
35			# This method is which you want to call to add a Dockable
36			sub add_dock {
37			my ($self, $dockable) = @_;
38			$self->{docks}->{"$dockable"} = $dockable;
39			delete $self->{dock_windows}->{"$dockable"};
40
41			$dockable->set_dockbar ($self);
42
43			# TODO: capture the guards to remove these connections
44			$dockable->connect (dock => sub {
45			my ($dockable) = @_;
46			#d# warn "DOCKABLE DOCK";
47			$self->dock ($dockable);
48			0
49			});
50
51			$dockable->connect (undock => sub {
52			my ($dockable) = @_;
53			#d# warn "DOCKABLE UNDOCK";
54			$self->undock ($dockable);
55			0
56			});
57
58			$dockable->connect (close_dock => sub {
59			my ($dockable) = @_;
60			$self->remove_dock ($dockable);
61			0
62			});
63
64			$self->dock ($dockable);
65			}
66
67			# This method will remove the dockable from the Dockbar. Which means that the
68			# window for this dockable is also removed (if it was undocked).
69			sub remove_dock {
70			my ($self, $dockable) = @_;
71
72			$self->undock_window ($dockable);
73			$self->undock_notebook ($dockable);
74			delete $self->{docks}->{"$dockable"};
75			$dockable->set_dockbar (undef);
76			}
77
78			# This method makes sure the dockable is 'docked' into the Dockbar
79			# and eg. removes the free floating window it maybe has.
80			sub dock {
81			my ($self, $dockable) = @_;
82			$self->undock_window ($dockable);
83
84			# here the assumption is done that $dockable is inserted at the end of the
85			# notebook tabs, so that the other tabs dont have to be updated
86			$self->{notebook}->add ($dockable);
87			$dockable->set_dockbar_pos ($self->{notebook}->page_index ($dockable));
88			$self->update_active;
89			}
90
91			# (private) This method updates all docked tabs and tells them whether their
92			# tab is 'active'.
93			sub update_active {
94			my ($self, $page) = @_;
95
96			unless ($page) {
97			$page = $self->{notebook}->get_current_page;
98			}
99
100			for ($self->{notebook}->pages) {
101			$_->set_dockbar_tab_active ($_ eq $page);
102			}
103			}
104
105			# This method undocks the dockable (if it isn't already undocked) and
106			# creates a floating window for it.
107			sub undock {
108			my ($self, $dockable) = @_;
109			return if $self->{dock_windows}->{"$dockable"};
110
111			$self->undock_notebook ($dockable);
112			my $win =
113			$self->{dock_windows}->{"$dockable"} =
114			DC::UI::Toplevel->new (
115			title => $dockable->get_title,
116			child => $dockable,
117			force_w => 100, force_h => 100,
118			x => 100, y => 100,
119			has_close_button => 1,
120			);
121
122			$win->connect (delete => sub {
123			$self->dock ($dockable);
124			0
125			});
126
127			$win->show;
128			}
129
130			# (private) This method does the cleanup stuff when the dockable is docked
131			# into the dockbar and had a floating window.
132			sub undock_window {
133			my ($self, $dockable) = @_;
134			my $win =
135			$self->{dock_windows}->{"$dockable"}
136			or return;
137
138			$win->remove ($dockable);
139			delete $self->{dock_windows}->{"$dockable"};
140			$win->hide; # XXX: neccessary?
141			}
142
143			# (private) This method does the cleanup stuff which is neccessary when the
144			# dockable is removed from the notebook.
145			sub undock_notebook {
146			my ($self, $dockable) = @_;
147			$self->{notebook}->remove ($dockable);
148			my $nextpage = ($self->{notebook}->pages)[0];
149			$self->{notebook}->set_current_page ($nextpage)
150			if $nextpage;
151			$dockable->set_dockbar_pos (undef);
152			$dockable->set_dockbar_tab_active (undef);
153			$self->update_dockbar_positions;
154			}
155
156			# (private) This method updates the position of the dockables in the dockbar.
157			sub update_dockbar_positions {
158			my ($self) = @_;
159			my $i = 0;
160			for ($self->{notebook}->pages) {
161			$_->set_dockbar_pos ($i++);
162			}
163			}
164
165			# Returns all Dockables of this Dockbar
166			sub dockables {
167			my ($self) = @_;
168			values %{$self->{docks}}
169			}
170
171			# Returns whether the dockable is currently docked. (and not
172			# a floating window).
173			sub is_docked {
174			my ($self, $dockable) = @_;
175			return not exists $self->{dock_windows}->{"$dockable"};
176			}
177
178	root	1.3	# switching to a page
179	elmex	1.1	sub user_switch_to_page {
180			my ($self, $page) = @_;
181			$page = $page eq '0' ? 10 : $page;
182
183			my @tabs = $self->{notebook}->pages;
184
185			for (my $i = 0; $i < ($page - 1); $i++) {
186			shift @tabs;
187			}
188
189			my $page = shift @tabs;
190			return unless $page;
191
192			$self->{notebook}->set_current_page ($page);
193			}
194
195			# This method activates the tab of the dockable if it is docked.
196			sub select_dockable {
197			my ($self, $dockable) = @_;
198			return unless exists $self->{docks}->{"$dockable"};
199			$self->{notebook}->set_current_page ($dockable);
200			}
201
202			# close current tab
203			sub close_current_tab {
204			my ($self) = @_;
205			$self->remove_dock ($self->{notebook}->get_current_page);
206			}
207
208			# "activates" the current page
209			sub activate_current {
210			my ($self) = @_;
211			$self->{notebook}->get_current_page->activate
212			}
213
214			1