ToolBarResizer Class Reference

a wxWindow that provides the resizer for a toolbar on the right hand side. Responsible for drawing the resizer appearance, resizing mouse events and constraining the resizing. More...

Inheritance diagram for ToolBarResizer:

Collaboration diagram for ToolBarResizer:

Public Member Functions
	ToolBarResizer (ToolBar *mBar)
virtual	~ToolBarResizer ()
bool	AcceptsFocusFromKeyboard () const override

Private Member Functions
void	OnErase (wxEraseEvent &event)
void	OnPaint (wxPaintEvent &event)
void	OnLeftDown (wxMouseEvent &event)
void	OnLeftUp (wxMouseEvent &event)
void	OnEnter (wxMouseEvent &event)
void	OnLeave (wxMouseEvent &event)
void	OnMotion (wxMouseEvent &event)
void	ResizeBar (const wxSize &size)
void	OnCaptureLost (wxMouseCaptureLostEvent &event)
void	OnKeyDown (wxKeyEvent &event)

Private Attributes
ToolBar *	mBar
wxPoint	mResizeOffset
wxSize	mOrigSize
wxWindowRef	mOrigFocus {}

Detailed Description

a wxWindow that provides the resizer for a toolbar on the right hand side. Responsible for drawing the resizer appearance, resizing mouse events and constraining the resizing.

Definition at line 68 of file ToolBar.cpp.

Constructor & Destructor Documentation

ToolBarResizer()

ToolBarResizer::ToolBarResizer

(

ToolBar *

mBar

)

Definition at line 115 of file ToolBar.cpp.

:  wxWindow(bar, wxID_ANY, wxDefaultPosition, wxSize(RWIDTH, -1))
{
   mBar = bar;
   SetCursor( wxCURSOR_SIZEWE );
}

~ToolBarResizer()

ToolBarResizer::~ToolBarResizer ( )

virtual

Definition at line 122 of file ToolBar.cpp.

{
   if(HasCapture())
      ReleaseMouse();
}

Member Function Documentation

AcceptsFocusFromKeyboard()

bool ToolBarResizer::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 77 of file ToolBar.cpp.

{return false;}

OnCaptureLost()

void ToolBarResizer::OnCaptureLost ( wxMouseCaptureLostEvent &  event )

private

Definition at line 279 of file ToolBar.cpp.

{
   if( HasCapture() )
   {
      ReleaseMouse();
      if (mOrigFocus)
         mOrigFocus->SetFocus();
      mOrigFocus = nullptr;
   }
}

References mOrigFocus.

OnEnter()

void ToolBarResizer::OnEnter ( wxMouseEvent &  event )

private

Definition at line 196 of file ToolBar.cpp.

{
   // 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();
   SetToolTip(text);
   if (!mOrigFocus)
      mOrigFocus = FindFocus();
}

References BasicUI::FindFocus(), and mOrigFocus.

Here is the call graph for this function:

OnErase()

void ToolBarResizer::OnErase ( wxEraseEvent &  event )

private

Definition at line 131 of file ToolBar.cpp.

{
   // Ignore it to prevent flashing
}

OnKeyDown()

void ToolBarResizer::OnKeyDown ( wxKeyEvent &  event )

private

Definition at line 290 of file ToolBar.cpp.

{
   event.Skip();
   if (HasCapture() && WXK_ESCAPE == event.GetKeyCode()) {
      ResizeBar( mOrigSize );
      ReleaseMouse();
      if (mOrigFocus)
         mOrigFocus->SetFocus();
      mOrigFocus = nullptr;
   }
}

References mOrigFocus, mOrigSize, and ResizeBar().

Here is the call graph for this function:

OnLeave()

void ToolBarResizer::OnLeave ( wxMouseEvent &  event )

private

Definition at line 207 of file ToolBar.cpp.

{
   if (!GetCapture())
      mOrigFocus = nullptr;
}

References mOrigFocus.

OnLeftDown()

void ToolBarResizer::OnLeftDown ( wxMouseEvent &  event )

private

Definition at line 163 of file ToolBar.cpp.

{
   // Go ahead and set the event to propagate
   event.Skip();
 
   // Retrieve the mouse position
   // Bug 1896: This is at time of processing the event, rather than at time 
   // of generation of event.  Works around event.GetPosition() giving
   // incorrect values if position of resizer is changing.
   mResizeOffset = wxGetMousePosition()-mBar->GetRect().GetBottomRight();
 
   mOrigSize = mBar->GetSize();
 
   // We want all of the mouse events
   if( !HasCapture() )
      CaptureMouse();
}

References mBar, mOrigSize, and mResizeOffset.

OnLeftUp()

void ToolBarResizer::OnLeftUp ( wxMouseEvent &  event )

private

Definition at line 181 of file ToolBar.cpp.

{
   // Go ahead and set the event to propagate
   event.Skip();
 
   if( HasCapture() )
   {
      ReleaseMouse();
      if (mOrigFocus)
         mOrigFocus->SetFocus();
      mOrigFocus = nullptr;
      mBar->ResizingDone();
   }
}

References mBar, mOrigFocus, and ToolBar::ResizingDone().

Here is the call graph for this function:

OnMotion()

void ToolBarResizer::OnMotion ( wxMouseEvent &  event )

private

Definition at line 213 of file ToolBar.cpp.

{
   // Go ahead and set the event to propagate
   event.Skip();
 
   if( HasCapture() && event.Dragging() )
   {
      // Retrieve the mouse position
      // Bug 1896: This is at time of processing the event, rather than at time 
      // of generation of event.  Works around event.GetPosition() giving
      // incorrect values if position of resizer is changing.
      wxPoint pos = wxGetMousePosition();
 
      wxRect r = mBar->GetRect();
      wxSize minsz = mBar->GetMinSize();
      wxSize maxsz = mBar->GetMaxSize();
      wxSize psz = mBar->GetParent()->GetClientSize();
 
      // Adjust the size based on updated mouse position.
      r.width = ( pos.x - mResizeOffset.x ) - r.x;
 
      // Keep it within max size, if specified
      if( maxsz != wxDefaultSize )
      {
         if( r.width > maxsz.x )
         {
            r.width = maxsz.x;
         }
         if( r.height > maxsz.y )
         {
            r.height = maxsz.y;
         }
      }
 
      // Constrain
      if( r.width < minsz.x )
      {
         // Don't allow resizing to go too small
         r.width = minsz.x;
      }
      else if( r.GetRight() > psz.x - 3 )
      {
         // Don't allow resizing to go too large
         //
         // The 3 magic pixels are because I'm too chicken to change the
         // calculations in ToolDock::LayoutToolBars() even though I'm
         // the one that set them up.  :-)
         r.SetRight( psz.x - 3 );
      }
 
      ResizeBar( r.GetSize() );
   }
}

References mBar, mResizeOffset, and ResizeBar().

Here is the call graph for this function:

OnPaint()

void ToolBarResizer::OnPaint ( wxPaintEvent &  event )

private

Definition at line 139 of file ToolBar.cpp.

{
   wxPaintDC dc( (wxWindow *) event.GetEventObject() );
 
   // Start with a clean background
   //
   // Under GTK, we specifically set the toolbar background to the background
   // colour in the system theme.
#if defined( __WXGTK__ )
//   dc.SetBackground( wxBrush( wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND ) ) );
#endif
   dc.SetBackground( wxBrush( theTheme.Colour( clrMedium  ) ) );
   dc.Clear();
 
   wxSize sz = GetSize();
 
   AColor::Dark( &dc, false );
   AColor::Line(dc, sz.x - 4,  0, sz.x - 4, sz.y );
   AColor::Line(dc, sz.x - 1,  0, sz.x - 1, sz.y );
}

References ThemeBase::Colour(), AColor::Dark(), AColor::Line(), and theTheme.

Here is the call graph for this function:

ResizeBar()

void ToolBarResizer::ResizeBar ( const wxSize &  size )

private

Definition at line 267 of file ToolBar.cpp.

{
   mBar->SetSize( size );
 
   // Tell everyone we've changed sizes
   mBar->Updated();
 
   // Refresh our world
   mBar->GetParent()->Refresh();
   mBar->GetParent()->Update();
}

References mBar, size, and ToolBar::Updated().

Referenced by OnKeyDown(), and OnMotion().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mBar

ToolBar* ToolBarResizer::mBar

private

Definition at line 92 of file ToolBar.cpp.

Referenced by OnLeftDown(), OnLeftUp(), OnMotion(), and ResizeBar().

mOrigFocus

wxWindowRef ToolBarResizer::mOrigFocus {}

private

Definition at line 95 of file ToolBar.cpp.

Referenced by OnCaptureLost(), OnEnter(), OnKeyDown(), OnLeave(), and OnLeftUp().

mOrigSize

wxSize ToolBarResizer::mOrigSize

private

Definition at line 94 of file ToolBar.cpp.

Referenced by OnKeyDown(), and OnLeftDown().

mResizeOffset

wxPoint ToolBarResizer::mResizeOffset

private

Definition at line 93 of file ToolBar.cpp.

Referenced by OnLeftDown(), and OnMotion().

---

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

• ToolBar.cpp