rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvRepeatButtonInteractor Class Reference

Button interactor with auto-repeat behavior. More...

#include <ilviews/graphics/inter.h>

Inheritance diagram for IlvRepeatButtonInteractor:
IlvButtonInteractor IlvInteractor

List of all members.

Public Member Functions

 IlvRepeatButtonInteractor (IlUShort button=((IlUShort) 0x0001), IlvApplyObject action=0, IlAny arg=0)
 Constructor.
IlUInt getPeriod () const
 Returns the interactor period.
void setPeriod (IlUInt p)
 Sets the repeat period of the interactor.

Detailed Description

Button interactor with auto-repeat behavior.

Library: views

Use this class to make an object act like a repeating button. Such a button automatically repeats the action of the button, as if the user was pressing and releasing the mouse button repeatedly.

The registered name of this interactor is "RButton".

See also:
IlvButton.

Constructor & Destructor Documentation

IlvRepeatButtonInteractor::IlvRepeatButtonInteractor ( IlUShort  button = ((IlUShort) 0x0001),
IlvApplyObject  action = 0,
IlAny  arg = 0 
)

Constructor.

Initializes a new instance of the IlvRepeatButtonInteractor class, setting a function to be called when the object is clicked.

Parameters:
button The mouse button that is used for the interaction.
action The user function called on a click.
arg The user argument.

Member Function Documentation

IlUInt IlvRepeatButtonInteractor::getPeriod (  )  const

Returns the interactor period.

Returns:
The repeat period of the interactor in milliseconds.
void IlvRepeatButtonInteractor::setPeriod ( IlUInt  p  ) 

Sets the repeat period of the interactor.

Parameters:
p The new period in milliseconds.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.