MButtonState

Flow Wiki

MButtonState

• FAccessProperty
  

• AccessRole
  

• AccessDescription
  

• AccessKbdShortcutString
  

• AccessSelectable
  

• AccessCallback
  

• AccessChildSelected
  

• AccessFocused
  

• AccessState
  

  • FAccessTabindex
    

    • tabindex : Transform<int>
      

  • FAccessEnabled
    

    • enabled : Transform<bool>
      

  • FAccessAttribute
    

    • name : string
      
    • value : Transform<string>
      

  • FAccessStyle
    

    • name : string
      
    • value : Transform<string>
      

  • FAccessTabOrder
    

    • tabOrder : Transform<[ int ]>
      

  • FAccessZorder
    

    • zOrder : Transform<int>
      

  • FAccessVisible
    

    • visible : Transform<bool>
      

• TagName
  

• LangAttribute
  

• MouseOnDownAroundState
  

  • MOnClick
    Only one type of MOnClick* is called when several conflicting styles are used.
    For example if button has MOnClick and MOnTripleClick, only MOnTripleClick on triple click.
    If click starts some async task, then consider to use MOnClickAsync instead
    

    • click : () -> void
      

  • MOnMiddleClick
    

    • click : () -> void
      

  • MOnRightClick
    

    • click : () -> void
      

  • MMousePosition
    Mouse coordinates inside component
    

    • point : DynamicBehaviour<Point>
      

  • MOnDoubleClick
    

    • click : () -> void
      

  • MOnTripleClick
    

    • click : () -> void
      

  • MOnClickAsync
    Blocks button till the end of async action started by the click
    

    • click : (() -> void) -> void
      

  • MOnLongClick
    

    • click : () -> void
      

  • MOnLongTouch
    

    • touch : () -> void
      

  • MLongTouchDelay
    

    • delay : int
      

  • MOnTouch
    ms, 500 by default
    

    • delay : int
      
    • touch : () -> void
      

  • MDisableHover
    

  • MInteractionId
    Id used in manager.currentInteractionItemID
    

    • id : int
      

  • MPassClicks
    Pass clicks to elements below
    

  • MAdditionalRollOutCheck
    Additional check for roll out
    Useful in cases when your component translated to different point while mouse inside
    

  • MMobileForceHover
    Force hover on mobile
    

• TButtonState
  

  • MEnabled
    Disables inner clickable materials in most of the components
    

    • enabled : Transform<bool>
      

  • MOnMouseDown
    

    • down : (point : Point, inside : bool) -> void
      

  • MOnMouseUp
    

    • up : (point : Point, inside : bool) -> void
      

  • MInteractionsOnTop
    Move interactions on top of the component
    

  • MRightDown
    

    • down : DynamicBehaviour<bool>
      

  • MMiddleDown
    

    • down : DynamicBehaviour<bool>
      

• MFocusEnabled
  Enable or disable shortcuts and keys for focus, theme changer and feedback snapshots.
  

  • enabled : Transform<bool>
    

• MForceFocusEnabled
  Force focus enabled
  

  • enabled : Transform<bool>
    

• MFocusOnPrevious
  Focus on previously focused item after focus is lost on current
  

• MShortcut
  Keyboard shortcut to active the button
  

  • shortcut : string
    

• MShortcutKeyCodeComparison
  Compare shortcuts by keycode instead of utf-8 character.
  

• MShortcutPreventDefault
  Call preventDefault
  

• MDefaultShortcutEnabled
  Enable default enter/space apply shortcut
  True by default
  

  • enabled : Transform<bool>
    

• MRippleStyle
  

  • MRippleColor
    Color of the ripple
    

    • color : Transform<MThemeColor>
      

  • MRippleOpacity
    Opacity of the ripple
    

    • opacity : Transform<double>
      

  • MRippleType
    Inspector
    Type of the ripple animation
    

    • type : Transform<RippleType>
      

  • MRipplePosition
    Position of top left corner of the ripple
    

    • position : Transform<Point>
      

  • MRippleShape
    

    • component : string
      

  • MRippleOverlay
    

    • overlay : bool
      

  • MRippleWidthHeight
    

    • wh : Transform<WidthHeight>
      

  • MRippleFocused
    default: true
    

    • focused : Transform<bool>
      

  • MRippleHovered
    

    • hovered : Transform<bool>
      

  • MRippleSelected
    

    • selected : Transform<bool>
      

  • MEnabled
    Disables inner clickable materials in most of the components
    

    • enabled : Transform<bool>
      

  • MRipplePercents
    

    • growth : DynamicBehaviour<double>
      
    • fade : DynamicBehaviour<double>
      

• MFocusOnDown
  Set focus to true on mouse down inside
  

  • enabled : ref bool
    

• MKeepFocusOnDown
  Doen't drop focus on mouse down inside
  

  • enabled : ref bool
    

• MHighlightOnFocus
  Add highlight if focused, selected or hovered
  

  • enabled : Transform<bool>
    

• MHighlightOnHover
  

  • enabled : Transform<bool>
    

• MHighlightOnSelect
  

  • enabled : Transform<bool>
    

• MCursorShape
  Shape of the cursor inside, disabled if MEnabled is disabled too
  

  • shape : Transform<CursorShape>
    

• MClickEnabled
  Disable any mouse interaction without making component disabled
  

  • enabled : Transform<bool>
    

• MHoverEnabled
  Disable hover
  

  • enabled : Transform<bool>
    

• MShortcutFilter
  Function to decide if shortcut should be handled or not
  

  • filterFn : (focused : bool, keyEvent : KeyEvent) -> bool
    

• MTooltipText
  Simple tooltip
  

  • text : Transform<string>
    

• MFocused
  Shows is this component focused
  Also allows to set focus
  

  • focused : DynamicBehaviour<bool>
    

• MSelected
  

  • selected : DynamicBehaviour<bool>
    

• MActive
  

  • active : DynamicBehaviour<bool>
    

• MKeepFocusOnClickOut
  Keep focus on clicks outside this component
  

• IScriptBehaviour
  

  • name : string
    
  • beh : DynamicBehaviour<flow>
    
  • type : IScriptRecordType
    

• IScriptId
  

  • id : string
    

• IScriptRecordingEnabled
  

  • enabled : Transform<bool>
    

• MFocusId
  Set MFocus id which acts also as taborder inside parent MFocusGroup
  Components with same MFocusId inside same parent can cause problems
  

  • id : Transform<int>
    

• MAddFocusGroup
  Wrap constructed MFocus and constructed content with MFocusGroup
  

  • add : bool
    

• MGetFocus
  Get contructed inside the component MFocus
  

  • getFn : (MFocus) -> void
    

• MElevation
  Elevation on focus (8. by default)
  

  • elevation : Transform<double>
    

• MFocusName
  

  • name : string
    

• MButtonTitle
  

  • title : Transform<string>
    

• MOnFocus
  Called when component gets or loses focus
  

  • onFocus : (focus : bool) -> void