new wxStringTokenizer

[wxWidgets.git] / src / msw / dialog.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        src/msw/dialog.cpp
// Purpose:     wxDialog class
// Author:      Julian Smart
// Modified by:
// Created:     01/02/97
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart and Markus Holzem
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

// ============================================================================
// declarations
// ============================================================================

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

#ifdef __GNUG__
    #pragma implementation "dialog.h"
#endif

// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

#ifndef WX_PRECOMP
    #include "wx/dialog.h"
    #include "wx/utils.h"
    #include "wx/frame.h"
    #include "wx/app.h"
    #include "wx/settings.h"
    #include "wx/intl.h"
    #include "wx/log.h"
#endif

#include "wx/msw/private.h"
#include "wx/log.h"

#if wxUSE_COMMON_DIALOGS
    #include <commdlg.h>
#endif

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

// default dialog pos and size

#define wxDIALOG_DEFAULT_X 300
#define wxDIALOG_DEFAULT_Y 300

#define wxDIALOG_DEFAULT_WIDTH 500
#define wxDIALOG_DEFAULT_HEIGHT 500

// ----------------------------------------------------------------------------
// globals
// ----------------------------------------------------------------------------

// all objects to be deleted during next idle processing - from window.cpp
extern wxList WXDLLEXPORT wxPendingDelete;

// all frames and modeless dialogs - not static, used in frame.cpp, mdi.cpp &c
wxWindowList wxModelessWindows;

// all modal dialogs currently shown
static wxWindowList wxModalDialogs;

// ----------------------------------------------------------------------------
// wxWin macros
// ----------------------------------------------------------------------------

IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxPanel)

BEGIN_EVENT_TABLE(wxDialog, wxPanel)
    EVT_BUTTON(wxID_OK, wxDialog::OnOK)
    EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
    EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)

    EVT_CHAR_HOOK(wxDialog::OnCharHook)

    EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)

    EVT_CLOSE(wxDialog::OnCloseWindow)
END_EVENT_TABLE()

// ============================================================================
// implementation
// ============================================================================

// ----------------------------------------------------------------------------
// wxDialog construction
// ----------------------------------------------------------------------------

wxDialog::wxDialog()
{
    m_isShown = FALSE;

    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
}

bool wxDialog::Create(wxWindow *parent, wxWindowID id,
                      const wxString& title,
                      const wxPoint& pos,
                      const wxSize& size,
                      long style,
                      const wxString& name)
{
    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
    SetName(name);

    if (!parent)
        wxTopLevelWindows.Append(this);

    //  windowFont = wxTheFontList->FindOrCreateFont(11, wxSWISS, wxNORMAL, wxNORMAL);

    if (parent) parent->AddChild(this);

    if ( id == -1 )
        m_windowId = (int)NewControlId();
    else
        m_windowId = id;

    int x = pos.x;
    int y = pos.y;
    int width = size.x;
    int height = size.y;

    if (x < 0)
        x = wxDIALOG_DEFAULT_X;
    if (y < 0)
        y = wxDIALOG_DEFAULT_Y;

    m_windowStyle = style;

    m_isShown = FALSE;

    if (width < 0)
        width = wxDIALOG_DEFAULT_WIDTH;
    if (height < 0)
        height = wxDIALOG_DEFAULT_HEIGHT;

    // All dialogs should really have this style
    m_windowStyle |= wxTAB_TRAVERSAL;

    WXDWORD extendedStyle = MakeExtendedStyle(m_windowStyle);
    if (m_windowStyle & wxSTAY_ON_TOP)
        extendedStyle |= WS_EX_TOPMOST;

    // Allows creation of dialogs with & without captions under MSWindows,
    // resizeable or not (but a resizeable dialog always has caption -
    // otherwise it would look too strange)
    const wxChar *dlg;
    if ( style & wxRESIZE_BORDER )
        dlg = wxT("wxResizeableDialog");
    else if ( style & wxCAPTION )
        dlg = wxT("wxCaptionDialog");
    else
        dlg = wxT("wxNoCaptionDialog");
    MSWCreate(m_windowId, parent, NULL, this, NULL,
              x, y, width, height,
              0, // style is not used if we have dlg template
              dlg,
              extendedStyle);

    HWND hwnd = (HWND)GetHWND();

    if ( !hwnd )
    {
        wxLogError(_("Failed to create dialog."));

        return FALSE;
    }

    SubclassWin(GetHWND());

    SetWindowText(hwnd, title);
    SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));

    return TRUE;
}

void wxDialog::SetModal(bool flag)
{
    if ( flag )
    {
        m_windowStyle |= wxDIALOG_MODAL;

        wxModelessWindows.DeleteObject(this);
    }
    else
    {
        m_windowStyle &= ~wxDIALOG_MODAL;

        wxModelessWindows.Append(this);
    }
}

wxDialog::~wxDialog()
{
    m_isBeingDeleted = TRUE;

    wxTopLevelWindows.DeleteObject(this);

    Show(FALSE);

    // VZ: this is bogus and breaks focus handling - it won't be returned to
    //     the window which had it previosuly if we do this
#if 0
    if (m_modalShowing)
    {
        // For some reason, wxWindows can activate another task altogether
        // when a frame is destroyed after a modal dialog has been invoked.
        // Try to bring the parent to the top.
        // dfgg: I moved this following line from end of function -
        //       must not call if another window is on top!!
        //       This can often happen with Close() and delayed deleting
        if (GetParent() && GetParent()->GetHWND())
            ::BringWindowToTop((HWND) GetParent()->GetHWND());
    }

    m_modalShowing = FALSE;
#endif // 0

    if ( !IsModal() )
        wxModelessWindows.DeleteObject(this);

    // If this is the last top-level window, exit.
    if ( wxTheApp && (wxTopLevelWindows.Number() == 0) )
    {
        wxTheApp->SetTopWindow(NULL);

        if ( wxTheApp->GetExitOnFrameDelete() )
        {
            ::PostQuitMessage(0);
        }
    }
}

// ----------------------------------------------------------------------------
// kbd handling
// ----------------------------------------------------------------------------

// By default, pressing escape cancels the dialog
void wxDialog::OnCharHook(wxKeyEvent& event)
{
  if (GetHWND())
  {
    if (event.m_keyCode == WXK_ESCAPE)
    {
        // Behaviour changed in 2.0: we'll send a Cancel message
        // to the dialog instead of Close.
        wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
        cancelEvent.SetEventObject( this );
        GetEventHandler()->ProcessEvent(cancelEvent);

        // ensure that there is another message for this window so the
        // ShowModal loop will exit and won't get stuck in GetMessage().
        ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
        return;
    }
  }
  // We didn't process this event.
  event.Skip();
}

// ----------------------------------------------------------------------------
// Windows dialog boxes can't be iconized
// ----------------------------------------------------------------------------

void wxDialog::Iconize(bool WXUNUSED(iconize))
{
}

bool wxDialog::IsIconized() const
{
    return FALSE;
}

// ----------------------------------------------------------------------------
// size/position handling
// ----------------------------------------------------------------------------

void wxDialog::DoSetClientSize(int width, int height)
{
    HWND hWnd = (HWND) GetHWND();
    RECT rect;
    ::GetClientRect(hWnd, &rect);

    RECT rect2;
    GetWindowRect(hWnd, &rect2);

    // Find the difference between the entire window (title bar and all)
    // and the client area; add this to the new client size to move the
    // window
    int actual_width = rect2.right - rect2.left - rect.right + width;
    int actual_height = rect2.bottom - rect2.top - rect.bottom + height;

    MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);

    wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
    event.SetEventObject( this );
    GetEventHandler()->ProcessEvent(event);
}

void wxDialog::DoGetPosition(int *x, int *y) const
{
    RECT rect;
    GetWindowRect(GetHwnd(), &rect);

    if ( x )
        *x = rect.left;
    if ( y )
        *y = rect.top;
}

// ----------------------------------------------------------------------------
// showing the dialogs
// ----------------------------------------------------------------------------

bool wxDialog::IsModal() const
{
    return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
}

// VZ: this is the old version unchanged (reindented only), it will be removed
//     as soon as we're sure the new one works correctly
#if 0

bool wxDialog::Show(bool show)
{
    m_isShown = show;

    if (show)
        InitDialog();

    bool modal = IsModal();

    if (modal)
    {
        if (show)
        {
            // find the top level window which had focus before - we will restore
            // focus to it later
            m_hwndOldFocus = 0;
            for ( HWND hwnd = ::GetFocus(); hwnd; hwnd = ::GetParent(hwnd) )
            {
                m_hwndOldFocus = (WXHWND)hwnd;
            }

            if (m_modalShowing)
            {
                BringWindowToTop((HWND) GetHWND());
                return TRUE;
            }

            m_modalShowing = TRUE;
            wxNode *node = wxModalDialogs.First();
            while (node)
            {
                wxDialog *box = (wxDialog *)node->Data();
                if (box != this)
                    ::EnableWindow((HWND) box->GetHWND(), FALSE);
                node = node->Next();
            }

            // if we don't do it, some window might be deleted while we have pointers
            // to them in our disabledWindows list and the program will crash when it
            // will try to reenable them after the modal dialog end
            wxTheApp->DeletePendingObjects();
            wxList disabledWindows;

            node = wxModelessWindows.First();
            while (node)
            {
                wxWindow *win = (wxWindow *)node->Data();
                if (::IsWindowEnabled((HWND) win->GetHWND()))
                {
                    ::EnableWindow((HWND) win->GetHWND(), FALSE);
                    disabledWindows.Append(win);
                }
                node = node->Next();
            }

            ShowWindow((HWND) GetHWND(), SW_SHOW);
            EnableWindow((HWND) GetHWND(), TRUE);
            BringWindowToTop((HWND) GetHWND());

            if ( !wxModalDialogs.Find(this) )
                wxModalDialogs.Append(this);

            MSG msg;
            // Must test whether this dialog still exists: we may not process
            // a message before the deletion.
            while (wxModalDialogs.Find(this) && m_modalShowing && GetMessage(&msg, NULL, 0, 0))
            {
                if ( m_acceleratorTable.Ok() &&
                        ::TranslateAccelerator((HWND)GetHWND(),
                            (HACCEL)m_acceleratorTable.GetHACCEL(),
                            &msg) )
                {
                    // Have processed the message
                }
                else if ( !wxTheApp->ProcessMessage((WXMSG *)&msg) )
                {
                    TranslateMessage(&msg);
                    DispatchMessage(&msg);
                }

                // If we get crashes (as per George Tasker's message) with nested modal dialogs,
                // we should try removing the m_modalShowing test

                if (m_modalShowing && !::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE))
                    // dfgg: NB MUST test m_modalShowing again as the message loop could have triggered
                    //       a Show(FALSE) in the mean time!!!
                    // Without the test, we might delete the dialog before the end of modal showing.
                {
                    while (wxTheApp->ProcessIdle() && m_modalShowing)
                    {
                        // Keep going until we decide we've done enough
                    }
                }
            }
            // dfgg: now must specifically re-enable all other app windows that we disabled earlier
            node=disabledWindows.First();
            while(node) {
                wxWindow* win = (wxWindow*) node->Data();
                if (wxModalDialogs.Find(win) || wxModelessWindows.Find(win))
                {
                    HWND hWnd = (HWND) win->GetHWND();
                    if (::IsWindow(hWnd))
                        ::EnableWindow(hWnd,TRUE);
                }
                node=node->Next();
            }
        }
        else // !show
        {
            ::SetFocus((HWND)m_hwndOldFocus);

            wxModalDialogs.DeleteObject(this);

            wxNode *last = wxModalDialogs.Last();

            // If there's still a modal dialog active, we
            // enable it, else we enable all modeless windows
            if (last)
            {
                // VZ: I don't understand what this is supposed to do, so I'll leave
                //     it out for now and look for horrible consequences
                wxDialog *box = (wxDialog *)last->Data();
                HWND hwnd = (HWND) box->GetHWND();
#if 0
                if (box->IsUserEnabled())
#endif // 0
                    EnableWindow(hwnd, TRUE);
                BringWindowToTop(hwnd);
            }
            else
            {
                wxNode *node = wxModelessWindows.First();
                while (node)
                {
                    wxWindow *win = (wxWindow *)node->Data();
                    HWND hwnd = (HWND) win->GetHWND();
                    // Only enable again if not user-disabled.
#if 0
                    if (win->IsUserEnabled())
#endif // 0
                        EnableWindow(hwnd, TRUE);
                    node = node->Next();
                }
            }
            // Try to highlight the correct window (the parent)
            HWND hWndParent = 0;
            if (GetParent())
            {
                hWndParent = (HWND) GetParent()->GetHWND();
                if (hWndParent)
                    ::BringWindowToTop(hWndParent);
            }
            ShowWindow((HWND) GetHWND(), SW_HIDE);
            m_modalShowing = FALSE;
        }
    }
    else // !modal
    {
        if (show)
        {
            ShowWindow((HWND) GetHWND(), SW_SHOW);
            BringWindowToTop((HWND) GetHWND());
        }
        else
        {
            // Try to highlight the correct window (the parent)
            HWND hWndParent = 0;
            if (GetParent())
            {
                hWndParent = (HWND) GetParent()->GetHWND();
                if (hWndParent)
                    ::BringWindowToTop(hWndParent);
            }

            if ( m_hWnd )
                ShowWindow((HWND) GetHWND(), SW_HIDE);
        }
    }

    return TRUE;
}

#else // 1

bool wxDialog::IsModalShowing() const
{
    return wxModalDialogs.Find((wxDialog *)this) != NULL; // const_cast
}

void wxDialog::DoShowModal()
{
    wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );

    wxModalDialogs.Append(this);

    wxWindow *parent = GetParent();

    // remember where the focus was
    wxWindow *winFocus = FindFocus();
    if ( !winFocus )
    {
        winFocus = parent;
    }
    if ( !winFocus )
    {
        winFocus = wxTheApp->GetTopWindow();
    }

    // disable the parent window first
    HWND hwndParent = parent ? GetHwndOf(parent) : (HWND)NULL;
    if ( hwndParent )
    {
        ::EnableWindow(hwndParent, FALSE);
    }

    // enter the modal loop
    while ( IsModalShowing() )
    {
#if wxUSE_THREADS
        wxMutexGuiLeaveOrEnter();
#endif // wxUSE_THREADS

        while ( !wxTheApp->Pending() && wxTheApp->ProcessIdle() )
            ;

        // a message came or no more idle processing to do
        wxTheApp->DoMessage();
    }

    // reenable the parent window if any
    if ( hwndParent )
    {
        ::EnableWindow(hwndParent, TRUE);
    }

    // and restore focus
    if ( winFocus )
    {
        winFocus->SetFocus();
    }
}

bool wxDialog::Show(bool show)
{
    if ( !wxDialogBase::Show(show) )
    {
        // nothing to do
        return FALSE;
    }

    if ( show )
    {
        // usually will result in TransferDataToWindow() being called
        InitDialog();
    }

    if ( IsModal() )
    {
        if ( show )
        {
            DoShowModal();
        }
        else // end of modal dialog
        {
            // this will cause IsModalShowing() return FALSE and our local
            // message loop will terminate
            wxModalDialogs.DeleteObject(this);
        }
    }

    return TRUE;
}

#endif // 0/1

// Replacement for Show(TRUE) for modal dialogs - returns return code
int wxDialog::ShowModal()
{
    m_windowStyle |= wxDIALOG_MODAL;
    Show(TRUE);
    return GetReturnCode();
}

// NB: this function (surprizingly) may be called for both modal and modeless
//     dialogs and should work for both of them
void wxDialog::EndModal(int retCode)
{
    SetReturnCode(retCode);
    Show(FALSE);
}

// ----------------------------------------------------------------------------
// wxWin event handlers
// ----------------------------------------------------------------------------

// Standard buttons
void wxDialog::OnOK(wxCommandEvent& event)
{
  if ( Validate() && TransferDataFromWindow() )
  {
      EndModal(wxID_OK);
  }
}

void wxDialog::OnApply(wxCommandEvent& event)
{
    if ( Validate() )
        TransferDataFromWindow();

    // TODO probably need to disable the Apply button until things change again
}

void wxDialog::OnCancel(wxCommandEvent& event)
{
    EndModal(wxID_CANCEL);
}

void wxDialog::OnCloseWindow(wxCloseEvent& event)
{
    // We'll send a Cancel message by default, which may close the dialog.
    // Check for looping if the Cancel event handler calls Close().

    // Note that if a cancel button and handler aren't present in the dialog,
    // nothing will happen when you close the dialog via the window manager, or
    // via Close(). We wouldn't want to destroy the dialog by default, since
    // the dialog may have been created on the stack. However, this does mean
    // that calling dialog->Close() won't delete the dialog unless the handler
    // for wxID_CANCEL does so. So use Destroy() if you want to be sure to
    // destroy the dialog. The default OnCancel (above) simply ends a modal
    // dialog, and hides a modeless dialog.

    // VZ: this is horrible and MT-unsafe. Can't we reuse some of these global
    //     lists here? don't dare to change it now, but should be done later!
    static wxList closing;

    if ( closing.Member(this) )
        return;

    closing.Append(this);

    wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
    cancelEvent.SetEventObject( this );
    GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog

    closing.DeleteObject(this);
}

// Destroy the window (delayed, if a managed window)
bool wxDialog::Destroy()
{
    wxCHECK_MSG( !wxPendingDelete.Member(this), FALSE,
                 _T("wxDialog destroyed twice") );

    wxPendingDelete.Append(this);

    return TRUE;
}

void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& event)
{
#if wxUSE_CTL3D
    Ctl3dColorChange();
#else
    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
    Refresh();
#endif
}

// ---------------------------------------------------------------------------
// dialog window proc
// ---------------------------------------------------------------------------

long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
{
    long rc = 0;
    bool processed = FALSE;

    switch ( message )
    {
        case WM_CLOSE:
            // if we can't close, tell the system that we processed the
            // message - otherwise it would close us
            processed = !Close();
            break;
    }

    if ( !processed )
        rc = wxWindow::MSWWindowProc(message, wParam, lParam);

    return rc;
}

#if wxUSE_CTL3D

// Define for each class of dialog and control
WXHBRUSH wxDialog::OnCtlColor(WXHDC WXUNUSED(pDC),
                              WXHWND WXUNUSED(pWnd),
                              WXUINT WXUNUSED(nCtlColor),
                              WXUINT message,
                              WXWPARAM wParam,
                              WXLPARAM lParam)
{
    return (WXHBRUSH)Ctl3dCtlColorEx(message, wParam, lParam);
}

#endif // wxUSE_CTL3D