wxWidgets/include/wx/msw/window.h

/////////////////////////////////////////////////////////////////////////////
// Name:        window.h
// Purpose:     wxWindow class
// Author:      Julian Smart
// Modified by:
// Created:     01/02/97
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart and Markus Holzem
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_WINDOW_H_
#define _WX_WINDOW_H_

// ---------------------------------------------------------------------------
// headers
// ---------------------------------------------------------------------------

#ifdef __GNUG__
    #pragma interface "window.h"
#endif

// windows.h #defines the following identifiers which are also used in wxWin
#ifdef GetCharWidth
    #undef GetCharWidth
#endif

#ifdef FindWindow
    #undef FindWindow
#endif

// ---------------------------------------------------------------------------
// forward declarations
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxButton;

// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------

// FIXME does anybody use those? they're unused by wxWindows...
enum
{
    wxKEY_SHIFT = 1,
    wxKEY_CTRL  = 2
};

// ---------------------------------------------------------------------------
// wxWindow declaration for MSW
// ---------------------------------------------------------------------------
class WXDLLEXPORT wxWindow : public wxWindowBase
{
    DECLARE_DYNAMIC_CLASS(wxWindow);

public:
    wxWindow() { Init(); }

    wxWindow(wxWindow *parent,
             wxWindowID id,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = 0,
             const wxString& name = wxPanelNameStr)
    {
        Init();
        Create(parent, id, pos, size, style, name);
    }

    virtual ~wxWindow();

    bool Create(wxWindow *parent,
                wxWindowID id,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxString& name = wxPanelNameStr);

    // implement base class pure virtuals
    virtual void Raise();
    virtual void Lower();

    virtual bool Show( bool show = TRUE );
    virtual bool Enable( bool enable = TRUE );

    virtual void SetFocus();

    virtual bool Reparent( wxWindow *newParent );

    virtual void WarpPointer(int x, int y);
    virtual void CaptureMouse();
    virtual void ReleaseMouse();

    virtual void Refresh( bool eraseBackground = TRUE,
                          const wxRect *rect = (const wxRect *) NULL );
    virtual void Clear();

    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 ClientToScreen( int *x, int *y ) const;
    virtual void ScreenToClient( int *x, int *y ) const;

    virtual bool PopupMenu( wxMenu *menu, int x, int y );

    virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                               int range, bool refresh = TRUE );
    virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
    virtual int GetScrollPos( int orient ) const;
    virtual int GetScrollThumb( int orient ) const;
    virtual int GetScrollRange( int orient ) const;
    virtual void ScrollWindow( int dx, int dy,
                               const wxRect* rect = (wxRect *) NULL );

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

    // Accept files for dragging
    virtual void DragAcceptFiles(bool accept);

#if WXWIN_COMPATIBILITY
    // Set/get scroll attributes
    virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
    virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
    virtual int OldGetScrollRange(int orient) const;
    virtual int GetScrollPage(int orient) const;
#endif // WXWIN_COMPATIBILITY

    // caret manipulation (MSW only)
    virtual void CreateCaret(int w, int h);
    virtual void CreateCaret(const wxBitmap *bitmap);
    virtual void DestroyCaret();
    virtual void ShowCaret(bool show);
    virtual void SetCaretPos(int x, int y);
    virtual void GetCaretPos(int *x, int *y) const;

    // event handlers (FIXME: shouldn't they be inside WXWIN_COMPATIBILITY?)
        // Handle a control command
    virtual void OnCommand(wxWindow& win, wxCommandEvent& event);

        // Override to define new behaviour for default action (e.g. double
        // clicking on a listbox)
    virtual void OnDefaultAction(wxControl *initiatingItem);

    // Native resource loading (implemented in src/msw/nativdlg.cpp)
    // FIXME: should they really be all virtual?
    virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
    virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
    virtual wxWindow* GetWindowChild1(wxWindowID id);
    virtual wxWindow* GetWindowChild(wxWindowID id);

    // implementation from now on
    // --------------------------

    // simple accessors
    // ----------------

    WXHWND GetHWND() const { return m_hWnd; }
    void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
    virtual WXWidget GetHandle() const { return GetHWND(); }

    bool GetUseCtl3D() const { return m_useCtl3D; }
    bool GetTransparentBackground() const { return m_backgroundTransparent; }
    void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }

    // event handlers
    // --------------
    void OnEraseBackground(wxEraseEvent& event);
    void OnKeyDown(wxKeyEvent& event);
    void OnKeyUp(wxKeyEvent& event);
    void OnPaint(wxPaintEvent& event);
    void OnChar(wxKeyEvent& event);
    void OnIdle(wxIdleEvent& event);

    // a window may have a default button
    // TODO move into wxPanel and/or wxFrame
    wxButton *GetDefaultItem() const { return m_btnDefault; }
    void SetDefaultItem(wxButton *btn) { m_btnDefault = btn; }

public:
    // For implementation purposes - sometimes decorations make the client area
    // smaller
    virtual wxPoint GetClientAreaOrigin() const;

    // Makes an adjustment to the window position (for example, a frame that has
    // a toolbar that it manages itself).
    virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);

    // Windows subclassing
    void SubclassWin(WXHWND hWnd);
    void UnsubclassWin();
    virtual long Default();
    virtual bool MSWCommand(WXUINT param, WXWORD id);

    // returns TRUE if the event was processed
    virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam, WXLPARAM *result);

    virtual wxWindow *FindItem(int id) const;
    virtual wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const ;
    virtual void PreDelete(WXHDC dc);              // Allows system cleanup

    // Make a Windows extended style from the given wxWindows window style
    virtual WXDWORD MakeExtendedStyle(long style, bool eliminateBorders = TRUE);
    // Determine whether 3D effects are wanted
    virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);

    // MSW only: TRUE if this control is part of the main control
    virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };

    wxObject *GetChild(int number) const ;

    void MSWCreate(int id, wxWindow *parent, const char *wclass, wxWindow *wx_win, const char *title,
            int x, int y, int width, int height,
            WXDWORD style, const char *dialog_template = NULL,
            WXDWORD exendedStyle = 0);

    // Actually defined in wx_canvs.cc since requires wxCanvas declaration
    virtual void MSWDeviceToLogical(float *x, float *y) const ;

    // Create an appropriate wxWindow from a HWND
    virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);

    // Make sure the window style reflects the HWND style (roughly)
    virtual void AdoptAttributesFromHWND();

    // Setup background and foreground colours correctly
    virtual void SetupColours();

    // Saves the last message information before calling base version
    virtual bool ProcessEvent(wxEvent& event);

    // Handlers
    virtual void MSWOnCreate(WXLPCREATESTRUCT cs);
    virtual bool MSWOnPaint();
    virtual WXHICON MSWOnQueryDragIcon() { return 0; }
    virtual void MSWOnSize(int x, int y, WXUINT flag);
    virtual void MSWOnWindowPosChanging(void *lpPos);
    virtual void MSWOnHScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
    virtual void MSWOnVScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
    virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
    virtual long MSWOnSysCommand(WXWPARAM wParam, WXLPARAM lParam);
    virtual long MSWOnNotify(WXWPARAM wParam, WXLPARAM lParam);
    virtual WXHBRUSH MSWOnCtlColor(WXHDC dc, WXHWND pWnd, WXUINT nCtlColor,
            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
    virtual bool MSWOnColorChange(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
    virtual long MSWOnPaletteChanged(WXHWND hWndPalChange);
    virtual long MSWOnQueryNewPalette();
    virtual bool MSWOnEraseBkgnd(WXHDC pDC);
    virtual void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
    virtual void MSWOnInitMenuPopup(WXHMENU menu, int pos, bool isSystem);
    virtual bool MSWOnClose();
    // Return TRUE to end session, FALSE to veto end session.
    virtual bool MSWOnQueryEndSession(long logOff);
    virtual bool MSWOnEndSession(bool endSession, long logOff);
    virtual bool MSWOnDestroy();
    virtual bool MSWOnSetFocus(WXHWND wnd);
    virtual bool MSWOnKillFocus(WXHWND wnd);
    virtual void MSWOnDropFiles(WXWPARAM wParam);
    virtual bool MSWOnInitDialog(WXHWND hWndFocus);
    virtual void MSWOnShow(bool show, int status);

    // TODO: rationalise these functions into 1 or 2 which take the
    // event type as argument.
    virtual void MSWOnLButtonDown(int x, int y, WXUINT flags);
    virtual void MSWOnLButtonUp(int x, int y, WXUINT flags);
    virtual void MSWOnLButtonDClick(int x, int y, WXUINT flags);

    virtual void MSWOnMButtonDown(int x, int y, WXUINT flags);
    virtual void MSWOnMButtonUp(int x, int y, WXUINT flags);
    virtual void MSWOnMButtonDClick(int x, int y, WXUINT flags);

    virtual void MSWOnRButtonDown(int x, int y, WXUINT flags);
    virtual void MSWOnRButtonUp(int x, int y, WXUINT flags);
    virtual void MSWOnRButtonDClick(int x, int y, WXUINT flags);

    virtual void MSWOnMouseMove(int x, int y, WXUINT flags);
    virtual void MSWOnMouseEnter(int x, int y, WXUINT flags);
    virtual void MSWOnMouseLeave(int x, int y, WXUINT flags);

    // These return TRUE if an event handler was found, FALSE otherwise (not processed)
    virtual bool MSWOnChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
    virtual bool MSWOnKeyDown(WXWORD wParam, WXLPARAM lParam);
    virtual bool MSWOnKeyUp(WXWORD wParam, WXLPARAM lParam);

    virtual bool MSWOnActivate(int flag, bool minimized, WXHWND activate);
    virtual long MSWOnMDIActivate(long flag, WXHWND activate, WXHWND deactivate);

    virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
    virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);

    virtual void MSWOnJoyDown(int joystick, int x, int y, WXUINT flags);
    virtual void MSWOnJoyUp(int joystick, int x, int y, WXUINT flags);
    virtual void MSWOnJoyMove(int joystick, int x, int y, WXUINT flags);
    virtual void MSWOnJoyZMove(int joystick, int z, WXUINT flags);

    virtual long MSWGetDlgCode();

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

    // Calls an appropriate default window procedure
    virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
    virtual bool MSWProcessMessage(WXMSG* pMsg);
    virtual bool MSWTranslateMessage(WXMSG* pMsg);
    virtual void MSWDestroyWindow();

    // Detach "Window" menu from menu bar so it doesn't get deleted
    void MSWDetachWindowMenu();

    inline WXFARPROC MSWGetOldWndProc() const;
    inline void MSWSetOldWndProc(WXFARPROC proc);

    // Define for each class of dialog and control
    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);

#if WXWIN_COMPATIBILITY
    void SetShowing(bool show) { (void)Show(show); }
    bool IsUserEnabled() const { return IsEnabled(); }
#endif // WXWIN_COMPATIBILITY

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

    // remember the parameters of the last message
    void PushLastMessage(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
    {
        m_lastMsg = msg;
        m_lastWParam = wParam;
        m_lastLParam = lParam;
    }

protected:
    // the window handle
    WXHWND                m_hWnd;

    // the old window proc (we subclass all windows)
    WXFARPROC             m_oldWndProc;

    // additional (MSW specific) flags
    bool                  m_useCtl3D:1; // Using CTL3D for this control
    bool                  m_inOnSize:1; // Protection against OnSize reentry
    bool                  m_backgroundTransparent:1;
    bool                  m_mouseInWindow:1;
    bool                  m_doubleClickAllowed:1;
    bool                  m_winCaptured:1;

    // Caret data
    bool                  m_caretEnabled:1;
    bool                  m_caretShown:1;
    int                   m_caretWidth;
    int                   m_caretHeight;

    // the size of one page for scrolling
    int                   m_xThumbSize;
    int                   m_yThumbSize;

    // the coordinates of the last mouse event and the typoe of it
    long                  m_lastMouseX,
                          m_lastMouseY;
    int                   m_lastMouseEvent;

    // the parameters of the last message used in Default()
    WXUINT                m_lastMsg;
    WXWPARAM              m_lastWParam;
    WXLPARAM              m_lastLParam;

    WXHMENU               m_hMenu; // Menu, if any

    wxButton             *m_btnDefault;

    // implement the base class pure virtuals
    virtual void DoGetPosition( int *x, int *y ) const;
    virtual void DoGetSize( int *width, int *height ) const;
    virtual void DoGetClientSize( int *width, int *height ) const;
    virtual void DoSetSize(int x, int y,
                           int width, int height,
                           int sizeFlags = wxSIZE_AUTO);
    virtual void DoSetClientSize(int width, int height);

#if wxUSE_TOOLTIPS
    virtual void DoSetToolTip( wxToolTip *tip );
#endif // wxUSE_TOOLTIPS

private:
    // common part of all ctors
    void Init();

    DECLARE_EVENT_TABLE()
};

// ---------------------------------------------------------------------------
// global functions
// ---------------------------------------------------------------------------

// kbd code translation
WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);

#endif
    // _WX_WINDOW_H_