170 lines
5.1 KiB
Python
170 lines
5.1 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 gtk
|
|
import gtk.glade
|
|
|
|
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'
|
|
|
|
####################
|
|
# FIXME: Can't this stuff happen once?
|
|
from common import i18n
|
|
_ = i18n._
|
|
APP = i18n.APP
|
|
|
|
GTKGUI_GLADE = 'gtkgui.glade'
|
|
####################
|
|
|
|
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, display_names, contact, account, resource = None):
|
|
'''The display_names argument is a two element tuple containing the desired
|
|
display name (pretty string) for the control in both singular and plural form'''
|
|
self.type_id = type_id
|
|
self.parent_win = parent_win
|
|
self.widget_name = widget_name
|
|
self.display_names = display_names
|
|
self.contact = contact
|
|
self.account = account
|
|
self.compact_view_always = False
|
|
self.compact_view_current = False
|
|
self.nb_unread = 0
|
|
self.resource = resource
|
|
|
|
gajim.last_message_time[self.account][self.get_full_jid()] = 0
|
|
|
|
self.xml = gtk.glade.XML(GTKGUI_GLADE, widget_name, APP)
|
|
self.widget = self.xml.get_widget(widget_name)
|
|
# Autoconnect glade signals
|
|
self.xml.signal_autoconnect(self)
|
|
|
|
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 types MUST implement this method
|
|
|
|
def allow_shutdown(self):
|
|
'''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 notify_on_new_messages(self):
|
|
# NOTE: Derived classes MUST implement this
|
|
return False
|
|
|
|
def repaint_themed_widgets(self, theme):
|
|
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 set_compact_view(self, state):
|
|
# NOTE: Derived classes MAY implement this
|
|
self.compact_view_current = state
|
|
|
|
def got_connected(self):
|
|
pass
|
|
|
|
def got_disconnected(self):
|
|
pass
|
|
|
|
def get_specific_unread(self):
|
|
n = 0
|
|
if gajim.awaiting_events[self.account].has_key(self.contact.jid):
|
|
n = len(gajim.awaiting_events[self.account][self.contact.jid])
|
|
return n
|
|
|
|
def send_message(self, message, keyID = '', type = 'chat',
|
|
chatstate = None, msg_id = None, composing_jep = None, resource = None):
|
|
'''Send the given message to the active tab'''
|
|
jid = self.contact.jid
|
|
# Send and update history
|
|
gajim.connections[self.account].send_message(jid, message, keyID,
|
|
type = type, chatstate = chatstate, msg_id = msg_id,
|
|
composing_jep = composing_jep, resource = self.resource)
|
|
|
|
def position_menu_under_button(self, menu):
|
|
#FIXME: BUG http://bugs.gnome.org/show_bug.cgi?id=316786
|
|
# pass btn instance when this bug is over
|
|
button = self.button_clicked
|
|
# here I get the coordinates of the button relative to
|
|
# window (self.window)
|
|
button_x, button_y = button.allocation.x, button.allocation.y
|
|
|
|
# now convert them to X11-relative
|
|
window_x, window_y = self.parent_win.get_origin()
|
|
x = window_x + button_x
|
|
y = window_y + button_y
|
|
|
|
menu_width, menu_height = menu.size_request()
|
|
|
|
## should we pop down or up?
|
|
if (y + button.allocation.height + menu_height
|
|
< gtk.gdk.screen_height()):
|
|
# now move the menu below the button
|
|
y += button.allocation.height
|
|
else:
|
|
# now move the menu above the button
|
|
y -= menu_height
|
|
|
|
|
|
# push_in is True so all the menuitems are always inside screen
|
|
push_in = True
|
|
return (x, y, push_in)
|
|
|