OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ocpnFloatingToolbarDialog Class Reference

Floating toolbar dialog for OpenCPN. More...

#include <toolbar.h>

Inheritance diagram for ocpnFloatingToolbarDialog:
iENCToolbar

Public Member Functions

 ocpnFloatingToolbarDialog (wxWindow *parent, wxPoint position, long orient, float size_factor, ToolbarDlgCallbacks callbacks)
 
void OnClose (wxCloseEvent &event)
 
void OnWindowCreate (wxWindowCreateEvent &event)
 
void OnToolLeftClick (wxCommandEvent &event)
 
virtual void OnKeyDown (wxKeyEvent &event)
 
virtual void OnKeyUp (wxKeyEvent &event)
 
void OldMouseEvent (wxMouseEvent &event)
 
bool MouseEvent (wxMouseEvent &event)
 
void FadeTimerEvent (wxTimerEvent &event)
 
bool IsToolbarShown ()
 
float GetScaleFactor ()
 
void DestroyTimerEvent (wxTimerEvent &event)
 
void DrawDC (ocpnDC &dc, double displayScale)
 
void DrawGL (ocpnDC &gldc, double displayScale)
 
void RefreshFadeTimer ()
 
void EnableSubmerge (bool enable)
 
void Realize ()
 
ocpnToolBarSimple * GetToolbar ()
 
ocpnToolBarSimple * CreateNewToolbar ()
 
void SetToolbarHideMethod (int n_method)
 
void SetToolConfigString (wxString string)
 
wxString GetToolConfigString ()
 
float GetSizeFactor ()
 
void CreateConfigMenu ()
 
bool _toolbarConfigMenuUtil (ToolbarItemContainer *tic)
 
void RefreshToolbar ()
 
void Submerge ()
 
void Surface ()
 
void HideTooltip ()
 
void ShowTooltips ()
 
void EnableTooltips ()
 
void DisableTooltips ()
 
void UpdateRecoveryWindow (bool b_toolbarEnable)
 
void EnableTool (int toolid, bool enable)
 
void SetToolShortHelp (int toolid, const wxString &helpString)
 
void DestroyToolBar ()
 
void ToggleOrientation ()
 
void MoveDialogInScreenCoords (wxPoint posn, wxPoint posn_old)
 
void SetDefaultPosition ()
 
void LockPosition (bool lock)
 
virtual void SetColorScheme (ColorScheme cs)
 
ColorScheme GetColorScheme ()
 
bool CheckSurfaceRequest (wxMouseEvent &event)
 
void GetFrameRelativePosition (int *x, int *y)
 
void RestoreRelativePosition (int x, int y)
 
void SetGeometry (bool bAvoid, wxRect rectAvoid)
 
void SetMinX (int offset)
 
void SetMinY (int offset)
 
long GetOrient ()
 
wxSize GetToolSize ()
 
wxRect GetToolbarRect ()
 
wxSize GetToolbarSize ()
 
wxPoint GetToolbarPosition ()
 
void SetAutoHideTimer (int time)
 
void SetAutoHide (bool hide)
 
size_t GetToolCount ()
 
void SetToolShowMask (wxString mask)
 
wxString GetToolShowMask ()
 
void SetToolShowCount (int count)
 
int GetToolShowCount ()
 
bool CheckAndAddPlugInTool (ocpnToolBarSimple *tb)
 
bool AddDefaultPositionPlugInTools (ocpnToolBarSimple *tb)
 
int GetDockX ()
 
int GetDockY ()
 
void SetDockX (int x)
 
void SetDockY (int y)
 
void SetYAuxOffset (int offset)
 
void SetCanToggleOrientation (bool enable)
 
bool GetCanToggleOrientation ()
 
void SetBackGroundColorString (wxString colorRef)
 
void SetULDockPosition (wxPoint position)
 
void AddToolItem (ToolbarItemContainer *item)
 
int RebuildToolbar ()
 
void EnableRolloverBitmaps (bool bEnable)
 
bool GetEnableRolloverBitmaps ()
 

Public Attributes

bool toolbarConfigChanged
 
wxMenu * m_FloatingToolbarConfigMenu
 
wxString m_tblastAISiconName
 
wxToolBarToolBase * m_pTBAISTool
 
bool m_toolbar_scale_tools_shown
 
ArrayOfToolbarItemContainer m_Items
 

Protected Attributes

ocpnToolBarSimple * m_ptoolbar
 

Detailed Description

Floating toolbar dialog for OpenCPN.

Definition at line 395 of file toolbar.h.

Constructor & Destructor Documentation

◆ ocpnFloatingToolbarDialog()

ocpnFloatingToolbarDialog::ocpnFloatingToolbarDialog ( wxWindow *  parent,
wxPoint  position,
long  orient,
float  size_factor,
ToolbarDlgCallbacks  callbacks 
)

Definition at line 155 of file toolbar.cpp.

◆ ~ocpnFloatingToolbarDialog()

ocpnFloatingToolbarDialog::~ocpnFloatingToolbarDialog ( )

Definition at line 212 of file toolbar.cpp.

Member Function Documentation

◆ _toolbarConfigMenuUtil()

bool ocpnFloatingToolbarDialog::_toolbarConfigMenuUtil ( ToolbarItemContainer *  tic)

Definition at line 317 of file toolbar.cpp.

◆ AddToolItem()

void ocpnFloatingToolbarDialog::AddToolItem ( ToolbarItemContainer *  item)

Definition at line 238 of file toolbar.cpp.

◆ CheckAndAddPlugInTool()

bool ocpnFloatingToolbarDialog::CheckAndAddPlugInTool ( ocpnToolBarSimple *  tb)

Definition at line 725 of file toolbar.cpp.

◆ CreateConfigMenu()

void ocpnFloatingToolbarDialog::CreateConfigMenu ( )

Definition at line 312 of file toolbar.cpp.

◆ CreateNewToolbar()

ocpnToolBarSimple * ocpnFloatingToolbarDialog::CreateNewToolbar ( )

Definition at line 694 of file toolbar.cpp.

◆ DestroyToolBar()

void ocpnFloatingToolbarDialog::DestroyToolBar ( )

Definition at line 710 of file toolbar.cpp.

◆ DisableTooltips()

void ocpnFloatingToolbarDialog::DisableTooltips ( )
inline

Definition at line 440 of file toolbar.h.

◆ DrawDC()

void ocpnFloatingToolbarDialog::DrawDC ( ocpnDC &  dc,
double  displayScale 
)

Definition at line 549 of file toolbar.cpp.

◆ DrawGL()

void ocpnFloatingToolbarDialog::DrawGL ( ocpnDC &  gldc,
double  displayScale 
)

Definition at line 559 of file toolbar.cpp.

◆ EnableRolloverBitmaps()

void ocpnFloatingToolbarDialog::EnableRolloverBitmaps ( bool  bEnable)

Definition at line 779 of file toolbar.cpp.

◆ EnableSubmerge()

void ocpnFloatingToolbarDialog::EnableSubmerge ( bool  enable)
inline

Definition at line 417 of file toolbar.h.

◆ EnableTool()

void ocpnFloatingToolbarDialog::EnableTool ( int  toolid,
bool  enable 
)

Definition at line 351 of file toolbar.cpp.

◆ EnableTooltips()

void ocpnFloatingToolbarDialog::EnableTooltips ( )
inline

Definition at line 437 of file toolbar.h.

◆ FadeTimerEvent()

void ocpnFloatingToolbarDialog::FadeTimerEvent ( wxTimerEvent &  event)

Definition at line 218 of file toolbar.cpp.

◆ GetCanToggleOrientation()

bool ocpnFloatingToolbarDialog::GetCanToggleOrientation ( )
inline

Definition at line 488 of file toolbar.h.

◆ GetColorScheme()

ColorScheme ocpnFloatingToolbarDialog::GetColorScheme ( )
inline

Definition at line 453 of file toolbar.h.

◆ GetDockX()

int ocpnFloatingToolbarDialog::GetDockX ( )
inline

Definition at line 480 of file toolbar.h.

◆ GetDockY()

int ocpnFloatingToolbarDialog::GetDockY ( )
inline

Definition at line 481 of file toolbar.h.

◆ GetEnableRolloverBitmaps()

bool ocpnFloatingToolbarDialog::GetEnableRolloverBitmaps ( )
inline

Definition at line 505 of file toolbar.h.

◆ GetOrient()

long ocpnFloatingToolbarDialog::GetOrient ( )
inline

Definition at line 461 of file toolbar.h.

◆ GetScaleFactor()

float ocpnFloatingToolbarDialog::GetScaleFactor ( )
inline

Definition at line 410 of file toolbar.h.

◆ GetSizeFactor()

float ocpnFloatingToolbarDialog::GetSizeFactor ( )
inline

Definition at line 426 of file toolbar.h.

◆ GetToolbar()

ocpnToolBarSimple * ocpnFloatingToolbarDialog::GetToolbar ( )

Definition at line 686 of file toolbar.cpp.

◆ GetToolbarPosition()

wxPoint ocpnFloatingToolbarDialog::GetToolbarPosition ( )

Definition at line 500 of file toolbar.cpp.

◆ GetToolbarRect()

wxRect ocpnFloatingToolbarDialog::GetToolbarRect ( )

Definition at line 491 of file toolbar.cpp.

◆ GetToolbarSize()

wxSize ocpnFloatingToolbarDialog::GetToolbarSize ( )

Definition at line 496 of file toolbar.cpp.

◆ GetToolConfigString()

wxString ocpnFloatingToolbarDialog::GetToolConfigString ( )
inline

Definition at line 424 of file toolbar.h.

◆ GetToolCount()

size_t ocpnFloatingToolbarDialog::GetToolCount ( )

Definition at line 280 of file toolbar.cpp.

◆ GetToolShowCount()

int ocpnFloatingToolbarDialog::GetToolShowCount ( )

Definition at line 296 of file toolbar.cpp.

◆ GetToolShowMask()

wxString ocpnFloatingToolbarDialog::GetToolShowMask ( )
inline

Definition at line 472 of file toolbar.h.

◆ GetToolSize()

wxSize ocpnFloatingToolbarDialog::GetToolSize ( )

Definition at line 365 of file toolbar.cpp.

◆ HideTooltip()

void ocpnFloatingToolbarDialog::HideTooltip ( )

Definition at line 477 of file toolbar.cpp.

◆ IsToolbarShown()

bool ocpnFloatingToolbarDialog::IsToolbarShown ( )
inline

Definition at line 409 of file toolbar.h.

◆ LockPosition()

void ocpnFloatingToolbarDialog::LockPosition ( bool  lock)
inline

Definition at line 451 of file toolbar.h.

◆ MouseEvent()

bool ocpnFloatingToolbarDialog::MouseEvent ( wxMouseEvent &  event)

Definition at line 504 of file toolbar.cpp.

◆ OnKeyDown()

void ocpnFloatingToolbarDialog::OnKeyDown ( wxKeyEvent &  event)
virtual

Definition at line 308 of file toolbar.cpp.

◆ OnKeyUp()

void ocpnFloatingToolbarDialog::OnKeyUp ( wxKeyEvent &  event)
virtual

Definition at line 310 of file toolbar.cpp.

◆ OnToolLeftClick()

void ocpnFloatingToolbarDialog::OnToolLeftClick ( wxCommandEvent &  event)

Definition at line 676 of file toolbar.cpp.

◆ Realize()

void ocpnFloatingToolbarDialog::Realize ( )

Definition at line 541 of file toolbar.cpp.

◆ RebuildToolbar()

int ocpnFloatingToolbarDialog::RebuildToolbar ( )

Definition at line 242 of file toolbar.cpp.

◆ RefreshFadeTimer()

void ocpnFloatingToolbarDialog::RefreshFadeTimer ( )

Definition at line 531 of file toolbar.cpp.

◆ RefreshToolbar()

void ocpnFloatingToolbarDialog::RefreshToolbar ( )

Definition at line 514 of file toolbar.cpp.

◆ SetAutoHide()

void ocpnFloatingToolbarDialog::SetAutoHide ( bool  hide)
inline

Definition at line 468 of file toolbar.h.

◆ SetAutoHideTimer()

void ocpnFloatingToolbarDialog::SetAutoHideTimer ( int  time)

Definition at line 523 of file toolbar.cpp.

◆ SetBackGroundColorString()

void ocpnFloatingToolbarDialog::SetBackGroundColorString ( wxString  colorRef)

Definition at line 303 of file toolbar.cpp.

◆ SetCanToggleOrientation()

void ocpnFloatingToolbarDialog::SetCanToggleOrientation ( bool  enable)
inline

Definition at line 487 of file toolbar.h.

◆ SetColorScheme()

void ocpnFloatingToolbarDialog::SetColorScheme ( ColorScheme  cs)
virtual

Definition at line 355 of file toolbar.cpp.

◆ SetDefaultPosition()

void ocpnFloatingToolbarDialog::SetDefaultPosition ( )

Definition at line 426 of file toolbar.cpp.

◆ SetDockX()

void ocpnFloatingToolbarDialog::SetDockX ( int  x)
inline

Definition at line 482 of file toolbar.h.

◆ SetDockY()

void ocpnFloatingToolbarDialog::SetDockY ( int  y)
inline

Definition at line 483 of file toolbar.h.

◆ SetGeometry()

void ocpnFloatingToolbarDialog::SetGeometry ( bool  bAvoid,
wxRect  rectAvoid 
)

Definition at line 380 of file toolbar.cpp.

◆ SetMinX()

void ocpnFloatingToolbarDialog::SetMinX ( int  offset)
inline

Definition at line 459 of file toolbar.h.

◆ SetMinY()

void ocpnFloatingToolbarDialog::SetMinY ( int  offset)
inline

Definition at line 460 of file toolbar.h.

◆ SetToolbarHideMethod()

void ocpnFloatingToolbarDialog::SetToolbarHideMethod ( int  n_method)
inline

Definition at line 421 of file toolbar.h.

◆ SetToolConfigString()

void ocpnFloatingToolbarDialog::SetToolConfigString ( wxString  string)
inline

Definition at line 423 of file toolbar.h.

◆ SetToolShortHelp()

void ocpnFloatingToolbarDialog::SetToolShortHelp ( int  toolid,
const wxString &  helpString 
)

Definition at line 537 of file toolbar.cpp.

◆ SetToolShowCount()

void ocpnFloatingToolbarDialog::SetToolShowCount ( int  count)

Definition at line 289 of file toolbar.cpp.

◆ SetToolShowMask()

void ocpnFloatingToolbarDialog::SetToolShowMask ( wxString  mask)

Definition at line 287 of file toolbar.cpp.

◆ SetULDockPosition()

void ocpnFloatingToolbarDialog::SetULDockPosition ( wxPoint  position)

Definition at line 275 of file toolbar.cpp.

◆ SetYAuxOffset()

void ocpnFloatingToolbarDialog::SetYAuxOffset ( int  offset)
inline

Definition at line 485 of file toolbar.h.

◆ ShowTooltips()

void ocpnFloatingToolbarDialog::ShowTooltips ( )

Definition at line 483 of file toolbar.cpp.

◆ Submerge()

void ocpnFloatingToolbarDialog::Submerge ( )

Definition at line 471 of file toolbar.cpp.

◆ ToggleOrientation()

void ocpnFloatingToolbarDialog::ToggleOrientation ( )

Definition at line 489 of file toolbar.cpp.

Member Data Documentation

◆ m_FloatingToolbarConfigMenu

wxMenu* ocpnFloatingToolbarDialog::m_FloatingToolbarConfigMenu

Definition at line 492 of file toolbar.h.

◆ m_Items

ArrayOfToolbarItemContainer ocpnFloatingToolbarDialog::m_Items

Definition at line 500 of file toolbar.h.

◆ m_pTBAISTool

wxToolBarToolBase* ocpnFloatingToolbarDialog::m_pTBAISTool

Definition at line 495 of file toolbar.h.

◆ m_ptoolbar

ocpnToolBarSimple* ocpnFloatingToolbarDialog::m_ptoolbar
protected

Definition at line 508 of file toolbar.h.

◆ m_tblastAISiconName

wxString ocpnFloatingToolbarDialog::m_tblastAISiconName

Definition at line 494 of file toolbar.h.

◆ m_toolbar_scale_tools_shown

bool ocpnFloatingToolbarDialog::m_toolbar_scale_tools_shown

Definition at line 496 of file toolbar.h.

◆ toolbarConfigChanged

bool ocpnFloatingToolbarDialog::toolbarConfigChanged

Definition at line 490 of file toolbar.h.

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