Customize toolbar on OSX

include/wx/control.h

@@ -46,7 +46,8 @@ class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
 
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
-
+    void MarkAvailable(bool available) { m_available = available; }
+    bool IsAvailable() const { return m_available; }
     // set label with mnemonics
     virtual void SetLabel(const wxString& label) override
     {
@@ -193,7 +194,7 @@ class WXDLLIMPEXP_CORE wxControlBase : public wxWindow
     // this field contains the label in wx format, i.e. with '&' mnemonics,
     // as it was passed to the last SetLabel() call
     wxString m_labelOrig;
-
+    bool m_available;
     wxDECLARE_NO_COPY_CLASS(wxControlBase);
 };
 

include/wx/event.h

@@ -724,6 +724,7 @@ wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMBOBOX, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_TOOL_RCLICKED, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_TOOL_DROPDOWN, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_TOOL_ENTER, wxCommandEvent);
+wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_TB_CUSTOMIZE, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMBOBOX_DROPDOWN, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMBOBOX_CLOSEUP, wxCommandEvent);
 
@@ -4682,6 +4683,7 @@ typedef void (wxEvtHandler::*wxFullScreenEventFunction)(wxFullScreenEvent&);
 #define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_TOOL_ENTER, winid, wxCommandEventHandler(func))
+#define EVT_TB_CUSTOMIZE(func) wx__DECLARE_EVT1(wxEVT_TB_CUSTOMIZE, wxCommandEventHandler(func))
 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_CHECKLISTBOX, winid, wxCommandEventHandler(func))
 #define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
 #define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))

include/wx/osx/toolbar.h

@@ -89,9 +89,11 @@ class WXDLLIMPEXP_CORE wxToolBar: public wxToolBarBase
                                           wxObject *clientData = nullptr,
                                           const wxString& shortHelp = wxEmptyString,
                                           const wxString& longHelp = wxEmptyString) override;
+
     virtual wxToolBarToolBase *CreateTool(wxControl *control,
                                           const wxString& label) override;
 
+    void *GetMacToolbar() { return m_macToolbar; };
 protected:
     // common part of all ctors
     void Init();

include/wx/tbarbase.h

@@ -72,7 +72,8 @@ class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject
                       const wxString& longHelpString = wxEmptyString)
         : m_label(label),
           m_shortHelpString(shortHelpString),
-          m_longHelpString(longHelpString)
+          m_longHelpString(longHelpString),
+          m_available(true)
     {
         Init
         (
@@ -94,7 +95,8 @@ class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject
     wxToolBarToolBase(wxToolBarBase *tbar,
                       wxControl *control,
                       const wxString& label)
-        : m_label(label)
+        : m_label(label),
+          m_available(true)
     {
         Init(tbar, wxTOOL_STYLE_CONTROL, control->GetId(), wxITEM_MAX);
 
@@ -144,6 +146,8 @@ class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject
     bool IsToggled() const { return m_toggled; }
     bool CanBeToggled() const
         { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; }
+    bool IsAvailable() const { return m_available; }
+    virtual void MarkAvailable(bool available) { m_available = available; }
 
     // attributes
     wxBitmapBundle GetNormalBitmapBundle() const { return m_bmpNormal; }
@@ -266,6 +270,7 @@ class WXDLLIMPEXP_CORE wxToolBarToolBase : public wxObject
     // short and long help strings
     wxString m_shortHelpString;
     wxString m_longHelpString;
+    bool m_available;
 
 #if wxUSE_MENUS
     wxMenu *m_dropdownMenu;
@@ -314,7 +319,7 @@ class WXDLLIMPEXP_CORE wxToolBarBase : public wxControl
                                const wxString& shortHelp = wxEmptyString,
                                wxItemKind kind = wxITEM_NORMAL)
     {
-        return AddTool(toolid, label, bitmap, wxBitmapBundle(), kind, shortHelp);
+        return AddTool(toolid, label, bitmap, wxBitmapBundle(), kind, shortHelp, wxEmptyString, nullptr);
     }
 
     // add a check tool, i.e. a tool which can be toggled

interface/wx/toolbar.h

@@ -159,6 +159,19 @@ class wxToolBarToolBase : public wxObject
 
     void SetDropdownMenu(wxMenu *menu);
     wxMenu *GetDropdownMenu() const;
+
+    /**
+     Mark the tool to be not visible.
+
+     By default all tools and controls in the toolbar are visible.
+     If you want, you can mark the tool/control not visible by default
+     When you do that user will be able to go to the customization
+     dialog and add the tool/control at a later time.
+     When you want that you pass "false" to this function.
+
+     @since 3.3.0
+     */
+    void MarkAvailable(bool available);
 };
 
 
@@ -271,6 +284,15 @@ class wxToolBarToolBase : public wxObject
         Process a @c wxEVT_TOOL_DROPDOWN event. If unhandled,
         displays the default dropdown menu set using
         wxToolBar::SetDropdownMenu().
+    @event{EVT_TB_CUSTOMIZE(id)}
+        Process a @c wxEVT_TB_CUSTOMIZE event. Under MSW and OSX
+        it will display native customization dialogs. On GTK it will
+        be generic.
+        In order for this event to happen you need to double click the
+        toolbar on MSW and right click + context menu selection on OSX/GTK
+        By default all added tools are displayed.
+
+        This event is implemented @since 3.3.0
     @endEventTable
 
     The toolbar class emits menu commands in the same way that a frame menubar
@@ -878,6 +900,25 @@ class wxToolBar : public wxControl
         @see GetMargins(), wxSize
     */
     void SetMargins(const wxSize& size);
+
+    /**
+        Return whether the tool is displayed by default or not
+        By default all tools are displayed.
+
+        @since 3.3
+    */
+    bool IsAvailable() const;
+
+    /**
+        Calling this function with the parameter set to false will not add the tool to the toolbar
+        by default.
+
+        @param available
+            Whether add the tool by default to the toolbar or not.
+
+        @since 3.3
+    */
+    void MarkAvailable(bool available);
     ///@}
 
     /**

samples/toolbar/toolbar.cpp

@@ -470,6 +470,7 @@ void MyFrame::PopulateToolbar(wxToolBarBase* toolBar)
         combo->Append("combobox with extremely, extremely, extremely, extremely long label");
         combo->Append("in a");
         combo->Append("toolbar");
+        combo->MarkAvailable( false );
         toolBar->AddControl(combo, "Combo Label");
     }
 #endif // USE_CONTROLS_IN_TOOLBAR
@@ -511,7 +512,9 @@ void MyFrame::PopulateToolbar(wxToolBarBase* toolBar)
     toolBar->AddStretchableSpace();
     toolBar->AddTool(wxID_HELP, "Help", toolBarBitmaps[Tool_help], "Help button", wxITEM_CHECK);
 
-    toolBar->AddTool(wxID_ABOUT, "About", toolBarBitmaps[Tool_about], "About");
+    wxToolBarToolBase *tool = new wxToolBarToolBase( toolBar, wxID_ABOUT, "About", toolBarBitmaps[Tool_about], toolBarBitmaps[Tool_about] );
+    tool->MarkAvailable( false );
+    toolBar->AddTool( tool );
 
     if ( !m_pathBmp.empty() )
     {

src/common/event.cpp

@@ -165,6 +165,7 @@ wxDEFINE_EVENT( wxEVT_COMBOBOX, wxCommandEvent );
 wxDEFINE_EVENT( wxEVT_TOOL_RCLICKED, wxCommandEvent );
 wxDEFINE_EVENT( wxEVT_TOOL_ENTER, wxCommandEvent );
 wxDEFINE_EVENT( wxEVT_TOOL_DROPDOWN, wxCommandEvent );
+wxDEFINE_EVENT( wxEVT_TB_CUSTOMIZE, wxCommandEvent);
 wxDEFINE_EVENT( wxEVT_COMBOBOX_DROPDOWN, wxCommandEvent);
 wxDEFINE_EVENT( wxEVT_COMBOBOX_CLOSEUP, wxCommandEvent);
 

src/common/tbarbase.cpp

@@ -467,9 +467,12 @@ void wxToolBarBase::AdjustToolBitmapSize()
           i != m_tools.end();
           ++i )
     {
-        const wxBitmapBundle& bmp = (*i)->GetNormalBitmapBundle();
-        if ( bmp.IsOk() )
-            bundles.push_back(bmp);
+        if( (*i)->IsAvailable() )
+        {
+            const wxBitmapBundle& bmp = (*i)->GetNormalBitmapBundle();
+            if ( bmp.IsOk() )
+                bundles.push_back(bmp);
+        }
     }
 
     if ( bundles.empty() )

src/gtk/toolbar.cpp

@@ -218,6 +218,14 @@ static void arrow_toggled(GtkToggleButton* button, wxToolBarTool* tool)
 }
 }
 
+extern "C"
+{
+static gboolean context_menu(GtkToolbar *WXUNUSED(self), gint WXUNUSED(x), gint WXUNUSED(y), gint WXUNUSED(button), gpointer WXUNUSED(user_data))
+{
+    return TRUE;
+}
+}
+
 //-----------------------------------------------------------------------------
 // "button_press_event" from dropdown menu button
 //-----------------------------------------------------------------------------
@@ -462,6 +470,7 @@ bool wxToolBar::Create( wxWindow *parent,
     wxGCC_WARNING_RESTORE()
 #endif // !__WXGTK4__
     g_object_ref(m_widget);
+    g_signal_connect( m_toolbar, "popup-context-menu", G_CALLBACK( context_menu ), nullptr );
     gtk_widget_show(GTK_WIDGET(m_toolbar));
 
     m_parent->DoAddChild( this );

src/osx/carbon/control.cpp

@@ -58,7 +58,7 @@ bool wxControl::Create( wxWindow *parent,
     if (rval)
         SetValidator( validator );
 #endif
-
+    m_available = true;
     return rval;
 }