src/msw/notebook.cpp

///////////////////////////////////////////////////////////////////////////////
// Name:        msw/notebook.cpp
// Purpose:     implementation of wxNotebook
// Author:      Vadim Zeitlin
// Modified by:
// Created:     11.06.98
// RCS-ID:      $Id$
// Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence:     wxWindows license
///////////////////////////////////////////////////////////////////////////////

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

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

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

#if wxUSE_NOTEBOOK

// wxWindows
#ifndef WX_PRECOMP
  #include  "wx/string.h"
#endif  // WX_PRECOMP

#include  "wx/log.h"
#include  "wx/imaglist.h"
#include  "wx/event.h"
#include  "wx/control.h"
#include  "wx/notebook.h"

#include  "wx/msw/private.h"

// Windows standard headers
#ifndef   __WIN95__
  #error  "wxNotebook is only supported Windows 95 and above"
#endif    //Win95

#include  <windowsx.h>  // for SetWindowFont

#ifndef __TWIN32__
    #ifdef __GNUWIN32_OLD__
        #include "wx/msw/gnuwin32/extra.h"
    #endif
#endif

#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
    #include <commctrl.h>
#endif

// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------

// check that the page index is valid
#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))

// hide the ugly cast
#define m_hwnd    (HWND)GetHWND()

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

// This is a work-around for missing defines in gcc-2.95 headers
#ifndef TCS_RIGHT
    #define TCS_RIGHT       0x0002
#endif

#ifndef TCS_VERTICAL
    #define TCS_VERTICAL    0x0080
#endif

#ifndef TCS_BOTTOM
    #define TCS_BOTTOM      TCS_RIGHT
#endif

// ----------------------------------------------------------------------------
// event table
// ----------------------------------------------------------------------------

DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)

BEGIN_EVENT_TABLE(wxNotebook, wxControl)
    EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)

    EVT_SIZE(wxNotebook::OnSize)

    EVT_SET_FOCUS(wxNotebook::OnSetFocus)

    EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
END_EVENT_TABLE()

IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)

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

// ----------------------------------------------------------------------------
// wxNotebook construction
// ----------------------------------------------------------------------------

// common part of all ctors
void wxNotebook::Init()
{
  m_imageList = NULL;
  m_nSelection = -1;
}

// default for dynamic class
wxNotebook::wxNotebook()
{
  Init();
}

// the same arguments as for wxControl
wxNotebook::wxNotebook(wxWindow *parent,
                       wxWindowID id,
                       const wxPoint& pos,
                       const wxSize& size,
                       long style,
                       const wxString& name)
{
  Init();

  Create(parent, id, pos, size, style, name);
}

// Create() function
bool wxNotebook::Create(wxWindow *parent,
                        wxWindowID id,
                        const wxPoint& pos,
                        const wxSize& size,
                        long style,
                        const wxString& name)
{
    // base init
    if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
        return FALSE;

    // notebook, so explicitly specify 0 as last parameter
    if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size,
                style | wxTAB_TRAVERSAL) )
        return FALSE;

    SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));

    return TRUE;
}

WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
{
    WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);

    tabStyle |= WS_TABSTOP | TCS_TABS;

    if ( style & wxTC_MULTILINE )
        tabStyle |= TCS_MULTILINE;
    if ( style & wxNB_FIXEDWIDTH )
        tabStyle |= TCS_FIXEDWIDTH;

    if ( style & wxNB_BOTTOM )
        tabStyle |= TCS_RIGHT;
    else if ( style & wxNB_LEFT )
        tabStyle |= TCS_VERTICAL;
    else if ( style & wxNB_RIGHT )
        tabStyle |= TCS_VERTICAL | TCS_RIGHT;

    // ex style
    if ( exstyle )
    {
        // note that we never want to have the default WS_EX_CLIENTEDGE style
        // as it looks too ugly for the notebooks
        *exstyle = 0;
    }

    return tabStyle;
}

// ----------------------------------------------------------------------------
// wxNotebook accessors
// ----------------------------------------------------------------------------

int wxNotebook::GetPageCount() const
{
  // consistency check
  wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );

  return m_pages.Count();
}

int wxNotebook::GetRowCount() const
{
  return TabCtrl_GetRowCount(m_hwnd);
}

int wxNotebook::SetSelection(int nPage)
{
  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );

  ChangePage(m_nSelection, nPage);

  return TabCtrl_SetCurSel(m_hwnd, nPage);
}

bool wxNotebook::SetPageText(int nPage, const wxString& strText)
{
  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );

  TC_ITEM tcItem;
  tcItem.mask = TCIF_TEXT;
  tcItem.pszText = (wxChar *)strText.c_str();

  return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
}

wxString wxNotebook::GetPageText(int nPage) const
{
  wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );

  wxChar buf[256];
  TC_ITEM tcItem;
  tcItem.mask = TCIF_TEXT;
  tcItem.pszText = buf;
  tcItem.cchTextMax = WXSIZEOF(buf);

  wxString str;
  if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
    str = tcItem.pszText;

  return str;
}

int wxNotebook::GetPageImage(int nPage) const
{
  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );

  TC_ITEM tcItem;
  tcItem.mask = TCIF_IMAGE;

  return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
}

bool wxNotebook::SetPageImage(int nPage, int nImage)
{
  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );

  TC_ITEM tcItem;
  tcItem.mask = TCIF_IMAGE;
  tcItem.iImage = nImage;

  return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
}

void wxNotebook::SetImageList(wxImageList* imageList)
{
  wxNotebookBase::SetImageList(imageList);

  if ( imageList )
  {
    TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
  }
}

// ----------------------------------------------------------------------------
// wxNotebook size settings
// ----------------------------------------------------------------------------

void wxNotebook::SetPageSize(const wxSize& size)
{
    // transform the page size into the notebook size
    RECT rc;
    rc.left =
    rc.top = 0;
    rc.right = size.x;
    rc.bottom = size.y;

    TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);

    // and now set it
    SetSize(rc.right - rc.left, rc.bottom - rc.top);
}

void wxNotebook::SetPadding(const wxSize& padding)
{
    TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
}

// Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
// style.
void wxNotebook::SetTabSize(const wxSize& sz)
{
    ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
}

// ----------------------------------------------------------------------------
// wxNotebook operations
// ----------------------------------------------------------------------------

// remove one page from the notebook, without deleting
wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
{
    wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
    if ( !pageRemoved )
        return NULL;

    TabCtrl_DeleteItem(m_hwnd, nPage);

    if ( m_pages.IsEmpty() )
    {
        // no selection any more, the notebook becamse empty
        m_nSelection = -1;
    }
    else // notebook still not empty
    {
        // change the selected page if it was deleted or became invalid
        int selNew;
        if ( m_nSelection == GetPageCount() )
        {
            // last page deleted, make the new last page the new selection
            selNew = m_nSelection - 1;
        }
        else if ( nPage <= m_nSelection )
        {
            // we must show another page, even if it has the same index
            selNew = m_nSelection;
        }
        else // nothing changes for the currently selected page
        {
            selNew = -1;

            // we still must refresh the current page: this needs to be done
            // for some unknown reason if the tab control shows the up-down
            // control (i.e. when there are too many pages) -- otherwise after
            // deleting a page nothing at all is shown
            m_pages[m_nSelection]->Refresh();
        }

        if ( selNew != -1 )
        {
            // m_nSelection must be always valid so reset it before calling
            // SetSelection()
            m_nSelection = -1;
            SetSelection(selNew);
        }
    }

    return pageRemoved;
}

// remove all pages
bool wxNotebook::DeleteAllPages()
{
  int nPageCount = GetPageCount();
  int nPage;
  for ( nPage = 0; nPage < nPageCount; nPage++ )
    delete m_pages[nPage];

  m_pages.Clear();

  TabCtrl_DeleteAllItems(m_hwnd);

  m_nSelection = -1;

  return TRUE;
}

// add a page to the notebook
bool wxNotebook::AddPage(wxNotebookPage *pPage,
                         const wxString& strText,
                         bool bSelect,
                         int imageId)
{
  return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
}

// same as AddPage() but does it at given position
bool wxNotebook::InsertPage(int nPage,
                            wxNotebookPage *pPage,
                            const wxString& strText,
                            bool bSelect,
                            int imageId)
{
  wxASSERT( pPage != NULL );
  wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE );

  // do add the tab to the control

  // init all fields to 0
  TC_ITEM tcItem;
  memset(&tcItem, 0, sizeof(tcItem));

  if ( imageId != -1 )
  {
    tcItem.mask |= TCIF_IMAGE;
    tcItem.iImage  = imageId;
  }

  if ( !strText.IsEmpty() )
  {
    tcItem.mask |= TCIF_TEXT;
    tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
  }

  if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
    wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());

    return FALSE;
  }

  // if the inserted page is before the selected one, we must update the
  // index of the selected page
  if ( nPage <= m_nSelection )
  {
    // one extra page added
    m_nSelection++;
  }

  // save the pointer to the page
  m_pages.Insert(pPage, nPage);

  // don't show pages by default (we'll need to adjust their size first)
  HWND hwnd = GetWinHwnd(pPage);
  SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);

  // this updates internal flag too - otherwise it will get out of sync
  pPage->Show(FALSE);

  // fit the notebook page to the tab control's display area
  RECT rc;
  rc.left = rc.top = 0;
  GetSize((int *)&rc.right, (int *)&rc.bottom);
  TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
  pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);

  // some page should be selected: either this one or the first one if there is
  // still no selection
  int selNew = -1;
  if ( bSelect )
    selNew = nPage;
  else if ( m_nSelection == -1 )
    selNew = 0;

  if ( selNew != -1 )
    SetSelection(selNew);

  return TRUE;
}

// ----------------------------------------------------------------------------
// wxNotebook callbacks
// ----------------------------------------------------------------------------

void wxNotebook::OnSize(wxSizeEvent& event)
{
  // fit the notebook page to the tab control's display area
  RECT rc;
  rc.left = rc.top = 0;
  GetSize((int *)&rc.right, (int *)&rc.bottom);

  TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);

  int width = rc.right - rc.left,
      height = rc.bottom - rc.top;
  size_t nCount = m_pages.Count();
  for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
    wxNotebookPage *pPage = m_pages[nPage];
    pPage->SetSize(rc.left, rc.top, width, height);
  }

  event.Skip();
}

void wxNotebook::OnSelChange(wxNotebookEvent& event)
{
  // is it our tab control?
  if ( event.GetEventObject() == this )
  {
      int sel = event.GetOldSelection();
      if ( sel != -1 )
        m_pages[sel]->Show(FALSE);

      sel = event.GetSelection();
      if ( sel != -1 )
      {
        wxNotebookPage *pPage = m_pages[sel];
        pPage->Show(TRUE);
        pPage->SetFocus();
      }

      m_nSelection = sel;
  }

  // we want to give others a chance to process this message as well
  event.Skip();
}

void wxNotebook::OnSetFocus(wxFocusEvent& event)
{
    // this function is only called when the focus is explicitly set (i.e. from
    // the program) to the notebook - in this case we don't need the
    // complicated OnNavigationKey() logic because the programmer knows better
    // what [s]he wants

    // set focus to the currently selected page if any
    if ( m_nSelection != -1 )
        m_pages[m_nSelection]->SetFocus();

    event.Skip();
}

void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
{
    if ( event.IsWindowChange() ) {
        // change pages
        AdvanceSelection(event.GetDirection());
    }
    else {
        // we get this event in 2 cases
        //
        // a) one of our pages might have generated it because the user TABbed
        // out from it in which case we should propagate the event upwards and
        // our parent will take care of setting the focus to prev/next sibling
        //
        // or
        //
        // b) the parent panel wants to give the focus to us so that we
        // forward it to our selected page. We can't deal with this in
        // OnSetFocus() because we don't know which direction the focus came
        // from in this case and so can't choose between setting the focus to
        // first or last panel child

        wxWindow *parent = GetParent();
        if ( event.GetEventObject() == parent )
        {
            // no, it doesn't come from child, case (b): forward to a page
            if ( m_nSelection != -1 )
            {
                // so that the page knows that the event comes from it's parent
                // and is being propagated downwards
                event.SetEventObject(this);

                wxWindow *page = m_pages[m_nSelection];
                if ( !page->GetEventHandler()->ProcessEvent(event) )
                {
                    page->SetFocus();
                }
                //else: page manages focus inside it itself
            }
            else
            {
                // we have no pages - still have to give focus to _something_
                SetFocus();
            }
        }
        else
        {
            // it comes from our child, case (a), pass to the parent
            if ( parent ) {
                event.SetCurrentFocus(this);
                parent->GetEventHandler()->ProcessEvent(event);
            }
        }
    }
}

// ----------------------------------------------------------------------------
// wxNotebook base class virtuals
// ----------------------------------------------------------------------------

// override these 2 functions to do nothing: everything is done in OnSize

void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
{
  // don't set the sizes of the pages - their correct size is not yet known
  wxControl::SetConstraintSizes(FALSE);
}

bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
{
  return TRUE;
}

// ----------------------------------------------------------------------------
// wxNotebook Windows message handlers
// ----------------------------------------------------------------------------

bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
                             WXWORD pos, WXHWND control)
{
    // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
    // up-down control
    if ( control )
        return FALSE;

    return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
}

bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
{
  wxNotebookEvent event(wxEVT_NULL, m_windowId);

  NMHDR* hdr = (NMHDR *)lParam;
  switch ( hdr->code ) {
    case TCN_SELCHANGE:
      event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
      break;

    case TCN_SELCHANGING:
      event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
      break;

    default:
      return wxControl::MSWOnNotify(idCtrl, lParam, result);
  }

  event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
  event.SetOldSelection(m_nSelection);
  event.SetEventObject(this);
  event.SetInt(idCtrl);

  bool processed = GetEventHandler()->ProcessEvent(event);
  *result = !event.IsAllowed();
  return processed;
}

// ----------------------------------------------------------------------------
// wxNotebook helper functions
// ----------------------------------------------------------------------------

// generate the page changing and changed events, hide the currently active
// panel and show the new one
void wxNotebook::ChangePage(int nOldSel, int nSel)
{
  // MT-FIXME should use a real semaphore
  static bool s_bInsideChangePage = FALSE;

  // when we call ProcessEvent(), our own OnSelChange() is called which calls
  // this function - break the infinite loop
  if ( s_bInsideChangePage )
    return;

  // it's not an error (the message may be generated by the tab control itself)
  // and it may happen - just do nothing
  if ( nSel == nOldSel )
    return;

  s_bInsideChangePage = TRUE;

  wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
  event.SetSelection(nSel);
  event.SetOldSelection(nOldSel);
  event.SetEventObject(this);
  if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
  {
    // program doesn't allow the page change
    s_bInsideChangePage = FALSE;
    return;
  }

  event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
  GetEventHandler()->ProcessEvent(event);

  s_bInsideChangePage = FALSE;
}

#endif // wxUSE_NOTEBOOK
Commit	Line	Data
	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: msw/notebook.cpp
	3	// Purpose: implementation of wxNotebook
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 11.06.98
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
	9	// Licence: wxWindows license
	10	///////////////////////////////////////////////////////////////////////////////
	11
	12	#ifdef __GNUG__
	13	#pragma implementation "notebook.h"
	14	#endif
	15
	16	// For compilers that support precompilation, includes "wx.h".
	17	#include "wx/wxprec.h"
	18
	19	#ifdef __BORLANDC__
	20	#pragma hdrstop
	21	#endif
	22
	23	#if wxUSE_NOTEBOOK
	24
	25	// wxWindows
	26	#ifndef WX_PRECOMP
	27	#include "wx/string.h"
	28	#endif // WX_PRECOMP
	29
	30	#include "wx/log.h"
	31	#include "wx/imaglist.h"
	32	#include "wx/event.h"
	33	#include "wx/control.h"
	34	#include "wx/notebook.h"
	35
	36	#include "wx/msw/private.h"
	37
	38	// Windows standard headers
	39	#ifndef __WIN95__
	40	#error "wxNotebook is only supported Windows 95 and above"
	41	#endif //Win95
	42
	43	#include <windowsx.h> // for SetWindowFont
	44
	45	#ifndef __TWIN32__
	46	#ifdef __GNUWIN32_OLD__
	47	#include "wx/msw/gnuwin32/extra.h"
	48	#endif
	49	#endif
	50
	51	#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) \|\| defined(__TWIN32__)) && !defined(__CYGWIN10__))
	52	#include <commctrl.h>
	53	#endif
	54
	55	// ----------------------------------------------------------------------------
	56	// macros
	57	// ----------------------------------------------------------------------------
	58
	59	// check that the page index is valid
	60	#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
	61
	62	// hide the ugly cast
	63	#define m_hwnd (HWND)GetHWND()
	64
	65	// ----------------------------------------------------------------------------
	66	// constants
	67	// ----------------------------------------------------------------------------
	68
	69	// This is a work-around for missing defines in gcc-2.95 headers
	70	#ifndef TCS_RIGHT
	71	#define TCS_RIGHT 0x0002
	72	#endif
	73
	74	#ifndef TCS_VERTICAL
	75	#define TCS_VERTICAL 0x0080
	76	#endif
	77
	78	#ifndef TCS_BOTTOM
	79	#define TCS_BOTTOM TCS_RIGHT
	80	#endif
	81
	82	// ----------------------------------------------------------------------------
	83	// event table
	84	// ----------------------------------------------------------------------------
	85
	86	DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
	87	DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
	88
	89	BEGIN_EVENT_TABLE(wxNotebook, wxControl)
	90	EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
	91
	92	EVT_SIZE(wxNotebook::OnSize)
	93
	94	EVT_SET_FOCUS(wxNotebook::OnSetFocus)
	95
	96	EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
	97	END_EVENT_TABLE()
	98
	99	IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
	100	IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
	101
	102	// ============================================================================
	103	// implementation
	104	// ============================================================================
	105
	106	// ----------------------------------------------------------------------------
	107	// wxNotebook construction
	108	// ----------------------------------------------------------------------------
	109
	110	// common part of all ctors
	111	void wxNotebook::Init()
	112	{
	113	m_imageList = NULL;
	114	m_nSelection = -1;
	115	}
	116
	117	// default for dynamic class
	118	wxNotebook::wxNotebook()
	119	{
	120	Init();
	121	}
	122
	123	// the same arguments as for wxControl
	124	wxNotebook::wxNotebook(wxWindow *parent,
	125	wxWindowID id,
	126	const wxPoint& pos,
	127	const wxSize& size,
	128	long style,
	129	const wxString& name)
	130	{
	131	Init();
	132
	133	Create(parent, id, pos, size, style, name);
	134	}
	135
	136	// Create() function
	137	bool wxNotebook::Create(wxWindow *parent,
	138	wxWindowID id,
	139	const wxPoint& pos,
	140	const wxSize& size,
	141	long style,
	142	const wxString& name)
	143	{
	144	// base init
	145	if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
	146	return FALSE;
	147
	148	// notebook, so explicitly specify 0 as last parameter
	149	if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size,
	150	style \| wxTAB_TRAVERSAL) )
	151	return FALSE;
	152
	153	SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
	154
	155	return TRUE;
	156	}
	157
	158	WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
	159	{
	160	WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
	161
	162	tabStyle \|= WS_TABSTOP \| TCS_TABS;
	163
	164	if ( style & wxTC_MULTILINE )
	165	tabStyle \|= TCS_MULTILINE;
	166	if ( style & wxNB_FIXEDWIDTH )
	167	tabStyle \|= TCS_FIXEDWIDTH;
	168
	169	if ( style & wxNB_BOTTOM )
	170	tabStyle \|= TCS_RIGHT;
	171	else if ( style & wxNB_LEFT )
	172	tabStyle \|= TCS_VERTICAL;
	173	else if ( style & wxNB_RIGHT )
	174	tabStyle \|= TCS_VERTICAL \| TCS_RIGHT;
	175
	176	// ex style
	177	if ( exstyle )
	178	{
	179	// note that we never want to have the default WS_EX_CLIENTEDGE style
	180	// as it looks too ugly for the notebooks
	181	*exstyle = 0;
	182	}
	183
	184	return tabStyle;
	185	}
	186
	187	// ----------------------------------------------------------------------------
	188	// wxNotebook accessors
	189	// ----------------------------------------------------------------------------
	190
	191	int wxNotebook::GetPageCount() const
	192	{
	193	// consistency check
	194	wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
	195
	196	return m_pages.Count();
	197	}
	198
	199	int wxNotebook::GetRowCount() const
	200	{
	201	return TabCtrl_GetRowCount(m_hwnd);
	202	}
	203
	204	int wxNotebook::SetSelection(int nPage)
	205	{
	206	wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
	207
	208	ChangePage(m_nSelection, nPage);
	209
	210	return TabCtrl_SetCurSel(m_hwnd, nPage);
	211	}
	212
	213	bool wxNotebook::SetPageText(int nPage, const wxString& strText)
	214	{
	215	wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
	216
	217	TC_ITEM tcItem;
	218	tcItem.mask = TCIF_TEXT;
	219	tcItem.pszText = (wxChar *)strText.c_str();
	220
	221	return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
	222	}
	223
	224	wxString wxNotebook::GetPageText(int nPage) const
	225	{
	226	wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );
	227
	228	wxChar buf[256];
	229	TC_ITEM tcItem;
	230	tcItem.mask = TCIF_TEXT;
	231	tcItem.pszText = buf;
	232	tcItem.cchTextMax = WXSIZEOF(buf);
	233
	234	wxString str;
	235	if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
	236	str = tcItem.pszText;
	237
	238	return str;
	239	}
	240
	241	int wxNotebook::GetPageImage(int nPage) const
	242	{
	243	wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
	244
	245	TC_ITEM tcItem;
	246	tcItem.mask = TCIF_IMAGE;
	247
	248	return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
	249	}
	250
	251	bool wxNotebook::SetPageImage(int nPage, int nImage)
	252	{
	253	wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
	254
	255	TC_ITEM tcItem;
	256	tcItem.mask = TCIF_IMAGE;
	257	tcItem.iImage = nImage;
	258
	259	return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
	260	}
	261
	262	void wxNotebook::SetImageList(wxImageList* imageList)
	263	{
	264	wxNotebookBase::SetImageList(imageList);
	265
	266	if ( imageList )
	267	{
	268	TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
	269	}
	270	}
	271
	272	// ----------------------------------------------------------------------------
	273	// wxNotebook size settings
	274	// ----------------------------------------------------------------------------
	275
	276	void wxNotebook::SetPageSize(const wxSize& size)
	277	{
	278	// transform the page size into the notebook size
	279	RECT rc;
	280	rc.left =
	281	rc.top = 0;
	282	rc.right = size.x;
	283	rc.bottom = size.y;
	284
	285	TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
	286
	287	// and now set it
	288	SetSize(rc.right - rc.left, rc.bottom - rc.top);
	289	}
	290
	291	void wxNotebook::SetPadding(const wxSize& padding)
	292	{
	293	TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
	294	}
	295
	296	// Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
	297	// style.
	298	void wxNotebook::SetTabSize(const wxSize& sz)
	299	{
	300	::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
	301	}
	302
	303	// ----------------------------------------------------------------------------
	304	// wxNotebook operations
	305	// ----------------------------------------------------------------------------
	306
	307	// remove one page from the notebook, without deleting
	308	wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
	309	{
	310	wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
	311	if ( !pageRemoved )
	312	return NULL;
	313
	314	TabCtrl_DeleteItem(m_hwnd, nPage);
	315
	316	if ( m_pages.IsEmpty() )
	317	{
	318	// no selection any more, the notebook becamse empty
	319	m_nSelection = -1;
	320	}
	321	else // notebook still not empty
	322	{
	323	// change the selected page if it was deleted or became invalid
	324	int selNew;
	325	if ( m_nSelection == GetPageCount() )
	326	{
	327	// last page deleted, make the new last page the new selection
	328	selNew = m_nSelection - 1;
	329	}
	330	else if ( nPage <= m_nSelection )
	331	{
	332	// we must show another page, even if it has the same index
	333	selNew = m_nSelection;
	334	}
	335	else // nothing changes for the currently selected page
	336	{
	337	selNew = -1;
	338
	339	// we still must refresh the current page: this needs to be done
	340	// for some unknown reason if the tab control shows the up-down
	341	// control (i.e. when there are too many pages) -- otherwise after
	342	// deleting a page nothing at all is shown
	343	m_pages[m_nSelection]->Refresh();
	344	}
	345
	346	if ( selNew != -1 )
	347	{
	348	// m_nSelection must be always valid so reset it before calling
	349	// SetSelection()
	350	m_nSelection = -1;
	351	SetSelection(selNew);
	352	}
	353	}
	354
	355	return pageRemoved;
	356	}
	357
	358	// remove all pages
	359	bool wxNotebook::DeleteAllPages()
	360	{
	361	int nPageCount = GetPageCount();
	362	int nPage;
	363	for ( nPage = 0; nPage < nPageCount; nPage++ )
	364	delete m_pages[nPage];
	365
	366	m_pages.Clear();
	367
	368	TabCtrl_DeleteAllItems(m_hwnd);
	369
	370	m_nSelection = -1;
	371
	372	return TRUE;
	373	}
	374
	375	// add a page to the notebook
	376	bool wxNotebook::AddPage(wxNotebookPage *pPage,
	377	const wxString& strText,
	378	bool bSelect,
	379	int imageId)
	380	{
	381	return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
	382	}
	383
	384	// same as AddPage() but does it at given position
	385	bool wxNotebook::InsertPage(int nPage,
	386	wxNotebookPage *pPage,
	387	const wxString& strText,
	388	bool bSelect,
	389	int imageId)
	390	{
	391	wxASSERT( pPage != NULL );
	392	wxCHECK( IS_VALID_PAGE(nPage) \|\| nPage == GetPageCount(), FALSE );
	393
	394	// do add the tab to the control
	395
	396	// init all fields to 0
	397	TC_ITEM tcItem;
	398	memset(&tcItem, 0, sizeof(tcItem));
	399
	400	if ( imageId != -1 )
	401	{
	402	tcItem.mask \|= TCIF_IMAGE;
	403	tcItem.iImage = imageId;
	404	}
	405
	406	if ( !strText.IsEmpty() )
	407	{
	408	tcItem.mask \|= TCIF_TEXT;
	409	tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
	410	}
	411
	412	if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
	413	wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
	414
	415	return FALSE;
	416	}
	417
	418	// if the inserted page is before the selected one, we must update the
	419	// index of the selected page
	420	if ( nPage <= m_nSelection )
	421	{
	422	// one extra page added
	423	m_nSelection++;
	424	}
	425
	426	// save the pointer to the page
	427	m_pages.Insert(pPage, nPage);
	428
	429	// don't show pages by default (we'll need to adjust their size first)
	430	HWND hwnd = GetWinHwnd(pPage);
	431	SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
	432
	433	// this updates internal flag too - otherwise it will get out of sync
	434	pPage->Show(FALSE);
	435
	436	// fit the notebook page to the tab control's display area
	437	RECT rc;
	438	rc.left = rc.top = 0;
	439	GetSize((int )&rc.right, (int )&rc.bottom);
	440	TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
	441	pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
	442
	443	// some page should be selected: either this one or the first one if there is
	444	// still no selection
	445	int selNew = -1;
	446	if ( bSelect )
	447	selNew = nPage;
	448	else if ( m_nSelection == -1 )
	449	selNew = 0;
	450
	451	if ( selNew != -1 )
	452	SetSelection(selNew);
	453
	454	return TRUE;
	455	}
	456
	457	// ----------------------------------------------------------------------------
	458	// wxNotebook callbacks
	459	// ----------------------------------------------------------------------------
	460
	461	void wxNotebook::OnSize(wxSizeEvent& event)
	462	{
	463	// fit the notebook page to the tab control's display area
	464	RECT rc;
	465	rc.left = rc.top = 0;
	466	GetSize((int )&rc.right, (int )&rc.bottom);
	467
	468	TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
	469
	470	int width = rc.right - rc.left,
	471	height = rc.bottom - rc.top;
	472	size_t nCount = m_pages.Count();
	473	for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
	474	wxNotebookPage *pPage = m_pages[nPage];
	475	pPage->SetSize(rc.left, rc.top, width, height);
	476	}
	477
	478	event.Skip();
	479	}
	480
	481	void wxNotebook::OnSelChange(wxNotebookEvent& event)
	482	{
	483	// is it our tab control?
	484	if ( event.GetEventObject() == this )
	485	{
	486	int sel = event.GetOldSelection();
	487	if ( sel != -1 )
	488	m_pages[sel]->Show(FALSE);
	489
	490	sel = event.GetSelection();
	491	if ( sel != -1 )
	492	{
	493	wxNotebookPage *pPage = m_pages[sel];
	494	pPage->Show(TRUE);
	495	pPage->SetFocus();
	496	}
	497
	498	m_nSelection = sel;
	499	}
	500
	501	// we want to give others a chance to process this message as well
	502	event.Skip();
	503	}
	504
	505	void wxNotebook::OnSetFocus(wxFocusEvent& event)
	506	{
	507	// this function is only called when the focus is explicitly set (i.e. from
	508	// the program) to the notebook - in this case we don't need the
	509	// complicated OnNavigationKey() logic because the programmer knows better
	510	// what [s]he wants
	511
	512	// set focus to the currently selected page if any
	513	if ( m_nSelection != -1 )
	514	m_pages[m_nSelection]->SetFocus();
	515
	516	event.Skip();
	517	}
	518
	519	void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
	520	{
	521	if ( event.IsWindowChange() ) {
	522	// change pages
	523	AdvanceSelection(event.GetDirection());
	524	}
	525	else {
	526	// we get this event in 2 cases
	527	//
	528	// a) one of our pages might have generated it because the user TABbed
	529	// out from it in which case we should propagate the event upwards and
	530	// our parent will take care of setting the focus to prev/next sibling
	531	//
	532	// or
	533	//
	534	// b) the parent panel wants to give the focus to us so that we
	535	// forward it to our selected page. We can't deal with this in
	536	// OnSetFocus() because we don't know which direction the focus came
	537	// from in this case and so can't choose between setting the focus to
	538	// first or last panel child
	539
	540	wxWindow *parent = GetParent();
	541	if ( event.GetEventObject() == parent )
	542	{
	543	// no, it doesn't come from child, case (b): forward to a page
	544	if ( m_nSelection != -1 )
	545	{
	546	// so that the page knows that the event comes from it's parent
	547	// and is being propagated downwards
	548	event.SetEventObject(this);
	549
	550	wxWindow *page = m_pages[m_nSelection];
	551	if ( !page->GetEventHandler()->ProcessEvent(event) )
	552	{
	553	page->SetFocus();
	554	}
	555	//else: page manages focus inside it itself
	556	}
	557	else
	558	{
	559	// we have no pages - still have to give focus to _something_
	560	SetFocus();
	561	}
	562	}
	563	else
	564	{
	565	// it comes from our child, case (a), pass to the parent
	566	if ( parent ) {
	567	event.SetCurrentFocus(this);
	568	parent->GetEventHandler()->ProcessEvent(event);
	569	}
	570	}
	571	}
	572	}
	573
	574	// ----------------------------------------------------------------------------
	575	// wxNotebook base class virtuals
	576	// ----------------------------------------------------------------------------
	577
	578	// override these 2 functions to do nothing: everything is done in OnSize
	579
	580	void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
	581	{
	582	// don't set the sizes of the pages - their correct size is not yet known
	583	wxControl::SetConstraintSizes(FALSE);
	584	}
	585
	586	bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
	587	{
	588	return TRUE;
	589	}
	590
	591	// ----------------------------------------------------------------------------
	592	// wxNotebook Windows message handlers
	593	// ----------------------------------------------------------------------------
	594
	595	bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
	596	WXWORD pos, WXHWND control)
	597	{
	598	// don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
	599	// up-down control
	600	if ( control )
	601	return FALSE;
	602
	603	return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
	604	}
	605
	606	bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
	607	{
	608	wxNotebookEvent event(wxEVT_NULL, m_windowId);
	609
	610	NMHDR* hdr = (NMHDR *)lParam;
	611	switch ( hdr->code ) {
	612	case TCN_SELCHANGE:
	613	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
	614	break;
	615
	616	case TCN_SELCHANGING:
	617	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
	618	break;
	619
	620	default:
	621	return wxControl::MSWOnNotify(idCtrl, lParam, result);
	622	}
	623
	624	event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
	625	event.SetOldSelection(m_nSelection);
	626	event.SetEventObject(this);
	627	event.SetInt(idCtrl);
	628
	629	bool processed = GetEventHandler()->ProcessEvent(event);
	630	*result = !event.IsAllowed();
	631	return processed;
	632	}
	633
	634	// ----------------------------------------------------------------------------
	635	// wxNotebook helper functions
	636	// ----------------------------------------------------------------------------
	637
	638	// generate the page changing and changed events, hide the currently active
	639	// panel and show the new one
	640	void wxNotebook::ChangePage(int nOldSel, int nSel)
	641	{
	642	// MT-FIXME should use a real semaphore
	643	static bool s_bInsideChangePage = FALSE;
	644
	645	// when we call ProcessEvent(), our own OnSelChange() is called which calls
	646	// this function - break the infinite loop
	647	if ( s_bInsideChangePage )
	648	return;
	649
	650	// it's not an error (the message may be generated by the tab control itself)
	651	// and it may happen - just do nothing
	652	if ( nSel == nOldSel )
	653	return;
	654
	655	s_bInsideChangePage = TRUE;
	656
	657	wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
	658	event.SetSelection(nSel);
	659	event.SetOldSelection(nOldSel);
	660	event.SetEventObject(this);
	661	if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
	662	{
	663	// program doesn't allow the page change
	664	s_bInsideChangePage = FALSE;
	665	return;
	666	}
	667
	668	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
	669	GetEventHandler()->ProcessEvent(event);
	670
	671	s_bInsideChangePage = FALSE;
	672	}
	673
	674	#endif // wxUSE_NOTEBOOK