MovableControl Class Reference

#include <MovableControl.h>

Inheritance diagram for MovableControl:

Collaboration diagram for MovableControl:

Public Member Functions
	MovableControl ()=default
	MovableControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
void	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
void	ProcessDragEvent (wxWindow *target, wxEventType eventType)
int	FindIndexInParent () const

Private Member Functions
void	OnKeyDown (wxKeyEvent &evt)
void	OnMouseCaptureLost (wxMouseCaptureLostEvent &event)
void	DragFinished ()
void	OnMouseDown (wxMouseEvent &evt)
void	OnMouseUp (wxMouseEvent &evt)
void	OnMove (wxMouseEvent &evt)

Private Attributes
bool	mDragging { false }
wxPoint	mInitialPosition
int	mTargetIndex { -1 }
int	mSourceIndex { -1 }

Detailed Description

Definition at line 43 of file MovableControl.h.

Constructor & Destructor Documentation

MovableControl() [1/2]

MovableControl::MovableControl ( )

default

MovableControl() [2/2]

MovableControl::MovableControl	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 48 of file MovableControl.cpp.

{
   Create(parent, id, pos, size, style, name);
}

References Create(), name, size, and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Here is the call graph for this function:

Member Function Documentation

Create()

void MovableControl::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 58 of file MovableControl.cpp.

{
   wxWindow::Create(parent, id, pos, size, style, name);
   Bind(wxEVT_LEFT_DOWN, &MovableControl::OnMouseDown, this);
   Bind(wxEVT_LEFT_UP, &MovableControl::OnMouseUp, this);
   Bind(wxEVT_MOTION, &MovableControl::OnMove, this);
   Bind(wxEVT_KEY_DOWN, &MovableControl::OnKeyDown, this);
   Bind(wxEVT_MOUSE_CAPTURE_LOST, &MovableControl::OnMouseCaptureLost, this);
}

References name, OnKeyDown(), OnMouseCaptureLost(), OnMouseDown(), OnMouseUp(), OnMove(), size, and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Referenced by anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::Create(), and MovableControl().

Here is the call graph for this function:

Here is the caller graph for this function:

DragFinished()

void MovableControl::DragFinished ( )

private

Definition at line 141 of file MovableControl.cpp.

{
   if(auto parent = GetParent())
   {
      wxWindowUpdateLocker freeze(this);
      ProcessDragEvent(parent, EVT_MOVABLE_CONTROL_DRAG_FINISHED);
   }
   mDragging = false;
}

References mDragging, and ProcessDragEvent().

Referenced by OnMouseCaptureLost(), OnMouseDown(), and OnMouseUp().

Here is the call graph for this function:

Here is the caller graph for this function:

FindIndexInParent()

int MovableControl::FindIndexInParent

(

)

const

Definition at line 82 of file MovableControl.cpp.

{
   auto parent = GetParent();
   if(!parent)
      return -1;
 
   if(auto sizer = parent->GetSizer())
   {
      for(size_t i = 0, count = sizer->GetItemCount(); i < count; ++i)
      {
         if(sizer->GetItem(i)->GetWindow() == this)
            return static_cast<int>(i);
      }
   }
   return -1;
}

Referenced by OnKeyDown(), and OnMouseDown().

Here is the caller graph for this function:

OnKeyDown()

void MovableControl::OnKeyDown ( wxKeyEvent &  evt )

private

Definition at line 99 of file MovableControl.cpp.

{
   const auto keyCode = evt.GetKeyCode();
   if(evt.AltDown() && (keyCode == WXK_DOWN || keyCode == WXK_UP))
   {
#ifdef __WXOSX__
      {//don't allow auto-repeats
         static long lastEventTimestamp = 0;
         if(lastEventTimestamp == evt.GetTimestamp())
            return;//don't skip
         lastEventTimestamp = evt.GetTimestamp();
      }
#endif
      const auto sourceIndex = FindIndexInParent();
      if(sourceIndex == -1)
      {
         evt.Skip();
         return;
      }
      
      const auto targetIndex = std::clamp(
         keyCode == WXK_DOWN ? sourceIndex + 1 : sourceIndex - 1,
         0,
         static_cast<int>(GetParent()->GetSizer()->GetItemCount()) - 1
      );
      if(sourceIndex != targetIndex)
      {
         mSourceIndex = sourceIndex;
         mTargetIndex = targetIndex;
         ProcessDragEvent(GetParent(), EVT_MOVABLE_CONTROL_DRAG_FINISHED);
      }
   }
   else
      evt.Skip();
}

References FindIndexInParent(), mSourceIndex, mTargetIndex, and ProcessDragEvent().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMouseCaptureLost()

void MovableControl::OnMouseCaptureLost ( wxMouseCaptureLostEvent &  event )

private

Definition at line 135 of file MovableControl.cpp.

{
   if(mDragging)
      DragFinished();
}

References DragFinished(), and mDragging.

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMouseDown()

void MovableControl::OnMouseDown ( wxMouseEvent &  evt )

private

Definition at line 151 of file MovableControl.cpp.

{
   if(mDragging)
   {
      DragFinished();
      return;
   }
 
   mSourceIndex = mTargetIndex = FindIndexInParent();
   if(mSourceIndex != -1)
   {
      CaptureMouse();
      ProcessDragEvent(GetParent(), EVT_MOVABLE_CONTROL_DRAG_STARTED);
 
      mInitialPosition = evt.GetPosition();
      mDragging=true;
   }
}

References DragFinished(), FindIndexInParent(), mDragging, mInitialPosition, mSourceIndex, mTargetIndex, and ProcessDragEvent().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMouseUp()

void MovableControl::OnMouseUp ( wxMouseEvent &  evt )

private

Definition at line 170 of file MovableControl.cpp.

{
   if(!mDragging)
      return;
 
   ReleaseMouse();
 
   DragFinished();
}

References DragFinished(), and mDragging.

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMove()

void MovableControl::OnMove ( wxMouseEvent &  evt )

private

Definition at line 180 of file MovableControl.cpp.

{
   if(!mDragging)
      return;
 
   auto parent = GetParent();
   if(!parent)
      return;
 
   wxPoint newPosition = wxGetMousePosition() - mInitialPosition;
   Move(GetParent()->ScreenToClient(newPosition));
 
   if(auto boxSizer = dynamic_cast<wxBoxSizer*>(parent->GetSizer()))
   {
      if(boxSizer->GetOrientation() == wxVERTICAL)
      {
         auto targetIndex = mSourceIndex;
 
         //assuming that items are ordered from top to bottom (i > j <=> y(i) > y(j))
         //compare wxSizerItem position with the current MovableControl position!
         if(GetPosition().y < boxSizer->GetItem(mSourceIndex)->GetPosition().y)
         {
            //moving up
            for(int i = 0; i < mSourceIndex; ++i)
            {
               const auto item = boxSizer->GetItem(i);
 
               if(GetRect().GetTop() <= item->GetPosition().y + item->GetSize().y / 2)
               {
                  targetIndex = i;
                  break;
               }
            }
         }
         else
         {
            //moving down
            for(int i = static_cast<int>(boxSizer->GetItemCount()) - 1; i > mSourceIndex; --i)
            {
               const auto item = boxSizer->GetItem(i);
               if(GetRect().GetBottom() >= item->GetPosition().y + item->GetSize().y / 2)
               {
                  targetIndex = i;
                  break;
               }
            }
         }
 
         if(targetIndex != mTargetIndex)
         {
            mTargetIndex = targetIndex;
            ProcessDragEvent(parent, EVT_MOVABLE_CONTROL_DRAG_POSITION);
         }
      }
   }
}

References mDragging, mInitialPosition, mSourceIndex, mTargetIndex, and ProcessDragEvent().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessDragEvent()

void MovableControl::ProcessDragEvent	(	wxWindow *	target,
		wxEventType	eventType
	)

Definition at line 73 of file MovableControl.cpp.

{
   MovableControlEvent event(eventType);
   event.SetSourceIndex(mSourceIndex);
   event.SetTargetIndex(mTargetIndex);
   event.SetEventObject(this);
   target->GetEventHandler()->ProcessEvent(event);
}

References mSourceIndex, and mTargetIndex.

Referenced by DragFinished(), OnKeyDown(), OnMouseDown(), and OnMove().

Here is the caller graph for this function:

Member Data Documentation

mDragging

bool MovableControl::mDragging { false }

private

Definition at line 45 of file MovableControl.h.

Referenced by DragFinished(), OnMouseCaptureLost(), OnMouseDown(), OnMouseUp(), and OnMove().

mInitialPosition

wxPoint MovableControl::mInitialPosition

private

Definition at line 46 of file MovableControl.h.

Referenced by OnMouseDown(), and OnMove().

mSourceIndex

int MovableControl::mSourceIndex { -1 }

private

Definition at line 49 of file MovableControl.h.

Referenced by OnKeyDown(), OnMouseDown(), OnMove(), and ProcessDragEvent().

mTargetIndex

int MovableControl::mTargetIndex { -1 }

private

Definition at line 48 of file MovableControl.h.

Referenced by OnKeyDown(), OnMouseDown(), OnMove(), and ProcessDragEvent().

---

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

• MovableControl.h
• MovableControl.cpp