← 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-14 06:46:18 UTC
  • mto: This revision was merged to the branch mainline in revision 5426.
  • Revision ID: mbp@sourcefrog.net-20100914064618-1b05bktzv3513mx0
Add ConfirmationUserInterfacePolicy that lets specific confirmations be configured off.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/ui.txt
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.)
 
40
implemented at present.)  GUIs can have a "don't ask me again" option
 
41
keyed by the confirmation id.
41
42
 
42
43
Confirmation ids look like Python paths to the logical code that should
43
44
use them.  (Because code may move or the check may for implementation
53
54
``bzrlib.msgeditor.unchanged``
54
55
    Proceed even though the user made no changes to the template message.
55
56
 
 
57
Interactive confirmations can be overridden by using a
 
58
`ConfirmationUserInterfacePolicy` decorator as the default
 
59
ui_factory.
 
60
 
56
61
 
57
62
Writing Output
58
63
==============