]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/notebook.cpp
docstring fixes
[wxWidgets.git] / src / gtk / notebook.cpp
index 55d9558f67affc01239497ef7ec6daaf28a59bf0..b8dfb49c813dd01d987b9d490fb6abce11c08a5c 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        notebook.cpp
+// Name:        src/gtk/notebook.cpp
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
+#if wxUSE_NOTEBOOK
+
 #include "wx/notebook.h"
 
-#if wxUSE_NOTEBOOK
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/utils.h"
+    #include "wx/panel.h"
+    #include "wx/msgdlg.h"
+    #include "wx/bitmap.h"
+#endif
 
-#include "wx/panel.h"
-#include "wx/utils.h"
 #include "wx/imaglist.h"
-#include "wx/intl.h"
-#include "wx/log.h"
-#include "wx/bitmap.h"
 #include "wx/fontutil.h"
 
 // FIXME: Use GtkImage instead of GtkPixmap. Don't use gtk_container_border_width
@@ -33,8 +37,6 @@
 
 #include <gdk/gdkkeysyms.h>
 
-#include "wx/msgdlg.h"
-
 // ----------------------------------------------------------------------------
 // events
 // ----------------------------------------------------------------------------
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
 
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
-
 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
@@ -103,7 +98,7 @@ static void gtk_notebook_page_change_callback(GtkNotebook *WXUNUSED(widget),
     wxCHECK_RET( !notebook->m_inSwitchPage,
                  _T("gtk_notebook_page_change_callback reentered") );
 
-    notebook->m_inSwitchPage = TRUE;
+    notebook->m_inSwitchPage = true;
     if (g_isIdle)
         wxapp_install_idle_handler();
 
@@ -133,7 +128,7 @@ static void gtk_notebook_page_change_callback(GtkNotebook *WXUNUSED(widget),
         notebook->GetEventHandler()->ProcessEvent( eventChanged );
     }
 
-    notebook->m_inSwitchPage = FALSE;
+    notebook->m_inSwitchPage = false;
 }
 }
 
@@ -296,11 +291,11 @@ END_EVENT_TABLE()
 void wxNotebook::Init()
 {
     m_padding = 0;
-    m_inSwitchPage = FALSE;
+    m_inSwitchPage = false;
 
     m_imageList = (wxImageList *) NULL;
     m_selection = -1;
-    m_themeEnabled = TRUE;
+    m_themeEnabled = true;
 }
 
 wxNotebook::wxNotebook()
@@ -325,15 +320,18 @@ bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
                         const wxPoint& pos, const wxSize& size,
                         long style, const wxString& name )
 {
-    m_needParent = TRUE;
-    m_acceptsFocus = TRUE;
+    m_needParent = true;
+    m_acceptsFocus = true;
     m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook;
 
+    if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
+        style |= wxBK_TOP;
+
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
     {
         wxFAIL_MSG( wxT("wxNoteBook creation failed") );
-        return FALSE;
+        return false;
     }
 
 
@@ -361,7 +359,7 @@ bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
     g_signal_connect (m_widget, "realize",
                       G_CALLBACK (gtk_notebook_realized_callback), this);
 
-    return TRUE;
+    return true;
 }
 
 int wxNotebook::GetSelection() const
@@ -390,13 +388,13 @@ int wxNotebook::GetSelection() const
 
 wxString wxNotebook::GetPageText( size_t page ) const
 {
-    wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid notebook") );
+    wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid notebook") );
 
     wxGtkNotebookPage* nb_page = GetNotebookPage(page);
     if (nb_page)
         return nb_page->m_text;
     else
-        return wxT("");
+        return wxEmptyString;
 }
 
 int wxNotebook::GetPageImage( size_t page ) const
@@ -440,17 +438,17 @@ int wxNotebook::SetSelection( size_t page )
 
 bool wxNotebook::SetPageText( size_t page, const wxString &text )
 {
-    wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
+    wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") );
 
     wxGtkNotebookPage* nb_page = GetNotebookPage(page);
 
-    wxCHECK_MSG( nb_page, FALSE, wxT("SetPageText: invalid page index") );
+    wxCHECK_MSG( nb_page, false, wxT("SetPageText: invalid page index") );
 
     nb_page->m_text = text;
 
     gtk_label_set_text( nb_page->m_label, wxGTK_CONV( nb_page->m_text ) );
 
-    return TRUE;
+    return true;
 }
 
 bool wxNotebook::SetPageImage( size_t page, int image )
@@ -459,13 +457,13 @@ bool wxNotebook::SetPageImage( size_t page, int image )
 
     wxGtkNotebookPage* nb_page = GetNotebookPage(page);
 
-    if (!nb_page) return FALSE;
+    if (!nb_page) return false;
 
     /* Optimization posibility: return immediately if image unchanged.
      * Not enabled because it may break existing (stupid) code that
      * manipulates the imagelist to cycle images */
 
-    /* if (image == nb_page->m_image) return TRUE; */
+    /* if (image == nb_page->m_image) return true; */
 
     /* For different cases:
        1) no image -> no image
@@ -474,7 +472,7 @@ bool wxNotebook::SetPageImage( size_t page, int image )
        4) image -> image */
 
     if (image == -1 && nb_page->m_image == -1)
-        return TRUE; /* Case 1): Nothing to do. */
+        return true; /* Case 1): Nothing to do. */
 
     GtkWidget *pixmapwid = (GtkWidget*) NULL;
 
@@ -502,7 +500,7 @@ bool wxNotebook::SetPageImage( size_t page, int image )
             gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid);
             nb_page->m_image = -1;
 
-            return TRUE; /* Case 2) */
+            return true; /* Case 2) */
         }
     }
 
@@ -535,7 +533,7 @@ bool wxNotebook::SetPageImage( size_t page, int image )
 
     nb_page->m_image = image;
 
-    return TRUE;
+    return true;
 }
 
 void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) )
@@ -577,7 +575,7 @@ void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
 
 bool wxNotebook::DeleteAllPages()
 {
-    wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
+    wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") );
 
     while (m_pagesData.GetCount() > 0)
         DeletePage( m_pagesData.GetCount()-1 );
@@ -629,12 +627,12 @@ bool wxNotebook::InsertPage( size_t position,
                              bool select,
                              int imageId )
 {
-    wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
+    wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") );
 
-    wxCHECK_MSG( win->GetParent() == this, FALSE,
+    wxCHECK_MSG( win->GetParent() == this, false,
                wxT("Can't add a page whose parent is not the notebook!") );
 
-    wxCHECK_MSG( position <= GetPageCount(), FALSE,
+    wxCHECK_MSG( position <= GetPageCount(), false,
                  _T("invalid page index in wxNotebookPage::InsertPage()") );
 
     // Hack Alert! (Part II): See above in wxInsertChildInNotebook callback
@@ -650,7 +648,7 @@ bool wxNotebook::InsertPage( size_t position,
                                           this);
 
     if (m_themeEnabled)
-        win->SetThemeEnabled(TRUE);
+        win->SetThemeEnabled(true);
 
     GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
 
@@ -698,7 +696,7 @@ bool wxNotebook::InsertPage( size_t position,
     /* set the label text */
 
     nb_page->m_text = text;
-    if (nb_page->m_text.IsEmpty()) nb_page->m_text = wxT("");
+    if (nb_page->m_text.empty()) nb_page->m_text = wxEmptyString;
 
     nb_page->m_label = GTK_LABEL( gtk_label_new(wxGTK_CONV(nb_page->m_text)) );
     gtk_box_pack_end( GTK_BOX(nb_page->m_box), GTK_WIDGET(nb_page->m_label), FALSE, FALSE, m_padding );
@@ -722,7 +720,7 @@ bool wxNotebook::InsertPage( size_t position,
                       G_CALLBACK (gtk_notebook_page_change_callback), this);
 
     InvalidateBestSize();
-    return TRUE;
+    return true;
 }
 
 // helper for HitTest(): check if the point lies inside the given widget which
@@ -780,15 +778,15 @@ int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
 
                 if ( pixmap && IsPointInsideWidget(pt, pixmap, x, y) )
                 {
-                    *flags = wxNB_HITTEST_ONICON;
+                    *flags = wxBK_HITTEST_ONICON;
                 }
                 else if ( IsPointInsideWidget(pt, GTK_WIDGET(nb_page->m_label), x, y) )
                 {
-                    *flags = wxNB_HITTEST_ONLABEL;
+                    *flags = wxBK_HITTEST_ONLABEL;
                 }
                 else
                 {
-                    *flags = wxNB_HITTEST_ONITEM;
+                    *flags = wxBK_HITTEST_ONITEM;
                 }
             }
 
@@ -797,7 +795,22 @@ int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
     }
 
     if ( flags )
-        *flags = wxNB_HITTEST_NOWHERE;
+    {
+        *flags = wxBK_HITTEST_NOWHERE;
+        wxWindowBase * page = GetCurrentPage();
+        if ( page )
+        {
+            // rect origin is in notebook's parent coordinates
+            wxRect rect = page->GetRect();
+
+            // adjust it to the notebook's coordinates
+            wxPoint pos = GetPosition();
+            rect.x -= pos.x;
+            rect.y -= pos.y;
+            if ( rect.Inside( pt ) )
+                *flags |= wxBK_HITTEST_ONPAGE;
+        }
+    }
 
     return wxNOT_FOUND;
 }
@@ -816,12 +829,12 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) )
 {
     // don't set the sizes of the pages - their correct size is not yet known
-    wxControl::SetConstraintSizes(FALSE);
+    wxControl::SetConstraintSizes(false);
 }
 
 bool wxNotebook::DoPhase( int WXUNUSED(nPhase) )
 {
-    return TRUE;
+    return true;
 }
 
 #endif