9b2f55833e
Allow returning a wxBitmapBundle rather than an individual wxBitmap.
Also make GetLargeIcon() non-pure even in wxOSX, as it now doesn't need
to be overridden if GetIcon() is -- but don't make GetIcon() pure
virtual neither to allow the existing code overriding GetLargeIcon() to
keep working.
This incidentally fixes the icons for the standard pages under macOS
broken by 388d322b68 (carry changes to toolbar over to prefs on osx,
2021-09-28), which replaced return statements with assignments,
resulting in the icon being set to the last value assigned to it instead
of the correct one -- this commit restores the previous control flow in
wxStockPreferencesPage::GetLargeIcon() (now called GetIcon()).
Closes #22187.
148 lines
4.3 KiB
C++
148 lines
4.3 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/preferences.h
|
|
// Purpose: Declaration of wxPreferencesEditor class.
|
|
// Author: Vaclav Slavik
|
|
// Created: 2013-02-19
|
|
// Copyright: (c) 2013 Vaclav Slavik <vslavik@fastmail.fm>
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_PREFERENCES_H_
|
|
#define _WX_PREFERENCES_H_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_PREFERENCES_EDITOR
|
|
|
|
#include "wx/bitmap.h"
|
|
#include "wx/bmpbndl.h"
|
|
#include "wx/vector.h"
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxWindow;
|
|
|
|
class wxPreferencesEditorImpl;
|
|
|
|
#if defined(__WXOSX_COCOA__)
|
|
// GetLargeIcon() is used
|
|
#define wxHAS_PREF_EDITOR_ICONS
|
|
// Changes should be applied immediately
|
|
#define wxHAS_PREF_EDITOR_APPLY_IMMEDIATELY
|
|
// The dialog is shown non-modally.
|
|
#define wxHAS_PREF_EDITOR_MODELESS
|
|
#elif defined(__WXGTK__)
|
|
// Changes should be applied immediately
|
|
#define wxHAS_PREF_EDITOR_APPLY_IMMEDIATELY
|
|
// The dialog is shown non-modally.
|
|
#define wxHAS_PREF_EDITOR_MODELESS
|
|
#endif
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxPreferencesEditor: Native preferences editing
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// One page of a preferences window
|
|
class WXDLLIMPEXP_CORE wxPreferencesPage
|
|
{
|
|
public:
|
|
wxPreferencesPage() {}
|
|
virtual ~wxPreferencesPage() {}
|
|
|
|
// Name of the page, used e.g. for tabs
|
|
virtual wxString GetName() const = 0;
|
|
|
|
// Return the icon to use for the page. Currently only used on OS X, where
|
|
// implementation is required; unused on other platforms. Because of this,
|
|
// these methods are not pure virtual but must be implemented if OS X is
|
|
// supported.
|
|
//
|
|
// New code should override GetIcon(), GetLargeIcon() only exists for
|
|
// backwards compatibility.
|
|
virtual wxBitmapBundle GetIcon() const { return GetLargeIcon(); }
|
|
virtual wxBitmap GetLargeIcon() const { return wxBitmap(); }
|
|
|
|
// Create a window (usually a wxPanel) for this page. The caller takes
|
|
// ownership of the returned window.
|
|
virtual wxWindow *CreateWindow(wxWindow *parent) = 0;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxPreferencesPage);
|
|
};
|
|
|
|
|
|
// Helper for implementing some common pages (General, Advanced)
|
|
class WXDLLIMPEXP_CORE wxStockPreferencesPage : public wxPreferencesPage
|
|
{
|
|
public:
|
|
enum Kind
|
|
{
|
|
Kind_General,
|
|
Kind_Advanced
|
|
};
|
|
|
|
wxStockPreferencesPage(Kind kind) : m_kind(kind) {}
|
|
Kind GetKind() const { return m_kind; }
|
|
|
|
virtual wxString GetName() const wxOVERRIDE;
|
|
#ifdef __WXOSX_COCOA__
|
|
virtual wxBitmapBundle GetIcon() const wxOVERRIDE;
|
|
#endif
|
|
|
|
private:
|
|
Kind m_kind;
|
|
};
|
|
|
|
|
|
// Notice that this class does not inherit from wxWindow.
|
|
class WXDLLIMPEXP_CORE wxPreferencesEditor
|
|
{
|
|
public:
|
|
// Ctor creates an empty editor, use AddPage() to add controls to it.
|
|
wxPreferencesEditor(const wxString& title = wxString());
|
|
|
|
// Dtor destroys the dialog if still shown.
|
|
virtual ~wxPreferencesEditor();
|
|
|
|
// Add a new page to the editor. The editor takes ownership of the page
|
|
// and won't delete it until it is destroyed itself.
|
|
void AddPage(wxPreferencesPage *page);
|
|
|
|
// Show the preferences dialog or bring it to the top if it's already
|
|
// shown. Notice that this method may or may not block depending on the
|
|
// platform, i.e. depending on whether the dialog is modal or not.
|
|
virtual void Show(wxWindow* parent);
|
|
|
|
// Hide the currently shown dialog, if any. This is typically used to
|
|
// dismiss the dialog if the object whose preferences it is editing was
|
|
// closed.
|
|
void Dismiss();
|
|
|
|
// Whether changes to values in the pages should be applied immediately
|
|
// (OS X, GTK+) or only when the user clicks OK/Apply (Windows)
|
|
static bool ShouldApplyChangesImmediately()
|
|
{
|
|
#ifdef wxHAS_PREF_EDITOR_APPLY_IMMEDIATELY
|
|
return true;
|
|
#else
|
|
return false;
|
|
#endif
|
|
}
|
|
|
|
// Whether the dialog is shown modally, i.e. Show() blocks, or not.
|
|
static bool ShownModally()
|
|
{
|
|
#ifdef wxHAS_PREF_EDITOR_MODELESS
|
|
return false;
|
|
#else
|
|
return true;
|
|
#endif
|
|
}
|
|
|
|
private:
|
|
wxPreferencesEditorImpl* m_impl;
|
|
|
|
wxDECLARE_NO_COPY_CLASS(wxPreferencesEditor);
|
|
};
|
|
|
|
#endif // wxUSE_PREFERENCES_EDITOR
|
|
|
|
#endif // _WX_PREFERENCES_H_
|