sugar-toolkit-gtk3/src/sugar3/graphics/notebook.py

138 lines
4.3 KiB
Python
Raw Normal View History

2007-05-06 17:03:43 +02:00
# Copyright (C) 2007, Eduardo Silva (edsiper@gmail.com)
#
2007-06-14 22:04:55 +02:00
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
2007-05-06 17:03:43 +02:00
#
2007-06-14 22:04:55 +02:00
# This library is distributed in the hope that it will be useful,
2007-05-06 17:03:43 +02:00
# but WITHOUT ANY WARRANTY; without even the implied warranty of
2007-06-14 22:04:55 +02:00
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
2007-05-06 17:03:43 +02:00
#
2007-06-14 22:04:55 +02:00
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
2007-05-06 17:03:43 +02:00
'''
Notebook class
This class creates a :class:`Gtk.Notebook` widget supporting
a close button in every tab when the `can-close-tabs` gproperty
is enabled (True).
.. literalinclude:: ../examples/notebook.py
'''
from gi.repository import Gtk
from gi.repository import GObject
2007-05-06 17:03:43 +02:00
2009-08-25 21:12:40 +02:00
class Notebook(Gtk.Notebook):
'''
Notebook class that creates a :class:`Gtk.Notebook`. It is possible to set
the `can-close-tabs` property from the constructor through Notebook(can_close_tabs=True)
'''
__gtype_name__ = 'SugarNotebook'
__gproperties__ = {
'can-close-tabs': (bool, None, None, False,
2013-05-18 04:27:04 +02:00
GObject.PARAM_READWRITE |
GObject.PARAM_CONSTRUCT_ONLY),
}
def __init__(self, **kwargs):
# Initialise the Widget
# Side effects:
# Set the 'can-close-tabs' property using **kwargs
# Set True the scrollable notebook property
self._can_close_tabs = None
GObject.GObject.__init__(self, **kwargs)
2007-05-06 17:03:43 +02:00
self.set_scrollable(True)
2007-05-06 17:03:43 +02:00
self.show()
def do_set_property(self, pspec, value):
'''
Implementation method. Use notebook.props to set properties.
'''
if pspec.name == 'can-close-tabs':
self._can_close_tabs = value
else:
raise AssertionError
2007-05-06 17:03:43 +02:00
def _add_icon_to_button(self, button):
icon_box = Gtk.HBox()
image = Gtk.Image()
image.set_from_stock(Gtk.STOCK_CLOSE, Gtk.IconSize.MENU)
Gtk.Button.set_relief(button, Gtk.ReliefStyle.NONE)
settings = Gtk.Widget.get_settings(button)
valid_, w, h = Gtk.icon_size_lookup_for_settings(settings,
Gtk.IconSize.MENU)
Gtk.Widget.set_size_request(button, w + 4, h + 4)
2007-05-06 17:03:43 +02:00
image.show()
icon_box.pack_start(image, True, False, 0)
button.add(icon_box)
icon_box.show()
2007-05-06 17:03:43 +02:00
def _create_custom_tab(self, text, child):
event_box = Gtk.EventBox()
tab_box = Gtk.HBox(False, 2)
tab_label = Gtk.Label(label=text)
2007-05-06 17:03:43 +02:00
tab_button = Gtk.Button()
tab_button.connect('clicked', self._close_page, child)
2007-05-06 17:03:43 +02:00
# Add a picture on a button
self._add_icon_to_button(tab_button)
2007-05-06 17:03:43 +02:00
event_box.show()
tab_button.show()
tab_label.show()
2007-05-06 17:03:43 +02:00
tab_box.pack_start(tab_label, True, False, 0)
tab_box.pack_start(tab_button, True, False, 0)
2007-05-06 17:03:43 +02:00
tab_box.show_all()
event_box.add(tab_box)
return event_box
2007-05-06 17:03:43 +02:00
def add_page(self, text_label, widget):
'''
Adds a page to the notebook and sets the newly added page as current.
Returns True if the page is successfully added to the notebook.
If `can-close-tabs` is true, then a GtkEventBox is also created to close the tab.
2008-09-21 04:22:56 +02:00
Args:
text_label (string): label of page to be added
2008-09-21 04:22:56 +02:00
widget (Gtk.Widget): widget to be used as contents of current page
'''
# Add a new page to the notebook
if self._can_close_tabs:
eventbox = self._create_custom_tab(text_label, widget)
self.append_page(widget, eventbox)
else:
self.append_page(widget, Gtk.Label(label=text_label))
pages = self.get_n_pages()
2007-05-06 17:03:43 +02:00
# Set the new page
2007-05-06 17:03:43 +02:00
self.set_current_page(pages - 1)
self.show_all()
2007-05-06 17:03:43 +02:00
return True
def _close_page(self, button, child):
# Remove a page from the notebook
2007-05-06 17:03:43 +02:00
page = self.page_num(child)
if page != -1:
self.remove_page(page)