#ifndef _WX_WINDOW_H_
#define _WX_WINDOW_H_
+#include "wx/settings.h" // solely for wxSystemColour
+
// if this is set to 1, we use deferred window sizing to reduce flicker when
// resizing complicated window hierarchies, but this can in theory result in
// different behaviour than the old code so we keep the possibility to use it
// created yet)
void MSWUpdateStyle(long flagsOld, long exflagsOld);
- // translate wxWidgets coords into Windows ones suitable to be passed to
- // ::CreateWindow()
- //
- // returns true if non default coords are returned, false otherwise
- bool MSWGetCreateWindowCoords(const wxPoint& pos,
- const wxSize& size,
- int& x, int& y,
- int& w, int& h) const;
-
// get the HWND to be used as parent of this window with CreateWindow()
virtual WXHWND MSWGetParent() const;
bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
bool HandleMouseMove(int x, int y, WXUINT flags);
- bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
+ bool HandleMouseWheel(wxMouseWheelAxis axis,
+ WXWPARAM wParam, WXLPARAM lParam);
- bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = false);
+ bool HandleChar(WXWPARAM wParam, WXLPARAM lParam);
bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
#if wxUSE_ACCEL
bool HandlePower(WXWPARAM wParam, WXLPARAM lParam, bool *vetoed);
- // Window procedure
+ // The main body of common window proc for all wxWindow objects. It tries
+ // to handle the given message and returns true if it was handled (the
+ // appropriate return value is then put in result, which must be non-NULL)
+ // or false if it wasn't.
+ //
+ // This function should be overridden in any new code instead of
+ // MSWWindowProc() even if currently most of the code overrides
+ // MSWWindowProc() as it had been written before this function was added.
+ virtual bool MSWHandleMessage(WXLRESULT *result,
+ WXUINT message,
+ WXWPARAM wParam,
+ WXLPARAM lParam);
+
+ // Common Window procedure for all wxWindow objects: forwards to
+ // MSWHandleMessage() and MSWDefWindowProc() if the message wasn't handled.
virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
// Calls an appropriate default window procedure
virtual void MSWDestroyWindow();
+ // Functions dealing with painting the window background. The derived
+ // classes should normally only need to reimplement MSWGetBgBrush() if they
+ // need to use a non-solid brush for erasing their background. This
+ // function is called by MSWGetBgBrushForChild() which only exists for the
+ // weird wxToolBar case and MSWGetBgBrushForChild() itself is used by
+ // MSWGetBgBrush() to actually find the right brush to use.
+
+ // Adjust the origin for the brush returned by MSWGetBgBrushForChild().
+ //
+ // This needs to be overridden for scrolled windows to ensure that the
+ // scrolling of their associated DC is taken into account.
+ //
+ // Both parameters must be non-NULL.
+ virtual void MSWAdjustBrushOrg(int* WXUNUSED(xOrg),
+ int* WXUNUSED(yOrg)) const
+ {
+ }
+
+ // The brush returned from here must remain valid at least until the next
+ // event loop iteration. Returning 0, as is done by default, indicates
+ // there is no custom background brush.
+ virtual WXHBRUSH MSWGetCustomBgBrush() { return 0; }
+
// this function should return the brush to paint the children controls
// background or 0 if this window doesn't impose any particular background
// on its children
// the hDC parameter is the DC background will be drawn on, it can be used
// to call SetBrushOrgEx() on it if the returned brush is a bitmap one
//
- // child parameter is never NULL
+ // child parameter is never NULL, it can be this window itself or one of
+ // its (grand)children
//
// the base class version returns a solid brush if we have a non default
// background colour or 0 otherwise
virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, wxWindowMSW *child);
// return the background brush to use for painting the given window by
- // quering the parent windows via their MSWGetBgBrushForChild() recursively
- WXHBRUSH MSWGetBgBrush(WXHDC hDC) { return MSWGetBgBrush(hDC, this); }
- WXHBRUSH MSWGetBgBrush(WXHDC hDC, wxWindowMSW *child);
+ // querying the parent windows via MSWGetBgBrushForChild() recursively
+ WXHBRUSH MSWGetBgBrush(WXHDC hDC);
+
+ enum MSWThemeColour
+ {
+ ThemeColourText = 0,
+ ThemeColourBackground,
+ ThemeColourBorder
+ };
+
+ // returns a specific theme colour, or if that is not possible then
+ // wxSystemSettings::GetColour(fallback)
+ wxColour MSWGetThemeColour(const wchar_t *themeName,
+ int themePart,
+ int themeState,
+ MSWThemeColour themeColour,
+ wxSystemColour fallback) const;
// gives the parent the possibility to draw its children background, e.g.
// this is used by wxNotebook to do it using DrawThemeBackground()
return true;
}
+ // This should be overridden to return true for the controls which have
+ // themed background that should through their children. Currently only
+ // wxNotebook uses this.
+ //
+ // The base class version already returns true if we have a solid
+ // background colour that should be propagated to our children.
+ virtual bool MSWHasInheritableBackground() const
+ {
+ return InheritsBackgroundColour();
+ }
+
+#if !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__)
+ #define wxHAS_MSW_BACKGROUND_ERASE_HOOK
+#endif
+
+#ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
+ // allows the child to hook into its parent WM_ERASEBKGND processing: call
+ // MSWSetEraseBgHook() with a non-NULL window to make parent call
+ // MSWEraseBgHook() on this window (don't forget to reset it to NULL
+ // afterwards)
+ //
+ // this hack is used by wxToolBar, see comments there
+ void MSWSetEraseBgHook(wxWindow *child);
+
+ // return true if WM_ERASEBKGND is currently hooked
+ bool MSWHasEraseBgHook() const;
+
+ // called when the window on which MSWSetEraseBgHook() had been called
+ // receives WM_ERASEBKGND
+ virtual bool MSWEraseBgHook(WXHDC WXUNUSED(hDC)) { return false; }
+#endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
+
// common part of Show/HideWithEffect()
bool MSWShowWithEffect(bool show,
wxShowEffect effect,
const wxString& ttip);
#endif // wxUSE_TOOLTIPS
- // the helper functions used by HandleChar/KeyXXX methods
- wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
- WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
+ // This is used by CreateKeyEvent() and also for wxEVT_CHAR[_HOOK] event
+ // creation. Notice that this method doesn't initialize wxKeyEvent
+ // m_keyCode and m_uniChar fields.
+ void InitAnyKeyEvent(wxKeyEvent& event,
+ WXWPARAM wParam,
+ WXLPARAM lParam) const;
+
+ // Helper functions used by HandleKeyXXX() methods and some derived
+ // classes, wParam and lParam have the same meaning as in WM_KEY{DOWN,UP}.
+ //
+ // NB: evType here must be wxEVT_KEY_{DOWN,UP} as wParam here contains the
+ // virtual key code, not character!
+ wxKeyEvent CreateKeyEvent(wxEventType evType,
+ WXWPARAM wParam,
+ WXLPARAM lParam = 0) const;
+
+ // Another helper for creating wxKeyEvent for wxEVT_CHAR and related types.
+ //
+ // The wParam and lParam here must come from WM_CHAR event parameters, i.e.
+ // wParam must be a character and not a virtual code.
+ wxKeyEvent CreateCharEvent(wxEventType evType,
+ WXWPARAM wParam,
+ WXLPARAM lParam) const;
// default OnEraseBackground() implementation, return true if we did erase
// for state as the system will decide for us what needs to be set
void MSWUpdateUIState(int action, int state = 0);
+ // translate wxWidgets coords into Windows ones suitable to be passed to
+ // ::CreateWindow(), called from MSWCreate()
+ virtual void MSWGetCreateWindowCoords(const wxPoint& pos,
+ const wxSize& size,
+ int& x, int& y,
+ int& w, int& h) const;
+
+ bool MSWEnableHWND(WXHWND hWnd, bool enable);
+
private:
// common part of all ctors
void Init();
DECLARE_EVENT_TABLE()
};
-// ----------------------------------------------------------------------------
-// inline functions
-// ----------------------------------------------------------------------------
-
-// ---------------------------------------------------------------------------
-// global functions
-// ---------------------------------------------------------------------------
-
-// kbd code translation
-WXDLLIMPEXP_CORE int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
-WXDLLIMPEXP_CORE WXWORD wxCharCodeWXToMSW(int id);
-
// window creation helper class: before creating a new HWND, instantiate an
// object of this class on stack - this allows to process the messages sent to
// the window even before CreateWindow() returns