gajim-plural/src/message_control.py

144 lines
4.4 KiB
Python
Raw Normal View History

## message_control.py
##
2006-02-03 08:48:10 +01:00
## Copyright (C) 2006 Travis Shirk <travis@pobox.com>
2007-09-01 01:19:23 +02:00
## Copyright (C) 2007 Stephan Erb <steve-e@h3c.de>
##
## This file is part of Gajim.
##
## Gajim 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 3 only.
##
## Gajim 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.
##
## You should have received a copy of the GNU General Public License
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
##
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'
####################
2006-01-02 23:08:50 +01:00
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 = False
2006-03-14 14:10:09 +01:00
self.resource = resource
2006-01-08 00:40:37 +01:00
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
2006-03-14 17:58:50 +01:00
return fjid
2006-01-02 10:04:30 +01:00
def set_control_active(self, state):
'''Called when the control becomes active (state is True)
or inactive (state is False)'''
2006-12-30 01:53:02 +01:00
pass # Derived classes MUST implement this method
2006-01-02 10:04:30 +01:00
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
2007-06-15 20:30:48 +02:00
should return 'no', else 'yes' or 'minimize' '''
# NOTE: Derived classes MAY implement this
2007-06-15 20:30:48 +02:00
return 'yes'
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
2006-01-05 03:58:59 +01:00
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
2006-01-05 03:58:59 +01:00
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 = state
2006-02-04 03:52:36 +01:00
def got_connected(self):
pass
2006-02-04 03:52:36 +01:00
def got_disconnected(self):
pass
def get_specific_unread(self):
return len(gajim.events.get_events(self.account, self.contact.jid))
def set_session(self, session):
if session == self.session:
return
2007-07-03 20:00:09 +02:00
if self.session:
2007-07-03 20:00:09 +02:00
print "starting a new session, dropping the old one!"
gajim.connections[self.account].delete_session(self.session.jid, self.session.thread_id)
2007-06-29 06:12:08 +02:00
self.session = session
def send_message(self, message, keyID = '', type = 'chat',
chatstate = None, msg_id = None, composing_xep = None, resource = None,
user_nick = None):
'''Send the given message to the active tab. Doesn't return None if error
'''
jid = self.contact.jid
2007-07-03 20:00:09 +02:00
if not self.session:
self.session = gajim.connections[self.account].make_new_session(self.contact.get_full_jid())
# Send and update history
return gajim.connections[self.account].send_message(jid, message, keyID,
type = type, chatstate = chatstate, msg_id = msg_id,
composing_xep = composing_xep, resource = self.resource,
user_nick = user_nick, session = self.session)