SelectionEngine Class Reference

#include <seleng.hxx>

Collaboration diagram for SelectionEngine:

Public Member Functions
	SelectionEngine (vcl::Window *pWindow, FunctionSet *pFunctions=nullptr)
	~SelectionEngine ()
	SelectionEngine (const SelectionEngine &)=delete
	SelectionEngine (SelectionEngine &&)=delete
SelectionEngine &	operator= (const SelectionEngine &)=delete
SelectionEngine &	operator= (SelectionEngine &&)=delete
bool	SelMouseButtonDown (const MouseEvent &rMEvt)
bool	SelMouseButtonUp (const MouseEvent &rMEvt)
bool	SelMouseMove (const MouseEvent &rMEvt)
void	ReleaseMouse ()
void	CaptureMouse ()
void	CursorPosChanging (bool bShift, bool bMod1)
void	SetVisibleArea (const tools::Rectangle &rNewArea)
void	SetAddMode (bool)
bool	IsAddMode () const
void	AddAlways (bool bOn)
bool	IsAlwaysAdding () const
void	EnableDrag (bool bOn)
void	SetSelectionMode (SelectionMode eMode)
SelectionMode	GetSelectionMode () const
void	SetFunctionSet (FunctionSet *pFuncs)
const FunctionSet *	GetFunctionSet () const
const Point &	GetMousePosPixel () const
const MouseEvent &	GetMouseEvent () const
void	SetWindow (vcl::Window *)
vcl::Window *	GetWindow () const
void	LockModifiers (sal_uInt16 nModifiers)
sal_uInt16	GetLockedModifiers () const
bool	IsInSelection () const
void	Reset ()
bool	Command (const CommandEvent &rCEvt)
bool	HasAnchor () const
void	SetAnchor (bool bAnchor)
void	SetUpdateInterval (sal_uLong nInterval)
void	ExpandSelectionOnMouseMove (bool bExpand=true)

Private Member Functions
	DECL_DLLPRIVATE_LINK (ImpWatchDog, Timer *, void)
bool	ShouldDeselect (bool bModifierKey1) const

Private Attributes
FunctionSet *	pFunctionSet
VclPtr< vcl::Window >	pWin
tools::Rectangle	aArea
Timer	aWTimer
MouseEvent	aLastMove
SelectionMode	eSelMode
sal_uLong	nUpdateInterval
sal_uInt16	nLockedMods
SelectionEngineFlags	nFlags

Detailed Description

Definition at line 78 of file seleng.hxx.

Constructor & Destructor Documentation

SelectionEngine::SelectionEngine	(	vcl::Window *	pWindow,
		FunctionSet *	pFunctions = nullptr
	)

Definition at line 37 of file seleng.cxx.

References aWTimer, eSelMode, EXPANDONMOVE, LINK, nFlags, nLockedMods, nUpdateInterval, pFunctionSet, Task::SetDebugName(), Timer::SetInvokeHandler(), Timer::SetTimeout(), and Single.

SelectionEngine::~SelectionEngine

(

)

Definition at line 51 of file seleng.cxx.

References aWTimer, and Task::Stop().

SelectionEngine::SelectionEngine ( const SelectionEngine &  )

delete

SelectionEngine::SelectionEngine ( SelectionEngine &&  )

delete

Member Function Documentation

void SelectionEngine::AddAlways ( bool  bOn )

inline

Definition at line 198 of file seleng.hxx.

References ADD_ALW, and nFlags.

Referenced by SvImpLBox::KeyInput(), SvImpLBox::SetSelectionMode(), and SvImpLBox::SetStyle().

void SelectionEngine::CaptureMouse

(

)

Definition at line 305 of file seleng.cxx.

References vcl::Window::CaptureMouse(), vcl::Window::IsMouseCaptured(), and pWin.

Referenced by SelMouseButtonDown(), and SetWindow().

bool SelectionEngine::Command

(

const CommandEvent &

rCEvt

)

Definition at line 367 of file seleng.cxx.

References aLastMove, aWTimer, FunctionSet::BeginDrag(), CMDEVT, DRG_ENAB, MouseEvent::GetButtons(), MouseEvent::GetClicks(), CommandEvent::GetCommand(), MouseEvent::GetMode(), MouseEvent::GetModifier(), CommandEvent::GetMousePosPixel(), IN_SEL, Task::IsActive(), CommandEvent::IsMouseEvent(), FunctionSet::IsSelectionAtPoint(), nFlags, pFunctionSet, SAL_WARN_IF, StartDrag, Task::Stop(), and WAIT_UPEVT.

Referenced by SvImpLBox::Command().

void SelectionEngine::CursorPosChanging	(	bool	bShift,
		bool	bMod1
	)

Definition at line 67 of file seleng.cxx.

References FunctionSet::CreateAnchor(), FunctionSet::DeselectAll(), FunctionSet::DestroyAnchor(), eSelMode, HAS_ANCH, IsAddMode(), nFlags, pFunctionSet, ShouldDeselect(), and Single.

Referenced by IconViewImpl::KeyInput(), and SvImpLBox::KeyInput().

SelectionEngine::DECL_DLLPRIVATE_LINK ( ImpWatchDog  , Timer *  , void    )

private

void SelectionEngine::EnableDrag ( bool  bOn )

inline

Definition at line 190 of file seleng.hxx.

References DRG_ENAB, and nFlags.

Referenced by SvImpLBox::SetDragDropMode().

void SelectionEngine::ExpandSelectionOnMouseMove ( bool  bExpand = true )

inline

Definition at line 165 of file seleng.hxx.

References EXPANDONMOVE.

Referenced by SvImpLBox::SetDragDropMode(), and SvImpLBox::SvImpLBox().

const FunctionSet* SelectionEngine::GetFunctionSet ( ) const

inline

Definition at line 141 of file seleng.hxx.

sal_uInt16 SelectionEngine::GetLockedModifiers ( ) const

inline

Definition at line 152 of file seleng.hxx.

const MouseEvent& SelectionEngine::GetMouseEvent ( ) const

inline

Definition at line 145 of file seleng.hxx.

const Point& SelectionEngine::GetMousePosPixel ( ) const

inline

Definition at line 143 of file seleng.hxx.

References MouseEvent::GetPosPixel(), and Point.

Referenced by SvImpLBox::BeginDrag().

SelectionMode SelectionEngine::GetSelectionMode ( ) const

inline

Definition at line 137 of file seleng.hxx.

Referenced by SvImpLBox::EntrySelected(), SvImpLBox::MakePointVisible(), SvImpLBox::MouseButtonDown(), SvImpLBox::MouseButtonUp(), SvImpLBox::MouseMove(), IconViewImpl::Paint(), SvImpLBox::Paint(), SvImpLBox::SetCurEntry(), SvImpLBox::SetCursor(), and SvImpLBox::SetStyle().

vcl::Window* SelectionEngine::GetWindow ( ) const

inline

Definition at line 148 of file seleng.hxx.

bool SelectionEngine::HasAnchor ( ) const

inline

Definition at line 222 of file seleng.hxx.

References HAS_ANCH, and nFlags.

bool SelectionEngine::IsAddMode ( ) const

inline

Definition at line 174 of file seleng.hxx.

References ADD_ALW, IN_ADD, and nFlags.

Referenced by CursorPosChanging(), SvImpLBox::KeyInput(), SelMouseButtonDown(), and SvImpLBox::SetCursor().

bool SelectionEngine::IsAlwaysAdding ( ) const

inline

Definition at line 206 of file seleng.hxx.

References ADD_ALW, and nFlags.

Referenced by SvImpLBox::KeyInput(), SvImpLBox::MouseButtonDown(), and SelMouseButtonUp().

bool SelectionEngine::IsInSelection ( ) const

inline

Definition at line 214 of file seleng.hxx.

References IN_SEL, and nFlags.

void SelectionEngine::LockModifiers ( sal_uInt16  nModifiers )

inline

Definition at line 150 of file seleng.hxx.

SelectionEngine& SelectionEngine::operator= ( const SelectionEngine &  )

delete

SelectionEngine& SelectionEngine::operator= ( SelectionEngine &&  )

delete

void SelectionEngine::ReleaseMouse

(

)

Definition at line 298 of file seleng.cxx.

References vcl::Window::IsMouseCaptured(), pWin, and vcl::Window::ReleaseMouse().

Referenced by Reset(), SelMouseButtonDown(), SelMouseButtonUp(), and SetWindow().

void SelectionEngine::Reset

(

void

)

Definition at line 358 of file seleng.cxx.

References aWTimer, HAS_ANCH, IN_SEL, nFlags, nLockedMods, ReleaseMouse(), and Task::Stop().

Referenced by SvImpLBox::DestroyAnchor().

bool SelectionEngine::SelMouseButtonDown

(

const MouseEvent &

rMEvt

)

Definition at line 115 of file seleng.cxx.

References ADD_ALW, aLastMove, CaptureMouse(), CMDEVT, FunctionSet::CreateAnchor(), FunctionSet::DeselectAll(), FunctionSet::DeselectAtPoint(), FunctionSet::DestroyAnchor(), DRG_ENAB, eSelMode, MouseEvent::GetClicks(), MouseEvent::GetModifier(), MouseEvent::GetPosPixel(), HAS_ANCH, IN_ADD, IN_SEL, comphelper::LibreOfficeKit::isActive(), IsAddMode(), MouseEvent::IsRight(), FunctionSet::IsSelectionAtPoint(), KEY_MOD1, KEY_MOD2, KEY_SHIFT, Multiple, nFlags, nLockedMods, pFunctionSet, Point, ReleaseMouse(), FunctionSet::SetCursorAtPoint(), Single, and WAIT_UPEVT.

Referenced by SvImpLBox::MouseButtonDown().

bool SelectionEngine::SelMouseButtonUp

(

const MouseEvent &

rMEvt

)

Definition at line 246 of file seleng.cxx.

References aLastMove, aWTimer, CMDEVT, FunctionSet::DeselectAll(), FunctionSet::DeselectAtPoint(), FunctionSet::DestroyAnchor(), eSelMode, MouseEvent::GetModifier(), MouseEvent::GetPosPixel(), HAS_ANCH, IN_SEL, IsAlwaysAdding(), MouseEvent::IsRight(), KEY_MOD1, KEY_SHIFT, nFlags, nLockedMods, pFunctionSet, ReleaseMouse(), FunctionSet::SetCursorAtPoint(), Single, Task::Stop(), and WAIT_UPEVT.

Referenced by SvImpLBox::MouseButtonUp().

bool SelectionEngine::SelMouseMove

(

const MouseEvent &

rMEvt

)

Definition at line 312 of file seleng.cxx.

References aArea, aLastMove, aWTimer, CMDEVT, tools::Rectangle::Contains(), FunctionSet::CreateAnchor(), eSelMode, EXPANDONMOVE, MouseEvent::GetPosPixel(), HAS_ANCH, IN_SEL, comphelper::LibreOfficeKit::isActive(), Task::IsActive(), nFlags, nUpdateInterval, pFunctionSet, FunctionSet::SetCursorAtPoint(), Timer::SetTimeout(), Single, Timer::Start(), and WAIT_UPEVT.

Referenced by SvImpLBox::MouseMove().

void SelectionEngine::SetAddMode ( bool  bNewMode )

inline

Definition at line 182 of file seleng.hxx.

References IN_ADD, and nFlags.

void SelectionEngine::SetAnchor ( bool  bAnchor )

inline

Definition at line 230 of file seleng.hxx.

References HAS_ANCH, and nFlags.

void SelectionEngine::SetFunctionSet ( FunctionSet *  pFuncs )

inline

Definition at line 139 of file seleng.hxx.

Referenced by SvImpLBox::SvImpLBox().

void SelectionEngine::SetSelectionMode

(

SelectionMode

eMode

)

Definition at line 62 of file seleng.cxx.

References eSelMode.

Referenced by SvImpLBox::SetSelectionMode().

void SelectionEngine::SetUpdateInterval

(

sal_uLong

nInterval

)

Definition at line 397 of file seleng.cxx.

References aWTimer, Task::IsActive(), nUpdateInterval, SELENG_AUTOREPEAT_INTERVAL_MIN, Timer::SetTimeout(), Timer::Start(), and Task::Stop().

void SelectionEngine::SetVisibleArea ( const tools::Rectangle &  rNewArea )

inline

Definition at line 125 of file seleng.hxx.

Referenced by IconViewImpl::AdjustScrollBars(), and SvImpLBox::AdjustScrollBars().

void SelectionEngine::SetWindow

(

vcl::Window *

pNewWin

)

Definition at line 346 of file seleng.cxx.

References CaptureMouse(), IN_SEL, nFlags, pWin, and ReleaseMouse().

bool SelectionEngine::ShouldDeselect ( bool  bModifierKey1 ) const

inlineprivate

Definition at line 30 of file seleng.cxx.

References eSelMode, and Multiple.

Referenced by CursorPosChanging().

Member Data Documentation

tools::Rectangle SelectionEngine::aArea

private

Definition at line 83 of file seleng.hxx.

Referenced by SelMouseMove().

MouseEvent SelectionEngine::aLastMove

private

Definition at line 85 of file seleng.hxx.

Referenced by Command(), SelMouseButtonDown(), SelMouseButtonUp(), and SelMouseMove().

Timer SelectionEngine::aWTimer

private

Definition at line 84 of file seleng.hxx.

Referenced by Command(), Reset(), SelectionEngine(), SelMouseButtonUp(), SelMouseMove(), SetUpdateInterval(), and ~SelectionEngine().

SelectionMode SelectionEngine::eSelMode

private

Definition at line 86 of file seleng.hxx.

Referenced by CursorPosChanging(), SelectionEngine(), SelMouseButtonDown(), SelMouseButtonUp(), SelMouseMove(), SetSelectionMode(), and ShouldDeselect().

SelectionEngineFlags SelectionEngine::nFlags

private

Definition at line 89 of file seleng.hxx.

Referenced by AddAlways(), Command(), CursorPosChanging(), EnableDrag(), HasAnchor(), IsAddMode(), IsAlwaysAdding(), IsInSelection(), Reset(), SelectionEngine(), SelMouseButtonDown(), SelMouseButtonUp(), SelMouseMove(), SetAddMode(), SetAnchor(), and SetWindow().

sal_uInt16 SelectionEngine::nLockedMods

private

Definition at line 88 of file seleng.hxx.

Referenced by Reset(), SelectionEngine(), SelMouseButtonDown(), and SelMouseButtonUp().

sal_uLong SelectionEngine::nUpdateInterval

private

Definition at line 87 of file seleng.hxx.

Referenced by SelectionEngine(), SelMouseMove(), and SetUpdateInterval().

FunctionSet* SelectionEngine::pFunctionSet

private

Definition at line 81 of file seleng.hxx.

Referenced by Command(), CursorPosChanging(), SelectionEngine(), SelMouseButtonDown(), SelMouseButtonUp(), and SelMouseMove().

VclPtr<vcl::Window> SelectionEngine::pWin

private

Definition at line 82 of file seleng.hxx.

Referenced by CaptureMouse(), ReleaseMouse(), and SetWindow().

---

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

• seleng.hxx
• seleng.cxx