terminator/terminatorlib/container.py

143 lines
4.9 KiB
Python
Raw Normal View History

2009-08-07 09:21:37 +00:00
#!/usr/bin/python
# Terminator by Chris Jones <cmsj@tenshu.net>
# GPL v2 only
"""container.py - classes necessary to contain Terminal widgets"""
import gobject
from config import Config
from util import dbg, err
# pylint: disable-msg=R0921
class Container(object):
2009-08-07 09:21:37 +00:00
"""Base class for Terminator Containers"""
2009-10-08 23:24:58 +00:00
terminator = None
2009-08-07 09:21:37 +00:00
immutable = None
children = None
config = None
2009-08-09 17:48:06 +00:00
state_zoomed = None
states_zoom = { 'none' : 0,
'zoomed' : 1,
'maximised' : 2 }
2009-08-07 09:21:37 +00:00
signals = None
cnxids = None
def __init__(self):
2009-08-07 09:21:37 +00:00
"""Class initialiser"""
self.children = []
self.signals = []
self.cnxids = {}
self.config = Config()
self.state_zoomed = self.states_zoom['none']
2009-08-07 09:21:37 +00:00
def register_signals(self, widget):
"""Register gobject signals in a way that avoids multiple inheritance"""
existing = gobject.signal_list_names(widget)
for signal in self.signals:
if signal['name'] in existing:
dbg('Container:: skipping signal %s for %s, already exists' % (
signal['name'], widget))
else:
dbg('Container:: registering signal for %s on %s' % (signal['name'], widget))
try:
gobject.signal_new(signal['name'],
widget,
signal['flags'],
signal['return_type'],
signal['param_types'])
except RuntimeError:
err('Container:: registering signal for %s on %s failed' %
(signal['name'], widget))
def connect_child(self, widget, signal, handler, data=None):
"""Register the requested signal and record its connection ID"""
if not self.cnxids.has_key(widget):
self.cnxids[widget] = []
if data is not None:
self.cnxids[widget].append(widget.connect(signal, handler, data))
dbg('Container::connect_child: registering %s(%s) to handle %s::%s' %
(handler.__name__, data, widget.__class__.__name__, signal))
else:
self.cnxids[widget].append(widget.connect(signal, handler))
dbg('Container::connect_child: registering %s to handle %s::%s' %
(handler.__name__, widget.__class__.__name__, signal))
def disconnect_child(self, widget):
"""De-register the signals for a child"""
if self.cnxids.has_key(widget):
for cnxid in self.cnxids[widget]:
# FIXME: Look up the IDs to print a useful debugging message
widget.disconnect(cnxid)
del(self.cnxids[widget])
2009-08-07 09:21:37 +00:00
def get_offspring(self):
"""Return a list of child widgets, if any"""
return(self.children)
def get_top_window(self, startpoint):
"""Return the Window instance this container belongs to"""
widget = startpoint
parent = widget.get_parent()
while parent:
widget = parent
parent = widget.get_parent()
return(widget)
2009-08-07 23:31:44 +00:00
def split_horiz(self, widget):
"""Split this container horizontally"""
return(self.split_axis(widget, True))
2009-08-07 09:21:37 +00:00
2009-08-07 23:31:44 +00:00
def split_vert(self, widget):
"""Split this container vertically"""
return(self.split_axis(widget, False))
2009-08-07 09:21:37 +00:00
2009-08-07 23:31:44 +00:00
def split_axis(self, widget, vertical=True):
"""Default axis splitter. This should be implemented by subclasses"""
raise NotImplementedError('split_axis')
2009-08-09 17:48:06 +00:00
def add(self, widget):
"""Add a widget to the container"""
raise NotImplementedError('add')
def remove(self, widget):
"""Remove a widget from the container"""
raise NotImplementedError('remove')
2009-08-09 17:48:06 +00:00
def closeterm(self, widget):
"""Handle the closure of a terminal"""
if self.state_zoomed != self.states_zoom['none']:
dbg('closeterm: current zoomed state is: %s' % self.state_zoomed)
2009-08-09 17:48:06 +00:00
self.unzoom(widget)
if not self.remove(widget):
return(False)
self.terminator.deregister_terminal(widget)
self.terminator.group_hoover()
2009-08-09 17:48:06 +00:00
return(True)
def resizeterm(self, widget, keyname):
"""Handle a keyboard event requesting a terminal resize"""
raise NotImplementedError('resizeterm')
2009-08-09 17:48:06 +00:00
def toggle_zoom(self, widget, fontscale = False):
"""Toggle the existing zoom state"""
if self.state_zoomed != self.states_zoom['none']:
2009-08-09 17:48:06 +00:00
self.unzoom(widget)
else:
self.zoom(widget, fontscale)
def zoom(self, widget, fontscale = False):
"""Zoom a terminal"""
raise NotImplementedError('zoom')
2009-08-09 17:48:06 +00:00
def unzoom(self, widget):
"""Unzoom a terminal"""
raise NotImplementedError('unzoom')
2009-08-09 17:48:06 +00:00
# vim: set expandtab ts=4 sw=4: