ToolFrame Class Reference

class ToolFrame More...

#include <ToolManager.h>

Inheritance diagram for ToolFrame:

Collaboration diagram for ToolFrame:

Public Member Functions
	ToolFrame (AudacityProject *parent, ToolManager *manager, ToolBar *bar, wxPoint pos)
	~ToolFrame ()
ToolBar *	GetBar ()
void	ClearBar ()
void	LockInMinSize (ToolBar *pBar)
void	OnGrabber (GrabberEvent &event)
void	OnToolBarUpdate (wxCommandEvent &event)
void	OnPaint (wxPaintEvent &WXUNUSED(event))
void	OnMotion (wxMouseEvent &event)
void	OnCaptureLost (wxMouseCaptureLostEvent &WXUNUSED(event))
void	OnClose (wxCloseEvent &event)
void	OnKeyDown (wxKeyEvent &event)
void	Resize (const wxSize &size)

Private Attributes
AudacityProject *const	mParent
ToolManager *	mManager
ToolBar *	mBar
wxSize	mMinSize
wxSize	mOrigSize

Detailed Description

class ToolFrame

Definition at line 188 of file ToolManager.h.

Constructor & Destructor Documentation

ToolFrame()

ToolFrame::ToolFrame	(	AudacityProject *	parent,
		ToolManager *	manager,
		ToolBar *	bar,
		wxPoint	pos
	)

Definition at line 72 of file ToolManager.cpp.

   : wxFrame( FindProjectFrame( parent ),
          bar->GetId(),
          wxEmptyString,
          pos,
          wxDefaultSize,
          wxNO_BORDER |
          wxFRAME_NO_TASKBAR |
#if !defined(__WXMAC__) // bug1358
          wxFRAME_TOOL_WINDOW |
#endif
          wxFRAME_FLOAT_ON_PARENT )
   , mParent{ parent }
{
   int width = bar->GetSize().x;
   int border = 1;
 
   // Save parameters
   mManager = manager;
   mBar = bar;
 
   // Transfer the bar to the ferry
   bar->Reparent(this);
 
   // Bug 2120 (comment 6 residual): No need to set a minimum size
   // if the toolbar is not resizable. On GTK, setting a minimum
   // size will prevent the frame from shrinking if the toolbar gets
   // reconfigured and needs to resize smaller.
   if (bar->IsResizable())
   {
      SetMinSize(bar->GetDockedSize());
   }
 
   {
      // We use a sizer to maintain proper spacing
      auto s = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
      // Add the bar to the sizer
      s->Add(bar, 1, wxEXPAND | wxALL, border);
 
      // Add space for the resize grabber
      if (bar->IsResizable())
      {
         s->Add(sizerW, 1);
         width += sizerW;
      }
 
      SetSize(width + 2 * ToolBarFloatMargin,
              bar->GetDockedSize().y + 2 * ToolBarFloatMargin);
 
      // Attach the sizer and resize the window to fit
      SetSizer(s.release());
   }
 
   Layout();
 
   // Inform toolbar of change
   bar->SetDocked( NULL, true );
 
   // Make sure resizable floaters don't get any smaller than initial size
   if( bar->IsResizable() )
   {
      // Calc the minimum size of the frame
      mMinSize = bar->GetMinSize() + ( GetSize() - bar->GetSize() );
   }
}

References ToolBar::GetDockedSize(), ToolBar::IsResizable(), manager, mBar, mManager, mMinSize, ToolBar::SetDocked(), sizerW, and ToolBarFloatMargin.

Here is the call graph for this function:

~ToolFrame()

ToolFrame::~ToolFrame

(

)

Definition at line 140 of file ToolManager.cpp.

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

Member Function Documentation

ClearBar()

void ToolFrame::ClearBar ( )

inline

Definition at line 197 of file ToolManager.h.

{ mBar = nullptr; }

References mBar.

Referenced by ToolManager::HandleEscapeKey(), and ToolManager::OnMouse().

Here is the caller graph for this function:

GetBar()

ToolBar * ToolFrame::GetBar ( )

inline

Definition at line 196 of file ToolManager.h.

{ return mBar; }

References mBar.

LockInMinSize()

void ToolFrame::LockInMinSize

(

ToolBar *

pBar

)

Definition at line 154 of file ToolManager.cpp.

{
   mBar = pBar;
 
   wxSize sz = mBar->GetSize();
   SetClientSize( sz );
   int yDesiredMin = 26;
   int y = sz.GetHeight();
   if (y > yDesiredMin) {
      sz.SetWidth((sz.GetWidth() * yDesiredMin) / y);
      sz.SetHeight( yDesiredMin );
   }
   mMinSize = sz -wxSize( 10, 0);
}

References mBar, and mMinSize.

OnCaptureLost()

void ToolFrame::OnCaptureLost

(

wxMouseCaptureLostEvent &

WXUNUSEDevent

)

Definition at line 281 of file ToolManager.cpp.

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

OnClose()

void ToolFrame::OnClose

(

wxCloseEvent &

event

)

Definition at line 289 of file ToolManager.cpp.

{
   event.Veto();
}

OnGrabber()

void ToolFrame::OnGrabber

(

GrabberEvent &

event

)

Definition at line 146 of file ToolManager.cpp.

{
   // Pass it on to the manager since it isn't in the handling hierarchy
   mManager->ProcessEvent( event );
}

References mManager.

OnKeyDown()

void ToolFrame::OnKeyDown

(

wxKeyEvent &

event

)

Definition at line 294 of file ToolManager.cpp.

{
   event.Skip();
   if( HasCapture() && event.GetKeyCode() == WXK_ESCAPE ) {
      Resize( mOrigSize );
      ReleaseMouse();
   }
}

References mOrigSize, and Resize().

Here is the call graph for this function:

OnMotion()

void ToolFrame::OnMotion

(

wxMouseEvent &

event

)

Definition at line 207 of file ToolManager.cpp.

{
   // Don't do anything if we're docked or not resizeable
   if( !mBar || mBar->IsDocked() || !mBar->IsResizable() )
   {
      return;
   }
 
   // Retrieve the mouse position
   wxPoint pos = ClientToScreen( event.GetPosition() );
   if( HasCapture() && event.Dragging() )
   {
      wxRect rect = GetRect();
 
      rect.SetBottomRight( pos );
 
      // Keep it within max size, if specified
      wxSize maxsz = mBar->GetMaxSize();
      if (maxsz != wxDefaultSize)
      {
         if (maxsz.x != wxDefaultCoord && rect.width > maxsz.x)
         {
            rect.width = maxsz.x;
         }
         if (maxsz.y != wxDefaultCoord && rect.height > maxsz.y)
         {
            rect.height = maxsz.y;
         }
      }
 
      if( rect.width < mMinSize.x )
      {
         rect.width = mMinSize.x;
      }
 
      if( rect.height < mMinSize.y )
      {
         rect.height = mMinSize.y;
      }
 
      Resize( rect.GetSize() );
   }
   else if( HasCapture() && event.LeftUp() )
   {
      ReleaseMouse();
   }
   else if( !HasCapture() )
   {
      wxRect rect = GetRect();
      wxRect r;
 
      r.x = rect.GetRight() - sizerW - 2,
      r.y = rect.GetBottom() - sizerW - 2;
      r.width = sizerW + 2;
      r.height = sizerW + 2;
 
      // Is left click within resize grabber?
      if( r.Contains( pos ) && !event.Leaving() )
      {
         mOrigSize = GetSize();
 
         SetCursor( wxCURSOR_SIZENWSE );
         if( event.LeftDown() )
         {
            CaptureMouse();
         }
      }
      else
      {
         SetCursor( wxCURSOR_ARROW );
      }
   }
}

References ToolBar::IsDocked(), ToolBar::IsResizable(), mBar, mMinSize, mOrigSize, Resize(), and sizerW.

Here is the call graph for this function:

OnPaint()

void ToolFrame::OnPaint

(

wxPaintEvent &

WXUNUSEDevent

)

Definition at line 180 of file ToolManager.cpp.

{
   wxPaintDC dc( this );
   wxSize sz = GetSize();
   wxRect r;
 
   dc.SetPen( theTheme.Colour( clrTrackPanelText ) );
   dc.SetBackground( wxBrush( theTheme.Colour( clrMedium ) ) );
   dc.Clear();
   dc.SetBrush( *wxTRANSPARENT_BRUSH );
   dc.DrawRectangle( 0, 0, sz.GetWidth(), sz.GetHeight() );
 
   if( mBar && mBar->IsResizable() )
   {
      r.x = sz.x - sizerW - 2,
      r.y = sz.y - sizerW - 2;
      r.width = sizerW + 2;
      r.height = sizerW + 2;
 
      AColor::Line(dc, r.GetLeft(), r.GetBottom(), r.GetRight(), r.GetTop() );
      AColor::Line(dc, r.GetLeft() + 3, r.GetBottom(), r.GetRight(), r.GetTop() + 3 );
      AColor::Line(dc, r.GetLeft() + 6, r.GetBottom(), r.GetRight(), r.GetTop() + 6 );
      AColor::Line(dc, r.GetLeft() + 9, r.GetBottom(), r.GetRight(), r.GetTop() + 9 );
   }
 
}

References ThemeBase::Colour(), ToolBar::IsResizable(), AColor::Line(), mBar, sizerW, and theTheme.

Here is the call graph for this function:

OnToolBarUpdate()

void ToolFrame::OnToolBarUpdate

(

wxCommandEvent &

event

)

Definition at line 169 of file ToolManager.cpp.

{
   // Resize floater window to exactly contain toolbar
   // use actual size rather than minimum size.
   if (mBar)
      mBar->GetParent()->SetClientSize( mBar->GetSize() );// ->GetMinSize() );
 
   // Allow it to propagate to our parent
   event.Skip();
}

References mBar.

Resize()

void ToolFrame::Resize

(

const wxSize &

size

)

Definition at line 303 of file ToolManager.cpp.

{
   SetMinSize( size );
   SetSize( size );
   Layout();
   Refresh( false );
}

References size.

Referenced by OnKeyDown(), and OnMotion().

Here is the caller graph for this function:

Member Data Documentation

mBar

ToolBar* ToolFrame::mBar

private

Definition at line 233 of file ToolManager.h.

Referenced by ClearBar(), GetBar(), LockInMinSize(), OnMotion(), OnPaint(), OnToolBarUpdate(), and ToolFrame().

mManager

ToolManager* ToolFrame::mManager

private

Definition at line 232 of file ToolManager.h.

Referenced by OnGrabber(), and ToolFrame().

mMinSize

wxSize ToolFrame::mMinSize

private

Definition at line 234 of file ToolManager.h.

Referenced by LockInMinSize(), OnMotion(), and ToolFrame().

mOrigSize

wxSize ToolFrame::mOrigSize

private

Definition at line 235 of file ToolManager.h.

Referenced by OnKeyDown(), and OnMotion().

mParent

AudacityProject* const ToolFrame::mParent

private

Definition at line 231 of file ToolManager.h.

---

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

• ToolManager.h
• ToolManager.cpp