Split wxTextCompleter into a base class and wxTextCompleterSimple.

[wxWidgets.git] / include / wx / bookctrl.h

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index e101e0660cc2713ebe11a1335cabce2ce86f3478..86a89acfd13c2b634cbcd136049da14382625a6f 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -106,7 +106,7 @@ public:
     }
 
     // get the currently selected page or wxNOT_FOUND if none
     }
 
     // get the currently selected page or wxNOT_FOUND if none

-    virtual int GetSelection() const = 0;
+    int GetSelection() const { return m_selection; }

 
     // set/get the title of a page
     virtual bool SetPageText(size_t n, const wxString& strText) = 0;
 
     // set/get the title of a page
     virtual bool SetPageText(size_t n, const wxString& strText) = 0;


@@ -137,8 +137,14 @@ public:
     // resize the notebook so that all pages will have the specified size
     virtual void SetPageSize(const wxSize& size);
 
     // resize the notebook so that all pages will have the specified size
     virtual void SetPageSize(const wxSize& size);
 

+    // return the size of the area needed to accommodate the controller
+    wxSize GetControllerSize() const;
+

     // calculate the size of the control from the size of its page
     // calculate the size of the control from the size of its page

-    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
+    //
+    // by default this simply returns size enough to fit both the page and the
+    // controller
+    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

 
     // get/set size of area between book control area and page area
     unsigned int GetInternalBorder() const { return m_internalBorder; }
 
     // get/set size of area between book control area and page area
     unsigned int GetInternalBorder() const { return m_internalBorder; }


@@ -175,6 +181,7 @@ public:
     // remove all pages and delete them
     virtual bool DeleteAllPages()
     {
     // remove all pages and delete them
     virtual bool DeleteAllPages()
     {

+        m_selection = wxNOT_FOUND;

         DoInvalidateBestSize();
         WX_CLEAR_ARRAY(m_pages);
         return true;
         DoInvalidateBestSize();
         WX_CLEAR_ARRAY(m_pages);
         return true;


@@ -198,7 +205,7 @@ public:
                             int imageId = -1) = 0;
 
     // set the currently selected page, return the index of the previously
                             int imageId = -1) = 0;
 
     // set the currently selected page, return the index of the previously

-    // selected one (or -1 on error)
+    // selected one (or wxNOT_FOUND on error)

     //
     // NB: this function will generate PAGE_CHANGING/ED events
     virtual int SetSelection(size_t n) = 0;
     //
     // NB: this function will generate PAGE_CHANGING/ED events
     virtual int SetSelection(size_t n) = 0;


@@ -211,7 +218,7 @@ public:
     void AdvanceSelection(bool forward = true)
     {
         int nPage = GetNextPage(forward);
     void AdvanceSelection(bool forward = true)
     {
         int nPage = GetNextPage(forward);

-        if ( nPage != -1 )
+        if ( nPage != wxNOT_FOUND )

         {
             // cast is safe because of the check above
             SetSelection((size_t)nPage);
         {
             // cast is safe because of the check above
             SetSelection((size_t)nPage);


@@ -245,6 +252,17 @@ protected:
     // choose the default border for this window
     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 
     // choose the default border for this window
     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 

+    // After the insertion of the page in the method InsertPage, calling this
+    // method sets the selection to the given page or the first one if there is
+    // still no selection. The "selection changed" event is sent only if
+    // bSelect is true, so when it is false, no event is sent even if the
+    // selection changed from wxNOT_FOUND to 0 when inserting the first page.
+    //
+    // Returns true if the selection was set to the specified page (explicitly
+    // because of bSelect == true or implicitly because it's the first page) or
+    // false otherwise.
+    bool DoSetSelectionAfterInsertion(size_t n, bool bSelect);
+

     // set the selection to the given page, sending the events (which can
     // possibly prevent the page change from taking place) if SendEvent flag is
     // included
     // set the selection to the given page, sending the events (which can
     // possibly prevent the page change from taking place) if SendEvent flag is
     // included


@@ -312,7 +330,6 @@ protected:
     virtual wxRect GetPageRect() const;
 
     // event handlers
     virtual wxRect GetPageRect() const;
 
     // event handlers

-    virtual wxSize GetControllerSize() const;

     void OnSize(wxSizeEvent& event);
 
     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)
     void OnSize(wxSizeEvent& event);
 
     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)


@@ -327,6 +344,11 @@ protected:
     // the margin around the choice control
     int m_controlMargin;
 
     // the margin around the choice control
     int m_controlMargin;
 

+    // The currently selected page (in range 0..m_pages.size()-1 inclusive) or
+    // wxNOT_FOUND if none (this can normally only be the case for an empty
+    // control without any pages).
+    int m_selection;
+

 private:
 
     // common part of all ctors
 private:
 
     // common part of all ctors


@@ -337,6 +359,7 @@ private:
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     wxDECLARE_NO_COPY_CLASS(wxBookCtrlBase);
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     wxDECLARE_NO_COPY_CLASS(wxBookCtrlBase);

+

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -348,7 +371,7 @@ class WXDLLIMPEXP_CORE wxBookCtrlEvent : public wxNotifyEvent
 {
 public:
     wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 {
 public:
     wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,

-                        int nSel = -1, int nOldSel = -1)
+                        int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND)

         : wxNotifyEvent(commandType, winid)
     {
         m_nSel = nSel;
         : wxNotifyEvent(commandType, winid)
     {
         m_nSel = nSel;


@@ -365,10 +388,10 @@ public:
     virtual wxEvent *Clone() const { return new wxBookCtrlEvent(*this); }
 
     // accessors
     virtual wxEvent *Clone() const { return new wxBookCtrlEvent(*this); }
 
     // accessors

-        // the currently selected page (-1 if none)
+        // the currently selected page (wxNOT_FOUND if none)

     int GetSelection() const { return m_nSel; }
     void SetSelection(int nSel) { m_nSel = nSel; }
     int GetSelection() const { return m_nSel; }
     void SetSelection(int nSel) { m_nSel = nSel; }

-        // the page that was selected before the change (-1 if none)
+        // the page that was selected before the change (wxNOT_FOUND if none)

     int GetOldSelection() const { return m_nOldSel; }
     void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
 
     int GetOldSelection() const { return m_nOldSel; }
     void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }