gajim-plural/src/message_control.py

124 lines
3.8 KiB
Python

## message_control.py
##
## Copyright (C) 2006 Travis Shirk <travis@pobox.com>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published
## by the Free Software Foundation; version 2 only.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
import gtkgui_helpers
from common import gajim
# Derived types MUST register their type IDs here if custom behavor is required
TYPE_CHAT = 'chat'
TYPE_GC = 'gc'
TYPE_PM = 'pm'
####################
class MessageControl:
'''An abstract base widget that can embed in the gtk.Notebook of a MessageWindow'''
def __init__(self, type_id, parent_win, widget_name, contact, account, resource = None):
# dict { cb id : widget}
# keep all registered callbacks of widgets, created by self.xml
self.handlers = {}
self.type_id = type_id
self.parent_win = parent_win
self.widget_name = widget_name
self.contact = contact
self.account = account
self.hide_chat_buttons_current = False
self.resource = resource
gajim.last_message_time[self.account][self.get_full_jid()] = 0
self.xml = gtkgui_helpers.get_glade('message_window.glade', widget_name)
self.widget = self.xml.get_widget(widget_name)
def get_full_jid(self):
fjid = self.contact.jid
if self.resource:
fjid += '/' + self.resource
return fjid
def set_control_active(self, state):
'''Called when the control becomes active (state is True)
or inactive (state is False)'''
pass # Derived classes MUST implement this method
def allow_shutdown(self, method):
'''Called to check is a control is allowed to shutdown.
If a control is not in a suitable shutdown state this method
should return False'''
# NOTE: Derived classes MAY implement this
return True
def shutdown(self):
# NOTE: Derived classes MUST implement this
pass
def repaint_themed_widgets(self):
pass # NOTE: Derived classes SHOULD implement this
def update_ui(self):
pass # NOTE: Derived classes SHOULD implement this
def toggle_emoticons(self):
pass # NOTE: Derived classes MAY implement this
def update_font(self):
pass # NOTE: Derived classes SHOULD implement this
def update_tags(self):
pass # NOTE: Derived classes SHOULD implement this
def get_tab_label(self, chatstate):
'''Return a suitable the tab label string. Returns a tuple such as:
(label_str, color) either of which can be None
if chatstate is given that means we have HE SENT US a chatstate and
we want it displayed'''
# NOTE: Derived classes MUST implement this
# Return a markup'd label and optional gtk.Color in a tupple like:
#return (label_str, None)
pass
def get_tab_image(self):
'''Return a suitable tab image for display. None clears any current label.'''
return None
def prepare_context_menu(self):
# NOTE: Derived classes SHOULD implement this
return None
def chat_buttons_set_visible(self, state):
# NOTE: Derived classes MAY implement this
self.hide_chat_buttons_current = state
def got_connected(self):
pass
def got_disconnected(self):
pass
def get_specific_unread(self):
return len(gajim.events.get_events(self.account, self.contact.jid))
def send_message(self, message, keyID = '', type = 'chat',
chatstate = None, msg_id = None, composing_jep = None, resource = None,
user_nick = None):
'''Send the given message to the active tab. Doesn't return None if error
'''
jid = self.contact.jid
# Send and update history
return gajim.connections[self.account].send_message(jid, message, keyID,
type = type, chatstate = chatstate, msg_id = msg_id,
composing_jep = composing_jep, resource = self.resource,
user_nick = user_nick)