Namespace: |
|
Type: |
embedded complexType |
Content: |
empty, 7 attributes |
Defined: |
globally within component.xsd, see XML source |
Used: |
at 1 location |
XML Representation Summary |
|||
<event |
|||
category | = |
xsd:string |
|
descriptionKey | = |
xsd:string |
|
displayName | = |
xsd:string |
|
group | = |
xsd:string |
|
handlerNameTemplate | = |
xsd:string |
|
helpKey | = |
xsd:string |
|
name | = |
xsd:string |
|
/> |
<xsd:element name="event"> <xsd:annotation> <xsd:documentation>The definition of a single event.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:annotation> <xsd:documentation> The internal name for the event. This does not need to be a dotted name, but it must be unique within the component and its base components. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> This displayable name for the event. This value should be localized. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Categories are used for grouping events in the Events view. As with property categories, this can be a key to a category localized by the component provider, or it can be a pre-localized or literal string. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> A key for descriptive information about the event. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation>A help topic for online help for the event.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> A template which is expanded to the proposed default name for the event handler function. An example of such a template is "Handle{title(name)}StateChangedL". The {} marks template variables. A variable may contain a simple property value, but generally only the 'name' property should be used. The pseudo-functions "lower", "upper", and "title" may be used to transform the property value. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> This is a grouping, separate from categories, used in event filtering. Events may only make sense for specific containers. The interface com.nokia.sdt.datamodel.adapter.IComponentEventInfo is used to filter applicable events from the complete set of declared events. When deriving from an existing base component it is not generally necessary to implement this interface. Instead, just use the groups defined by the base component in your own events. For example to make events visible in a CCoeControl container, The CCoeControlBase component uses the filter group "Control". </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> |
Type: |
xsd:string |
Use: |
optional |
Defined: |
locally, within this element |
<xsd:attribute name="category" type="xsd:string"> <xsd:annotation> <xsd:documentation> Categories are used for grouping events in the Events view. As with property categories, this can be a key to a category localized by the component provider, or it can be a pre-localized or literal string. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
optional |
Defined: |
locally, within this element |
<xsd:attribute name="descriptionKey" type="xsd:string"> <xsd:annotation> <xsd:documentation> A key for descriptive information about the event. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
optional |
Defined: |
locally, within this element |
<xsd:attribute name="displayName" type="xsd:string"> <xsd:annotation> <xsd:documentation> This displayable name for the event. This value should be localized. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
optional |
Defined: |
locally, within this element |
<xsd:attribute name="group" type="xsd:string"> <xsd:annotation> <xsd:documentation> This is a grouping, separate from categories, used in event filtering. Events may only make sense for specific containers. The interface com.nokia.sdt.datamodel.adapter.IComponentEventInfo is used to filter applicable events from the complete set of declared events. When deriving from an existing base component it is not generally necessary to implement this interface. Instead, just use the groups defined by the base component in your own events. For example to make events visible in a CCoeControl container, The CCoeControlBase component uses the filter group "Control". </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
required |
Defined: |
locally, within this element |
<xsd:attribute name="handlerNameTemplate" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation> A template which is expanded to the proposed default name for the event handler function. An example of such a template is "Handle{title(name)}StateChangedL". The {} marks template variables. A variable may contain a simple property value, but generally only the 'name' property should be used. The pseudo-functions "lower", "upper", and "title" may be used to transform the property value. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
optional |
Defined: |
locally, within this element |
<xsd:attribute name="helpKey" type="xsd:string"> <xsd:annotation> <xsd:documentation>A help topic for online help for the event.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
xsd:string |
Use: |
required |
Defined: |
locally, within this element |
<xsd:attribute name="name" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation> The internal name for the event. This does not need to be a dotted name, but it must be unique within the component and its base components. </xsd:documentation> </xsd:annotation> </xsd:attribute> |