solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Get rid of wxHAS_MSW_TASKDIALOG checks

Browse source 
All the necessary declarations should be available in the SDK headers of
any still supported compilers.

Note that we still need to keep the run-time checks because the task
dialog may be unavailable even in the latest OS versions when using old
comctl32.dll, as it happens if the application doesn't have a manifest
specifying the use of comctl32.dll v6.

See #22689.
This commit is contained in:
Vadim Zeitlin 2022-11-10 16:00:18 +00:00
parent e09d786b62
commit 4a650cf001
4 changed files with 9 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

23
include/wx/msw/private/msgdlg.h
View file

@ -13,19 +13,10 @@
#include "wx/msw/wrapcctl.h"
#include "wx/scopedarray.h"
// Macro to help identify if task dialogs are available: we rely on
// TD_WARNING_ICON being defined in the headers for this as this symbol is used
// by the task dialogs only. Also notice that task dialogs are available for
// Unicode applications only.
#if defined(TD_WARNING_ICON)
#define wxHAS_MSW_TASKDIALOG
#endif
// Provides methods for creating a task dialog.
namespace wxMSWMessageDialog
{
#ifdef wxHAS_MSW_TASKDIALOG
class wxMSWTaskDialogConfig
{
public:
@ -74,15 +65,15 @@ namespace wxMSWMessageDialog
typedef HRESULT (WINAPI *TaskDialogIndirect_t)(const TASKDIALOGCONFIG *,
int *, int *, BOOL *);
// Return the pointer to TaskDialogIndirect(). This should only be called
// if HasNativeTaskDialog() returned true and is normally guaranteed to
// succeed in this case.
// Return the pointer to TaskDialogIndirect(). It can return a null pointer
// if the task dialog is not available, which may happen even under modern
// OS versions when using comctl32.dll v5, as it happens if the application
// doesn't provide a manifest specifying that it wants to use v6.
TaskDialogIndirect_t GetTaskDialogIndirectFunc();
#endif // wxHAS_MSW_TASKDIALOG
// Check if the task dialog is available: this simply checks the OS version
// as we know that it's only present in Vista and later.
// Return true if the task dialog is available, but we don't actually need
// to show it yet (if we do, then GetTaskDialogIndirectFunc() should be
// used directly).
bool HasNativeTaskDialog();
// Translates standard MSW button IDs like IDCANCEL into an equivalent

23
src/msw/msgdlg.cpp
View file

@ -542,12 +542,8 @@ int wxMessageDialog::ShowModal()
wxWindowDisabler disableOthers(this, GetParentForModalDialog());
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
if ( TaskDialogIndirect_t taskDialogIndirect = GetTaskDialogIndirectFunc() )
{
TaskDialogIndirect_t taskDialogIndirect = GetTaskDialogIndirectFunc();
wxCHECK_MSG( taskDialogIndirect, wxID_CANCEL, wxS("no task dialog?") );
WinStruct<TASKDIALOGCONFIG> tdc;
wxMSWTaskDialogConfig wxTdc( *this );
wxTdc.MSWCommonTaskDialogInit( tdc );
@ -572,7 +568,6 @@ int wxMessageDialog::ShowModal()
return MSWTranslateReturnCode( msAns );
}
#endif // wxHAS_MSW_TASKDIALOG
return ShowMessageBox();
}
@ -591,13 +586,11 @@ long wxMessageDialog::GetEffectiveIcon() const
void wxMessageDialog::DoCentre(int dir)
{
#ifdef wxHAS_MSW_TASKDIALOG
// Task dialog is always centered on its parent window and trying to center
// it manually doesn't work because its HWND is not created yet so don't
// even try as this would only result in (debug) error messages.
if ( HasNativeTaskDialog() )
return;
#endif // wxHAS_MSW_TASKDIALOG
wxMessageDialogBase::DoCentre(dir);
}
@ -606,8 +599,6 @@ void wxMessageDialog::DoCentre(int dir)
// Helpers of the wxMSWMessageDialog namespace
// ----------------------------------------------------------------------------
#ifdef wxHAS_MSW_TASKDIALOG
wxMSWTaskDialogConfig::wxMSWTaskDialogConfig(const wxMessageDialogBase& dlg)
: buttons(new TASKDIALOG_BUTTON[MAX_BUTTONS])
{
@ -808,19 +799,9 @@ TaskDialogIndirect_t wxMSWMessageDialog::GetTaskDialogIndirectFunc()
return s_TaskDialogIndirect;
}
#endif // wxHAS_MSW_TASKDIALOG
bool wxMSWMessageDialog::HasNativeTaskDialog()
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( wxGetWinVersion() >= wxWinVersion_6 )
{
if ( wxMSWMessageDialog::GetTaskDialogIndirectFunc() )
return true;
}
#endif // wxHAS_MSW_TASKDIALOG
return false;
return wxMSWMessageDialog::GetTaskDialogIndirectFunc() != nullptr;
}
int wxMSWMessageDialog::MSWTranslateReturnCode(int msAns)

65
src/msw/progdlg.cpp
View file

@ -35,8 +35,6 @@
using namespace wxMSWMessageDialog;
#ifdef wxHAS_MSW_TASKDIALOG
// ----------------------------------------------------------------------------
// Constants
// ----------------------------------------------------------------------------
@ -382,8 +380,6 @@ void PerformNotificationUpdates(HWND hwnd,
} // anonymous namespace
#endif // wxHAS_MSW_TASKDIALOG
// ============================================================================
// wxProgressDialog implementation
// ============================================================================
@ -399,7 +395,6 @@ wxProgressDialog::wxProgressDialog( const wxString& title,
m_message(message),
m_title(title)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
SetTopParent(parent);
@ -412,14 +407,12 @@ wxProgressDialog::wxProgressDialog( const wxString& title,
return;
}
#endif // wxHAS_MSW_TASKDIALOG
Create(title, message, maximum, parent, style);
}
wxProgressDialog::~wxProgressDialog()
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( !m_taskDialogRunner )
return;
@ -472,12 +465,10 @@ wxProgressDialog::~wxProgressDialog()
ReenableOtherWindows();
delete m_taskDialogRunner;
#endif // wxHAS_MSW_TASKDIALOG
}
bool wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
if ( !DoNativeBeforeUpdate(skip) )
@ -545,14 +536,12 @@ bool wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
loop.Run();
return true;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::Update( value, newmsg, skip );
}
bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
if ( !DoNativeBeforeUpdate(skip) )
@ -582,14 +571,12 @@ bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
return m_sharedData->m_state != Canceled;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::Pulse( newmsg, skip );
}
void wxProgressDialog::DispatchEvents()
{
#ifdef wxHAS_MSW_TASKDIALOG
// No need for HasNativeTaskDialog() check, we're only called when this is
// the case.
@ -598,14 +585,10 @@ void wxProgressDialog::DispatchEvents()
// other user actions while the dialog is shown.
wxEventLoop::GetActive()->
YieldFor(wxEVT_CATEGORY_ALL & ~wxEVT_CATEGORY_USER_INPUT);
#else // !wxHAS_MSW_TASKDIALOG
wxFAIL_MSG( "unreachable" );
#endif // wxHAS_MSW_TASKDIALOG/!wxHAS_MSW_TASKDIALOG
}
bool wxProgressDialog::DoNativeBeforeUpdate(bool *skip)
{
#ifdef wxHAS_MSW_TASKDIALOG
DispatchEvents();
wxCriticalSectionLocker locker(m_sharedData->m_cs);
@ -624,19 +607,12 @@ bool wxProgressDialog::DoNativeBeforeUpdate(bool *skip)
m_timeStop = m_sharedData->m_timeStop;
return m_sharedData->m_state != Canceled;
#else // !wxHAS_MSW_TASKDIALOG
wxUnusedVar(skip);
wxFAIL_MSG( "unreachable" );
return false;
#endif // wxHAS_MSW_TASKDIALOG/!wxHAS_MSW_TASKDIALOG
}
void wxProgressDialog::Resume()
{
wxGenericProgressDialog::Resume();
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
HWND hwnd;
@ -668,48 +644,40 @@ void wxProgressDialog::Resume()
// thread would simply fail.
::BringWindowToTop(hwnd);
}
#endif // wxHAS_MSW_TASKDIALOG
}
WXWidget wxProgressDialog::GetHandle() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
wxCriticalSectionLocker locker(m_sharedData->m_cs);
return m_sharedData->m_hwnd;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::GetHandle();
}
int wxProgressDialog::GetValue() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
wxCriticalSectionLocker locker(m_sharedData->m_cs);
return m_sharedData->m_value;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::GetValue();
}
wxString wxProgressDialog::GetMessage() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
return m_message;
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::GetMessage();
}
void wxProgressDialog::SetRange(int maximum)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
SetMaximum(maximum);
@ -721,14 +689,12 @@ void wxProgressDialog::SetRange(int maximum)
return;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::SetRange( maximum );
}
bool wxProgressDialog::WasSkipped() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
if ( !m_sharedData )
@ -740,27 +706,23 @@ bool wxProgressDialog::WasSkipped() const
wxCriticalSectionLocker locker(m_sharedData->m_cs);
return m_sharedData->m_skipped;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::WasSkipped();
}
bool wxProgressDialog::WasCancelled() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
wxCriticalSectionLocker locker(m_sharedData->m_cs);
return m_sharedData->m_state == Canceled;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::WasCancelled();
}
void wxProgressDialog::SetTitle(const wxString& title)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
m_title = title;
@ -772,24 +734,20 @@ void wxProgressDialog::SetTitle(const wxString& title)
m_sharedData->m_notifications |= wxSPDD_TITLE_CHANGED;
}
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::SetTitle(title);
}
wxString wxProgressDialog::GetTitle() const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
return m_title;
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::GetTitle();
}
void wxProgressDialog::SetIcons(const wxIconBundle& icons)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
m_icons = icons; // We can't just call to parent's SetIcons()
@ -816,14 +774,12 @@ void wxProgressDialog::SetIcons(const wxIconBundle& icons)
return;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::SetIcons(icons);
}
void wxProgressDialog::DoMoveWindow(int x, int y, int width, int height)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
if ( m_sharedData )
@ -835,7 +791,6 @@ void wxProgressDialog::DoMoveWindow(int x, int y, int width, int height)
return;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::DoMoveWindow(x, y, width, height);
}
@ -844,22 +799,17 @@ wxRect wxProgressDialog::GetTaskDialogRect() const
{
wxRect r;
#ifdef wxHAS_MSW_TASKDIALOG
if ( m_sharedData )
{
wxCriticalSectionLocker locker(m_sharedData->m_cs);
r = wxRectFromRECT(wxGetWindowRect(m_sharedData->m_hwnd));
}
#else // !wxHAS_MSW_TASKDIALOG
wxFAIL_MSG( "unreachable" );
#endif // wxHAS_MSW_TASKDIALOG/!wxHAS_MSW_TASKDIALOG
return r;
}
void wxProgressDialog::DoGetPosition(int *x, int *y) const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
const wxRect r = GetTaskDialogRect();
@ -870,14 +820,12 @@ void wxProgressDialog::DoGetPosition(int *x, int *y) const
return;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::DoGetPosition(x, y);
}
void wxProgressDialog::DoGetSize(int *width, int *height) const
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
const wxRect r = GetTaskDialogRect();
@ -888,14 +836,12 @@ void wxProgressDialog::DoGetSize(int *width, int *height) const
return;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::DoGetSize(width, height);
}
void wxProgressDialog::Fit()
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
wxCriticalSectionLocker locker(m_sharedData->m_cs);
@ -906,14 +852,12 @@ void wxProgressDialog::Fit()
// Don't change the message, but pretend that it did change.
m_sharedData->m_notifications |= wxSPDD_MESSAGE_CHANGED;
}
#endif // wxHAS_MSW_TASKDIALOG
wxGenericProgressDialog::Fit();
}
bool wxProgressDialog::Show(bool show)
{
#ifdef wxHAS_MSW_TASKDIALOG
if ( HasNativeTaskDialog() )
{
// The dialog can't be hidden at all and showing it again after it had
@ -981,14 +925,12 @@ bool wxProgressDialog::Show(bool show)
// Do not show the underlying dialog.
return false;
}
#endif // wxHAS_MSW_TASKDIALOG
return wxGenericProgressDialog::Show( show );
}
void wxProgressDialog::UpdateExpandedInformation(int value)
{
#ifdef wxHAS_MSW_TASKDIALOG
unsigned long elapsedTime;
unsigned long estimatedTime;
unsigned long remainingTime;
@ -1041,17 +983,12 @@ void wxProgressDialog::UpdateExpandedInformation(int value)
m_sharedData->m_expandedInformation = expandedInformation;
m_sharedData->m_notifications |= wxSPDD_EXPINFO_CHANGED;
}
#else // !wxHAS_MSW_TASKDIALOG
wxUnusedVar(value);
#endif // wxHAS_MSW_TASKDIALOG/!wxHAS_MSW_TASKDIALOG
}
// ----------------------------------------------------------------------------
// wxProgressDialogTaskRunner and related methods
// ----------------------------------------------------------------------------
#ifdef wxHAS_MSW_TASKDIALOG
void* wxProgressDialogTaskRunner::Entry()
{
WinStruct<TASKDIALOGCONFIG> tdc;
@ -1268,6 +1205,4 @@ wxProgressDialogTaskRunner::TaskDialogCallbackProc
return S_OK;
}
#endif // wxHAS_MSW_TASKDIALOG
#endif // wxUSE_PROGRESSDLG && wxUSE_THREADS

4
src/msw/richmsgdlg.cpp
View file

@ -20,8 +20,6 @@
#include "wx/utils.h" // for wxWindowDisabler
#endif
// This will define wxHAS_MSW_TASKDIALOG if we have support for it in the
// headers we use.
#include "wx/msw/private/msgdlg.h"
// ----------------------------------------------------------------------------
@ -32,7 +30,6 @@ int wxRichMessageDialog::ShowModal()
{
WX_HOOK_MODAL_DIALOG();
#ifdef wxHAS_MSW_TASKDIALOG
using namespace wxMSWMessageDialog;
if ( HasNativeTaskDialog() )
@ -105,7 +102,6 @@ int wxRichMessageDialog::ShowModal()
return MSWTranslateReturnCode( msAns );
}
#endif // wxHAS_MSW_TASKDIALOG
// use the generic version when task dialog is't available at either
// compile or run-time.