src/motif/choice.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choice.cpp
   3 // Purpose:     wxChoice
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "choice.h"
  14 #endif
  15
  16 #ifdef __VMS
  17 #define XtDisplay XTDISPLAY
  18 #define XtParent XTPARENT
  19 #endif
  20
  21 #include "wx/defs.h"
  22
  23 #include "wx/choice.h"
  24 #include "wx/utils.h"
  25
  26 #ifdef __VMS__
  27 #pragma message disable nosimpint
  28 #endif
  29 #include <Xm/Xm.h>
  30 #include <Xm/PushBG.h>
  31 #include <Xm/PushB.h>
  32 #include <Xm/RowColumn.h>
  33 #ifdef __VMS__
  34 #pragma message enable nosimpint
  35 #endif
  36
  37 #include "wx/motif/private.h"
  38
  39 #define WIDTH_OVERHEAD 48
  40 #define WIDTH_OVERHEAD_SUBTRACT 40
  41 #define HEIGHT_OVERHEAD 15
  42
  43 IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
  44
  45 void wxChoiceCallback (Widget w, XtPointer clientData,
  46                        XtPointer ptr);
  47
  48 wxChoice::wxChoice()
  49 {
  50     Init();
  51 }
  52
  53 void wxChoice::Init()
  54 {
  55     InitBase();
  56
  57     m_noStrings = 0;
  58     m_buttonWidget = (WXWidget) 0;
  59     m_menuWidget = (WXWidget) 0;
  60     m_formWidget = (WXWidget) 0;
  61 }
  62
  63 bool wxChoice::Create(wxWindow *parent, wxWindowID id,
  64                       const wxPoint& pos,
  65                       const wxSize& size,
  66                       int n, const wxString choices[],
  67                       long style,
  68                       const wxValidator& validator,
  69                       const wxString& name)
  70 {
  71     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
  72         return FALSE;
  73
  74     Widget parentWidget = (Widget) parent->GetClientWidget();
  75
  76     m_formWidget = (WXWidget) XtVaCreateManagedWidget(name.c_str(),
  77         xmRowColumnWidgetClass, parentWidget,
  78         XmNmarginHeight, 0,
  79         XmNmarginWidth, 0,
  80         XmNpacking, XmPACK_TIGHT,
  81         XmNorientation, XmHORIZONTAL,
  82         XmNresizeWidth, False,
  83         XmNresizeHeight, False,
  84         NULL);
  85
  86     XtVaSetValues ((Widget) m_formWidget, XmNspacing, 0, NULL);
  87
  88     /*
  89     * Create the popup menu
  90     */
  91     m_menuWidget = (WXWidget) XmCreatePulldownMenu ((Widget) m_formWidget,
  92                                                     "choiceMenu", NULL, 0);
  93
  94     if (n > 0)
  95     {
  96         int i;
  97         for (i = 0; i < n; i++)
  98             Append (choices[i]);
  99     }
 100
 101     /*
 102     * Create button
 103     */
 104     Arg args[10];
 105     Cardinal argcnt = 0;
 106
 107     XtSetArg (args[argcnt], XmNsubMenuId, (Widget) m_menuWidget); ++argcnt;
 108     XtSetArg (args[argcnt], XmNmarginWidth, 0); ++argcnt;
 109     XtSetArg (args[argcnt], XmNmarginHeight, 0); ++argcnt;
 110     XtSetArg (args[argcnt], XmNpacking, XmPACK_TIGHT); ++argcnt;
 111     m_buttonWidget = (WXWidget) XmCreateOptionMenu ((Widget) m_formWidget,
 112                                                     "choiceButton",
 113                                                     args, argcnt);
 114
 115     m_mainWidget = m_buttonWidget;
 116
 117     XtManageChild ((Widget) m_buttonWidget);
 118
 119     // New code from Roland Haenel (roland_haenel@ac.cybercity.de)
 120     // Some time ago, I reported a problem with wxChoice-items under
 121     // Linux and Motif 2.0 (they caused sporadic GPFs). Now it seems
 122     // that I have found the code responsible for this behaviour.
 123 #if XmVersion >= 1002
 124 #if XmVersion <  2000
 125     // JACS, 24/1/99: this seems to cause a malloc crash later on, e.g.
 126     // in controls sample.
 127     //
 128     // Widget optionLabel = XmOptionLabelGadget ((Widget) m_buttonWidget);
 129     // XtUnmanageChild (optionLabel);
 130 #endif
 131 #endif
 132
 133     wxSize bestSize = GetBestSize();
 134     if( size.x > 0 ) bestSize.x = size.x;
 135     if( size.y > 0 ) bestSize.y = size.y;
 136
 137     XtVaSetValues((Widget) m_formWidget, XmNresizePolicy, XmRESIZE_NONE, NULL);
 138
 139     ChangeFont(FALSE);
 140     ChangeBackgroundColour();
 141
 142     AttachWidget (parent, m_buttonWidget, m_formWidget,
 143                   pos.x, pos.y, bestSize.x, bestSize.y);
 144
 145     return TRUE;
 146 }
 147
 148 wxChoice::~wxChoice()
 149 {
 150     // For some reason destroying the menuWidget
 151     // can cause crashes on some machines. It will
 152     // be deleted implicitly by deleting the parent form
 153     // anyway.
 154     //  XtDestroyWidget (menuWidget);
 155
 156     if (GetMainWidget())
 157     {
 158         DetachWidget(GetMainWidget()); // Removes event handlers
 159         DetachWidget(m_formWidget);
 160
 161         XtDestroyWidget((Widget) m_formWidget);
 162         m_formWidget = (WXWidget) 0;
 163
 164         // Presumably the other widgets have been deleted now, via the form
 165         m_mainWidget = (WXWidget) 0;
 166         m_buttonWidget = (WXWidget) 0;
 167     }
 168     if ( HasClientObjectData() )
 169         m_clientDataDict.DestroyData();
 170 }
 171
 172 int wxChoice::DoAppend(const wxString& item)
 173 {
 174     Widget w = XtVaCreateManagedWidget (wxStripMenuCodes(item),
 175 #if USE_GADGETS
 176         xmPushButtonGadgetClass, (Widget) m_menuWidget,
 177 #else
 178         xmPushButtonWidgetClass, (Widget) m_menuWidget,
 179 #endif
 180         NULL);
 181
 182     wxDoChangeBackgroundColour((WXWidget) w, m_backgroundColour);
 183
 184     if( m_font.Ok() )
 185         wxDoChangeFont( w, m_font );
 186
 187     m_widgetArray.Add(w);
 188
 189     char mnem = wxFindMnemonic (item);
 190     if (mnem != 0)
 191         XtVaSetValues (w, XmNmnemonic, mnem, NULL);
 192
 193     XtAddCallback (w, XmNactivateCallback,
 194                    (XtCallbackProc) wxChoiceCallback,
 195                    (XtPointer) this);
 196
 197     if (m_noStrings == 0 && m_buttonWidget)
 198     {
 199         XtVaSetValues ((Widget) m_buttonWidget, XmNmenuHistory, w, NULL);
 200         Widget label = XmOptionButtonGadget ((Widget) m_buttonWidget);
 201         wxXmString text( item );
 202         XtVaSetValues (label,
 203             XmNlabelString, text(),
 204             NULL);
 205     }
 206     m_stringList.Add(item);
 207     m_noStrings ++;
 208
 209     return GetCount() - 1;
 210 }
 211
 212 void wxChoice::Delete(int n)
 213 {
 214     Widget w = (Widget)m_widgetArray[n];
 215     XtRemoveCallback(w, XmNactivateCallback, (XtCallbackProc)wxChoiceCallback,
 216                      (XtPointer)this);
 217     m_stringList.DeleteNode(m_stringList.Item(n));
 218     m_widgetArray.RemoveAt(size_t(n));
 219     m_clientDataDict.Delete(n, HasClientObjectData());
 220
 221     XtDestroyWidget(w);
 222     m_noStrings --;
 223 }
 224
 225 void wxChoice::Clear()
 226 {
 227     m_stringList.Clear ();
 228     size_t i;
 229     for (i = 0; i < m_noStrings; i++)
 230     {
 231         XtRemoveCallback((Widget) m_widgetArray[i],
 232                          XmNactivateCallback, (XtCallbackProc)wxChoiceCallback,
 233                          (XtPointer)this);
 234         XtUnmanageChild ((Widget) m_widgetArray[i]);
 235         XtDestroyWidget ((Widget) m_widgetArray[i]);
 236     }
 237     m_widgetArray.Clear();
 238     if (m_buttonWidget)
 239         XtVaSetValues ((Widget) m_buttonWidget,
 240                        XmNmenuHistory, (Widget) NULL,
 241                        NULL);
 242
 243     if ( HasClientObjectData() )
 244         m_clientDataDict.DestroyData();
 245
 246     m_noStrings = 0;
 247 }
 248
 249 int wxChoice::GetSelection() const
 250 {
 251     XmString text;
 252     Widget label = XmOptionButtonGadget ((Widget) m_buttonWidget);
 253     XtVaGetValues (label,
 254         XmNlabelString, &text,
 255         NULL);
 256     wxXmString freeMe(text);
 257     wxString s = wxXmStringToString( text );
 258
 259     if (!s.IsEmpty())
 260     {
 261         int i = 0;
 262         for (wxStringListNode* node = m_stringList.GetFirst ();
 263              node; node = node->GetNext ())
 264         {
 265             if (wxStrcmp(node->GetData(), s.c_str()) == 0)
 266             {
 267                 return i;
 268             }
 269             else
 270                 i++;
 271         }            // for()
 272
 273         return -1;
 274     }
 275     return -1;
 276 }
 277
 278 void wxChoice::SetSelection(int n)
 279 {
 280     m_inSetValue = TRUE;
 281
 282     wxStringListNode *node = m_stringList.Item(n);
 283     if (node)
 284     {
 285 #if 0
 286         Dimension selectionWidth, selectionHeight;
 287 #endif
 288         wxXmString text( node->GetData() );
 289 // MBN: this seems silly, at best, and causes wxChoices to be clipped:
 290 //      will remove "soon"
 291 #if 0
 292         XtVaGetValues ((Widget) m_widgetArray[n],
 293                        XmNwidth, &selectionWidth,
 294                        XmNheight, &selectionHeight,
 295                        NULL);
 296 #endif
 297         Widget label = XmOptionButtonGadget ((Widget) m_buttonWidget);
 298         XtVaSetValues (label,
 299             XmNlabelString, text(),
 300             NULL);
 301 #if 0
 302         XtVaSetValues ((Widget) m_buttonWidget,
 303             XmNwidth, selectionWidth, XmNheight, selectionHeight,
 304             XmNmenuHistory, (Widget) m_widgetArray[n], NULL);
 305 #endif
 306     }
 307     m_inSetValue = FALSE;
 308 }
 309
 310 int wxChoice::FindString(const wxString& s) const
 311 {
 312     int i = 0;
 313     for (wxStringListNode* node = m_stringList.GetFirst();
 314          node; node = node->GetNext ())
 315     {
 316         if (s == node->GetData())
 317             return i;
 318
 319         i++;
 320     }
 321
 322     return -1;
 323 }
 324
 325 wxString wxChoice::GetString(int n) const
 326 {
 327     wxStringListNode *node = m_stringList.Item(n);
 328     if (node)
 329         return node->GetData();
 330     else
 331         return wxEmptyString;
 332 }
 333
 334 void wxChoice::SetColumns(int n)
 335 {
 336     if (n<1) n = 1 ;
 337
 338     short numColumns = n ;
 339     Arg args[3];
 340
 341     XtSetArg(args[0], XmNnumColumns, numColumns);
 342     XtSetArg(args[1], XmNpacking, XmPACK_COLUMN);
 343     XtSetValues((Widget) m_menuWidget,args,2) ;
 344 }
 345
 346 int wxChoice::GetColumns(void) const
 347 {
 348     short numColumns ;
 349
 350     XtVaGetValues((Widget) m_menuWidget,XmNnumColumns,&numColumns,NULL) ;
 351     return numColumns ;
 352 }
 353
 354 void wxChoice::SetFocus()
 355 {
 356     XmProcessTraversal(XtParent((Widget)m_mainWidget), XmTRAVERSE_CURRENT);
 357 }
 358
 359 void wxChoice::DoSetSize(int x, int y, int width, int height, int sizeFlags)
 360 {
 361     XtVaSetValues((Widget) m_formWidget, XmNresizePolicy, XmRESIZE_ANY, NULL);
 362     bool managed = XtIsManaged((Widget) m_formWidget);
 363
 364     if (managed)
 365         XtUnmanageChild ((Widget) m_formWidget);
 366
 367     int actualWidth = width - WIDTH_OVERHEAD_SUBTRACT,
 368         actualHeight = height - HEIGHT_OVERHEAD;
 369
 370     if (width > -1)
 371     {
 372         size_t i;
 373         for (i = 0; i < m_noStrings; i++)
 374             XtVaSetValues ((Widget) m_widgetArray[i],
 375                            XmNwidth, actualWidth,
 376                            NULL);
 377         XtVaSetValues ((Widget) m_buttonWidget, XmNwidth, actualWidth,
 378             NULL);
 379     }
 380     if (height > -1)
 381     {
 382 #if 0
 383         size_t i;
 384         for (i = 0; i < m_noStrings; i++)
 385             XtVaSetValues ((Widget) m_widgetArray[i],
 386                            XmNheight, actualHeight,
 387                            NULL);
 388 #endif
 389         XtVaSetValues ((Widget) m_buttonWidget, XmNheight, actualHeight,
 390             NULL);
 391     }
 392
 393     if (managed)
 394         XtManageChild ((Widget) m_formWidget);
 395     XtVaSetValues((Widget) m_formWidget, XmNresizePolicy, XmRESIZE_NONE, NULL);
 396
 397     wxControl::DoSetSize (x, y, width, height, sizeFlags);
 398 }
 399
 400 void wxChoice::Command(wxCommandEvent & event)
 401 {
 402     SetSelection (event.GetInt());
 403     ProcessCommand (event);
 404 }
 405
 406 void wxChoiceCallback (Widget w, XtPointer clientData, XtPointer WXUNUSED(ptr))
 407 {
 408     wxChoice *item = (wxChoice *) clientData;
 409     if (item)
 410     {
 411         if (item->InSetValue())
 412             return;
 413
 414         int n = item->GetWidgets().Index(w);
 415         if (n != wxNOT_FOUND)
 416         {
 417             wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, item->GetId());
 418             event.SetEventObject(item);
 419             event.m_commandInt = n;
 420             event.m_commandString = item->GetStrings().Item(n)->GetData();
 421             if ( item->HasClientObjectData() )
 422                 event.SetClientObject( item->GetClientObject(n) );
 423             else if ( item->HasClientUntypedData() )
 424                 event.SetClientData( item->GetClientData(n) );
 425             item->ProcessCommand (event);
 426         }
 427     }
 428 }
 429
 430 void wxChoice::ChangeFont(bool keepOriginalSize)
 431 {
 432     // Note that this causes the widget to be resized back
 433     // to its original size! We therefore have to set the size
 434     // back again. TODO: a better way in Motif?
 435     if (m_font.Ok())
 436     {
 437         int width, height, width1, height1;
 438         GetSize(& width, & height);
 439
 440         WXFontType fontType =
 441             m_font.GetFontType(XtDisplay((Widget) m_mainWidget));
 442         WXString fontTag = wxFont::GetFontTag();
 443
 444         XtVaSetValues ((Widget) m_formWidget, fontTag, fontType, NULL);
 445         XtVaSetValues ((Widget) m_buttonWidget, fontTag, fontType, NULL);
 446
 447         for( size_t i = 0; i < m_noStrings; ++i )
 448             XtVaSetValues( (Widget)m_widgetArray[i],
 449                            fontTag, fontType,
 450                            NULL );
 451
 452         GetSize(& width1, & height1);
 453         if (keepOriginalSize && (width != width1 || height != height1))
 454         {
 455             SetSize(-1, -1, width, height);
 456         }
 457     }
 458 }
 459
 460 void wxChoice::ChangeBackgroundColour()
 461 {
 462     wxDoChangeBackgroundColour(m_formWidget, m_backgroundColour);
 463     wxDoChangeBackgroundColour(m_buttonWidget, m_backgroundColour);
 464     wxDoChangeBackgroundColour(m_menuWidget, m_backgroundColour);
 465     size_t i;
 466     for (i = 0; i < m_noStrings; i++)
 467         wxDoChangeBackgroundColour(m_widgetArray[i], m_backgroundColour);
 468 }
 469
 470 void wxChoice::ChangeForegroundColour()
 471 {
 472     wxDoChangeForegroundColour(m_formWidget, m_foregroundColour);
 473     wxDoChangeForegroundColour(m_buttonWidget, m_foregroundColour);
 474     wxDoChangeForegroundColour(m_menuWidget, m_foregroundColour);
 475     size_t i;
 476     for (i = 0; i < m_noStrings; i++)
 477         wxDoChangeForegroundColour(m_widgetArray[i], m_foregroundColour);
 478 }
 479
 480 int wxChoice::GetCount() const
 481 {
 482     return m_noStrings;
 483 }
 484
 485 void wxChoice::DoSetItemClientData(int n, void* clientData)
 486 {
 487     m_clientDataDict.Set(n, (wxClientData*)clientData, FALSE);
 488 }
 489
 490 void* wxChoice::DoGetItemClientData(int n) const
 491 {
 492     return (void*)m_clientDataDict.Get(n);
 493 }
 494
 495 void wxChoice::DoSetItemClientObject(int n, wxClientData* clientData)
 496 {
 497     // don't delete, wxItemContainer does that for us
 498     m_clientDataDict.Set(n, clientData, FALSE);
 499 }
 500
 501 wxClientData* wxChoice::DoGetItemClientObject(int n) const
 502 {
 503     return m_clientDataDict.Get(n);
 504 }
 505
 506 void wxChoice::SetString(int WXUNUSED(n), const wxString& WXUNUSED(s))
 507 {
 508     wxFAIL_MSG( wxT("wxChoice::SetString not implemented") );
 509 }
 510
 511 wxSize wxChoice::GetItemsSize() const
 512 {
 513     int x, y, mx = 0, my = 0;
 514
 515     // get my
 516     GetTextExtent( "|", &x, &my );
 517
 518     wxStringList::Node* curr = m_stringList.GetFirst();
 519     while( curr )
 520     {
 521         GetTextExtent( curr->GetData(), &x, &y );
 522         mx = wxMax( mx, x );
 523         my = wxMax( my, y );
 524         curr = curr->GetNext();
 525     }
 526
 527     return wxSize( mx, my );
 528 }
 529
 530 wxSize wxChoice::DoGetBestSize() const
 531 {
 532     wxSize items = GetItemsSize();
 533     // FIXME arbitrary constants
 534     return wxSize( ( items.x ? items.x + WIDTH_OVERHEAD : 120 ),
 535                      items.y + HEIGHT_OVERHEAD );
 536 }