doc/signals.txt
branchnew-model
changeset 909 aa0e42229784
parent 908 f56199193fad
child 910 b9f1bd52df9a
equal deleted inserted replaced
908:f56199193fad 909:aa0e42229784
     1 This is the list of the signals sent by the different widgets :
       
     2 
       
     3 Mediafragments
       
     4 ==============    
       
     5     IriSP.Mediafragment.hashchange(hashvalue): This message is used by the iframe embed code to relay data
       
     6     outside of the iframe. This message sends as a parameter the
       
     7     new anchor value of the url.
       
     8             
       
     9     IriSP.Mediafragment.showAnnotation(annotationId): This message is sent when the mediafragment code 
       
    10                                                       has fast-forwarded to the beginning of an annotation
       
    11                                                       specified in the url. The subscribing widgets receive
       
    12                                                       the id of the annotation and can highlight it if they
       
    13                                                       want.
       
    14 
       
    15 PlayerWidget
       
    16 ============                                                      
       
    17     IriSP.PlayerWidget.AnnotateButton.clicked: sent whenever the "Annotate" button is clicked on the player widget.
       
    18     IriSP.PlayerWidget.MouseOver: sent when the mouse is hovering the widget. Used to maximize the sliderWidget to 
       
    19                                   get a behaviour similar to youtube.
       
    20     IriSP.PlayerWidget.MouseOut: sent when the mouse has left the widget.
       
    21     
       
    22     IriSP.search.open: sent when the searchbox has been opened
       
    23     IriSP.search.closed: sent when the searchbox has been closed
       
    24     IriSP.search(searchQuery): sent whenever the user presses a key in the searchfield. Param searchQuery 
       
    25                                holds the contents of the search field. 
       
    26     
       
    27     IriSP.search.triggeredSearch(searchText): triggered by other widgets when they want to launch a new search. searchText is the search term. 
       
    28     IriSP.search.noMatchFound: triggered by other widgets to indicate that they've not found content matching the search terms.
       
    29     IriSP.search.matchFound: triggered by other widgets to indicate that they've found content matching the search terms.
       
    30     Note: the PlayerWidget changes the highlighting of the search box depending on if it has received these messages.
       
    31     
       
    32 ArrowWidget
       
    33 ===========
       
    34     IriSP.ArrowWidget.blockArrow: prevent the ArrowWidget from moving automatically
       
    35     IriSP.ArrowWidget.releaseArrow: restore the ArrowWidget to its non-blocked state
       
    36 
       
    37 SliceWidget
       
    38 ===========
       
    39 
       
    40     IriSP.SliceWidget.hide: sent to the SliceWidget. hides the widget.
       
    41     IriSP.SliceWidget.show: sent to the SliceWidget. shows the widget.
       
    42     IriSP.SliceWidget.position, [left, width]: sent to the SliceWidget. Param is an array with the 
       
    43                                                left position and the width of the zone, in percents.
       
    44     IriSP.SliceWidget.zoneChange [left, width]: sent by the widget whenever the user moves the widget. The parameter
       
    45                                                 is an array with the left position of the zone its width. Both values
       
    46                                                 are in percents.
       
    47 
       
    48 AnnotationWidget
       
    49 ================                                               
       
    50     
       
    51     IriSP.AnnotationsWidget.show: received by the AnnotationsWidget. hides the widget.
       
    52     IriSP.AnnotationsWidget.hide: received by the AnnotationsWidget. shows the widget.
       
    53 
       
    54 
       
    55 CreateAnnotationWidget
       
    56 ======================
       
    57     
       
    58     IriSP.createAnnotationWidget.addedAnnotation(annotation): sent by the widget when an annotation has been created.
       
    59                                                               passes the annotation dict as parameter.
       
    60                                                               
       
    61 PolemicWidget
       
    62 =============
       
    63     
       
    64     IriSP.PolemicTweet.click(elementId): sent by the widget when the user clicks on it. Passes the annotation id as a param.
       
    65                                          the mediafragment modules listens to this message to update the url accordingly.
       
    66                                          
       
    67 SegmentsWidget
       
    68 ==============
       
    69 
       
    70    IriSP.SegmentsWidget.click(annotationId): sent by the widget when the user clicks on it. Passes the annotation id as a param.
       
    71                                          the mediafragment modules listens to this message to update the url accordingly.
       
    72 
       
    73 SparklineWidget
       
    74 ===============
       
    75 
       
    76      IriSP.SparklineWidget.clicked(newTime): sent whenever the sparkline widget is clicked. Param newTime is the new time the video
       
    77                                              is seeking too. The mediafragment module listens to this.
       
    78                                              
       
    79 StackGraphWidget
       
    80 =================
       
    81 
       
    82      IriSP.StackGraphWidget.clicked(newTime): sent whenever the stackgraph widget is clicked. Param newTime is the new time the video
       
    83                                              is seeking too. The mediafragment module listens to this.