במסגרת עבודתי על פרוייקט המבוסס על PyGTK, נזקקתי לרכיב Entry בעל יכולת אימות התוכן והצגת חיווי למשתמש במקרה של אי התאמה. היה צורך לאפשר להשתמש ברכיב בממשקים המתוכננים בעזרת גלייד. הוחלט לכתוב רכיב כזה בפייתון ולא ב-C כדי למנוע בעיות הידור, אריזה והפצה (הפרוייקט עובד על מספר פלטפורמות). בפייתון נוכל פשוט לכלול אותו עם שאר הקוד של הפרוייקט ולבצע לו import. בנוסף פייתון נוחה יותר לכתיבה ;-)

המדריך מתאר את כתיבת הרכיב והגדרת סיגנל נוסף עבורו, שימוש ברכיבים המותאמים אישית של גלייד (או גאספאצ'ו) ושילובו ביישום.

תוכן:

מנגנון הרכיבים המותאמים של גלייד ושילובם ב-PyGTK
הרכיב המותאם אישית
יישום דוגמא
הורדת הקוד

מנגנון הרכיבים המותאמים של גלייד ושילובם ב-PyGTK

הרכיב המותאם אישית

import gtk
import gobject
import re

class RegexEntry(gtk.HBox):
    """ Implements a regular expression matching entry, with a state 
    icon.
    
    signals:
        'changed' : triggerd when the child entry changes. Updates the icon
                    and tooltips visibility prior to emition.
    """
    
    __gsignals__ = {
        'changed': ( gobject.SIGNAL_RUN_LAST, gobject.TYPE_NONE, () )
    }
    
    def __init__(self, str1, str2, int1, int2):
        '''Creates the regex entry
        
        @param str1: The Regular expression
        @param str2: Tooltip in case of invalid entry
        @param int1: Max length of the entry
        @param int2: Unused
        '''
        
        gtk.HBox.__init__(self)
        
        # our regular expression
        self._re = re.compile(str1)
        
        # create the entry, listen to it's changed event
        self.entry = gtk.Entry()
        self.entry.set_max_length(int1)
        self.entry.connect("changed", self.entry_changed)
        
        # our icon
        self.icon = gtk.Image()
        self.icon.set_from_stock(gtk.STOCK_INFO, gtk.ICON_SIZE_BUTTON)
        
        # Event box holding the icon
        self.eventbox = gtk.EventBox()
        self.eventbox.add(self.icon)
        
        # add the children and make them visible
        self.pack_start(self.entry)
        self.pack_end(self.eventbox, False, True, 2)
        
        self.show_all()
        
        # the tooltips object for the widgets
        self.tooltips = gtk.Tooltips()
        
        self.tooltips.set_tip(self.eventbox, str2)
        self.tooltips.set_tip(self.entry, str2)

        # Make sure the icon/tooltips are in the right statr
        self.entry_changed(self.entry)
        
    def set_text(self, text):
        ''' Sets the entry's text
        
        @param text: The text for the entry
        '''
        self.entry.set_text(text)
        
        
    def get_text(self):
        '''Returns the text in the entry'''
        
        return self.entry.get_text()
    
    def entry_changed(self, widget):
        ''' Listens to changes in the entry and sets the notification elements
        
        @param widget: Widget generating the event. Passed by gobject
        '''
        
        # found the match ?
        if self._re.search(self.entry.get_text()):
            self.eventbox.hide()
            self.tooltips.disable()
        else:
            self.eventbox.show()
            self.tooltips.enable()
        
        # notify those listening to the changed event if needed.
        self.emit('changed')

    def is_valid(self):
        '''Returns validity state of the widget'''
        
        return not self.eventbox.get_property("visible")

יישום דוגמא

import gtk, gtk.glade
import regex_entry
import os

def our_handler(glade, function_name, widget_name, str1, str2, int1 , int2):
    """ the handler should return the widgets, based on function_name """
    if function_name == "regex_entry":
        return regex_entry.RegexEntry(str1, str2, int1, int2)

class MainWindow(object):

    def __init__(self):
        xml = gtk.glade.XML("project2.glade", "main_window")
        window = xml.get_widget("main_window")
        window.connect("destroy", self.quit)

        self.btn_ok = xml.get_widget("buttonOK")
        self.name = xml.get_widget("customName")
        self.cellular= xml.get_widget("customCellular")

        xml.signal_autoconnect(self)

        # set initial state of OK button
        self.on_custom_changed(None)

    def on_buttonCancel_clicked(self, widget):
        """Quit on cancel"""
        self.quit(widget)
        	
    def on_buttonOK_clicked(self, widget):
        """Print name,celluar and exit"""
        
        print self.name.get_text(), self.cellular.get_text()
        self.quit(widget)
        
    def on_custom_changed(self, widget):
        """Listens to change visual warnings state depending on
        validity state"""
        
        self.btn_ok.set_sensitive( self.name.is_valid() and self.cellular.is_valid() )
        
    def quit(self, widget):
        gtk.main_quit()

    def run(self):
        gtk.main()

if __name__ == "__main__":
    # this is important part: sets the custom handler
    gtk.glade.set_custom_handler(our_handler)
    main_window = MainWindow()
    main_window.run()

הורדת הקוד