← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gramps/trusty-proposed

« back to all changes in this revision

Viewing changes to src/gen/user.py

  • Committer: Package Import Robot
  • Author(s): Ross Gammon
  • Date: 2014-02-03 17:28:04 UTC
  • mfrom: (39.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20140203172804-76y7nwxiw92zhlnj
Tags: 4.0.3+dfsg-1
http://bugs.debian.org/720858
http://bugs.debian.org/680692
http://bugs.debian.org/736436
http://bugs.debian.org/502532
* New upstream release (Closes: #720858)
* To-do notes improved and made persistent (Closes: #680692)
* Applied patch to setup.py to fix resource path problem
* Applied patch to disable the optional HTML View & prevent a crash
* Remove sourceless javascript files (Closes: #736436)
* Gramps uses Bat Mitzva internally (Closes: #502532)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/gen/user.py
1
 
#
2
 
# Gramps - a GTK+/GNOME based genealogy program
3
 
#
4
 
# Copyright (C) 2010  Brian G. Matherly
5
 
#
6
 
# This program is free software; you can redistribute it and/or modify
7
 
# it under the terms of the GNU General Public License as published by
8
 
# the Free Software Foundation; either version 2 of the License, or
9
 
# (at your option) any later version.
10
 
#
11
 
# This program is distributed in the hope that it will be useful,
12
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 
# GNU General Public License for more details.
15
 
#
16
 
# You should have received a copy of the GNU General Public License
17
 
# along with this program; if not, write to the Free Software
18
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
 
#
20
 
# $Id: user.py 19674 2012-05-27 14:44:37Z paul-franklin $
21
 
#
22
 
 
23
 
"""
24
 
The User class provides basic interaction with the user.
25
 
"""
26
 
 
27
 
#-------------------------------------------------------------------------
28
 
#
29
 
# User class
30
 
#
31
 
#-------------------------------------------------------------------------
32
 
class User():
33
 
    """
34
 
    This class provides a means to interact with the user in an abstract way.
35
 
    This class should be overridden by each respective user interface to
36
 
    provide the appropriate interaction (eg. dialogs for GTK, prompts for CLI).
37
 
    """
38
 
    def begin_progress(self, title, message, steps):
39
 
        """
40
 
        Start showing a progress indicator to the user.
41
 
        
42
 
        @param title: the title of the progress meter
43
 
        @type title: str
44
 
        @param message: the message associated with the progress meter
45
 
        @type message: str
46
 
        @param steps: the total number of steps for the progress meter.
47
 
            a value of 0 indicates that the ending is unknown and the
48
 
            meter should just show activity.
49
 
        @type steps: int
50
 
        @returns: none
51
 
        """
52
 
        pass
53
 
    
54
 
    def step_progress(self):
55
 
        """
56
 
        Advance the progress meter.
57
 
        """
58
 
        pass
59
 
    
60
 
    def end_progress(self):
61
 
        """
62
 
        Stop showing the progress indicator to the user.
63
 
        """
64
 
        pass
65
 
    
66
 
    def prompt(self, title, question):
67
 
        """
68
 
        Ask the user a question. The answer must be "yes" or "no".
69
 
        The user will be forced to answer the question before proceeding.
70
 
        
71
 
        @param title: the title of the question
72
 
        @type title: str
73
 
        @param question: the question
74
 
        @type question: str
75
 
        @returns: the user's answer to the question
76
 
        @rtype: bool
77
 
        """
78
 
        return False
79
 
    
80
 
    def warn(self, title, warning=""):
81
 
        """
82
 
        Warn the user.
83
 
        
84
 
        @param title: the title of the warning
85
 
        @type title: str
86
 
        @param warning: the warning
87
 
        @type warning: str
88
 
        @returns: none
89
 
        """
90
 
        pass
91
 
    
92
 
    def notify_error(self, title, error=""):
93
 
        """
94
 
        Notify the user of an error.
95
 
        
96
 
        @param title: the title of the error
97
 
        @type title: str
98
 
        @param error: the error message
99
 
        @type error: str
100
 
        @returns: none
101
 
        """
102
 
        pass