ShotSelector.ShotSelector Class Reference

#include <class_shot_selector_1_1_shot_selector.h>

Inheritance diagram for ShotSelector.ShotSelector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  GetList ()
  cleanup ()
  highlight ()
  Call when you want to highlight a control at the specified position.
  select ()
  Call when you want to select a control at the specified position.
  release ()
  Mouse up event.
  popupMenu ()
  If the UI wants to show a popup menu then this is the time to do it.
  scrollUp ()
  Map scroll up on mouse wheel to scroll left in shot selector Return True if event handled.
  scrollDown ()
  Map scroll down on mouse wheel to scroll right in shot selector Return True if event handled.
  Frame ()
  Called on each frame update.
  setVisible ()
  setSize ()
  Returns True if the sizing was actually modified.
  setSelectedShot ()
  setShotShowPlayState ()
  setShotShowLoopState ()
  getHotkeyTrigger ()
  setShots ()
  selectCallback ()
  This method is called whenever a control in the list is selected.
  doubleClickCallback ()
  This method is called whenever a control in the list is double clicked.

Public Attributes

string  kShotPlaying = "ShotPlaying"
string  kShotPaused = "ShotPaused"
string  kShotStopped = "ShotStopped"

Member Function Documentation

ShotSelector.ShotSelector.__init__ ( )
ShotSelector.ShotSelector.GetList ( )
ShotSelector.ShotSelector.cleanup ( )
ShotSelector.ShotSelector.highlight ( )

Call when you want to highlight a control at the specified position.

Test each control in the UI to see if it contains the given position. Return the control containing the position, or None if no control does.

ShotSelector.ShotSelector.select ( )

Call when you want to select a control at the specified position.

Test each control in the UI to see if it contains the given position.

Return the control containing the position, or None if no control does.

ShotSelector.ShotSelector.release ( )

Mouse up event.

Deselect any selected controls Return True if handled

ShotSelector.ShotSelector.popupMenu ( )

If the UI wants to show a popup menu then this is the time to do it.

The popup menu may vary depending on what part of the UI the mouse pointer is over. Use the position argument to determine what UI is under the pointer.

Return True if the position argument is over a part of the UI. You should return True whether you show a popup menu or not.

ShotSelector.ShotSelector.scrollUp ( )

Map scroll up on mouse wheel to scroll left in shot selector Return True if event handled.

ShotSelector.ShotSelector.scrollDown ( )

Map scroll down on mouse wheel to scroll right in shot selector Return True if event handled.

ShotSelector.ShotSelector.Frame ( )

Called on each frame update.

Inform lists of the frame.

Reimplemented from UiSelector.UiSelector.

ShotSelector.ShotSelector.setVisible ( )
ShotSelector.ShotSelector.setSize ( )

Returns True if the sizing was actually modified.

Reimplemented from UiSelector.UiSelector.

ShotSelector.ShotSelector.setSelectedShot ( )
ShotSelector.ShotSelector.setShotShowPlayState ( )
ShotSelector.ShotSelector.setShotShowLoopState ( )
ShotSelector.ShotSelector.getHotkeyTrigger ( )
ShotSelector.ShotSelector.setShots ( )
ShotSelector.ShotSelector.selectCallback ( )

This method is called whenever a control in the list is selected.

ShotSelector.ShotSelector.doubleClickCallback ( )

This method is called whenever a control in the list is double clicked.


Member Data Documentation


ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector
ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector ShotSelector.ShotSelector