← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ui.txt

  • Committer: Martin Pool
  • Date: 2010-09-10 06:35:30 UTC
  • mto: This revision was merged to the branch mainline in revision 5426.
  • Revision ID: mbp@sourcefrog.net-20100910063530-ntk3qfbtke6zmafl
Add list of confirmation ids

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/ui.txt
1
 
=========================
2
 
Interacting with the user
3
 
=========================
 
1
==========================================
 
2
Bazaar Developer Guide to User Interaction
 
3
==========================================
4
4
 
5
5
Getting Input
6
6
=============
25
25
presence of different locales.
26
26
 
27
27
Confirmation
28
 
============
 
28
------------
29
29
 
30
30
There are some operations, such as uncommitting, or breaking a lock, where
31
31
bzr may want to get confirmation from the user before proceeding.
37
37
We provide a special UIFactory method `confirm_action` to do this.  It
38
38
takes a `confirmation_id` parameter that acts as a symbolic name for the
39
39
type of confirmation, so the user can configure them off.  (This is not
40
 
implemented at present.)  GUIs can have a "don't ask me again" option
41
 
keyed by the confirmation id.
 
40
implemented at present.)
42
41
 
43
42
Confirmation ids look like Python paths to the logical code that should
44
43
use them.  (Because code may move or the check may for implementation
45
44
reasons be done elsewhere, they need not perfectly correspond to the place
46
45
they're used, and they should stay stable even when the code moves.)
47
46
 
48
 
``bzrlib.builtins.uncommit``
49
 
    Before the ``uncommit`` command actually changes the branch.
50
 
 
51
 
``bzrlib.lockdir.break``
 
47
bzrlib.lockdir.break
52
48
    Before breaking a lock.
53
49
 
54
 
``bzrlib.msgeditor.unchanged``
55
 
    Proceed even though the user made no changes to the template message.
56
 
 
57
 
Interactive confirmations can be overridden by using a
58
 
`ConfirmationUserInterfacePolicy` decorator as the default
59
 
ui_factory.
60
 
 
61
50
 
62
51
Writing Output
63
52
==============