gajim-plural/gajim/gtk/util.py

387 lines
11 KiB
Python
Raw Normal View History

# 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/>.
2018-10-12 21:59:49 +02:00
from typing import Any
from typing import List
from typing import Tuple
2018-10-28 10:44:05 +01:00
from typing import Optional
2018-09-23 15:33:31 +02:00
import os
import sys
import logging
2018-07-16 23:22:33 +02:00
import xml.etree.ElementTree as ET
from pathlib import Path
2018-07-16 23:22:33 +02:00
from gi.repository import Gdk
from gi.repository import Gtk
from gi.repository import GLib
import cairo
2018-07-16 23:22:33 +02:00
from gajim.common import app
from gajim.common import configpaths
2018-09-23 15:33:31 +02:00
from gajim.common import i18n
from gajim.common.i18n import _
from gajim.gtk.const import GajimIconSet
_icon_theme = Gtk.IconTheme.get_default()
if _icon_theme is not None:
_icon_theme.append_search_path(configpaths.get('ICONS'))
log = logging.getLogger('gajim.gtk.util')
2018-09-09 15:29:55 +02:00
class Builder:
2018-10-12 21:59:49 +02:00
def __init__(self,
filename: str,
widgets: List[str] = None,
2018-10-12 21:59:49 +02:00
domain: str = None,
gettext_: Any = None) -> None:
2018-09-09 15:29:55 +02:00
self._builder = Gtk.Builder()
2018-10-12 21:59:49 +02:00
if domain is None:
domain = i18n.DOMAIN
self._builder.set_translation_domain(domain)
if gettext_ is None:
gettext_ = _
2018-09-09 15:29:55 +02:00
file_path = os.path.join(configpaths.get('GUI'), filename)
if sys.platform == "win32":
# This is a workaround for non working translation on Windows
tree = ET.parse(file_path)
for node in tree.iter():
2018-09-23 15:33:31 +02:00
if 'translatable' in node.attrib and node.text is not None:
2018-10-12 21:59:49 +02:00
node.text = gettext_(node.text)
2018-09-09 15:29:55 +02:00
xml_text = ET.tostring(tree.getroot(),
encoding='unicode',
method='xml')
if widgets is not None:
self._builder.add_objects_from_string(xml_text, widgets)
2018-09-09 15:29:55 +02:00
else:
# Workaround
# https://gitlab.gnome.org/GNOME/pygobject/issues/255
Gtk.Builder.__mro__[1].add_from_string(
self._builder, xml_text, len(xml_text.encode("utf-8")))
else:
if widgets is not None:
self._builder.add_objects_from_file(file_path, widgets)
2018-09-09 15:29:55 +02:00
else:
self._builder.add_from_file(file_path)
def __getattr__(self, name):
try:
return getattr(self._builder, name)
except AttributeError:
return self._builder.get_object(name)
def get_builder(file_name: str, widgets: List[str] = None) -> Builder:
return Builder(file_name, widgets)
2018-09-09 15:29:55 +02:00
def icon_exists(name: str) -> bool:
return _icon_theme.has_icon(name)
2018-11-18 18:03:08 +01:00
def load_icon(icon_name, widget=None, size=16, pixbuf=False,
scale=None, flags=Gtk.IconLookupFlags.FORCE_SIZE):
if widget is not None:
scale = widget.get_scale_factor()
if not scale:
log.warning('Could not determine scale factor')
scale = 1
try:
iconinfo = _icon_theme.lookup_icon_for_scale(
icon_name, size, scale, flags)
2018-07-16 23:22:33 +02:00
if pixbuf:
return iconinfo.load_icon()
return iconinfo.load_surface(None)
2018-09-23 15:33:31 +02:00
except GLib.GError as error:
log.error('Unable to load icon %s: %s', icon_name, str(error))
def get_app_icon_list(scale_widget):
pixbufs = []
for size in (16, 32, 48, 64, 128):
pixbuf = load_icon('org.gajim.Gajim', scale_widget, size, pixbuf=True)
if pixbuf is not None:
pixbufs.append(pixbuf)
return pixbufs
def get_icon_name(name: str,
iconset: Optional[str] = None,
transport: Optional[str] = None) -> str:
2018-07-16 23:22:33 +02:00
if name == 'not in roster':
name = 'notinroster'
if iconset is not None:
return '%s-%s' % (iconset, name)
2018-10-28 10:44:05 +01:00
if transport is not None:
return '%s-%s' % (transport, name)
iconset = app.config.get('iconset')
2018-07-16 23:22:33 +02:00
if not iconset:
iconset = app.config.DEFAULT_ICONSET
return '%s-%s' % (iconset, name)
def load_user_iconsets():
iconsets_path = Path(configpaths.get('MY_ICONSETS'))
if not iconsets_path.exists():
return
for path in iconsets_path.iterdir():
if not path.is_dir():
continue
log.info('Found iconset: %s', path.stem)
_icon_theme.append_search_path(str(path))
def get_available_iconsets():
iconsets = []
for iconset in GajimIconSet:
iconsets.append(iconset.value)
iconsets_path = Path(configpaths.get('MY_ICONSETS'))
if not iconsets_path.exists():
return iconsets
for path in iconsets_path.iterdir():
if not path.is_dir():
continue
iconsets.append(path.stem)
return iconsets
2018-09-23 15:33:31 +02:00
def get_total_screen_geometry() -> Tuple[int, int]:
2018-07-16 23:22:33 +02:00
screen = Gdk.Screen.get_default()
window = Gdk.Screen.get_root_window(screen)
2018-09-23 15:33:31 +02:00
width, height = window.get_width(), window.get_height()
log.debug('Get screen geometry: %s %s', width, height)
return width, height
2018-07-16 23:22:33 +02:00
2018-09-23 15:33:31 +02:00
def resize_window(window: Gtk.Window, width: int, height: int) -> None:
2018-07-16 23:22:33 +02:00
"""
Resize window, but also checks if huge window or negative values
"""
screen_w, screen_h = get_total_screen_geometry()
2018-09-23 15:33:31 +02:00
if not width or not height:
2018-07-16 23:22:33 +02:00
return
2018-09-23 15:33:31 +02:00
if width > screen_w:
width = screen_w
if height > screen_h:
height = screen_h
window.resize(abs(width), abs(height))
2018-07-16 23:22:33 +02:00
2018-09-23 15:33:31 +02:00
def move_window(window: Gtk.Window, pos_x: int, pos_y: int) -> None:
2018-07-16 23:22:33 +02:00
"""
Move the window, but also check if out of screen
"""
screen_w, screen_h = get_total_screen_geometry()
2018-09-23 15:33:31 +02:00
if pos_x < 0:
pos_x = 0
if pos_y < 0:
pos_y = 0
width, height = window.get_size()
if pos_x + width > screen_w:
pos_x = screen_w - width
if pos_y + height > screen_h:
pos_y = screen_h - height
window.move(pos_x, pos_y)
def get_completion_liststore(entry: Gtk.Entry) -> Gtk.ListStore:
2018-07-16 23:22:33 +02:00
"""
Create a completion model for entry widget completion list consists of
(Pixbuf, Text) rows
"""
completion = Gtk.EntryCompletion()
liststore = Gtk.ListStore(str, str)
render_pixbuf = Gtk.CellRendererPixbuf()
completion.pack_start(render_pixbuf, False)
completion.add_attribute(render_pixbuf, 'icon_name', 0)
render_text = Gtk.CellRendererText()
completion.pack_start(render_text, True)
completion.add_attribute(render_text, 'text', 1)
completion.set_property('text_column', 1)
completion.set_model(liststore)
entry.set_completion(completion)
return liststore
2018-09-23 15:33:31 +02:00
def get_cursor(attr: str) -> Gdk.Cursor:
2018-07-16 23:22:33 +02:00
display = Gdk.Display.get_default()
cursor = getattr(Gdk.CursorType, attr)
return Gdk.Cursor.new_for_display(display, cursor)
2018-09-23 15:33:31 +02:00
def scroll_to_end(widget: Gtk.ScrolledWindow) -> bool:
2018-07-16 23:22:33 +02:00
"""Scrolls to the end of a GtkScrolledWindow.
Args:
widget (GtkScrolledWindow)
Returns:
bool: The return value is False so it can be used with GLib.idle_add.
"""
adj_v = widget.get_vadjustment()
if adj_v is None:
# This can happen when the Widget is already destroyed when called
# from GLib.idle_add
return False
max_scroll_pos = adj_v.get_upper() - adj_v.get_page_size()
adj_v.set_value(max_scroll_pos)
adj_h = widget.get_hadjustment()
adj_h.set_value(0)
return False
2018-09-23 15:33:31 +02:00
def at_the_end(widget: Gtk.ScrolledWindow) -> bool:
2018-07-16 23:22:33 +02:00
"""Determines if a Scrollbar in a GtkScrolledWindow is at the end.
Args:
widget (GtkScrolledWindow)
Returns:
bool: The return value is True if at the end, False if not.
"""
adj_v = widget.get_vadjustment()
max_scroll_pos = adj_v.get_upper() - adj_v.get_page_size()
2018-09-16 17:11:52 +02:00
return adj_v.get_value() == max_scroll_pos
2018-07-16 23:22:33 +02:00
def get_image_button(icon_name, tooltip, toggle=False):
if toggle:
button = Gtk.ToggleButton()
image = Gtk.Image.new_from_icon_name(icon_name, Gtk.IconSize.MENU)
button.set_image(image)
else:
2018-10-28 23:19:24 +01:00
button = Gtk.Button.new_from_icon_name(icon_name, Gtk.IconSize.MENU)
2018-07-16 23:22:33 +02:00
button.set_tooltip_text(tooltip)
return button
def get_image_from_icon_name(icon_name: str, scale: int) -> Any:
icon = get_icon_name(icon_name)
surface = _icon_theme.load_surface(icon, 16, scale, None, 0)
return Gtk.Image.new_from_surface(surface)
2018-09-23 15:33:31 +02:00
def python_month(month: int) -> int:
return month + 1
2018-09-23 15:33:31 +02:00
def gtk_month(month: int) -> int:
return month - 1
2018-09-23 15:33:31 +02:00
def convert_rgb_to_hex(rgb_string: str) -> str:
rgb = Gdk.RGBA()
rgb.parse(rgb_string)
rgb.to_color()
red = int(rgb.red * 255)
green = int(rgb.green * 255)
blue = int(rgb.blue * 255)
return '#%02x%02x%02x' % (red, green, blue)
def get_monitor_scale_factor() -> int:
display = Gdk.Display.get_default()
monitor = display.get_primary_monitor()
if monitor is None:
log.warning('Could not determine scale factor')
return 1
return monitor.get_scale_factor()
def get_metacontact_surface(icon_name, expanded, scale):
icon_size = 16
state_surface = _icon_theme.load_surface(
icon_name, icon_size, scale, None, 0)
if 'event' in icon_name:
return state_surface
if expanded:
icon = get_icon_name('opened')
expanded_surface = _icon_theme.load_surface(
icon, icon_size, scale, None, 0)
else:
icon = get_icon_name('closed')
expanded_surface = _icon_theme.load_surface(
icon, icon_size, scale, None, 0)
ctx = cairo.Context(state_surface)
ctx.rectangle(0, 0, icon_size, icon_size)
ctx.set_source_surface(expanded_surface)
ctx.fill()
return state_surface
2018-11-18 15:59:59 +01:00
def get_affiliation_surface(icon_name, affiliation, scale):
surface = _icon_theme.load_surface(
icon_name, 16, scale, None, 0)
ctx = cairo.Context(surface)
ctx.rectangle(16 - 4, 16 - 4, 4, 4)
if affiliation == 'owner':
ctx.set_source_rgb(204/255, 0, 0)
elif affiliation == 'admin':
ctx.set_source_rgb(255/255, 140/255, 0)
elif affiliation == 'member':
ctx.set_source_rgb(0, 255/255, 0)
ctx.fill()
return surface
def get_show_in_roster(event, session=None):
"""
Return True if this event must be shown in roster, else False
"""
if event == 'gc_message_received':
return True
if event == 'message_received':
if app.config.get('autopopup_chat_opened'):
return True
if session and session.control:
return False
return True
def get_show_in_systray(type_, jid):
"""
Return True if this event must be shown in systray, else False
"""
notify = app.config.get('notify_on_all_muc_messages')
notify_for_jid = app.config.get_per(
'rooms', jid, 'notify_on_all_messages')
if type_ == 'printed_gc_msg' and not notify and not notify_for_jid:
# it's not an highlighted message, don't show in systray
return False
return app.config.get('trayicon_notification_on_events')