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

#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 | wxTAB_TRAVERSAL,
                        wxDefaultValidator, name) )
        return FALSE;

    if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size) )
        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 & wxNB_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") );

  if ( nPage != m_nSelection )
  {
    wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
    event.SetSelection(nPage);
    event.SetOldSelection(m_nSelection);
    event.SetEventObject(this);
    if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
    {
      // program allows the page change
      event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
      (void)GetEventHandler()->ProcessEvent(event);

      TabCtrl_SetCurSel(m_hwnd, nPage);
    }
  }

  return m_nSelection;
}

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

void wxNotebook::AdjustPageSize(wxNotebookPage *page)
{
    wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );

    RECT rc;
    rc.left =
    rc.top = 0;

    // get the page size from the notebook size
    GetSize((int *)&rc.right, (int *)&rc.bottom);
    TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);

    page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
}

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

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

    wxASSERT_MSG( pPage->GetParent() == this,
                    _T("notebook pages must have notebook as parent") );

    // add a new tab to the control
    // ----------------------------

    // init all fields to 0
    TC_ITEM tcItem;
    wxZeroMemory(tcItem);

    // set the image, if any
    if ( imageId != -1 )
    {
        tcItem.mask |= TCIF_IMAGE;
        tcItem.iImage  = imageId;
    }

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

    // fit the notebook page to the tab control's display area: this should be
    // done before adding it to the notebook or TabCtrl_InsertItem() will
    // change the notebooks size itself!
    AdjustPageSize(pPage);

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

        return FALSE;
    }

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

    // for the first page (only) we need to adjust the size again because the
    // notebook size changed: the tabs which hadn't been there before are now
    // shown
    if ( m_pages.GetCount() == 1 )
    {
        AdjustPageSize(pPage);
    }

    // hide the page: unless it is selected, it shouldn't be shown (and if it
    // is selected it will be shown later)
    HWND hwnd = GetWinHwnd(pPage);
    SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);

    // this updates internal flag too -- otherwise it would get out of sync
    // with the real state
    pPage->Show(FALSE);


    // now deal with the selection
    // ---------------------------

    // 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++;
    }

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

#if wxUSE_CONSTRAINTS

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

#endif // wxUSE_CONSTRAINTS

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

#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 licence
	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 \| wxTAB_TRAVERSAL,
	146	wxDefaultValidator, name) )
	147	return FALSE;
	148
	149	if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size) )
	150	return FALSE;
	151
	152	SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
	153
	154	return TRUE;
	155	}
	156
	157	WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
	158	{
	159	WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
	160
	161	tabStyle \|= WS_TABSTOP \| TCS_TABS;
	162
	163	if ( style & wxNB_MULTILINE )
	164	tabStyle \|= TCS_MULTILINE;
	165	if ( style & wxNB_FIXEDWIDTH )
	166	tabStyle \|= TCS_FIXEDWIDTH;
	167
	168	if ( style & wxNB_BOTTOM )
	169	tabStyle \|= TCS_RIGHT;
	170	else if ( style & wxNB_LEFT )
	171	tabStyle \|= TCS_VERTICAL;
	172	else if ( style & wxNB_RIGHT )
	173	tabStyle \|= TCS_VERTICAL \| TCS_RIGHT;
	174
	175	// ex style
	176	if ( exstyle )
	177	{
	178	// note that we never want to have the default WS_EX_CLIENTEDGE style
	179	// as it looks too ugly for the notebooks
	180	*exstyle = 0;
	181	}
	182
	183	return tabStyle;
	184	}
	185
	186	// ----------------------------------------------------------------------------
	187	// wxNotebook accessors
	188	// ----------------------------------------------------------------------------
	189
	190	int wxNotebook::GetPageCount() const
	191	{
	192	// consistency check
	193	wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
	194
	195	return m_pages.Count();
	196	}
	197
	198	int wxNotebook::GetRowCount() const
	199	{
	200	return TabCtrl_GetRowCount(m_hwnd);
	201	}
	202
	203	int wxNotebook::SetSelection(int nPage)
	204	{
	205	wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
	206
	207	if ( nPage != m_nSelection )
	208	{
	209	wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
	210	event.SetSelection(nPage);
	211	event.SetOldSelection(m_nSelection);
	212	event.SetEventObject(this);
	213	if ( !GetEventHandler()->ProcessEvent(event) \|\| event.IsAllowed() )
	214	{
	215	// program allows the page change
	216	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
	217	(void)GetEventHandler()->ProcessEvent(event);
	218
	219	TabCtrl_SetCurSel(m_hwnd, nPage);
	220	}
	221	}
	222
	223	return m_nSelection;
	224	}
	225
	226	bool wxNotebook::SetPageText(int nPage, const wxString& strText)
	227	{
	228	wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
	229
	230	TC_ITEM tcItem;
	231	tcItem.mask = TCIF_TEXT;
	232	tcItem.pszText = (wxChar *)strText.c_str();
	233
	234	return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
	235	}
	236
	237	wxString wxNotebook::GetPageText(int nPage) const
	238	{
	239	wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );
	240
	241	wxChar buf[256];
	242	TC_ITEM tcItem;
	243	tcItem.mask = TCIF_TEXT;
	244	tcItem.pszText = buf;
	245	tcItem.cchTextMax = WXSIZEOF(buf);
	246
	247	wxString str;
	248	if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
	249	str = tcItem.pszText;
	250
	251	return str;
	252	}
	253
	254	int wxNotebook::GetPageImage(int nPage) const
	255	{
	256	wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
	257
	258	TC_ITEM tcItem;
	259	tcItem.mask = TCIF_IMAGE;
	260
	261	return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
	262	}
	263
	264	bool wxNotebook::SetPageImage(int nPage, int nImage)
	265	{
	266	wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
	267
	268	TC_ITEM tcItem;
	269	tcItem.mask = TCIF_IMAGE;
	270	tcItem.iImage = nImage;
	271
	272	return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
	273	}
	274
	275	void wxNotebook::SetImageList(wxImageList* imageList)
	276	{
	277	wxNotebookBase::SetImageList(imageList);
	278
	279	if ( imageList )
	280	{
	281	TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
	282	}
	283	}
	284
	285	// ----------------------------------------------------------------------------
	286	// wxNotebook size settings
	287	// ----------------------------------------------------------------------------
	288
	289	void wxNotebook::SetPageSize(const wxSize& size)
	290	{
	291	// transform the page size into the notebook size
	292	RECT rc;
	293	rc.left =
	294	rc.top = 0;
	295	rc.right = size.x;
	296	rc.bottom = size.y;
	297
	298	TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
	299
	300	// and now set it
	301	SetSize(rc.right - rc.left, rc.bottom - rc.top);
	302	}
	303
	304	void wxNotebook::SetPadding(const wxSize& padding)
	305	{
	306	TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
	307	}
	308
	309	// Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
	310	// style.
	311	void wxNotebook::SetTabSize(const wxSize& sz)
	312	{
	313	::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
	314	}
	315
	316	void wxNotebook::AdjustPageSize(wxNotebookPage *page)
	317	{
	318	wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
	319
	320	RECT rc;
	321	rc.left =
	322	rc.top = 0;
	323
	324	// get the page size from the notebook size
	325	GetSize((int )&rc.right, (int )&rc.bottom);
	326	TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
	327
	328	page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
	329	}
	330
	331	// ----------------------------------------------------------------------------
	332	// wxNotebook operations
	333	// ----------------------------------------------------------------------------
	334
	335	// remove one page from the notebook, without deleting
	336	wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
	337	{
	338	wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
	339	if ( !pageRemoved )
	340	return NULL;
	341
	342	TabCtrl_DeleteItem(m_hwnd, nPage);
	343
	344	if ( m_pages.IsEmpty() )
	345	{
	346	// no selection any more, the notebook becamse empty
	347	m_nSelection = -1;
	348	}
	349	else // notebook still not empty
	350	{
	351	// change the selected page if it was deleted or became invalid
	352	int selNew;
	353	if ( m_nSelection == GetPageCount() )
	354	{
	355	// last page deleted, make the new last page the new selection
	356	selNew = m_nSelection - 1;
	357	}
	358	else if ( nPage <= m_nSelection )
	359	{
	360	// we must show another page, even if it has the same index
	361	selNew = m_nSelection;
	362	}
	363	else // nothing changes for the currently selected page
	364	{
	365	selNew = -1;
	366
	367	// we still must refresh the current page: this needs to be done
	368	// for some unknown reason if the tab control shows the up-down
	369	// control (i.e. when there are too many pages) -- otherwise after
	370	// deleting a page nothing at all is shown
	371	m_pages[m_nSelection]->Refresh();
	372	}
	373
	374	if ( selNew != -1 )
	375	{
	376	// m_nSelection must be always valid so reset it before calling
	377	// SetSelection()
	378	m_nSelection = -1;
	379	SetSelection(selNew);
	380	}
	381	}
	382
	383	return pageRemoved;
	384	}
	385
	386	// remove all pages
	387	bool wxNotebook::DeleteAllPages()
	388	{
	389	int nPageCount = GetPageCount();
	390	int nPage;
	391	for ( nPage = 0; nPage < nPageCount; nPage++ )
	392	delete m_pages[nPage];
	393
	394	m_pages.Clear();
	395
	396	TabCtrl_DeleteAllItems(m_hwnd);
	397
	398	m_nSelection = -1;
	399
	400	return TRUE;
	401	}
	402
	403	// same as AddPage() but does it at given position
	404	bool wxNotebook::InsertPage(int nPage,
	405	wxNotebookPage *pPage,
	406	const wxString& strText,
	407	bool bSelect,
	408	int imageId)
	409	{
	410	wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") );
	411	wxCHECK_MSG( IS_VALID_PAGE(nPage) \|\| nPage == GetPageCount(), FALSE,
	412	_T("invalid index in wxNotebook::InsertPage") );
	413
	414	wxASSERT_MSG( pPage->GetParent() == this,
	415	_T("notebook pages must have notebook as parent") );
	416
	417	// add a new tab to the control
	418	// ----------------------------
	419
	420	// init all fields to 0
	421	TC_ITEM tcItem;
	422	wxZeroMemory(tcItem);
	423
	424	// set the image, if any
	425	if ( imageId != -1 )
	426	{
	427	tcItem.mask \|= TCIF_IMAGE;
	428	tcItem.iImage = imageId;
	429	}
	430
	431	// and the text
	432	if ( !strText.IsEmpty() )
	433	{
	434	tcItem.mask \|= TCIF_TEXT;
	435	tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
	436	}
	437
	438	// fit the notebook page to the tab control's display area: this should be
	439	// done before adding it to the notebook or TabCtrl_InsertItem() will
	440	// change the notebooks size itself!
	441	AdjustPageSize(pPage);
	442
	443	// finally do insert it
	444	if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 )
	445	{
	446	wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
	447
	448	return FALSE;
	449	}
	450
	451	// succeeded: save the pointer to the page
	452	m_pages.Insert(pPage, nPage);
	453
	454	// for the first page (only) we need to adjust the size again because the
	455	// notebook size changed: the tabs which hadn't been there before are now
	456	// shown
	457	if ( m_pages.GetCount() == 1 )
	458	{
	459	AdjustPageSize(pPage);
	460	}
	461
	462	// hide the page: unless it is selected, it shouldn't be shown (and if it
	463	// is selected it will be shown later)
	464	HWND hwnd = GetWinHwnd(pPage);
	465	SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
	466
	467	// this updates internal flag too -- otherwise it would get out of sync
	468	// with the real state
	469	pPage->Show(FALSE);
	470
	471
	472	// now deal with the selection
	473	// ---------------------------
	474
	475	// if the inserted page is before the selected one, we must update the
	476	// index of the selected page
	477	if ( nPage <= m_nSelection )
	478	{
	479	// one extra page added
	480	m_nSelection++;
	481	}
	482
	483	// some page should be selected: either this one or the first one if there
	484	// is still no selection
	485	int selNew = -1;
	486	if ( bSelect )
	487	selNew = nPage;
	488	else if ( m_nSelection == -1 )
	489	selNew = 0;
	490
	491	if ( selNew != -1 )
	492	SetSelection(selNew);
	493
	494	return TRUE;
	495	}
	496
	497	// ----------------------------------------------------------------------------
	498	// wxNotebook callbacks
	499	// ----------------------------------------------------------------------------
	500
	501	void wxNotebook::OnSize(wxSizeEvent& event)
	502	{
	503	// fit the notebook page to the tab control's display area
	504	RECT rc;
	505	rc.left = rc.top = 0;
	506	GetSize((int )&rc.right, (int )&rc.bottom);
	507
	508	TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
	509
	510	int width = rc.right - rc.left,
	511	height = rc.bottom - rc.top;
	512	size_t nCount = m_pages.Count();
	513	for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
	514	wxNotebookPage *pPage = m_pages[nPage];
	515	pPage->SetSize(rc.left, rc.top, width, height);
	516	}
	517
	518	event.Skip();
	519	}
	520
	521	void wxNotebook::OnSelChange(wxNotebookEvent& event)
	522	{
	523	// is it our tab control?
	524	if ( event.GetEventObject() == this )
	525	{
	526	int sel = event.GetOldSelection();
	527	if ( sel != -1 )
	528	m_pages[sel]->Show(FALSE);
	529
	530	sel = event.GetSelection();
	531	if ( sel != -1 )
	532	{
	533	wxNotebookPage *pPage = m_pages[sel];
	534	pPage->Show(TRUE);
	535	pPage->SetFocus();
	536	}
	537
	538	m_nSelection = sel;
	539	}
	540
	541	// we want to give others a chance to process this message as well
	542	event.Skip();
	543	}
	544
	545	void wxNotebook::OnSetFocus(wxFocusEvent& event)
	546	{
	547	// this function is only called when the focus is explicitly set (i.e. from
	548	// the program) to the notebook - in this case we don't need the
	549	// complicated OnNavigationKey() logic because the programmer knows better
	550	// what [s]he wants
	551
	552	// set focus to the currently selected page if any
	553	if ( m_nSelection != -1 )
	554	m_pages[m_nSelection]->SetFocus();
	555
	556	event.Skip();
	557	}
	558
	559	void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
	560	{
	561	if ( event.IsWindowChange() ) {
	562	// change pages
	563	AdvanceSelection(event.GetDirection());
	564	}
	565	else {
	566	// we get this event in 2 cases
	567	//
	568	// a) one of our pages might have generated it because the user TABbed
	569	// out from it in which case we should propagate the event upwards and
	570	// our parent will take care of setting the focus to prev/next sibling
	571	//
	572	// or
	573	//
	574	// b) the parent panel wants to give the focus to us so that we
	575	// forward it to our selected page. We can't deal with this in
	576	// OnSetFocus() because we don't know which direction the focus came
	577	// from in this case and so can't choose between setting the focus to
	578	// first or last panel child
	579
	580	wxWindow *parent = GetParent();
	581	if ( event.GetEventObject() == parent )
	582	{
	583	// no, it doesn't come from child, case (b): forward to a page
	584	if ( m_nSelection != -1 )
	585	{
	586	// so that the page knows that the event comes from it's parent
	587	// and is being propagated downwards
	588	event.SetEventObject(this);
	589
	590	wxWindow *page = m_pages[m_nSelection];
	591	if ( !page->GetEventHandler()->ProcessEvent(event) )
	592	{
	593	page->SetFocus();
	594	}
	595	//else: page manages focus inside it itself
	596	}
	597	else
	598	{
	599	// we have no pages - still have to give focus to _something_
	600	SetFocus();
	601	}
	602	}
	603	else
	604	{
	605	// it comes from our child, case (a), pass to the parent
	606	if ( parent ) {
	607	event.SetCurrentFocus(this);
	608	parent->GetEventHandler()->ProcessEvent(event);
	609	}
	610	}
	611	}
	612	}
	613
	614	// ----------------------------------------------------------------------------
	615	// wxNotebook base class virtuals
	616	// ----------------------------------------------------------------------------
	617
	618	#if wxUSE_CONSTRAINTS
	619
	620	// override these 2 functions to do nothing: everything is done in OnSize
	621
	622	void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
	623	{
	624	// don't set the sizes of the pages - their correct size is not yet known
	625	wxControl::SetConstraintSizes(FALSE);
	626	}
	627
	628	bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
	629	{
	630	return TRUE;
	631	}
	632
	633	#endif // wxUSE_CONSTRAINTS
	634
	635	// ----------------------------------------------------------------------------
	636	// wxNotebook Windows message handlers
	637	// ----------------------------------------------------------------------------
	638
	639	bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
	640	WXWORD pos, WXHWND control)
	641	{
	642	// don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
	643	// up-down control
	644	if ( control )
	645	return FALSE;
	646
	647	return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
	648	}
	649
	650	bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
	651	{
	652	wxNotebookEvent event(wxEVT_NULL, m_windowId);
	653
	654	NMHDR* hdr = (NMHDR *)lParam;
	655	switch ( hdr->code ) {
	656	case TCN_SELCHANGE:
	657	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
	658	break;
	659
	660	case TCN_SELCHANGING:
	661	event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
	662	break;
	663
	664	default:
	665	return wxControl::MSWOnNotify(idCtrl, lParam, result);
	666	}
	667
	668	event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
	669	event.SetOldSelection(m_nSelection);
	670	event.SetEventObject(this);
	671	event.SetInt(idCtrl);
	672
	673	bool processed = GetEventHandler()->ProcessEvent(event);
	674	*result = !event.IsAllowed();
	675	return processed;
	676	}
	677
	678	#endif // wxUSE_NOTEBOOK