wxColour -> NSColor conversion.

[wxWidgets.git] / include / wx / msw / window.h

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index 3b7ad3fb3c42d2e1bebe79eea08fc60479433415..51a09d5579dce373361b189ec5889850b1d32df6 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -13,24 +13,21 @@
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 

-// ---------------------------------------------------------------------------
-// constants
-// ---------------------------------------------------------------------------
-
-#if WXWIN_COMPATIBILITY_2_4
-// they're unused by wxWidgets...
-enum
-{
-    wxKEY_SHIFT = 1,
-    wxKEY_CTRL  = 2
-};
+// 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
+// by setting this to 0 (in the future this should be removed completely)
+#ifdef __WXWINCE__
+    #define wxUSE_DEFERRED_SIZING 0
+#else
+    #define wxUSE_DEFERRED_SIZING 1

 #endif
 
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 // ---------------------------------------------------------------------------
 
 #endif
 
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxWindowMSW : public wxWindowBase
+class WXDLLIMPEXP_CORE wxWindowMSW : public wxWindowBase

 {
     friend class wxSpinCtrl;
     friend class wxSlider;
 {
     friend class wxSpinCtrl;
     friend class wxSlider;


@@ -68,8 +65,17 @@ public:
     virtual void Raise();
     virtual void Lower();
 
     virtual void Raise();
     virtual void Lower();
 

-    virtual bool Show( bool show = true );
-    virtual bool Enable( bool enable = true );
+    virtual bool Show(bool show = true);
+    virtual bool ShowWithEffect(wxShowEffect effect,
+                                unsigned timeout = 0)
+    {
+        return MSWShowWithEffect(true, effect, timeout);
+    }
+    virtual bool HideWithEffect(wxShowEffect effect,
+                                unsigned timeout = 0)
+    {
+        return MSWShowWithEffect(false, effect, timeout);
+    }

 
     virtual void SetFocus();
     virtual void SetFocusFromKbd();
 
     virtual void SetFocus();
     virtual void SetFocusFromKbd();


@@ -81,21 +87,14 @@ public:
     virtual void Refresh( bool eraseBackground = true,
                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();
     virtual void Refresh( bool eraseBackground = true,
                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();

-    virtual void Freeze();
-    virtual void Thaw();

 
 

-    virtual void SetWindowStyleFlag( long style );
+    virtual void SetWindowStyleFlag(long style);
+    virtual void SetExtraStyle(long exStyle);

     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;

-    virtual void GetTextExtent(const wxString& string,
-                               int *x, int *y,
-                               int *descent = (int *) NULL,
-                               int *externalLeading = (int *) NULL,
-                               const wxFont *theFont = (const wxFont *) NULL)
-                               const;

 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );


@@ -104,11 +103,17 @@ public:
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual void ScrollWindow( int dx, int dy,
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual void ScrollWindow( int dx, int dy,

-                               const wxRect* rect = (wxRect *) NULL );
+                               const wxRect* rect = NULL );

 
     virtual bool ScrollLines(int lines);
     virtual bool ScrollPages(int pages);
 
 
     virtual bool ScrollLines(int lines);
     virtual bool ScrollPages(int pages);
 

+    virtual void SetLayoutDirection(wxLayoutDirection dir);
+    virtual wxLayoutDirection GetLayoutDirection() const;
+    virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                             wxCoord widthTotal) const;
+

 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP


@@ -116,12 +121,6 @@ public:
     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);
 
     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);
 

-#if WXWIN_COMPATIBILITY_2_4
-    wxDEPRECATED( bool GetUseCtl3D() const );
-    wxDEPRECATED( bool GetTransparentBackground() const );
-    wxDEPRECATED( void SetTransparent(bool t = true) );
-#endif // WXWIN_COMPATIBILITY_2_4
-

 #ifndef __WXUNIVERSAL__
     // Native resource loading (implemented in src/msw/nativdlg.cpp)
     // FIXME: should they really be all virtual?
 #ifndef __WXUNIVERSAL__
     // Native resource loading (implemented in src/msw/nativdlg.cpp)
     // FIXME: should they really be all virtual?


@@ -137,6 +136,11 @@ public:
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 

+#ifdef __POCKETPC__
+    bool IsContextMenuEnabled() const { return m_contextMenuEnabled; }
+    void EnableContextMenu(bool enable = true) { m_contextMenuEnabled = enable; }
+#endif
+

     // window handle stuff
     // -------------------
 
     // window handle stuff
     // -------------------
 


@@ -150,6 +154,29 @@ public:
     // does this window have deferred position and/or size?
     bool IsSizeDeferred() const;
 
     // does this window have deferred position and/or size?
     bool IsSizeDeferred() const;
 

+    // these functions allow to register a global handler for the given Windows
+    // message: it will be called from MSWWindowProc() of any window which gets
+    // this event if it's not processed before (i.e. unlike a hook procedure it
+    // does not override the normal processing)
+    //
+    // notice that if you want to process a message for a given window only you
+    // should override its MSWWindowProc() instead
+
+    // type of the handler: it is called with the message parameters (except
+    // that the window object is passed instead of window handle) and should
+    // return true if it handled the message or false if it should be passed to
+    // DefWindowProc()
+    typedef bool (*MSWMessageHandler)(wxWindowMSW *win,
+                                      WXUINT nMsg,
+                                      WXWPARAM wParam,
+                                      WXLPARAM lParam);
+
+    // install a handler, shouldn't be called more than one for the same message
+    static bool MSWRegisterMessageHandler(int msg, MSWMessageHandler handler);
+
+    // unregister a previously registered handler
+    static void MSWUnregisterMessageHandler(int msg, MSWMessageHandler handler);
+

 
     // implementation from now on
     // ==========================
 
     // implementation from now on
     // ==========================


@@ -158,7 +185,6 @@ public:
     // --------------
 
     void OnPaint(wxPaintEvent& event);
     // --------------
 
     void OnPaint(wxPaintEvent& event);

-    void OnEraseBackground(wxEraseEvent& event);

 #ifdef __WXWINCE__
     void OnInitDialog(wxInitDialogEvent& event);
 #endif
 #ifdef __WXWINCE__
     void OnInitDialog(wxInitDialogEvent& event);
 #endif


@@ -180,7 +206,12 @@ public:
     wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
 
     // MSW only: true if this control is part of the main control
     wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
 
     // MSW only: true if this control is part of the main control

-    virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return false; };
+    virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return false; }
+
+#if wxUSE_TOOLTIPS
+    // MSW only: true if this window or any of its children have a tooltip
+    virtual bool HasToolTips() const { return GetToolTip() != NULL; }
+#endif // wxUSE_TOOLTIPS

 
     // translate wxWidgets style flags for this control into the Windows style
     // and optional extended style for the corresponding native control
 
     // translate wxWidgets style flags for this control into the Windows style
     // and optional extended style for the corresponding native control


@@ -196,6 +227,11 @@ public:
     WXDWORD MSWGetCreateWindowFlags(WXDWORD *exflags = NULL) const
         { return MSWGetStyle(GetWindowStyle(), exflags); }
 
     WXDWORD MSWGetCreateWindowFlags(WXDWORD *exflags = NULL) const
         { return MSWGetStyle(GetWindowStyle(), exflags); }
 

+    // update the real underlying window style flags to correspond to the
+    // current wxWindow object style (safe to call even if window isn't fully
+    // created yet)
+    void MSWUpdateStyle(long flagsOld, long exflagsOld);
+

     // translate wxWidgets coords into Windows ones suitable to be passed to
     // ::CreateWindow()
     //
     // translate wxWidgets coords into Windows ones suitable to be passed to
     // ::CreateWindow()
     //


@@ -208,6 +244,9 @@ public:
     // get the HWND to be used as parent of this window with CreateWindow()
     virtual WXHWND MSWGetParent() const;
 
     // get the HWND to be used as parent of this window with CreateWindow()
     virtual WXHWND MSWGetParent() const;
 

+    // get the Win32 window class name used by all wxWindow objects by default
+    static const wxChar *MSWGetRegisteredClassName();
+

     // creates the window of specified Windows class with given style, extended
     // style, title and geometry (default values
     //
     // creates the window of specified Windows class with given style, extended
     // style, title and geometry (default values
     //


@@ -286,6 +325,8 @@ public:
     bool HandleSize(int x, int y, WXUINT flag);
     bool HandleSizing(wxRect& rect);
     bool HandleGetMinMaxInfo(void *mmInfo);
     bool HandleSize(int x, int y, WXUINT flag);
     bool HandleSizing(wxRect& rect);
     bool HandleGetMinMaxInfo(void *mmInfo);

+    bool HandleEnterSizeMove();
+    bool HandleExitSizeMove();

 
     bool HandleShow(bool show, int status);
     bool HandleActivate(int flag, bool minimized, WXHWND activate);
 
     bool HandleShow(bool show, int status);
     bool HandleActivate(int flag, bool minimized, WXHWND activate);


@@ -299,6 +340,7 @@ public:
     bool HandleSysColorChange();
     bool HandleDisplayChange();
     bool HandleCaptureChanged(WXHWND gainedCapture);
     bool HandleSysColorChange();
     bool HandleDisplayChange();
     bool HandleCaptureChanged(WXHWND gainedCapture);

+    virtual bool HandleSettingChange(WXWPARAM wParam, WXLPARAM lParam);

 
     bool HandleQueryEndSession(long logOff, bool *mayEnd);
     bool HandleEndSession(bool endSession, long logOff);
 
     bool HandleQueryEndSession(long logOff, bool *mayEnd);
     bool HandleEndSession(bool endSession, long logOff);


@@ -321,11 +363,16 @@ public:
 #ifdef __WIN32__
     int HandleMenuChar(int chAccel, WXLPARAM lParam);
 #endif
 #ifdef __WIN32__
     int HandleMenuChar(int chAccel, WXLPARAM lParam);
 #endif

+    // Create and process a clipboard event specified by type.
+    bool HandleClipboardEvent( WXUINT nMsg );

 
     bool HandleQueryDragIcon(WXHICON *hIcon);
 
     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 
 
     bool HandleQueryDragIcon(WXHICON *hIcon);
 
     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 

+    bool HandlePower(WXWPARAM wParam, WXLPARAM lParam, bool *vetoed);
+
+

     // Window procedure
     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 
     // Window procedure
     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 


@@ -381,6 +428,10 @@ public:
         return true;
     }
 
         return true;
     }
 

+    // common part of Show/HideWithEffect()
+    bool MSWShowWithEffect(bool show,
+                           wxShowEffect effect,
+                           unsigned timeout);

 
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);


@@ -391,6 +442,11 @@ public:
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 

+    // check if a native double-buffering applies for this window
+    virtual bool IsDoubleBuffered() const;
+
+    void SetDoubleBuffered(bool on);
+

     // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
     void GenerateMouseLeave();
 
     // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
     void GenerateMouseLeave();
 


@@ -399,6 +455,17 @@ public:
     virtual void OnInternalIdle();
 
 protected:
     virtual void OnInternalIdle();
 
 protected:

+    // this allows you to implement standard control borders without
+    // repeating the code in different classes that are not derived from
+    // wxControl
+    virtual wxBorder GetDefaultBorderForControl() const;
+
+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const;
+
+    // Translate wxBORDER_THEME (and other border styles if necessary to the value
+    // that makes most sense for this Windows environment
+    virtual wxBorder TranslateBorder(wxBorder border) const;

 
 #if wxUSE_MENUS_NATIVE
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
 #if wxUSE_MENUS_NATIVE
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );


@@ -419,6 +486,11 @@ protected:
     int                   m_yThumbSize;
 
     // implement the base class pure virtuals
     int                   m_yThumbSize;
 
     // implement the base class pure virtuals

+    virtual void DoGetTextExtent(const wxString& string,
+                                 int *x, int *y,
+                                 int *descent = NULL,
+                                 int *externalLeading = NULL,
+                                 const wxFont *font = NULL) const;

     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     virtual void DoGetPosition( int *x, int *y ) const;
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     virtual void DoGetPosition( int *x, int *y ) const;


@@ -429,11 +501,15 @@ protected:
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 

+    virtual wxSize DoGetBorderSize() const;
+

     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 

-    // has the window been frozen by Freeze()?
-    bool IsFrozen() const { return m_frozenness > 0; }
+    virtual void DoEnable(bool enable);
+
+    virtual void DoFreeze();
+    virtual void DoThaw();

 
     // this simply moves/resizes the given HWND which is supposed to be our
     // sibling (this is useful for controls which are composite at MSW level
 
     // this simply moves/resizes the given HWND which is supposed to be our
     // sibling (this is useful for controls which are composite at MSW level


@@ -486,11 +562,14 @@ private:
     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 
     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 

-    // list of disabled children before last call to our Disable()
-    wxWindowList *m_childrenDisabled;
-
-    // number of calls to Freeze() minus number of calls to Thaw()
-    unsigned int m_frozenness;
+#if wxUSE_DEFERRED_SIZING
+protected:
+    // this function is called after the window was resized to its new size
+    virtual void MSWEndDeferWindowPos()
+    {
+        m_pendingPosition = wxDefaultPosition;
+        m_pendingSize = wxDefaultSize;
+    }

 
     // current defer window position operation handle (may be NULL)
     WXHANDLE m_hDWP;
 
     // current defer window position operation handle (may be NULL)
     WXHANDLE m_hDWP;


@@ -500,9 +579,15 @@ private:
     // this window before the group of deferred changes is completed.
     wxPoint     m_pendingPosition;
     wxSize      m_pendingSize;
     // this window before the group of deferred changes is completed.
     wxPoint     m_pendingPosition;
     wxSize      m_pendingSize;

+#endif // wxUSE_DEFERRED_SIZING
+
+private:
+#ifdef __POCKETPC__
+    bool        m_contextMenuEnabled;
+#endif

 
     DECLARE_DYNAMIC_CLASS(wxWindowMSW)
 
     DECLARE_DYNAMIC_CLASS(wxWindowMSW)

-    DECLARE_NO_COPY_CLASS(wxWindowMSW)
+    wxDECLARE_NO_COPY_CLASS(wxWindowMSW);

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -510,21 +595,13 @@ private:
 // inline functions
 // ----------------------------------------------------------------------------
 
 // inline functions
 // ----------------------------------------------------------------------------
 

-#if WXWIN_COMPATIBILITY_2_4
-
-inline bool wxWindowMSW::GetUseCtl3D() const { return false; }
-inline bool wxWindowMSW::GetTransparentBackground() const { return false; }
-inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
-
-#endif // WXWIN_COMPATIBILITY_2_4
-

 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 
 // kbd code translation
 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 
 // kbd code translation

-WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
-WXDLLEXPORT WXWORD wxCharCodeWXToMSW(int id, bool *IsVirtual);
+WXDLLIMPEXP_CORE int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
+WXDLLIMPEXP_CORE WXWORD wxCharCodeWXToMSW(int id, bool *IsVirtual = NULL);

 
 // 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
 
 // 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


@@ -536,21 +613,4 @@ public:
     ~wxWindowCreationHook();
 };
 
     ~wxWindowCreationHook();
 };
 

-// ----------------------------------------------------------------------------
-// global objects
-// ----------------------------------------------------------------------------
-
-// notice that this hash must be defined after wxWindow declaration as it
-// needs to "see" its dtor and not just forward declaration
-#include "wx/hash.h"
-
-// pseudo-template HWND <-> wxWindow hash table
-#if WXWIN_COMPATIBILITY_2_4
-WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
-#else
-WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);
-#endif
-
-extern wxWinHashTable *wxWinHandleHash;
-

 #endif // _WX_WINDOW_H_
 #endif // _WX_WINDOW_H_