finalcut::FMouse Class Reference

Inheritance diagram for finalcut::FMouse:

Collaboration diagram for finalcut::FMouse:

Public Types
enum	MouseType {   None = 0, Gpm = 1, X11 = 2, Sgr = 3,   Urxvt = 4 }

Public Member Functions
auto	getClassName () const -> FString override
auto	getMouseTypeID () const noexcept -> MouseType
void	clearEvent () noexcept
void	setMaxWidth (uInt16) noexcept
void	setMaxHeight (uInt16) noexcept
void	setDblclickInterval (const uInt64) noexcept
virtual auto	hasData () -> bool=0
auto	hasEvent () const noexcept -> bool
auto	hasUnprocessedInput () const noexcept -> bool
virtual void	setRawData (FKeyboard::keybuffer &)=0
virtual void	processEvent (const TimeValue &)=0
Public Member Functions inherited from finalcut::FMouseData
	FMouseData (const FMouseData &)=default
	FMouseData (FMouseData &&) noexcept=default
auto	operator= (const FMouseData &) -> FMouseData &=default
auto	operator= (FMouseData &&) noexcept -> FMouseData &=default
auto	getPos () const &noexcept -> const FPoint &
auto	isLeftButtonPressed () const noexcept -> bool
auto	isLeftButtonReleased () const noexcept -> bool
auto	isLeftButtonDoubleClick () const noexcept -> bool
auto	isRightButtonPressed () const noexcept -> bool
auto	isRightButtonReleased () const noexcept -> bool
auto	isMiddleButtonPressed () const noexcept -> bool
auto	isMiddleButtonReleased () const noexcept -> bool
auto	isShiftKeyPressed () const noexcept -> bool
auto	isControlKeyPressed () const noexcept -> bool
auto	isMetaKeyPressed () const noexcept -> bool
auto	isWheelUp () const noexcept -> bool
auto	isWheelDown () const noexcept -> bool
auto	isMoved () const noexcept -> bool
void	clearButtonState () noexcept

Static Public Member Functions
template<typename ClassT >
static auto	createMouseObject () -> std::unique_ptr< ClassT >

Protected Member Functions
auto	getNewPos () const &noexcept -> const FPoint &
auto	getMaxWidth () const noexcept -> uInt16
auto	getMaxHeight () const noexcept -> uInt16
auto	getDblclickInterval () const noexcept -> uInt64
auto	getMousePressedTime () const noexcept -> TimeValue
void	setMouseTypeID (MouseType) noexcept
void	setNewPos (int, int) noexcept
void	useNewPos () noexcept
void	setPending (bool=true) noexcept
void	setEvent () noexcept
void	setMousePressedTime (const TimeValue &) noexcept
void	resetMousePressedTime () noexcept
auto	isDblclickTimeout (const TimeValue &) const -> bool
Protected Member Functions inherited from finalcut::FMouseData
auto	getButtonState () &noexcept -> FMouseButton &
auto	getButtonState () const &noexcept -> const FMouseButton &
void	setPos (const FPoint &) noexcept

Additional Inherited Members
Protected Types inherited from finalcut::FMouseData
enum	State : uChar { Undefined = 0, Pressed = 1, Released = 2, DoubleClick = 3 }

---

The documentation for this class was generated from the following files:

• final/input/fmouse.h
• final/input/fmouse.cpp