Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
calITransactionManager Interface Reference

calITransactionManager is a service designed to handle nsITransactions regarding the calendar. More...

import "calITransactionManager.idl";

Inheritance diagram for calITransactionManager:
Inheritance graph
[legend]
Collaboration diagram for calITransactionManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void createAndCommitTxn (in AUTF8String aAction, in calIItemBase aItem, in calICalendar aCalendar, in calIItemBase aOldItem, in calIOperationListener aListener)
void beginBatch ()
 Signals the transaction manager that a series of transactions are going to be performed, but that, for the purposes of undo and redo, they should all be regarded as a single transaction.
void endBatch ()
 Ends the batch transaction in process.
void undo ()
 Undo the last transaction in the transaction manager's stack.
boolean canUndo ()
 Returns true if it is possible to undo a transaction at this time.
void redo ()
 Redo the last transaction.
boolean canRedo ()
 Returns true if it is possible to redo a transaction at this time.

Public Attributes

readonly attribute
nsITransactionManager 
transactionManager
 A reference to the transaction manager for calendar operations.

Detailed Description

calITransactionManager is a service designed to handle nsITransactions regarding the calendar.

It is here as a service so that we can keep the transactions around without holding onto the whole global js scope+window.

Definition at line 50 of file calITransactionManager.idl.


Member Function Documentation

Signals the transaction manager that a series of transactions are going to be performed, but that, for the purposes of undo and redo, they should all be regarded as a single transaction.

See also nsITransactionManager::beginBatch

Returns true if it is possible to redo a transaction at this time.

Returns true if it is possible to undo a transaction at this time.

void calITransactionManager::createAndCommitTxn ( in AUTF8String  aAction,
in calIItemBase  aItem,
in calICalendar  aCalendar,
in calIItemBase  aOldItem,
in calIOperationListener  aListener 
)
Parameters:
aActionThe Action to execute. This can be one of: add Adds an item modify Modfifies an item delete Deletes an item move Move an item from one calendar to the next. With this operation, aCalendar is the calendar that the event should be moved to.
aCalendarThe Calendar to execute the transaction on
aItemThe changed item for this transaction. This item should be immutable
aOldItemThe Item in its original form. Only needed for modify.
aListenerThe listener to call when the transaction has completed. This parameter can be null.

Ends the batch transaction in process.

See also nsITransactionManager::endBatch

Redo the last transaction.

Undo the last transaction in the transaction manager's stack.


Member Data Documentation

A reference to the transaction manager for calendar operations.

Definition at line 112 of file calITransactionManager.idl.


The documentation for this interface was generated from the following file: