BackedPanel Class Reference

BackedPanel is for a panel that consists of a bitmap with something drawn over it. It supports efficient repainting when the overlays change and recreation of the bitmap when the panel size is changed. More...

#include <BackedPanel.h>

Inheritance diagram for BackedPanel:

Collaboration diagram for BackedPanel:

Public Member Functions
	BackedPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style)
	~BackedPanel ()
wxDC &	GetBackingDC ()
wxDC &	GetBackingDCForRepaint ()
void	ResizeBacking ()
void	RepairBitmap (wxDC &dc, wxCoord x, wxCoord y, wxCoord width, wxCoord height)
void	DisplayBitmap (wxDC &dc)
void	OnSize (wxSizeEvent &event)
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Attributes
std::unique_ptr< wxBitmap >	mBacking
wxMemoryDC	mBackingDC
bool	mResizeBacking {}

Detailed Description

BackedPanel is for a panel that consists of a bitmap with something drawn over it. It supports efficient repainting when the overlays change and recreation of the bitmap when the panel size is changed.

Definition at line 19 of file BackedPanel.h.

Constructor & Destructor Documentation

BackedPanel()

BackedPanel::BackedPanel	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style
	)

Definition at line 12 of file BackedPanel.cpp.

: wxPanelWrapper(parent, id, pos, size, style)
, mBacking{ std::make_unique<wxBitmap>(1, 1, 24) }
{
   // Preinit the backing DC and bitmap so routines that require it will
   // not cause a crash if they run before the panel is fully initialized.
   mBackingDC.SelectObject(*mBacking);
}

References mBacking, and mBackingDC.

~BackedPanel()

BackedPanel::~BackedPanel

(

)

Definition at line 24 of file BackedPanel.cpp.

{
   if (mBacking)
      mBackingDC.SelectObject( wxNullBitmap );
}

References mBacking, and mBackingDC.

Member Function Documentation

DisplayBitmap()

void BackedPanel::DisplayBitmap

(

wxDC &

dc

)

Definition at line 65 of file BackedPanel.cpp.

{
   if( mBacking ) 
      RepairBitmap(dc, 0, 0, mBacking->GetWidth(), mBacking->GetHeight());
}

References mBacking, and RepairBitmap().

Referenced by TrackPanel::OnPaint(), and AdornedRulerPanel::OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

GetBackingDC()

wxDC & BackedPanel::GetBackingDC

(

)

Definition at line 30 of file BackedPanel.cpp.

{
   return mBackingDC;
}

References mBackingDC.

Referenced by OverlayPanel::DrawOverlays().

Here is the caller graph for this function:

GetBackingDCForRepaint()

wxDC & BackedPanel::GetBackingDCForRepaint

(

)

Definition at line 35 of file BackedPanel.cpp.

{
   if (mResizeBacking)
   {
      // Reset
      mResizeBacking = false;
 
      ResizeBacking();
   }
 
   return mBackingDC;
}

References mBackingDC, mResizeBacking, and ResizeBacking().

Referenced by TrackPanel::OnPaint(), and AdornedRulerPanel::OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSize()

void BackedPanel::OnSize

(

wxSizeEvent &

event

)

Definition at line 71 of file BackedPanel.cpp.

{
   // Tell OnPaint() to recreate the backing bitmap
   mResizeBacking = true;
   event.Skip();
   // Refresh the entire area.  Really only need to refresh when
   // expanding...is it worth the trouble?
   Refresh();
}

References mResizeBacking.

Referenced by AdornedRulerPanel::OnSize().

Here is the caller graph for this function:

RepairBitmap()

void BackedPanel::RepairBitmap	(	wxDC &	dc,
		wxCoord	x,
		wxCoord	y,
		wxCoord	width,
		wxCoord	height
	)

Definition at line 60 of file BackedPanel.cpp.

{
   dc.Blit(x, y, width, height, &mBackingDC, x, y);
}

References mBackingDC.

Referenced by DisplayBitmap(), and TrackPanel::OnPaint().

Here is the caller graph for this function:

ResizeBacking()

void BackedPanel::ResizeBacking

(

)

Definition at line 48 of file BackedPanel.cpp.

{
   if (mBacking)
      mBackingDC.SelectObject(wxNullBitmap);
 
   wxSize sz = GetClientSize();
   mBacking = std::make_unique<wxBitmap>();
   // Bug 2040 - Avoid 0 x 0 bitmap when minimized.
   mBacking->Create(std::max(sz.x,1), std::max(sz.y,1),24); //, *dc);
   mBackingDC.SelectObject(*mBacking);
}

References mBacking, and mBackingDC.

Referenced by GetBackingDCForRepaint().

Here is the caller graph for this function:

Member Data Documentation

mBacking

std::unique_ptr<wxBitmap> BackedPanel::mBacking

private

Definition at line 36 of file BackedPanel.h.

Referenced by BackedPanel(), DisplayBitmap(), ResizeBacking(), and ~BackedPanel().

mBackingDC

wxMemoryDC BackedPanel::mBackingDC

private

Definition at line 37 of file BackedPanel.h.

Referenced by BackedPanel(), GetBackingDC(), GetBackingDCForRepaint(), RepairBitmap(), ResizeBacking(), and ~BackedPanel().

mResizeBacking

bool BackedPanel::mResizeBacking {}

private

Definition at line 38 of file BackedPanel.h.

Referenced by GetBackingDCForRepaint(), and OnSize().

---

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

• BackedPanel.h
• BackedPanel.cpp