Grabber Class Reference

The widget to the left of a ToolBar that allows it to be dragged around to NEW positions. More...

#include <Grabber.h>

Inheritance diagram for Grabber:

Collaboration diagram for Grabber:

Public Member Functions
	Grabber (wxWindow *parent, Identifier id)
	Methods for Grabber. More...
virtual	~Grabber ()
bool	AcceptsFocusFromKeyboard () const override
void	PushButton (bool state)
void	SetAsSpacer (bool bIsSpacer)
void	SetToolTip (const TranslatableString &toolTip)

Protected Member Functions
void	OnLeftDown (wxMouseEvent &event)
void	OnLeftUp (wxMouseEvent &event)
void	OnEnter (wxMouseEvent &event)
void	OnLeave (wxMouseEvent &event)
void	OnErase (wxEraseEvent &event)
void	OnPaint (wxPaintEvent &event)
void	OnKeyDown (wxKeyEvent &event)

Private Member Functions
void	DrawGrabber (wxDC &dc)
void	SendEvent (wxEventType type, const wxPoint &pos, bool escaping)

Private Attributes
const Identifier	mIdentifier
bool	mOver
bool	mPressed
bool	mAsSpacer

Detailed Description

The widget to the left of a ToolBar that allows it to be dragged around to NEW positions.

Definition at line 106 of file Grabber.h.

Constructor & Destructor Documentation

Grabber()

Grabber::Grabber	(	wxWindow *	parent,
		Identifier	id
	)

Methods for Grabber.

Definition at line 54 of file Grabber.cpp.

: wxWindow(parent,
           wxID_ANY,
           wxDefaultPosition,
           wxSize(grabberWidth, 27),
           wxFULL_REPAINT_ON_RESIZE)
, mIdentifier{ id }
{
   mOver = false;
   mPressed = false;
   mAsSpacer = false;
   SetBackgroundColour( theTheme.Colour( clrMedium ) );
 
   /* i18n-hint: A 'Grabber' is a region you can click and drag on
   It's used to drag a track around (when in multi-tool mode) rather
   than requiring that you use the drag tool.  It's shown as a series
   of horizontal bumps */
   SetLabel(_("Grabber"));
   SetName(_("Grabber"));
}

~Grabber()

Grabber::~Grabber ( )

virtual

Definition at line 78 of file Grabber.cpp.

{
}

Member Function Documentation

AcceptsFocusFromKeyboard()

bool Grabber::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 120 of file Grabber.h.

{return false;}

DrawGrabber()

void Grabber::DrawGrabber ( wxDC &  dc )

private

Definition at line 117 of file Grabber.cpp.

{
   wxRect r = GetRect();
   // PaintDC positions are relative to the grabber, not the parent window.
   // So use 0,0 as origin for draw, so that the grabber draws right if 
   // positioned in its parent at some non zero position.
   r.SetPosition( wxPoint(0,0) );
   int y, left, right, top, bottom;
 
   AColor::Medium(&dc, mOver );
   dc.DrawRectangle(r);
 
   // HACK: We used a wider rectangle to also cover one pixel of space just to the right.
   if( mAsSpacer )
      r.width -= 1;
 
   // No bumps in a spacer grabber.
   if( mAsSpacer )
      return;
   // Calculate the bump rectangle
   r.Deflate(2, 2);
   if ((r.GetHeight() % 4) < 2) {
      r.Offset(0, 1);
   }
 
   // 2-bar toolbars and larger get padding
   int padding = r.GetHeight() > 32 ? 22 : 6;
 
   // Cache
   left = r.GetLeft();
   right = r.GetRight();
   top = r.GetTop();
   bottom = r.GetBottom();
 
   // Draw the bumps
   if (mPressed) {
      AColor::Light(&dc, false);
   }
   else {
      dc.SetPen(wxPen(theTheme.Colour(clrGrabber), 1, wxPENSTYLE_SOLID));
   }
 
   for (y = top + padding; y < bottom - padding; y += 5) {
      dc.DrawRectangle(left, y, 2, 2);
      dc.DrawRectangle(right, y, 2, 2);
   }
}

References ThemeBase::Colour(), AColor::Light(), mAsSpacer, AColor::Medium(), mOver, mPressed, and theTheme.

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

OnEnter()

void Grabber::OnEnter ( wxMouseEvent &  event )

protected

Definition at line 212 of file Grabber.cpp.

{
#if defined(__WXMAC__)
   // Bug 2416:  On Mac, we can get Enter events from grabbers other
   // than the one being dragged. So, ignore Enter events if another
   // window has captured the mouse.
   if (wxWindow::GetCapture() != nullptr)
   {
      return;
   }
#endif
 
   // Bug 1201:  On Mac, unsetting and re-setting the tooltip may be needed
   // to make it pop up when we want it.
   const auto text = GetToolTipText();
   UnsetToolTip();
   wxWindow::SetToolTip(text);
 
   if( mAsSpacer )
      return;
 
   // Redraw highlighted
   mOver = true;
   Refresh(false);
}

References mAsSpacer, and mOver.

OnErase()

void Grabber::OnErase ( wxEraseEvent &  event )

protected

Definition at line 260 of file Grabber.cpp.

{
   // Ignore it to prevent flashing
}

OnKeyDown()

void Grabber::OnKeyDown ( wxKeyEvent &  event )

protected

Definition at line 276 of file Grabber.cpp.

{
   event.Skip();
 
   if(event.GetKeyCode() == WXK_ESCAPE) {
      // We must not only skip this key event, but propagate it up the window
      // hierarchy, so that ToolFrame detects it too.
      event.ResumePropagation(wxEVENT_PROPAGATE_MAX);
      SendEvent(EVT_GRABBER_CLICKED, wxPoint{ -1, -1 }, true);
   }
}

References SendEvent().

Here is the call graph for this function:

OnLeave()

void Grabber::OnLeave ( wxMouseEvent &  event )

protected

Definition at line 241 of file Grabber.cpp.

{
#if defined(__WXMAC__)
   // Bug 2416:  On Mac, we can get Leave events from grabbers other
   // than the one being dragged. So, ignore Leave events if another
   // window has captured the mouse.
   if (wxWindow::GetCapture() != nullptr)
   {
      return;
   }
#endif
 
   if (!GetCapture()) {
      // Redraw plain
      mOver = false;
      Refresh(false);
   }
}

References mOver.

OnLeftDown()

void Grabber::OnLeftDown ( wxMouseEvent &  event )

protected

Definition at line 185 of file Grabber.cpp.

{
   // Button should be drawn pushed
   PushButton(true);
 
   // Notify parent
   SendEvent(EVT_GRABBER_CLICKED, event.GetPosition(), false);
 
   event.Skip();
}

References PushButton(), and SendEvent().

Here is the call graph for this function:

OnLeftUp()

void Grabber::OnLeftUp ( wxMouseEvent &  event )

protected

Definition at line 199 of file Grabber.cpp.

{
   // Normally, "left up" events are handled by the ToolManager::OnMouse() method
   // but, if the user double clicks a grabber, the "left up" event will come here
   // instead, so just "unpush" the button.
   PushButton(false);
 
   event.Skip();
}

References PushButton().

Here is the call graph for this function:

OnPaint()

void Grabber::OnPaint ( wxPaintEvent &  event )

protected

Definition at line 268 of file Grabber.cpp.

{
   wxPaintDC dc(this);
 
   // Redraw the grabber
   DrawGrabber(dc);
}

References DrawGrabber().

Here is the call graph for this function:

PushButton()

void Grabber::PushButton

(

bool

state

)

Definition at line 168 of file Grabber.cpp.

{
   if( mAsSpacer )
      return;
   if (!state)
      mPressed = state;
   wxRect r = GetRect();
   mOver = r.Contains(ScreenToClient(wxGetMousePosition()));
 
   // Redraw button
   mPressed = state;
   Refresh(false);
}

References mAsSpacer, mOver, and mPressed.

Referenced by OnLeftDown(), OnLeftUp(), and ToolBar::SetDocked().

Here is the caller graph for this function:

SendEvent()

void Grabber::SendEvent ( wxEventType  type, const wxPoint &  pos, bool  escaping  )

private

Definition at line 85 of file Grabber.cpp.

{
   wxWindow *parent = GetParent();
 
   // Initialize event and convert mouse coordinates to screen space
   GrabberEvent e(type, mIdentifier, parent->ClientToScreen(pos), escaping);
 
   // Set the object of our desire
   e.SetEventObject(parent);
 
   // Queue the event
   parent->GetEventHandler()->AddPendingEvent(e);
}

References mIdentifier.

Referenced by OnKeyDown(), and OnLeftDown().

Here is the caller graph for this function:

SetAsSpacer()

void Grabber::SetAsSpacer

(

bool

bIsSpacer

)

Definition at line 99 of file Grabber.cpp.

                                          { 
   if( mAsSpacer != bIsSpacer ){
      // HACK: Use a wider rectangle to also cover one pixel of space just to the right.
      wxSize siz = GetSize();
      siz.IncBy( bIsSpacer ? 1:-1, 0 );
      SetSize( siz );
   }
   mAsSpacer = bIsSpacer;
};

References mAsSpacer.

SetToolTip()

void Grabber::SetToolTip

(

const TranslatableString &

toolTip

)

Definition at line 109 of file Grabber.cpp.

{
   wxWindow::SetToolTip( toolTip.Stripped().Translation() );
}

References TranslatableString::Stripped(), and TranslatableString::Translation().

Referenced by ToolBar::SetDocked(), and ToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAsSpacer

bool Grabber::mAsSpacer

private

Definition at line 146 of file Grabber.h.

Referenced by DrawGrabber(), OnEnter(), PushButton(), and SetAsSpacer().

mIdentifier

const Identifier Grabber::mIdentifier

private

Definition at line 143 of file Grabber.h.

Referenced by SendEvent().

mOver

bool Grabber::mOver

private

Definition at line 144 of file Grabber.h.

Referenced by DrawGrabber(), OnEnter(), OnLeave(), and PushButton().

mPressed

bool Grabber::mPressed

private

Definition at line 145 of file Grabber.h.

Referenced by DrawGrabber(), and PushButton().

---

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

• Grabber.h
• Grabber.cpp