KiCad PCB EDA Suite
WX_INFOBAR Class Reference

A modified version of the wxInfoBar class that allows us to: More...

#include <infobar.h>

Inheritance diagram for WX_INFOBAR:

Public Types

enum  MESSAGE_TYPE { MESSAGE_TYPE::GENERIC, MESSAGE_TYPE::OUTDATED_SAVE }
 Sets the type of message for special handling if needed. More...
 

Public Member Functions

 WX_INFOBAR (wxWindow *aParent, wxAuiManager *aMgr=nullptr, wxWindowID aWinid=wxID_ANY)
 Construct an infobar that can exist inside an AUI managed frame. More...
 
 ~WX_INFOBAR ()
 
void SetShowTime (int aTime)
 Set the time period to show the infobar. More...
 
void AddCloseButton (const wxString &aTooltip=_("Hide this message."))
 Add the default close button to the infobar on the right side. More...
 
void AddButton (wxButton *aButton)
 Add an already created button to the infobar. More...
 
void AddButton (wxHyperlinkCtrl *aHypertextButton)
 Add an already created hypertext link to the infobar. More...
 
void AddButton (wxWindowID aId, const wxString &aLabel=wxEmptyString) override
 Add a button with the provided ID and text. More...
 
void RemoveAllButtons ()
 Remove all the buttons that have been added by the user. More...
 
bool HasCloseButton () const
 
void SetCallback (std::function< void(void)> aCallback)
 Provide a callback to be called when the infobar is dismissed (either by user action or timer). More...
 
void ShowMessageFor (const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION)
 Show the infobar with the provided message and icon for a specific period of time. More...
 
void ShowMessage (const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
 Show the info bar with the provided message and icon. More...
 
void ShowMessage (const wxString &aMessage, int aFlags, MESSAGE_TYPE aType)
 Show the info bar with the provided message and icon, setting the type. More...
 
void Dismiss () override
 Dismisses the infobar and updates the containing layout and AUI manager (if one is provided). More...
 
void DismissOutdatedSave ()
 Dismisses the infobar for outdated save warnings and updates the containing layout and AUI manager (if one is provided). More...
 
void QueueShowMessage (const wxString &aMessage, int aFlags=wxICON_INFORMATION)
 Send the infobar an event telling it to show a message. More...
 
void QueueDismiss ()
 Send the infobar an event telling it to hide itself. More...
 
bool IsLocked ()
 Returns true if the infobar is being updated. More...
 

Protected Member Functions

void onShowInfoBar (wxCommandEvent &aEvent)
 Event handler for showing the infobar using a wxCommandEvent of the type KIEVT_SHOW_INFOBAR. More...
 
void onDismissInfoBar (wxCommandEvent &aEvent)
 Event handler for dismissing the infobar using a wxCommandEvent of the type KIEVT_DISMISS_INFOBAR. More...
 
void onCloseButton (wxCommandEvent &aEvent)
 Event handler for the close button. More...
 
void onTimer (wxTimerEvent &aEvent)
 Event handler for the automatic closing timer. More...
 
void onSize (wxSizeEvent &aEvent)
 
void updateAuiLayout (bool aShow)
 Update the AUI pane to show or hide this infobar. More...
 

Protected Attributes

int m_showTime
 The time to show the infobar. 0 = don't auto hide. More...
 
bool m_updateLock
 True if this infobar requested the UI update. More...
 
wxTimer * m_showTimer
 The timer counting the autoclose period. More...
 
wxAuiManager * m_auiManager
 The AUI manager that contains this infobar. More...
 
MESSAGE_TYPE m_type
 The type of message being displayed. More...
 
OPT< std::function< void(void)> > m_callback
 Optional callback made when closing infobar. More...
 

Detailed Description

A modified version of the wxInfoBar class that allows us to:

  • Show the close button along with the other buttons
  • Remove all user-provided buttons at once
  • Allow automatically hiding the infobar after a time period
  • Show/hide using events
  • Place it inside an AUI manager

This inherits from the generic infobar because the native infobar on GTK doesn't include the icon on the left and it looks worse.

There are 2 events associated with the infobar:

KIEVT_SHOW_INFOBAR: An event that tells the infobar to show a message.

The message text is contained inside the string component, and the message flag is contained inside the int component.

Sample event creation code: wxCommandEvent* evt = new wxCommandEvent( KIEVT_SHOW_INFOBAR ); evt->SetString( "A message to show" ); evt->SetInt( wxICON_WARNING );

KIEVT_DISMISS_INFOBAR: An event that tells the infobar to hide itself.

Definition at line 73 of file infobar.h.

Member Enumeration Documentation

◆ MESSAGE_TYPE

Sets the type of message for special handling if needed.

Enumerator
GENERIC 

GENERIC Are messages that do not have special handling.

OUTDATED_SAVE 

OUTDATED_SAVE Messages that should be cleared on save.

Definition at line 91 of file infobar.h.

92  {
93  GENERIC,
94  OUTDATED_SAVE
95  };

Constructor & Destructor Documentation

◆ WX_INFOBAR()

WX_INFOBAR::WX_INFOBAR ( wxWindow *  aParent,
wxAuiManager *  aMgr = nullptr,
wxWindowID  aWinid = wxID_ANY 
)

Construct an infobar that can exist inside an AUI managed frame.

Parameters
aParentis the parent
aMgris the AUI manager that this infobar is added to
aWinIdis the ID for this infobar object

Definition at line 47 of file infobar.cpp.

48  : wxInfoBarGeneric( aParent, aWinid ),
49  m_showTime( 0 ),
50  m_updateLock( false ),
51  m_showTimer( nullptr ),
52  m_auiManager( aMgr ),
54 {
55  m_showTimer = new wxTimer( this, ID_CLOSE_INFOBAR );
56 
57 #ifdef __WXMAC__
58  // wxWidgets hard-codes wxSYS_COLOUR_INFOBK to { 0xFF, 0xFF, 0xD3 } on Mac.
60  SetBackgroundColour( wxColour( 28, 27, 20 ) );
61  else
62  SetBackgroundColour( wxColour( 255, 249, 189 ) );
63 #endif
64 
65  SetShowHideEffects( wxSHOW_EFFECT_ROLL_TO_BOTTOM, wxSHOW_EFFECT_ROLL_TO_TOP );
66  SetEffectDuration( 300 );
67 
68  // The infobar seems to start too small, so increase its height
69  int sx, sy;
70  GetSize( &sx, &sy );
71  sy = 1.5 * sy;
72  SetSize( sx, sy );
73 
74  // The bitmap gets cutoff sometimes with the default size, so force it to be the same
75  // height as the infobar.
76  wxSizer* sizer = GetSizer();
77  wxSize iconSize = wxArtProvider::GetSizeHint( wxART_BUTTON );
78 
79  sizer->SetItemMinSize( (size_t) 0, iconSize.x, sy );
80 
81  // Forcefully remove all existing buttons added by the wx constructors.
82  // The default close button doesn't work with the AUI manager update scheme, so this
83  // ensures any close button displayed is ours.
85 
86  Layout();
87 
88  m_parent->Bind( wxEVT_SIZE, &WX_INFOBAR::onSize, this );
89 }
void onSize(wxSizeEvent &aEvent)
Definition: infobar.cpp:196
GENERIC Are messages that do not have special handling.
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:31
wxTimer * m_showTimer
The timer counting the autoclose period.
Definition: infobar.h:254
ID for the close button on the frame's infobar.
Definition: infobar.h:39
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:287
wxAuiManager * m_auiManager
The AUI manager that contains this infobar.
Definition: infobar.h:255
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253
MESSAGE_TYPE m_type
The type of message being displayed.
Definition: infobar.h:256
int m_showTime
The time to show the infobar. 0 = don't auto hide.
Definition: infobar.h:252

References ID_CLOSE_INFOBAR, KIPLATFORM::UI::IsDarkTheme(), and onSize().

◆ ~WX_INFOBAR()

WX_INFOBAR::~WX_INFOBAR ( )

Definition at line 92 of file infobar.cpp.

93 {
94  delete m_showTimer;
95 }
wxTimer * m_showTimer
The timer counting the autoclose period.
Definition: infobar.h:254

References m_showTimer.

Member Function Documentation

◆ AddButton() [1/3]

void WX_INFOBAR::AddButton ( wxButton *  aButton)

Add an already created button to the infobar.

New buttons are added in the right-most position.

Parameters
aButtonis the button to add

Definition at line 246 of file infobar.cpp.

247 {
248  wxSizer* sizer = GetSizer();
249 
250  wxASSERT( aButton );
251 
252 #ifdef __WXMAC__
253  // Based on the code in the original class:
254  // smaller buttons look better in the (narrow) info bar under OS X
255  aButton->SetWindowVariant( wxWINDOW_VARIANT_SMALL );
256 #endif // __WXMAC__
257  sizer->Add( aButton, wxSizerFlags().Centre().Border( wxRIGHT ) );
258 
259  if( IsShown() )
260  sizer->Layout();
261 }

Referenced by AddButton(), AddCloseButton(), DIALOG_ERC::DIALOG_ERC(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), APPEARANCE_CONTROLS::onReadOnlySwatch(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

◆ AddButton() [2/3]

void WX_INFOBAR::AddButton ( wxHyperlinkCtrl *  aHypertextButton)

Add an already created hypertext link to the infobar.

New buttons are added in the right-most position.

Parameters
aHypertextButtonis the button to add

Definition at line 264 of file infobar.cpp.

265 {
266  wxSizer* sizer = GetSizer();
267 
268  wxASSERT( aHypertextButton );
269 
270  sizer->Add( aHypertextButton, wxSizerFlags().Centre().Border( wxRIGHT ) );
271 
272  if( IsShown() )
273  sizer->Layout();
274 }

◆ AddButton() [3/3]

void WX_INFOBAR::AddButton ( wxWindowID  aId,
const wxString &  aLabel = wxEmptyString 
)
override

Add a button with the provided ID and text.

The new button is created on the right-most position.

Parameters
aIdis the ID to assign to the button
aLabelis the text for the button

Definition at line 238 of file infobar.cpp.

239 {
240  wxButton* button = new wxButton( this, aId, aLabel );
241 
242  AddButton( button );
243 }
void AddButton(wxButton *aButton)
Add an already created button to the infobar.
Definition: infobar.cpp:246

References AddButton().

◆ AddCloseButton()

void WX_INFOBAR::AddCloseButton ( const wxString &  aTooltip = _( "Hide this message." ))

Add the default close button to the infobar on the right side.

Parameters
aTooltipis the tooltip to give the close button

Definition at line 277 of file infobar.cpp.

278 {
279  wxBitmapButton* button = wxBitmapButton::NewCloseButton( this, ID_CLOSE_INFOBAR );
280 
281  button->SetToolTip( aTooltip );
282 
283  AddButton( button );
284 }
void AddButton(wxButton *aButton)
Add an already created button to the infobar.
Definition: infobar.cpp:246
ID for the close button on the frame's infobar.
Definition: infobar.h:39

References AddButton(), and ID_CLOSE_INFOBAR.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), APPEARANCE_CONTROLS::onReadOnlySwatch(), onShowInfoBar(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::ShowFindReplaceStatus(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), and EDA_BASE_FRAME::ShowInfoBarWarning().

◆ Dismiss()

void WX_INFOBAR::Dismiss ( )
override

Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).

Definition at line 176 of file infobar.cpp.

177 {
178  // Don't do anything if we requested the UI update
179  if( m_updateLock )
180  return;
181 
182  m_updateLock = true;
183 
184  wxInfoBarGeneric::Dismiss();
185 
186  if( m_auiManager )
187  updateAuiLayout( false );
188 
189  if( m_callback )
190  (*m_callback)();
191 
192  m_updateLock = false;
193 }
void updateAuiLayout(bool aShow)
Update the AUI pane to show or hide this infobar.
Definition: infobar.cpp:218
OPT< std::function< void(void)> > m_callback
Optional callback made when closing infobar.
Definition: infobar.h:258
wxAuiManager * m_auiManager
The AUI manager that contains this infobar.
Definition: infobar.h:255
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253

References m_auiManager, m_callback, m_updateLock, and updateAuiLayout().

Referenced by SCH_EDIT_FRAME::ClearFindReplaceStatus(), DismissOutdatedSave(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), onCloseButton(), onDismissInfoBar(), DIALOG_BOARD_SETUP::OnPageChange(), onTimer(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::saveAllLibraries(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_EDIT_FRAME::SavePcbFile(), SYMBOL_EDIT_FRAME::SetCurSymbol(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ DismissOutdatedSave()

void WX_INFOBAR::DismissOutdatedSave ( )

Dismisses the infobar for outdated save warnings and updates the containing layout and AUI manager (if one is provided).

Definition at line 167 of file infobar.cpp.

168 {
170  return;
171 
172  Dismiss();
173 }
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:176
OUTDATED_SAVE Messages that should be cleared on save.
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253
MESSAGE_TYPE m_type
The type of message being displayed.
Definition: infobar.h:256

References Dismiss(), m_type, m_updateLock, and OUTDATED_SAVE.

Referenced by PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().

◆ HasCloseButton()

bool WX_INFOBAR::HasCloseButton ( ) const

Definition at line 311 of file infobar.cpp.

312 {
313  wxSizer* sizer = GetSizer();
314 
315  if( sizer->GetItemCount() == 0 )
316  return false;
317 
318  if( sizer->GetItem( sizer->GetItemCount() - 1 )->IsSpacer() )
319  return false;
320 
321  wxSizerItem* item = sizer->GetItem( sizer->GetItemCount() - 1 );
322 
323  return ( item->GetWindow()->GetId() == ID_CLOSE_INFOBAR );
324 }
ID for the close button on the frame's infobar.
Definition: infobar.h:39

References ID_CLOSE_INFOBAR.

Referenced by FOOTPRINT_EDITOR_CONTROL::SaveAs(), and PCB_EDIT_FRAME::SavePcbFile().

◆ IsLocked()

bool WX_INFOBAR::IsLocked ( )
inline

Returns true if the infobar is being updated.

Definition at line 212 of file infobar.h.

213  {
214  return m_updateLock;
215  }
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253

References m_updateLock.

Referenced by EDA_DRAW_PANEL_GAL::onSize().

◆ onCloseButton()

void WX_INFOBAR::onCloseButton ( wxCommandEvent &  aEvent)
protected

Event handler for the close button.

This is bound to ID_CLOSE_INFOBAR on the infobar.

Definition at line 341 of file infobar.cpp.

342 {
343  Dismiss();
344 }
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:176

References Dismiss().

◆ onDismissInfoBar()

void WX_INFOBAR::onDismissInfoBar ( wxCommandEvent &  aEvent)
protected

Event handler for dismissing the infobar using a wxCommandEvent of the type KIEVT_DISMISS_INFOBAR.

Definition at line 335 of file infobar.cpp.

336 {
337  Dismiss();
338 }
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:176

References Dismiss().

◆ onShowInfoBar()

void WX_INFOBAR::onShowInfoBar ( wxCommandEvent &  aEvent)
protected

Event handler for showing the infobar using a wxCommandEvent of the type KIEVT_SHOW_INFOBAR.

The message is stored inside the string field, and the icon flag is stored inside the int field.

Definition at line 327 of file infobar.cpp.

328 {
330  AddCloseButton();
331  ShowMessage( aEvent.GetString(), aEvent.GetInt() );
332 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:134
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:287
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:277

References AddCloseButton(), RemoveAllButtons(), and ShowMessage().

◆ onSize()

void WX_INFOBAR::onSize ( wxSizeEvent &  aEvent)
protected

Definition at line 196 of file infobar.cpp.

197 {
198  int barWidth = GetSize().GetWidth();
199 
200  // Calculate the horizontal size: because the infobar is shown on top of the draw canvas
201  // it is adjusted to the canvas width.
202  // On Mac, the canvas is the parent
203  // On other OS the parent is EDA_BASE_FRAME that contains the canvas
204  int parentWidth = m_parent->GetClientSize().GetWidth();
205  EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_parent );
206 
207  if( frame && frame->GetToolCanvas() )
208  parentWidth = frame->GetToolCanvas()->GetSize().GetWidth();
209 
210 
211  if( barWidth != parentWidth )
212  SetSize( parentWidth, GetSize().GetHeight() );
213 
214  aEvent.Skip();
215 }
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
The base frame for deriving all KiCad main window classes.

References TOOLS_HOLDER::GetToolCanvas().

Referenced by WX_INFOBAR().

◆ onTimer()

void WX_INFOBAR::onTimer ( wxTimerEvent &  aEvent)
protected

Event handler for the automatic closing timer.

Definition at line 347 of file infobar.cpp.

348 {
349  // Reset and clear the timer
350  m_showTimer->Stop();
351  m_showTime = 0;
352 
353  Dismiss();
354 }
wxTimer * m_showTimer
The timer counting the autoclose period.
Definition: infobar.h:254
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:176
int m_showTime
The time to show the infobar. 0 = don't auto hide.
Definition: infobar.h:252

References Dismiss(), m_showTime, and m_showTimer.

◆ QueueDismiss()

void WX_INFOBAR::QueueDismiss ( )

Send the infobar an event telling it to hide itself.

Definition at line 115 of file infobar.cpp.

116 {
117  wxCommandEvent* evt = new wxCommandEvent( KIEVT_DISMISS_INFOBAR );
118 
119  GetEventHandler()->QueueEvent( evt );
120 }

Referenced by INFOBAR_REPORTER::Finalize().

◆ QueueShowMessage()

void WX_INFOBAR::QueueShowMessage ( const wxString &  aMessage,
int  aFlags = wxICON_INFORMATION 
)

Send the infobar an event telling it to show a message.

Parameters
aMessageis the message to display
aFlagsis the flag containing the icon to display on the left side of the infobar

Definition at line 104 of file infobar.cpp.

105 {
106  wxCommandEvent* evt = new wxCommandEvent( KIEVT_SHOW_INFOBAR );
107 
108  evt->SetString( aMessage.c_str() );
109  evt->SetInt( aFlags );
110 
111  GetEventHandler()->QueueEvent( evt );
112 }

Referenced by INFOBAR_REPORTER::Finalize().

◆ RemoveAllButtons()

void WX_INFOBAR::RemoveAllButtons ( )

Remove all the buttons that have been added by the user.

Definition at line 287 of file infobar.cpp.

288 {
289  wxSizer* sizer = GetSizer();
290 
291  if( sizer->GetItemCount() == 0 )
292  return;
293 
294  // The last item is already the spacer
295  if( sizer->GetItem( sizer->GetItemCount() - 1 )->IsSpacer() )
296  return;
297 
298  for( int i = sizer->GetItemCount() - 1; i >= 0; i-- )
299  {
300  wxSizerItem* sItem = sizer->GetItem( i );
301 
302  // The spacer is the end of the custom buttons
303  if( sItem->IsSpacer() )
304  break;
305 
306  delete sItem->GetWindow();
307  }
308 }

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ERC::DIALOG_ERC(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), APPEARANCE_CONTROLS::onReadOnlySwatch(), onShowInfoBar(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::ShowFindReplaceStatus(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), and EDA_BASE_FRAME::ShowInfoBarWarning().

◆ SetCallback()

void WX_INFOBAR::SetCallback ( std::function< void(void)>  aCallback)
inline

Provide a callback to be called when the infobar is dismissed (either by user action or timer).

Parameters
aCallback

Definition at line 152 of file infobar.h.

153  {
154  m_callback = aCallback;
155  }
OPT< std::function< void(void)> > m_callback
Optional callback made when closing infobar.
Definition: infobar.h:258

References m_callback.

Referenced by EDA_BASE_FRAME::ShowInfoBarError().

◆ SetShowTime()

void WX_INFOBAR::SetShowTime ( int  aTime)

Set the time period to show the infobar.

This only applies for the next showing of the infobar, so it must be reset every time. A value of 0 disables the automatic hiding (this is the default).

Parameters
aTimeis the time in milliseconds to show the infobar

Definition at line 98 of file infobar.cpp.

99 {
100  m_showTime = aTime;
101 }
int m_showTime
The time to show the infobar. 0 = don't auto hide.
Definition: infobar.h:252

References m_showTime.

◆ ShowMessage() [1/2]

void WX_INFOBAR::ShowMessage ( const wxString &  aMessage,
int  aFlags = wxICON_INFORMATION 
)
override

Show the info bar with the provided message and icon.

Parameters
aMessageis the message to display
aFlagsis the flag containing the icon to display on the left side of the infobar

Definition at line 134 of file infobar.cpp.

135 {
136  // Don't do anything if we requested the UI update
137  if( m_updateLock )
138  return;
139 
140  m_updateLock = true;
141 
142  wxInfoBarGeneric::ShowMessage( aMessage, aFlags );
143 
144  if( m_auiManager )
145  updateAuiLayout( true );
146 
147  if( m_showTime > 0 )
148  m_showTimer->StartOnce( m_showTime );
149 
151  m_updateLock = false;
152 }
void updateAuiLayout(bool aShow)
Update the AUI pane to show or hide this infobar.
Definition: infobar.cpp:218
GENERIC Are messages that do not have special handling.
wxTimer * m_showTimer
The timer counting the autoclose period.
Definition: infobar.h:254
wxAuiManager * m_auiManager
The AUI manager that contains this infobar.
Definition: infobar.h:255
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253
MESSAGE_TYPE m_type
The type of message being displayed.
Definition: infobar.h:256
int m_showTime
The time to show the infobar. 0 = don't auto hide.
Definition: infobar.h:252

References GENERIC, m_auiManager, m_showTime, m_showTimer, m_type, m_updateLock, and updateAuiLayout().

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ERC::DIALOG_ERC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), PAD_TOOL::EditPad(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), DIALOG_BOARD_SETUP::OnPageChange(), onShowInfoBar(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::SetCurSymbol(), ShowMessage(), ShowMessageFor(), and PAGED_DIALOG::TransferDataFromWindow().

◆ ShowMessage() [2/2]

void WX_INFOBAR::ShowMessage ( const wxString &  aMessage,
int  aFlags,
MESSAGE_TYPE  aType 
)

Show the info bar with the provided message and icon, setting the type.

Parameters
aMessageis the message to display
aFlagsis the flag containing the icon to display on the left side of the infobar
aTypeis the type of message being displayed

Definition at line 155 of file infobar.cpp.

156 {
157  // Don't do anything if we requested the UI update
158  if( m_updateLock )
159  return;
160 
161  ShowMessage( aMessage, aFlags );
162 
163  m_type = aType;
164 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:134
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253
MESSAGE_TYPE m_type
The type of message being displayed.
Definition: infobar.h:256

References m_type, m_updateLock, and ShowMessage().

◆ ShowMessageFor()

void WX_INFOBAR::ShowMessageFor ( const wxString &  aMessage,
int  aTime,
int  aFlags = wxICON_INFORMATION 
)

Show the infobar with the provided message and icon for a specific period of time.

Parameters
aMessageis the message to display
aTimeis the amount of time in milliseconds to show the infobar
aFlagsis the flag containing the icon to display on the left side of the infobar

Definition at line 123 of file infobar.cpp.

124 {
125  // Don't do anything if we requested the UI update
126  if( m_updateLock )
127  return;
128 
129  m_showTime = aTime;
130  ShowMessage( aMessage, aFlags );
131 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:134
bool m_updateLock
True if this infobar requested the UI update.
Definition: infobar.h:253
int m_showTime
The time to show the infobar. 0 = don't auto hide.
Definition: infobar.h:252

References m_showTime, m_updateLock, and ShowMessage().

Referenced by AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), APPEARANCE_CONTROLS::onReadOnlySwatch(), PAGED_DIALOG::OnUpdateUI(), SYMBOL_EDIT_FRAME::saveAllLibraries(), SCH_EDIT_FRAME::ShowFindReplaceStatus(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), and EDA_BASE_FRAME::ShowInfoBarWarning().

◆ updateAuiLayout()

void WX_INFOBAR::updateAuiLayout ( bool  aShow)
protected

Update the AUI pane to show or hide this infobar.

Parameters
aShowis true to show the pane

Definition at line 218 of file infobar.cpp.

219 {
220  wxASSERT( m_auiManager );
221 
222  wxAuiPaneInfo& pane = m_auiManager->GetPane( this );
223 
224  // If the infobar is in a pane, then show/hide the pane
225  if( pane.IsOk() )
226  {
227  if( aShow )
228  pane.Show();
229  else
230  pane.Hide();
231  }
232 
233  // Update the AUI manager regardless
234  m_auiManager->Update();
235 }
wxAuiManager * m_auiManager
The AUI manager that contains this infobar.
Definition: infobar.h:255

References m_auiManager.

Referenced by Dismiss(), and ShowMessage().

Member Data Documentation

◆ m_auiManager

wxAuiManager* WX_INFOBAR::m_auiManager
protected

The AUI manager that contains this infobar.

Definition at line 255 of file infobar.h.

Referenced by Dismiss(), ShowMessage(), and updateAuiLayout().

◆ m_callback

OPT<std::function<void(void)> > WX_INFOBAR::m_callback
protected

Optional callback made when closing infobar.

Definition at line 258 of file infobar.h.

Referenced by Dismiss(), and SetCallback().

◆ m_showTime

int WX_INFOBAR::m_showTime
protected

The time to show the infobar. 0 = don't auto hide.

Definition at line 252 of file infobar.h.

Referenced by onTimer(), SetShowTime(), ShowMessage(), and ShowMessageFor().

◆ m_showTimer

wxTimer* WX_INFOBAR::m_showTimer
protected

The timer counting the autoclose period.

Definition at line 254 of file infobar.h.

Referenced by onTimer(), ShowMessage(), and ~WX_INFOBAR().

◆ m_type

MESSAGE_TYPE WX_INFOBAR::m_type
protected

The type of message being displayed.

Definition at line 256 of file infobar.h.

Referenced by DismissOutdatedSave(), and ShowMessage().

◆ m_updateLock

bool WX_INFOBAR::m_updateLock
protected

True if this infobar requested the UI update.

Definition at line 253 of file infobar.h.

Referenced by Dismiss(), DismissOutdatedSave(), IsLocked(), ShowMessage(), and ShowMessageFor().


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