Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Send wxEVT_COLOUR_CHANGED from wxColourDialog under MSW

Browse Source 
Add support for a new event sent by wxColourDialog, currently only under
MSW, when the colour currently selected in it changes.

Based on work by Trylz, see https://github.com/wxWidgets/wxWidgets/pull/1219
This commit is contained in:
Vadim Zeitlin
2019-04-20 21:47:42 +02:00
parent 5b7114b4d7
commit 35c16935f1
7 changed files with 228 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
include/wx/colordlg.h
View File

@@ -31,6 +31,52 @@
#define wxColourDialog wxGenericColourDialog
#endif
// Under some platforms (currently only wxMSW) wxColourDialog can send events
// of this type while it is shown.
//
// Notice that this class is almost identical to wxColourPickerEvent but it
// doesn't really sense to reuse the same class for both controls.
class WXDLLIMPEXP_CORE wxColourDialogEvent : public wxCommandEvent
{
public:
wxColourDialogEvent()
{
}
wxColourDialogEvent(wxEventType evtType,
wxColourDialog* dialog,
const wxColour& colour)
: wxCommandEvent(evtType, dialog->GetId()),
m_colour(colour)
{
SetEventObject(dialog);
}
// default copy ctor and dtor are ok
wxColour GetColour() const { return m_colour; }
void SetColour(const wxColour& colour) { m_colour = colour; }
virtual wxEvent *Clone() const wxOVERRIDE
{
return new wxColourDialogEvent(*this);
}
private:
wxColour m_colour;
wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxColourDialogEvent);
};
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COLOUR_CHANGED, wxColourDialogEvent);
#define wxColourDialogEventHandler(func) \
wxEVENT_HANDLER_CAST(wxColourDialogEventFunction, func)
#define EVT_COLOUR_CHANGED(id, fn) \
wx__DECLARE_EVT1(wxEVT_COLOUR_CHANGED, id, wxColourDialogEventHandler(fn))
// get the colour from user and return it
WXDLLIMPEXP_CORE wxColour wxGetColourFromUser(wxWindow *parent = NULL,
const wxColour& colInit = wxNullColour,

6
include/wx/msw/colordlg.h
View File

@@ -44,6 +44,9 @@ public:
// called from the hook procedure on WM_INITDIALOG reception
virtual void MSWOnInitDone(WXHWND hDlg);
// called from the hook procedure
void MSWCheckIfCurrentChanged(WXCOLORREF currentCol);
protected:
// common part of all ctors
void Init();
@@ -57,6 +60,9 @@ protected:
wxColourData m_colourData;
wxString m_title;
// Currently selected colour, used while the dialog is being shown.
WXCOLORREF m_currentCol;
// indicates that the dialog should be centered in this direction if non 0
// (set by DoCentre(), used by MSWOnInitDone())
int m_centreDir;

60
interface/wx/colordlg.h
View File

@@ -10,11 +10,46 @@
This class represents the colour chooser dialog.
Starting from wxWidgets 3.1.3 and currently in the MSW port only, this
dialog generates wxEVT_COLOUR_CHANGED events while it is being shown, i.e.
from inside its ShowModal() method, that notify the program about the
change of the currently selected colour and allow it to e.g. preview the
effect of selecting this colour. Note that if you react to this event, you
should also correctly revert to the previously selected colour if the
dialog is cancelled by the user.
Example of using this class with dynamic feedback for the selected colour:
@code
// Some function for redrawing using the given colour. Ideally, it
// shouldn't do anything if the colour is the same as the one used
// before.
void Redraw(const wxColour& colour);
wxColourData data;
data.SetColour(initialColourToUse);
wxColourData dlg(this, &data);
dlg.Bind(wxEVT_COLOUR_CHANGED, [](wxColourDialogEvent& event) {
Redraw(event.GetColour());
});
if ( dlg.ShowModal() == wxID_OK ) {
// Colour did change.
} else {
// Colour didn't change.
}
// This call is unnecessary under platforms generating
// wxEVT_COLOUR_CHANGED if the dialog was accepted and unnecessary
// under the platforms not generating this event if it was cancelled,
// so we could check for the different cases explicitly to avoid it,
// but it's simpler to just always call it.
Redraw(data.GetColour());
@endcode
@library{wxcore}
@category{cmndlg}
@see @ref overview_cmndlg_colour, wxColour, wxColourData,
wxGetColourFromUser()
wxColourDialogEvent, wxGetColourFromUser()
*/
class wxColourDialog : public wxDialog
{
@@ -55,7 +90,30 @@ public:
virtual int ShowModal();
};
/**
This event class is used for the events generated by wxColourDialog.
@beginEventTable{wxColourPickerEvent}
@event{EVT_COLOUR_CHANGED(id, func)}
Generated whenever the currently selected colour in the dialog
changes. This event is currently only implemented in wxMSW.
@endEventTable
@library{wxcore}
@category{events}
@see wxColourDialog
@since 3.1.3
*/
class wxColourDialogEvent : public wxCommandEvent
{
public:
/**
Retrieve the colour the user has just selected.
*/
wxColour GetColour() const;
};
// ============================================================================
// Global functions/macros

21
samples/dialogs/dialogs.cpp
View File

@@ -734,20 +734,35 @@ MyFrame::~MyFrame()
#if wxUSE_COLOURDLG
void MyFrame::DoApplyColour(const wxColour& colour)
{
if ( colour == m_canvas->GetBackgroundColour() )
return;
m_canvas->SetBackgroundColour(colour);
m_canvas->ClearBackground();
m_canvas->Refresh();
}
void MyFrame::OnColourChanged(wxColourDialogEvent& event)
{
DoApplyColour(event.GetColour());
}
void MyFrame::ChooseColour(wxCommandEvent& event)
{
m_clrData.SetColour(m_canvas->GetBackgroundColour());
m_clrData.SetChooseAlpha(event.GetId() == DIALOGS_CHOOSE_COLOUR_ALPHA);
wxColourDialog dialog(this, &m_clrData);
dialog.Bind(wxEVT_COLOUR_CHANGED, &MyFrame::OnColourChanged, this);
dialog.SetTitle("Please choose the background colour");
if ( dialog.ShowModal() == wxID_OK )
{
m_clrData = dialog.GetColourData();
m_canvas->SetBackgroundColour(m_clrData.GetColour());
m_canvas->ClearBackground();
m_canvas->Refresh();
}
DoApplyColour(m_clrData.GetColour());
}
void MyFrame::GetColour(wxCommandEvent& WXUNUSED(event))

5
samples/dialogs/dialogs.h
View File

@@ -506,6 +506,11 @@ public:
void OnExit(wxCommandEvent& event);
private:
#if wxUSE_COLOURDLG
void OnColourChanged(wxColourDialogEvent& event);
void DoApplyColour(const wxColour& colour);
#endif // wxUSE_COLOURDLG
#if wxUSE_DIRDLG
void DoDirChoose(int style);
#endif // wxUSE_DIRDLG

4
src/common/colourdata.cpp
View File

@@ -129,6 +129,10 @@ bool wxColourData::FromString(const wxString& str)
#include "wx/colordlg.h"
wxIMPLEMENT_DYNAMIC_CLASS(wxColourDialogEvent, wxCommandEvent);
wxDEFINE_EVENT(wxEVT_COLOUR_CHANGED, wxColourDialogEvent);
wxColour wxGetColourFromUser(wxWindow *parent,
const wxColour& colInit,
const wxString& caption,

98
src/msw/colordlg.cpp
View File

@@ -37,6 +37,8 @@
#include "wx/math.h"
#endif
#include "wx/scopeguard.h"
#include "wx/msw/private.h"
#include <stdlib.h>
@@ -51,6 +53,9 @@
// and "Define Custom Colors" extension not shown
static wxRect gs_rectDialog(0, 0, 222, 324);
// The dialog currently being shown or null.
static wxColourDialog* gs_activeDialog = NULL;
// ----------------------------------------------------------------------------
// wxWin macros
// ----------------------------------------------------------------------------
@@ -61,6 +66,53 @@ wxIMPLEMENT_DYNAMIC_CLASS(wxColourDialog, wxDialog);
// implementation
// ============================================================================
#ifndef COLORBOXES
#define COLORBOXES 64
#endif
// Undocumented property storing the COLORINFO struct in the standard dialog.
#ifndef COLORPROP
#define COLORPROP (LPCTSTR) 0xA000L
#endif
namespace
{
// The private and undocumented Windows structure used by the standard dialog.
// See https://social.msdn.microsoft.com/Forums/en-US/c5fcfd9f-6b27-4848-bb9d-94bec105eabd/get-the-current-clicked-color-from-choosecolor-dialog?forum=windowsgeneraldevelopmentissues
struct COLORINFO
{
UINT ApiType;
LPCHOOSECOLOR pCC;
HANDLE hLocal;
HANDLE hDialog;
HPALETTE hPal;
DWORD currentRGB;
WORD currentHue;
WORD currentSat;
WORD currentLum;
WORD nHueWidth;
WORD nSatHeight;
WORD nLumHeight;
WORD nCurMix;
WORD nCurDsp;
WORD nCurBox;
WORD nHuePos;
WORD nSatPos;
WORD nLumPos;
RECT rOriginal;
RECT rRainbow;
RECT rLumScroll;
RECT rLumPaint;
RECT rCurrentColor;
RECT rNearestPure;
RECT rColorSamples;
BOOL bFoldOut;
DWORD rgbBoxColor[COLORBOXES];
};
} // anonymous namespace
// ----------------------------------------------------------------------------
// colour dialog hook proc
// ----------------------------------------------------------------------------
@@ -69,19 +121,30 @@ UINT_PTR CALLBACK
wxColourDialogHookProc(HWND hwnd,
UINT uiMsg,
WPARAM WXUNUSED(wParam),
LPARAM lParam)
LPARAM WXUNUSED(lParam))
{
if ( uiMsg == WM_INITDIALOG )
switch ( uiMsg )
{
CHOOSECOLOR *pCC = (CHOOSECOLOR *)lParam;
wxColourDialog * const
dialog = reinterpret_cast<wxColourDialog *>(pCC->lCustData);
const wxString title = dialog->GetTitle();
case WM_INITDIALOG:
{
const wxString title = gs_activeDialog->GetTitle();
if ( !title.empty() )
::SetWindowText(hwnd, title.t_str());
dialog->MSWOnInitDone((WXHWND)hwnd);
gs_activeDialog->MSWOnInitDone((WXHWND)hwnd);
}
break;
default:
// Check if the currently selected colour changed.
//
// Doing it for all messages might be an overkill, we probably
// could only do it for keyboard/mouse ones.
if ( const COLORINFO* pCI = (COLORINFO*)::GetProp(hwnd, COLORPROP) )
{
gs_activeDialog->MSWCheckIfCurrentChanged(pCI->currentRGB);
}
break;
}
return 0;
@@ -135,9 +198,11 @@ int wxColourDialog::ShowModal()
custColours[i] = RGB(255,255,255);
}
m_currentCol = wxColourToRGB(m_colourData.GetColour());
chooseColorStruct.lStructSize = sizeof(CHOOSECOLOR);
chooseColorStruct.hwndOwner = hWndParent;
chooseColorStruct.rgbResult = wxColourToRGB(m_colourData.GetColour());
chooseColorStruct.rgbResult = m_currentCol;
chooseColorStruct.lpCustColors = custColours;
chooseColorStruct.Flags = CC_RGBINIT | CC_ENABLEHOOK;
@@ -147,6 +212,10 @@ int wxColourDialog::ShowModal()
if ( m_colourData.GetChooseFull() )
chooseColorStruct.Flags |= CC_FULLOPEN;
// Set the global pointer for the duration of the modal dialog life-time.
gs_activeDialog = this;
wxON_BLOCK_EXIT_NULL(gs_activeDialog);
// do show the modal dialog
if ( !::ChooseColor(&chooseColorStruct) )
{
@@ -277,4 +346,15 @@ void wxColourDialog::MSWOnInitDone(WXHWND hDlg)
SetHWND(NULL);
}
void wxColourDialog::MSWCheckIfCurrentChanged(WXCOLORREF currentCol)
{
if ( currentCol == m_currentCol )
return;
m_currentCol = currentCol;
wxColourDialogEvent event(wxEVT_COLOUR_CHANGED, this, wxRGBToColour(currentCol));
ProcessWindowEvent(event);
}
#endif // wxUSE_COLOURDLG