terminator/terminatorlib/container.py

101 lines
3.0 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
# pylint: disable-msg=R0921
class Container(object):
2009-08-07 09:21:37 +00:00
"""Base class for Terminator Containers"""
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 = [ {'name': 'group-hoover-needed',
'flags': gobject.SIGNAL_RUN_LAST,
'return_type': gobject.TYPE_BOOLEAN,
'param_types': ()
}
]
2009-08-07 09:21:37 +00:00
def __init__(self, configobject):
"""Class initialiser"""
self.children = []
self.config = configobject
def register_signals(self, widget):
"""Register gobject signals in a way that avoids multiple inheritance"""
for signal in self.signals:
gobject.signal_new(signal['name'],
widget,
signal['flags'],
signal['return_type'],
signal['param_types'])
def emit(self, signal):
"""Emit a gobject signal"""
raise NotImplementedError('emit')
2009-08-07 09:21:37 +00:00
def get_offspring(self):
"""Return a list of child widgets, if any"""
return(self.children)
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 unsplit(self, widget, keep=False):
"""Default unsplitter. This should be implemented by subclasses"""
raise NotImplementedError('unsplit')
2009-08-07 09:21:37 +00:00
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['normal']:
self.unzoom(widget)
if not self.remove(widget):
return(False)
self.emit('need_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['normal']:
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: