Handle Shift-TAB correctly in wxOSX/Carbon wxComboBox.

[wxWidgets.git] / src / generic / choicdgg.cpp

diff --git a/src/generic/choicdgg.cpp b/src/generic/choicdgg.cpp
index 5a8d6f2135ee7406ce26a8556ecb1f4c24c7149e..612b285ba4659b2bbee88875ee5c0b7db82838b7 100644 (file)
--- a/src/generic/choicdgg.cpp
+++ b/src/generic/choicdgg.cpp
@@ -40,6 +40,7 @@
 #endif
 
 #include "wx/statline.h"
 #endif
 
 #include "wx/statline.h"

+#include "wx/settings.h"

 #include "wx/generic/choicdgg.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/generic/choicdgg.h"
 
 // ----------------------------------------------------------------------------


@@ -48,20 +49,6 @@
 
 #define wxID_LISTBOX 3000
 
 
 #define wxID_LISTBOX 3000
 

-// ---------------------------------------------------------------------------
-// macros
-// ---------------------------------------------------------------------------
-
-/* Macro for avoiding #ifdefs when value have to be different depending on size of
-   device we display on - take it from something like wxDesktopPolicy in the future
- */
-
-#if defined(__SMARTPHONE__)
-    #define wxLARGESMALL(large,small) small
-#else
-    #define wxLARGESMALL(large,small) large
-#endif
-

 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------


@@ -100,9 +87,13 @@ wxString wxGetSingleChoice( const wxString& message,
                             wxWindow *parent,
                             int WXUNUSED(x), int WXUNUSED(y),
                             bool WXUNUSED(centre),
                             wxWindow *parent,
                             int WXUNUSED(x), int WXUNUSED(y),
                             bool WXUNUSED(centre),

-                            int WXUNUSED(width), int WXUNUSED(height) )
+                            int WXUNUSED(width), int WXUNUSED(height),
+                            int initialSelection)

 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices);
 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices);

+
+    dialog.SetSelection(initialSelection);
+

     wxString choice;
     if ( dialog.ShowModal() == wxID_OK )
         choice = dialog.GetStringSelection();
     wxString choice;
     if ( dialog.ShowModal() == wxID_OK )
         choice = dialog.GetStringSelection();


@@ -116,26 +107,56 @@ wxString wxGetSingleChoice( const wxString& message,
                             wxWindow *parent,
                             int x, int y,
                             bool centre,
                             wxWindow *parent,
                             int x, int y,
                             bool centre,

-                            int width, int height)
+                            int width, int height,
+                            int initialSelection)

 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     wxString res = wxGetSingleChoice(message, caption, n, choices, parent,
 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     wxString res = wxGetSingleChoice(message, caption, n, choices, parent,

-                                     x, y, centre, width, height);
+                                     x, y, centre, width, height,
+                                     initialSelection);

     delete [] choices;
 
     return res;
 }
 
     delete [] choices;
 
     return res;
 }
 

+wxString wxGetSingleChoice( const wxString& message,
+                            const wxString& caption,
+                            const wxArrayString& choices,
+                            int initialSelection,
+                            wxWindow *parent)
+{
+    return wxGetSingleChoice(message, caption, choices, parent,
+                             wxDefaultCoord, wxDefaultCoord,
+                             true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                             initialSelection);
+}
+
+wxString wxGetSingleChoice( const wxString& message,
+                            const wxString& caption,
+                            int n, const wxString *choices,
+                            int initialSelection,
+                            wxWindow *parent)
+{
+    return wxGetSingleChoice(message, caption, n, choices, parent,
+                             wxDefaultCoord, wxDefaultCoord,
+                             true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                             initialSelection);
+}
+

 int wxGetSingleChoiceIndex( const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,
                             wxWindow *parent,
                             int WXUNUSED(x), int WXUNUSED(y),
                             bool WXUNUSED(centre),
 int wxGetSingleChoiceIndex( const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,
                             wxWindow *parent,
                             int WXUNUSED(x), int WXUNUSED(y),
                             bool WXUNUSED(centre),

-                            int WXUNUSED(width), int WXUNUSED(height) )
+                            int WXUNUSED(width), int WXUNUSED(height),
+                            int initialSelection)

 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices);
 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices);

+
+    dialog.SetSelection(initialSelection);
+

     int choice;
     if ( dialog.ShowModal() == wxID_OK )
         choice = dialog.GetSelection();
     int choice;
     if ( dialog.ShowModal() == wxID_OK )
         choice = dialog.GetSelection();


@@ -151,17 +172,45 @@ int wxGetSingleChoiceIndex( const wxString& message,
                             wxWindow *parent,
                             int x, int y,
                             bool centre,
                             wxWindow *parent,
                             int x, int y,
                             bool centre,

-                            int width, int height)
+                            int width, int height,
+                            int initialSelection)

 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     int res = wxGetSingleChoiceIndex(message, caption, n, choices, parent,
 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     int res = wxGetSingleChoiceIndex(message, caption, n, choices, parent,

-                                     x, y, centre, width, height);
+                                     x, y, centre, width, height,
+                                     initialSelection);

     delete [] choices;
 
     return res;
 }
 
     delete [] choices;
 
     return res;
 }
 

+int wxGetSingleChoiceIndex( const wxString& message,
+                            const wxString& caption,
+                            const wxArrayString& choices,
+                            int initialSelection,
+                            wxWindow *parent)
+{
+    return wxGetSingleChoiceIndex(message, caption, choices, parent,
+                                  wxDefaultCoord, wxDefaultCoord,
+                                  true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                                  initialSelection);
+}
+
+
+int wxGetSingleChoiceIndex( const wxString& message,
+                            const wxString& caption,
+                            int n, const wxString *choices,
+                            int initialSelection,
+                            wxWindow *parent)
+{
+    return wxGetSingleChoiceIndex(message, caption, n, choices, parent,
+                                  wxDefaultCoord, wxDefaultCoord,
+                                  true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                                  initialSelection);
+}
+
+

 void *wxGetSingleChoiceData( const wxString& message,
                              const wxString& caption,
                              int n, const wxString *choices,
 void *wxGetSingleChoiceData( const wxString& message,
                              const wxString& caption,
                              int n, const wxString *choices,


@@ -169,13 +218,17 @@ void *wxGetSingleChoiceData( const wxString& message,
                              wxWindow *parent,
                              int WXUNUSED(x), int WXUNUSED(y),
                              bool WXUNUSED(centre),
                              wxWindow *parent,
                              int WXUNUSED(x), int WXUNUSED(y),
                              bool WXUNUSED(centre),

-                             int WXUNUSED(width), int WXUNUSED(height) )
+                             int WXUNUSED(width), int WXUNUSED(height),
+                             int initialSelection)

 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices,
 {
     wxSingleChoiceDialog dialog(parent, message, caption, n, choices,

-                                (char **)client_data);
+                                client_data);
+
+    dialog.SetSelection(initialSelection);
+

     void *data;
     if ( dialog.ShowModal() == wxID_OK )
     void *data;
     if ( dialog.ShowModal() == wxID_OK )

-        data = dialog.GetSelectionClientData();
+        data = dialog.GetSelectionData();

     else
         data = NULL;
 
     else
         data = NULL;
 


@@ -189,19 +242,50 @@ void *wxGetSingleChoiceData( const wxString& message,
                              wxWindow *parent,
                              int x, int y,
                              bool centre,
                              wxWindow *parent,
                              int x, int y,
                              bool centre,

-                             int width, int height)
+                             int width, int height,
+                             int initialSelection)

 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     void *res = wxGetSingleChoiceData(message, caption, n, choices,
                                       client_data, parent,
 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
     void *res = wxGetSingleChoiceData(message, caption, n, choices,
                                       client_data, parent,

-                                      x, y, centre, width, height);
+                                      x, y, centre, width, height,
+                                      initialSelection);

     delete [] choices;
 
     return res;
 }
 
     delete [] choices;
 
     return res;
 }
 

-size_t wxGetMultipleChoices(wxArrayInt& selections,
+void* wxGetSingleChoiceData( const wxString& message,
+                             const wxString& caption,
+                             const wxArrayString& choices,
+                             void **client_data,
+                             int initialSelection,
+                             wxWindow *parent)
+{
+    return wxGetSingleChoiceData(message, caption, choices,
+                                 client_data, parent,
+                                 wxDefaultCoord, wxDefaultCoord,
+                                 true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                                 initialSelection);
+}
+
+void* wxGetSingleChoiceData( const wxString& message,
+                             const wxString& caption,
+                             int n, const wxString *choices,
+                             void **client_data,
+                             int initialSelection,
+                             wxWindow *parent)
+{
+    return wxGetSingleChoiceData(message, caption, n, choices,
+                                 client_data, parent,
+                                 wxDefaultCoord, wxDefaultCoord,
+                                 true, wxCHOICE_WIDTH, wxCHOICE_HEIGHT,
+                                 initialSelection);
+}
+
+
+int wxGetSelectedChoices(wxArrayInt& selections,

                             const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,
                             const wxString& message,
                             const wxString& caption,
                             int n, const wxString *choices,


@@ -216,15 +300,19 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
     // deselects the first item which is selected by default
     dialog.SetSelections(selections);
 
     // deselects the first item which is selected by default
     dialog.SetSelections(selections);
 

-    if ( dialog.ShowModal() == wxID_OK )
-        selections = dialog.GetSelections();
-    else
-        selections.Empty();
+    if ( dialog.ShowModal() != wxID_OK )
+    {
+        // NB: intentionally do not clear the selections array here, the caller
+        //     might want to preserve its original contents if the dialog was
+        //     cancelled
+        return -1;
+    }

 
 

+    selections = dialog.GetSelections();

     return selections.GetCount();
 }
 
     return selections.GetCount();
 }
 

-size_t wxGetMultipleChoices(wxArrayInt& selections,
+int wxGetSelectedChoices(wxArrayInt& selections,

                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,
                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,


@@ -235,7 +323,7 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);
 {
     wxString *choices;
     int n = ConvertWXArrayToC(aChoices, &choices);

-    size_t res = wxGetMultipleChoices(selections, message, caption,
+    int res = wxGetSelectedChoices(selections, message, caption,

                                       n, choices, parent,
                                       x, y, centre, width, height);
     delete [] choices;
                                       n, choices, parent,
                                       x, y, centre, width, height);
     delete [] choices;


@@ -243,6 +331,50 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
     return res;
 }
 
     return res;
 }
 

+#if WXWIN_COMPATIBILITY_2_8
+size_t wxGetMultipleChoices(wxArrayInt& selections,
+                            const wxString& message,
+                            const wxString& caption,
+                            int n, const wxString *choices,
+                            wxWindow *parent,
+                            int x, int y,
+                            bool centre,
+                            int width, int height)
+{
+    int rc = wxGetSelectedChoices(selections, message, caption,
+                                  n, choices,
+                                  parent, x, y, centre, width, height);
+    if ( rc == -1 )
+    {
+        selections.clear();
+        return 0;
+    }
+
+    return rc;
+}
+
+size_t wxGetMultipleChoices(wxArrayInt& selections,
+                            const wxString& message,
+                            const wxString& caption,
+                            const wxArrayString& aChoices,
+                            wxWindow *parent,
+                            int x, int y,
+                            bool centre,
+                            int width, int height)
+{
+    int rc = wxGetSelectedChoices(selections, message, caption,
+                                  aChoices,
+                                  parent, x, y, centre, width, height);
+    if ( rc == -1 )
+    {
+        selections.clear();
+        return 0;
+    }
+
+    return rc;
+}
+#endif // WXWIN_COMPATIBILITY_2_8
+

 // ----------------------------------------------------------------------------
 // wxAnyChoiceDialog
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAnyChoiceDialog
 // ----------------------------------------------------------------------------


@@ -255,41 +387,34 @@ bool wxAnyChoiceDialog::Create(wxWindow *parent,
                                const wxPoint& pos,
                                long styleLbox)
 {
                                const wxPoint& pos,
                                long styleLbox)
 {

-#ifdef __WXMAC__
-    if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg & (~wxCANCEL) ) )
-        return false;
-#else
+    // extract the buttons styles from the dialog one and remove them from it
+    const long styleBtns = styleDlg & (wxOK | wxCANCEL);
+    styleDlg &= ~styleBtns;
+

     if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg) )
         return false;
     if ( !wxDialog::Create(parent, wxID_ANY, caption, pos, wxDefaultSize, styleDlg) )
         return false;

-#endif

 
     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 
     // 1) text message
 
     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 
     // 1) text message

-#ifdef __WXMAC__
-    // align text and list at least on mac
-    topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(15,0) );
-#else
-    topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) );
-#endif
+    topsizer->
+        Add(CreateTextSizer(message), wxSizerFlags().Expand().TripleBorder());
+

     // 2) list box
     // 2) list box

-    m_listbox = CreateList(n,choices,styleLbox);
+    m_listbox = CreateList(n, choices, styleLbox);

 
     if ( n > 0 )
         m_listbox->SetSelection(0);
 
 
     if ( n > 0 )
         m_listbox->SetSelection(0);
 

-    topsizer->Add( m_listbox, 1, wxEXPAND|wxLEFT|wxRIGHT, wxLARGESMALL(15,0) );
+    topsizer->
+        Add(m_listbox, wxSizerFlags().Expand().Proportion(1).TripleBorder(wxLEFT | wxRIGHT));

 
     // 3) buttons if any
 
     // 3) buttons if any

-    wxSizer *buttonSizer = CreateButtonSizer( styleDlg & ButtonSizerFlags , true, wxLARGESMALL(10,0) );
-    if(buttonSizer->GetChildren().GetCount() > 0 )
+    wxSizer *
+        buttonSizer = CreateSeparatedButtonSizer(styleBtns);
+    if ( buttonSizer )

     {
     {

-        topsizer->Add( buttonSizer, 0, wxEXPAND | wxALL, wxLARGESMALL(10,0) );
-    }
-    else
-    {
-        topsizer->AddSpacer( wxLARGESMALL(15,0) );
-        delete buttonSizer;
+        topsizer->Add(buttonSizer, wxSizerFlags().Expand().DoubleBorder());

     }
 
     SetSizer( topsizer );
     }
 
     SetSizer( topsizer );


@@ -342,35 +467,12 @@ END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxSingleChoiceDialog, wxDialog)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxSingleChoiceDialog, wxDialog)
 

-wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
-                                           const wxString& message,
-                                           const wxString& caption,
-                                           int n,
-                                           const wxString *choices,
-                                           char **clientData,
-                                           long style,
-                                           const wxPoint& WXUNUSED(pos))
-{
-    Create(parent, message, caption, n, choices, clientData, style);
-}
-
-wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *parent,
-                                           const wxString& message,
-                                           const wxString& caption,
-                                           const wxArrayString& choices,
-                                           char **clientData,
-                                           long style,
-                                           const wxPoint& WXUNUSED(pos))
-{
-    Create(parent, message, caption, choices, clientData, style);
-}
-

 bool wxSingleChoiceDialog::Create( wxWindow *parent,
                                    const wxString& message,
                                    const wxString& caption,
                                    int n,
                                    const wxString *choices,
 bool wxSingleChoiceDialog::Create( wxWindow *parent,
                                    const wxString& message,
                                    const wxString& caption,
                                    int n,
                                    const wxString *choices,

-                                   char **clientData,
+                                   void **clientData,

                                    long style,
                                    const wxPoint& pos )
 {
                                    long style,
                                    const wxPoint& pos )
 {


@@ -394,7 +496,7 @@ bool wxSingleChoiceDialog::Create( wxWindow *parent,
                                    const wxString& message,
                                    const wxString& caption,
                                    const wxArrayString& choices,
                                    const wxString& message,
                                    const wxString& caption,
                                    const wxArrayString& choices,

-                                   char **clientData,
+                                   void **clientData,

                                    long style,
                                    const wxPoint& pos )
 {
                                    long style,
                                    const wxPoint& pos )
 {


@@ -406,6 +508,9 @@ bool wxSingleChoiceDialog::Create( wxWindow *parent,
 // Set the selection
 void wxSingleChoiceDialog::SetSelection(int sel)
 {
 // Set the selection
 void wxSingleChoiceDialog::SetSelection(int sel)
 {

+    wxCHECK_RET( sel >= 0 && (unsigned)sel < m_listbox->GetCount(),
+                 "Invalid initial selection" );
+

     m_listbox->SetSelection(sel);
     m_selection = sel;
 }
     m_listbox->SetSelection(sel);
     m_selection = sel;
 }


@@ -454,10 +559,17 @@ bool wxMultiChoiceDialog::Create( wxWindow *parent,
                                   long style,
                                   const wxPoint& pos )
 {
                                   long style,
                                   const wxPoint& pos )
 {

+    long styleLbox;
+#if wxUSE_CHECKLISTBOX
+    styleLbox = wxLB_ALWAYS_SB;
+#else
+    styleLbox = wxLB_ALWAYS_SB | wxLB_EXTENDED;
+#endif
+

     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos,
     if ( !wxAnyChoiceDialog::Create(parent, message, caption,
                                     n, choices,
                                     style, pos,

-                                    wxLB_ALWAYS_SB | wxLB_EXTENDED) )
+                                    styleLbox) )

         return false;
 
     return true;
         return false;
 
     return true;


@@ -477,6 +589,30 @@ bool wxMultiChoiceDialog::Create( wxWindow *parent,
 
 void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 {
 
 void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 {

+#if wxUSE_CHECKLISTBOX
+    wxCheckListBox* checkListBox = wxDynamicCast(m_listbox, wxCheckListBox);
+    if (checkListBox)
+    {
+        // first clear all currently selected items
+        size_t n,
+            count = checkListBox->GetCount();
+        for ( n = 0; n < count; ++n )
+        {
+            if (checkListBox->IsChecked(n))
+                checkListBox->Check(n, false);
+        }
+
+        // now select the ones which should be selected
+        count = selections.GetCount();
+        for ( n = 0; n < count; n++ )
+        {
+            checkListBox->Check(selections[n]);
+        }
+
+        return;
+    }
+#endif
+

     // first clear all currently selected items
     size_t n,
            count = m_listbox->GetCount();
     // first clear all currently selected items
     size_t n,
            count = m_listbox->GetCount();


@@ -496,6 +632,21 @@ void wxMultiChoiceDialog::SetSelections(const wxArrayInt& selections)
 bool wxMultiChoiceDialog::TransferDataFromWindow()
 {
     m_selections.Empty();
 bool wxMultiChoiceDialog::TransferDataFromWindow()
 {
     m_selections.Empty();

+
+#if wxUSE_CHECKLISTBOX
+    wxCheckListBox* checkListBox = wxDynamicCast(m_listbox, wxCheckListBox);
+    if (checkListBox)
+    {
+        size_t count = checkListBox->GetCount();
+        for ( size_t n = 0; n < count; n++ )
+        {
+            if ( checkListBox->IsChecked(n) )
+                m_selections.Add(n);
+        }
+        return true;
+    }
+#endif
+

     size_t count = m_listbox->GetCount();
     for ( size_t n = 0; n < count; n++ )
     {
     size_t count = m_listbox->GetCount();
     for ( size_t n = 0; n < count; n++ )
     {