[top] > parcels > osaf > framework > blocks > NewItemEvent (Kind)
Description: Adds or creates a new Item, adds it to a C{collection} and displays it properly. If the event's arguments dictionary contains an item with the key "item", that will be used as the item to display. Otherwise if the NewItemEvent implements the C{onNewItem} method it will be called to create the item. This is handy if you want to use a dialog to get some information to create the item. If C{onNewItem} returns None, no Item will be created. If you didn't implement C{onNewItem} the C{classParameter} attribute is used to determine what item to create. The attribute has a default value of C{MissingClass}; in this case in Item matching the ApplicationBar is created; e.g. if you're in Calendar View you'll get an Item that has been stamped as an Event; if you're in All you'll get a Note. To create a specific item, you can either: 1. Specify a Kind's class as the C{classParameter} e.g. C{osaf.pim.Note} will force creation of a Note, no matter what's selected in the ApplicationBar. 2. Specify a subclass of C{osaf.pim.Stamp} to create a Note with the appropriate stamp. E.g. C{osaf.pim.Task} will get you a Task Item (i.e. a Note stamped as a Task). The view in the sidebar is switched to match the kind, e.g. if you create an Event, you'll switch to the Calendar View. If there isn't a kind specific view, you'll switch to All view. If the C{collection} is None or it's not a UserCollection, the Item will be added to the all collection. If you specify a C{collectionAddEvent} that references an AddToSidebarEvent and your C{collection} is not in the Sidebar, it will be used to add your C{collection} if it's not in the sidebar.
Child items: collection, collectionAddEvent, commitAfterDispatch, dispatchEnum, methodName
Attributes defined for this kind:
Attribute (inherited from) Description / Issues Cardinality Type Initial Value Required?
blockName (from BlockEvent) single Text N/A No
classParameter (from ClassParameterizedEvent) single Class N/A No
collection single ContentCollection N/A No
collectionAddEvent single BlockEvent N/A No
commitAfterDispatch single Boolean True No
description (from Item)   single Bytes N/A No
destinationBlockReference (from BlockEvent) single Block N/A No
dispatchEnum single dispatchEnumType ActiveViewBubbleUp No
dispatchToBlockName (from BlockEvent) single Text N/A No
freeValueOf (from Item) (inverse: 'freeValues')   dict N/A N/A No
freeValues (from Item) (inverse: 'freeValueOf')   dict N/A N/A No
inheritFrom (from Item) (inverse: 'inheritTo')   single N/A N/A No
inheritTo (from Item) (inverse: 'inheritFrom')   list N/A N/A No
menuOrToolForEvent (from BlockEvent) (inverse: 'event') list BaseItem N/A No
methodName single Text onNewItemEvent No
monitors (from Item) (inverse: 'item')   list N/A N/A No
osaf.framework.blocks.BranchPointBlock.detailItem.inverse (from Item) (inverse: 'detailItem') list BranchPointBlock N/A No
osaf.framework.blocks.BranchPointBlock.detailItemCollection.inverse (from Item) (inverse: 'detailItemCollection') list BranchPointBlock N/A No
osaf.framework.blocks.BranchPointBlock.selectedItem.inverse (from Item) (inverse: 'selectedItem') list BranchPointBlock N/A No
p2p.mail.MailAccount.imap.inverse (from Item) (inverse: 'imap') list MailAccount N/A No
p2p.mail.MailAccount.smtp.inverse (from Item) (inverse: 'smtp') list MailAccount N/A No
references (from Item) (inverse: 'item')   list Item N/A No
watchers (from Item) (inverse: 'watchedItems')   dict N/A N/A No
watches (from Item) (inverse: 'watchingItem')   list N/A N/A No

Attribute values for this item:
Attribute Value
classespython: class 'osaf.framework.blocks.Block.NewItemEvent' (class 'application.schema.ItemClass')
clouds
description Adds or creates a new Item, adds it to a C{collection} and displays it properly. If the event's arguments dictionary contains an item with the key "item", that will be used as the item to display. Otherwise if the NewItemEvent implements the C{onNewItem} method it will be called to create the item. This is handy if you want to use a dialog to get some information to create the item. If C{onNewItem} returns None, no Item will be created. If you didn't implement C{onNewItem} the C{classParameter} attribute is used to determine what item to create. The attribute has a default value of C{MissingClass}; in this case in Item matching the ApplicationBar is created; e.g. if you're in Calendar View you'll get an Item that has been stamped as an Event; if you're in All you'll get a Note. To create a specific item, you can either: 1. Specify a Kind's class as the C{classParameter} e.g. C{osaf.pim.Note} will force creation of a Note, no matter what's selected in the ApplicationBar. 2. Specify a subclass of C{osaf.pim.Stamp} to create a Note with the appropriate stamp. E.g. C{osaf.pim.Task} will get you a Task Item (i.e. a Note stamped as a Task). The view in the sidebar is switched to match the kind, e.g. if you create an Event, you'll switch to the Calendar View. If there isn't a kind specific view, you'll switch to All view. If the C{collection} is None or it's not a UserCollection, the Item will be added to the all collection. If you specify a C{collectionAddEvent} that references an AddToSidebarEvent and your C{collection} is not in the Sidebar, it will be used to add your C{collection} if it's not in the sidebar. (type 'str')
extentNone
subKindsImportCertificateEvent, NewImageEvent
superKindsClassParameterizedEvent

Clouds associated with this kind:
Cloud Endpoints
copying classParameter in cloud //parcels/osaf/framework/blocks/ClassParameterizedEvent/CopyingCloud: (alias 'classParameter') policy 'byRef'
destinationBlockReference in cloud //parcels/osaf/framework/blocks/BlockEvent/CopyingCloud: (alias 'destinationBlockReference') policy 'byRef'
menuOrToolForEvent in cloud //parcels/osaf/framework/blocks/BlockEvent/CopyingCloud: (alias 'menuOrToolForEvent') policy 'byRef'