wxWidgets/src/msw/dialog.cpp

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

#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"
#endif

#include "wx/msw/private.h"

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

#define wxDIALOG_DEFAULT_X 300
#define wxDIALOG_DEFAULT_Y 300

// Lists to keep track of windows, so we can disable/enable them
// for modal dialogs
wxList wxModalDialogs;
wxList wxModelessWindows;  // Frames and modeless dialogs
extern wxList wxPendingDelete;

#if !USE_SHARED_LIBRARY
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()

#endif

long wxDialog::MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
  return ::CallWindowProc(CASTWNDPROC (FARPROC) m_oldWndProc, (HWND) GetHWND(), (UINT) nMsg, (WPARAM) wParam, (LPARAM) lParam);
}

bool wxDialog::MSWProcessMessage(WXMSG* pMsg)
{
  return (::IsDialogMessage((HWND) GetHWND(), (MSG*)pMsg) != 0);
}

bool wxDialog::MSWOnClose(void)
{
    return Close();
}

wxDialog::wxDialog(void)
{
  m_isShown = FALSE;
  m_modalShowing = FALSE;

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

bool wxDialog::Create(wxWindow *parent, const wxWindowID id,
           const wxString& title,
           const wxPoint& pos,
           const wxSize& size,
           const long style,
           const wxString& name)
{
  SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
  SetDefaultBackgroundColour(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;
  m_modalShowing = FALSE;

  if (width < 0)
    width = 500;
  if (height < 0)
    height = 500;

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

  // Allows creation of dialogs with & without captions under MSWindows
  if(style & wxCAPTION){
    MSWCreate(m_windowId, (wxWindow *)parent, NULL, this, NULL, x, y, width, height, 0, "wxCaptionDialog",
	  extendedStyle);
  }
  else{
    MSWCreate(m_windowId, (wxWindow *)parent, NULL, this, NULL, x, y, width, height, 0, "wxNoCaptionDialog",
	  extendedStyle);
  }

  SubclassWin(GetHWND());

  SetWindowText((HWND) GetHWND(), (const char *)title);
  SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));

  return TRUE;
}

void wxDialog::SetModal(const bool flag)
{
	if ( flag )
		m_windowStyle |= wxDIALOG_MODAL ;
	else
		if ( m_windowStyle & wxDIALOG_MODAL )
  			m_windowStyle -= wxDIALOG_MODAL ;
  
  wxModelessWindows.DeleteObject(this);
  if (!flag)
    wxModelessWindows.Append(this);
}

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

  wxTopLevelWindows.DeleteObject(this);

  if (m_modalShowing)
  {
    Show(FALSE);
    // 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;
  if ( GetHWND() )
    ShowWindow((HWND) GetHWND(), SW_HIDE);

  if ( (GetWindowStyleFlag() & wxDIALOG_MODAL) != wxDIALOG_MODAL )
    wxModelessWindows.DeleteObject(this);

  UnsubclassWin();

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

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

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

		return;
    }
  }
  // We didn't process this event.
  event.Skip();
}

void wxDialog::OnPaint(wxPaintEvent& event)
{
	// No: if you call the default procedure, it makes
	// the following painting code not work.
//	wxWindow::OnPaint(event);
}

void wxDialog::Fit(void)
{
  wxWindow::Fit();
}

void wxDialog::Iconize(const bool WXUNUSED(iconize))
{
  // Windows dialog boxes can't be iconized
}

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

void wxDialog::SetSize(const int x, const int y, const int width, const int height, const int WXUNUSED(sizeFlags))
{
  wxWindow::SetSize(x, y, width, height);
}

void wxDialog::SetClientSize(const int width, const 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);
#if WXWIN_COMPATIBILITY
  GetEventHandler()->OldOnSize(actual_width, actual_height);
#else
  wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
  event.eventObject = this;
  GetEventHandler()->ProcessEvent(event);
#endif
}

void wxDialog::GetPosition(int *x, int *y) const
{
  HWND hWnd = (HWND) GetHWND();
  RECT rect;
  GetWindowRect(hWnd, &rect);

  *x = rect.left;
  *y = rect.top;
}

bool wxDialog::IsShown(void) const
{
  return m_isShown;
}

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

  if (show)
    InitDialog();

  bool modal =  ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL) ;

#if WXGARBAGE_COLLECTION_ON /* MATTHEW: GC */
  if (!modal) {
    if (show) {
      if (!wxModelessWindows.Member(this))
	wxModelessWindows.Append(this);
    } else
      wxModelessWindows.DeleteObject(this);
  }
  if (show) {
    if (!wxTopLevelWindows.Member(this))
      wxTopLevelWindows.Append(this);
  } else
    wxTopLevelWindows.DeleteObject(this);
#endif

  if (modal)
  {
    if (show)
    {
      wxList DisabledWindows;
      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();
      }
      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.Member(this))
        wxModalDialogs.Append(this);

      MSG msg;
      // Must test whether this dialog still exists: we may not process
      // a message before the deletion.
      while (wxModalDialogs.Member(this) && m_modalShowing && GetMessage(&msg, NULL, 0, 0))
      {
        if (!IsDialogMessage((HWND) GetHWND(), &msg))
        {
          TranslateMessage(&msg);
          DispatchMessage(&msg);
        }
        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();
        HWND hWnd = (HWND) win->GetHWND();
        if (::IsWindow(hWnd) && (wxModalDialogs.Member(win) || wxModelessWindows.Member(win) ))
          ::EnableWindow(hWnd,TRUE);
        node=node->Next();
      }
    }
    else
    {
      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)
      {
        wxDialog *box = (wxDialog *)last->Data();
        HWND hwnd = (HWND) box->GetHWND();
        if (box->m_winEnabled)
          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 (win->IsUserEnabled())
            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
  {
    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);
      }
      ShowWindow((HWND) GetHWND(), SW_HIDE);
    }
  }
  return TRUE;
}

void wxDialog::SetTitle(const wxString& title)
{
  SetWindowText((HWND) GetHWND(), (const char *)title);
}

wxString wxDialog::GetTitle(void) const
{
  GetWindowText((HWND) GetHWND(), wxBuffer, 1000);
  return wxString(wxBuffer);
}

void wxDialog::Centre(const int direction)
{
  int x_offset,y_offset ;
  int display_width, display_height;
  int  width, height, x, y;
  wxFrame *frame ;
  if (direction & wxCENTER_FRAME)
  {
    frame = (wxFrame*)GetParent() ;
    if (frame)
    {
      frame->GetPosition(&x_offset,&y_offset) ;
      frame->GetSize(&display_width,&display_height) ;
    }
  }
  else
    frame = NULL ;

  if (frame==NULL)
  {
    wxDisplaySize(&display_width, &display_height);
    x_offset = 0 ;
    y_offset = 0 ;
  }


  GetSize(&width, &height);
  GetPosition(&x, &y);

  if (direction & wxHORIZONTAL)
    x = (int)((display_width - width)/2);
  if (direction & wxVERTICAL)
    y = (int)((display_height - height)/2);

  SetSize(x+x_offset, y+y_offset, width, height);
}

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

void wxDialog::EndModal(int retCode)
{
	SetReturnCode(retCode);
	Show(FALSE);
}

// Define for each class of dialog and control
WXHBRUSH wxDialog::OnCtlColor(const WXHDC pDC, const WXHWND pWnd, const WXUINT nCtlColor,
			WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
{
#if CTL3D
  HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
  return (WXHBRUSH) hbrush;
#else
  return 0;
#endif
}

// Standard buttons
void wxDialog::OnOK(wxCommandEvent& event)
{
	if ( Validate() && TransferDataFromWindow() )
	{
        if ( IsModal() )
            EndModal(wxID_OK);
        else
        {
		    SetReturnCode(wxID_OK);
		    this->Show(FALSE);
        }
	}
}

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)
{
    if ( IsModal() )
        EndModal(wxID_CANCEL);
    else
    {
        SetReturnCode(wxID_CANCEL);
		this->Show(FALSE);
    }
}

bool wxDialog::OnClose(void)
{
	// Behaviour changed in 2.0: we'll send a Cancel message by default,
    // which may close the dialog.
    // Check for looping if the Cancel event handler calls Close()

    static wxList closing;

    if ( closing.Member(this) )
        return FALSE;

    closing.Append(this);

	wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
	cancelEvent.SetEventObject( this );
	GetEventHandler()->ProcessEvent(cancelEvent);

    closing.DeleteObject(this);

	return FALSE;
}

void wxDialog::OnCloseWindow(wxCloseEvent& event)
{
    // Compatibility
    if ( GetEventHandler()->OnClose() || event.GetForce())
    {
        this->Destroy();
    }
}

// Destroy the window (delayed, if a managed window)
bool wxDialog::Destroy(void)
{
  if (!wxPendingDelete.Member(this))
    wxPendingDelete.Append(this);
  return TRUE;
}

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

long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
{
	return wxWindow::MSWWindowProc(message, wParam, lParam);
}