gramps/src/DisplayModels/_NoteModel.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2006  Donald N. Allingham
#
# 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; either version 2 of the License, or
# (at your option) any later version.
#
# 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# $Id$

#-------------------------------------------------------------------------
#
# python modules
#
#-------------------------------------------------------------------------
import time
import logging
import re
log = logging.getLogger(".")

#-------------------------------------------------------------------------
#
# GNOME/GTK modules
#
#-------------------------------------------------------------------------
import gtk

#-------------------------------------------------------------------------
#
# GRAMPS modules
#
#-------------------------------------------------------------------------
import const
import ToolTips
import GrampsLocale
from _BaseModel import BaseModel
import RelLib

#-------------------------------------------------------------------------
#
# PlaceModel
#
#-------------------------------------------------------------------------
class NoteModel(BaseModel):

    HANDLE_COL = 2
    _MARKER_COL = 6

    def __init__(self,db,scol=0,order=gtk.SORT_ASCENDING,search=None,
                 skip=set(), sort_map=None):
        self.gen_cursor = db.get_note_cursor
        self.map = db.get_raw_note_data
        self.fmap = [
            self.column_id,
            self.column_type,
            self.column_marker,
            self.column_preview,
            self.column_handle,
            self.column_marker_color,
            ]
        self.smap = [
            self.column_id,
            self.column_type,
            self.column_marker,
            self.column_preview,
            self.column_handle,
            self.column_marker_color,
            ]
        self.marker_color_column = 5
        BaseModel.__init__(self, db, scol, order,
                           search=search, skip=skip, sort_map=sort_map)

    def __unattached_note(self, handle):
        """ function that returns true if note is not attached to another 
            object
        """
        if handle :
            return len([x for x in self.db.find_backlink_handles(handle)]) == 0
        return False
        
    def _rebuild_search(self,ignore=None):
        """ function called when view must be build, given a search text
            in the top search bar
            Remark: this method is overrides BaseModel as only unattached notes
                    must be shown
        """
        self.total = 0
        if self.db.is_open():
            if self.search and self.search.text:
                dlist = [h for h in self.sort_keys()\
                             if self.search.match(h) and \
                             h not in self.skip and h != ignore and \
                             self.__unattached_note(h)]
            else:
                dlist = [h for h in self.sort_keys() \
                             if h not in self.skip and h != ignore and \
                             self.__unattached_note(h)]
            self.displayed = len(dlist)
            self.node_map.set_path_map(dlist)
        else:
            self.displayed = 0
            self.node_map.clear_map()

    def _rebuild_filter(self, ignore=None):
        """ function called when view must be build, given filter options
            in the filter sidebar
            Remark: this method is overrides BaseModel as only unattached notes
                    must be shown
        """
        self.total = 0
        if self.db.is_open():
            if self.search:
                dlist = self.search.apply(self.db, 
                [ k for k in self.sort_keys()\
                      if k != ignore and \
                             self.__unattached_note(k)])
            else:
                dlist = [ k for k in self.sort_keys() \
                              if k != ignore and \
                             self.__unattached_note(k)]

            self.displayed = len(dlist)
            self.node_map.set_path_map(dlist)
        else:
            self.displayed = 0
            self.node_map.clear_map()

    def on_get_n_columns(self):
        return len(self.fmap)+1

    def column_handle(self,data):
        return data[0]

    def column_id(self,data):
        return unicode(data[1])

    def column_type(self,data):
        temp = RelLib.NoteType()
        temp.set(data[4])
        return unicode(str(temp))

    def column_marker(self, data):
        temp = RelLib.MarkerType()
        temp.set(data[6])
        return unicode(str(temp))
    
    def column_preview(self,data):
        note = " ".join(data[2].split())
        note = re.sub(r'(<.*?>)', '', note)
        note = note.replace('&amp;', '&')
        note = note.replace('&lt;', '<')
        note = note.replace('&gt;', '>')

        if len(note) > 80:
            return note[:80]+"..."
        else:
            return note

    def column_marker_color(self, data):
        try:
            col = data[NoteModel._MARKER_COL][0]
            if col == RelLib.MarkerType.COMPLETE:
                return self.complete_color
            elif col == RelLib.MarkerType.TODO_TYPE:
                return self.todo_color
            elif col == RelLib.MarkerType.CUSTOM:
                return self.custom_color
        except IndexError:
            pass
        return None