Developer

API Reference

ApplyScrollProps()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
InitialiseMoreUpDownProps() InitialiseMoreLeftRightProps() Extension Helper Functions Model Events Error Codes
Description
Will update the attribute leftUpAttrId with a value between 0 and MORE_INDICATOR_RANGE which will indicate the amount of data, text, and so forth, that can be scrolled up/left. A value of zero indicates that the element cannot be scrolled up/left.
Will update the attribute rightDownAttrId with a value between 0 and MORE_INDICATOR_RANGE which will indicate the amount of data, text ect. that can be scrolled down/right. A value of zero indicates that the element cannot be scrolled down/right.
Parameters
  • pElement
    []:
    [in] Pointer to the ITrigmlElement on which to update the scroll properties.
  • classId
    []:
    [in] The class ID of the extension to which the element belongs. This should be a KTrigml*ExtensionClassId constant from an extension metadata header.
  • sev
    []:
    [in] Pointer to a ScrollEvent that describes a change in the view model.
  • leftUpAttrId
    []:
    [in] Id of the attribute that will be updated with the left/up progress value.
  • rightDownAttrId
    []:
    [in] Id of the attribute that will be updated with the right/down progress value.
Prototype
   int ApplyScrollProps(ITrigmlElement * pElement, 
                        AEECLSID classId, 
                        const ScrollEvent *sev, 
                        uint16 leftUpAttrId, 
                        uint16 rightDownAttrId);
Return
One of the Error Codes
Side Effect
Will update the values of the attribute IDs that are passed in.
Comment
If the element supports both moreup moredown and moreleft moreright attributes, then this function should be called twice, once with the moreup moredown attributes, and once again with the moreleft moreright attributes.
  • Follow