interface/wx/combo.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        combo.h
   3 // Purpose:     interface of wxComboCtrl and wxComboPopup
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxComboPopup
  11
  12     In order to use a custom popup with wxComboCtrl, an interface class must be
  13     derived from wxComboPopup.
  14
  15     For more information on how to use it, see @ref comboctrl_custompopup.
  16
  17     @library{wxcore}
  18     @category{ctrl}
  19
  20     @see wxComboCtrl
  21 */
  22 class wxComboPopup
  23 {
  24 public:
  25     /**
  26         Default constructor. It is recommended that internal variables are
  27         prepared in Init() instead (because m_combo is not valid in
  28         constructor).
  29     */
  30     wxComboPopup();
  31
  32     /**
  33         The derived class must implement this to create the popup control.
  34
  35         @return @true if the call succeeded, @false otherwise.
  36     */
  37     virtual bool Create(wxWindow* parent) = 0;
  38
  39     /**
  40         Utility function that hides the popup.
  41     */
  42     void Dismiss();
  43
  44     /**
  45         The derived class may implement this to return adjusted size for the
  46         popup control, according to the variables given.
  47
  48         @param minWidth
  49             Preferred minimum width.
  50         @param prefHeight
  51             Preferred height. May be -1 to indicate no preference.
  52         @param maxHeight
  53             Max height for window, as limited by screen size.
  54
  55         @remarks This function is called each time popup is about to be shown.
  56     */
  57     virtual wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight);
  58
  59     /**
  60         Returns pointer to the associated parent wxComboCtrl.
  61     */
  62     wxComboCtrl* GetComboCtrl() const;
  63
  64     /**
  65         The derived class must implement this to return pointer to the
  66         associated control created in Create().
  67     */
  68     virtual wxWindow* GetControl() = 0;
  69
  70     /**
  71         The derived class must implement this to return string representation
  72         of the value.
  73     */
  74     virtual wxString GetStringValue() const = 0;
  75
  76     /**
  77         The derived class must implement this to initialize its internal
  78         variables. This method is called immediately after construction
  79         finishes. m_combo member variable has been initialized before the call.
  80     */
  81     virtual void Init();
  82
  83     /**
  84         Utility method that returns @true if Create has been called.
  85
  86         Useful in conjunction with LazyCreate().
  87     */
  88     bool IsCreated() const;
  89
  90     /**
  91         The derived class may implement this to return @true if it wants to
  92         delay call to Create() until the popup is shown for the first time. It
  93         is more efficient, but on the other hand it is often more convenient to
  94         have the control created immediately.
  95
  96         @remarks Base implementation returns @false.
  97     */
  98     virtual bool LazyCreate();
  99
 100     /**
 101         The derived class may implement this to do something when the parent
 102         wxComboCtrl gets double-clicked.
 103     */
 104     virtual void OnComboDoubleClick();
 105
 106     /**
 107         The derived class may implement this to receive key events from the
 108         parent wxComboCtrl.
 109
 110         Events not handled should be skipped, as usual.
 111     */
 112     virtual void OnComboKeyEvent(wxKeyEvent& event);
 113
 114     /**
 115         The derived class may implement this to do special processing when
 116         popup is hidden.
 117     */
 118     virtual void OnDismiss();
 119
 120     /**
 121         The derived class may implement this to do special processing when
 122         popup is shown.
 123     */
 124     virtual void OnPopup();
 125
 126     /**
 127         The derived class may implement this to paint the parent wxComboCtrl.
 128
 129         Default implementation draws value as string.
 130     */
 131     virtual void PaintComboControl(wxDC& dc, const wxRect& rect);
 132
 133     /**
 134         The derived class must implement this to receive string value changes
 135         from wxComboCtrl.
 136     */
 137     virtual void SetStringValue(const wxString& value);
 138
 139 protected:
 140     /**
 141         Parent wxComboCtrl. This member variable is prepared automatically
 142         before Init() is called.
 143     */
 144     wxComboCtrl*    m_combo;
 145 };
 146
 147
 148
 149 /**
 150     Features enabled for wxComboCtrl.
 151
 152     @see wxComboCtrl::GetFeatures()
 153 */
 154 struct wxComboCtrlFeatures
 155 {
 156     enum
 157     {
 158         MovableButton   = 0x0001, ///< Button can be on either side of control.
 159         BitmapButton    = 0x0002, ///< Button may be replaced with bitmap.
 160         ButtonSpacing   = 0x0004, ///< Button can have spacing from the edge
 161                                   ///< of the control.
 162         TextIndent      = 0x0008, ///< wxComboCtrl::SetMargins() can be used.
 163         PaintControl    = 0x0010, ///< Combo control itself can be custom painted.
 164         PaintWritable   = 0x0020, ///< A variable-width area in front of writable
 165                                   ///< combo control's textctrl can be custom
 166                                   ///< painted.
 167         Borderless      = 0x0040, ///< wxNO_BORDER window style works.
 168
 169         All             = MovableButton | BitmapButton | ButtonSpacing |
 170                           TextIndent | PaintControl | PaintWritable |
 171                           Borderless ///< All features.
 172     };
 173 };
 174
 175
 176 /**
 177     @class wxComboCtrl
 178
 179     A combo control is a generic combobox that allows totally custom popup. In
 180     addition it has other customization features. For instance, position and
 181     size of the dropdown button can be changed.
 182
 183     @section comboctrl_custompopup Setting Custom Popup for wxComboCtrl
 184
 185     wxComboCtrl needs to be told somehow which control to use and this is done
 186     by SetPopupControl(). However, we need something more than just a wxControl
 187     in this method as, for example, we need to call
 188     SetStringValue("initial text value") and wxControl doesn't have such
 189     method. So we also need a wxComboPopup which is an interface which must be
 190     implemented by a control to be usable as a popup.
 191
 192     We couldn't derive wxComboPopup from wxControl as this would make it
 193     impossible to have a class deriving from a wxWidgets control and from it,
 194     so instead it is just a mix-in.
 195
 196     Here's a minimal sample of wxListView popup:
 197
 198     @code
 199     #include <wx/combo.h>
 200     #include <wx/listctrl.h>
 201
 202     class wxListViewComboPopup : public wxListView, public wxComboPopup
 203     {
 204     public:
 205         // Initialize member variables
 206         virtual void Init()
 207         {
 208             m_value = -1;
 209         }
 210
 211         // Create popup control
 212         virtual bool Create(wxWindow* parent)
 213         {
 214             return wxListView::Create(parent,1,wxPoint(0,0),wxDefaultSize);
 215         }
 216
 217         // Return pointer to the created control
 218         virtual wxWindow *GetControl() { return this; }
 219
 220         // Translate string into a list selection
 221         virtual void SetStringValue(const wxString& s)
 222         {
 223             int n = wxListView::FindItem(-1,s);
 224             if ( n >= 0 && n < wxListView::GetItemCount() )
 225                 wxListView::Select(n);
 226         }
 227
 228         // Get list selection as a string
 229         virtual wxString GetStringValue() const
 230         {
 231             if ( m_value >= 0 )
 232             return wxListView::GetItemText(m_value);
 233             return wxEmptyString;
 234         }
 235
 236         // Do mouse hot-tracking (which is typical in list popups)
 237         void OnMouseMove(wxMouseEvent& event)
 238         {
 239             // TODO: Move selection to cursor
 240         }
 241
 242         // On mouse left up, set the value and close the popup
 243         void OnMouseClick(wxMouseEvent& WXUNUSED(event))
 244         {
 245             m_value = wxListView::GetFirstSelected();
 246
 247             // TODO: Send event as well
 248
 249             Dismiss();
 250         }
 251
 252     protected:
 253
 254         int m_value; // current item index
 255
 256     private:
 257         DECLARE_EVENT_TABLE()
 258     };
 259
 260     BEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView)
 261         EVT_MOTION(wxListViewComboPopup::OnMouseMove)
 262         EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick)
 263     END_EVENT_TABLE()
 264     @endcode
 265
 266     Here's how you would create and populate it in a dialog constructor:
 267
 268     @code
 269     wxComboCtrl* comboCtrl = new wxComboCtrl(this, wxID_ANY, wxEmptyString);
 270
 271     wxListViewComboPopup* popupCtrl = new wxListViewComboPopup();
 272
 273     // It is important to call SetPopupControl() as soon as possible
 274     comboCtrl->SetPopupControl(popupCtrl);
 275
 276     // Populate using wxListView methods
 277     popupCtrl->InsertItem(popupCtrl->GetItemCount(), "First Item");
 278     popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Second Item");
 279     popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Third Item");
 280     @endcode
 281
 282     @beginStyleTable
 283     @style{wxCB_READONLY}
 284            Text will not be editable.
 285     @style{wxCB_SORT}
 286            Sorts the entries in the list alphabetically.
 287     @style{wxTE_PROCESS_ENTER}
 288            The control will generate the event wxEVT_COMMAND_TEXT_ENTER
 289            (otherwise pressing Enter key is either processed internally by the
 290            control or used for navigation between dialog controls). Windows
 291            only.
 292     @style{wxCC_SPECIAL_DCLICK}
 293            Double-clicking triggers a call to popup's OnComboDoubleClick.
 294            Actual behaviour is defined by a derived class. For instance,
 295            wxOwnerDrawnComboBox will cycle an item. This style only applies if
 296            wxCB_READONLY is used as well.
 297     @style{wxCC_STD_BUTTON}
 298            Drop button will behave more like a standard push button.
 299     @endStyleTable
 300
 301     @beginEventEmissionTable{wxCommandEvent}
 302     @event{EVT_TEXT(id, func)}
 303            Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
 304     @event{EVT_TEXT_ENTER(id, func)}
 305            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
 306            the combo control.
 307     @endEventTable
 308
 309     @library{wxbase}
 310     @category{ctrl}
 311     @appearance{comboctrl.png}
 312
 313     @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup,
 314          wxCommandEvent
 315 */
 316 class wxComboCtrl : public wxControl
 317 {
 318 public:
 319     /**
 320         Default constructor.
 321     */
 322     wxComboCtrl();
 323
 324     /**
 325         Constructor, creating and showing a combo control.
 326
 327         @param parent
 328             Parent window. Must not be @NULL.
 329         @param id
 330             Window identifier. The value wxID_ANY indicates a default value.
 331         @param value
 332             Initial selection string. An empty string indicates no selection.
 333         @param pos
 334             Window position.
 335             If ::wxDefaultPosition is specified then a default position is chosen.
 336         @param size
 337             Window size.
 338             If ::wxDefaultSize is specified then the window is sized appropriately.
 339         @param style
 340             Window style. See wxComboCtrl.
 341         @param validator
 342             Window validator.
 343         @param name
 344             Window name.
 345
 346         @see Create(), wxValidator
 347     */
 348     wxComboCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
 349                 const wxString& value = wxEmptyString,
 350                 const wxPoint& pos = wxDefaultPosition,
 351                 const wxSize& size = wxDefaultSize,
 352                 long style = 0,
 353                 const wxValidator& validator = wxDefaultValidator,
 354                 const wxString& name = wxComboBoxNameStr);
 355
 356     /**
 357         Destructor, destroying the combo control.
 358     */
 359     virtual ~wxComboCtrl();
 360
 361     /**
 362         Copies the selected text to the clipboard.
 363     */
 364     virtual void Copy();
 365
 366     /**
 367         Creates the combo control for two-step construction. Derived classes
 368         should call or replace this function. See wxComboCtrl() for further
 369         details.
 370     */
 371     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
 372                 const wxString& value = wxEmptyString,
 373                 const wxPoint& pos = wxDefaultPosition,
 374                 const wxSize& size = wxDefaultSize,
 375                 long style = 0,
 376                 const wxValidator& validator = wxDefaultValidator,
 377                 const wxString& name = wxComboBoxNameStr);
 378
 379     /**
 380         Copies the selected text to the clipboard and removes the selection.
 381     */
 382     virtual void Cut();
 383
 384     /**
 385         Enables or disables popup animation, if any, depending on the value of
 386         the argument.
 387     */
 388     void EnablePopupAnimation(bool enable = true);
 389
 390     /**
 391         Returns disabled button bitmap that has been set with
 392         SetButtonBitmaps().
 393
 394         @return A reference to the disabled state bitmap.
 395     */
 396     const wxBitmap& GetBitmapDisabled() const;
 397
 398     /**
 399         Returns button mouse hover bitmap that has been set with
 400         SetButtonBitmaps().
 401
 402         @return A reference to the mouse hover state bitmap.
 403     */
 404     const wxBitmap& GetBitmapHover() const;
 405
 406     /**
 407         Returns default button bitmap that has been set with
 408         SetButtonBitmaps().
 409
 410         @return A reference to the normal state bitmap.
 411     */
 412     const wxBitmap& GetBitmapNormal() const;
 413
 414     /**
 415         Returns depressed button bitmap that has been set with
 416         SetButtonBitmaps().
 417
 418         @return A reference to the depressed state bitmap.
 419     */
 420     const wxBitmap& GetBitmapPressed() const;
 421
 422     /**
 423         Returns current size of the dropdown button.
 424     */
 425     wxSize GetButtonSize();
 426
 427     /**
 428         Returns custom painted area in control.
 429
 430         @see SetCustomPaintWidth().
 431     */
 432     int GetCustomPaintWidth() const;
 433
 434     /**
 435         Returns features supported by wxComboCtrl. If needed feature is
 436         missing, you need to instead use wxGenericComboCtrl, which however may
 437         lack a native look and feel (but otherwise sports identical API).
 438
 439         @return Value returned is a combination of the flags defined in
 440                 wxComboCtrlFeatures.
 441     */
 442     static int GetFeatures();
 443
 444     /**
 445         Returns the insertion point for the combo control's text field.
 446
 447         @note Under Windows, this function always returns 0 if the combo
 448               control doesn't have the focus.
 449     */
 450     virtual long GetInsertionPoint() const;
 451
 452     /**
 453         Returns the last position in the combo control text field.
 454     */
 455     virtual long GetLastPosition() const;
 456
 457     /**
 458         Returns the margins used by the control. The @c x field of the returned
 459         point is the horizontal margin and the @c y field is the vertical one.
 460
 461         @remarks If given margin cannot be accurately determined, its value
 462                 will be set to -1.
 463
 464         @see SetMargins()
 465
 466         @since 2.9.1
 467     */
 468     wxPoint GetMargins() const;
 469
 470     /**
 471         Returns current popup interface that has been set with
 472         SetPopupControl().
 473     */
 474     wxComboPopup* GetPopupControl();
 475
 476     /**
 477         Returns popup window containing the popup control.
 478     */
 479     wxWindow* GetPopupWindow() const;
 480
 481     /**
 482         Get the text control which is part of the combo control.
 483     */
 484     wxTextCtrl* GetTextCtrl() const;
 485
 486     /**
 487         Returns actual indentation in pixels.
 488
 489         @deprecated Use GetMargins() instead.
 490     */
 491     wxCoord GetTextIndent() const;
 492
 493     /**
 494         Returns area covered by the text field (includes everything except
 495         borders and the dropdown button).
 496     */
 497     const wxRect& GetTextRect() const;
 498
 499     /**
 500         Returns text representation of the current value. For writable combo
 501         control it always returns the value in the text field.
 502     */
 503     virtual wxString GetValue() const;
 504
 505     /**
 506         Dismisses the popup window.
 507     */
 508     virtual void HidePopup();
 509
 510     /**
 511         Returns @true if the popup is currently shown
 512     */
 513     bool IsPopupShown() const;
 514
 515     /**
 516         Returns @true if the popup window is in the given state. Possible
 517         values are:
 518
 519         @beginTable
 520         @row2col{wxComboCtrl::Hidden,    Popup window is hidden.}
 521         @row2col{wxComboCtrl::Animating, Popup window is being shown, but the
 522                                          popup animation has not yet finished.}
 523         @row2col{wxComboCtrl::Visible,   Popup window is fully visible.}
 524         @endTable
 525     */
 526     bool IsPopupWindowState(int state) const;
 527
 528     /**
 529         Implement in a derived class to define what happens on dropdown button
 530         click. Default action is to show the popup.
 531
 532         @note If you implement this to do something else than show the popup,
 533               you must then also implement DoSetPopupControl() to always return
 534               @NULL.
 535     */
 536     virtual void OnButtonClick();
 537
 538     /**
 539         Pastes text from the clipboard to the text field.
 540     */
 541     virtual void Paste();
 542
 543     /**
 544         Removes the text between the two positions in the combo control text
 545         field.
 546
 547         @param from
 548             The first position.
 549         @param to
 550             The last position.
 551     */
 552     virtual void Remove(long from, long to);
 553
 554     /**
 555         Replaces the text between two positions with the given text, in the
 556         combo control text field.
 557
 558         @param from
 559             The first position.
 560         @param to
 561             The second position.
 562         @param text
 563             The text to insert.
 564     */
 565     virtual void Replace(long from, long to, const wxString& text);
 566
 567     /**
 568         Sets custom dropdown button graphics.
 569
 570         @param bmpNormal
 571             Default button image.
 572         @param pushButtonBg
 573             If @true, blank push button background is painted below the image.
 574         @param bmpPressed
 575             Depressed button image.
 576         @param bmpHover
 577             Button image when mouse hovers above it. This should be ignored on
 578             platforms and themes that do not generally draw different kind of
 579             button on mouse hover.
 580         @param bmpDisabled
 581             Disabled button image.
 582     */
 583     void SetButtonBitmaps(const wxBitmap& bmpNormal,
 584                           bool pushButtonBg = false,
 585                           const wxBitmap& bmpPressed = wxNullBitmap,
 586                           const wxBitmap& bmpHover = wxNullBitmap,
 587                           const wxBitmap& bmpDisabled = wxNullBitmap);
 588
 589     /**
 590         Sets size and position of dropdown button.
 591
 592         @param width
 593             Button width. Value = 0 specifies default.
 594         @param height
 595             Button height. Value = 0 specifies default.
 596         @param side
 597             Indicates which side the button will be placed. Value can be wxLEFT
 598             or wxRIGHT.
 599         @param spacingX
 600             Horizontal spacing around the button. Default is 0.
 601     */
 602     void SetButtonPosition(int width = -1, int height = -1,
 603                            int side = wxRIGHT, int spacingX = 0);
 604
 605     /**
 606         Set width, in pixels, of custom painted area in control without
 607         @c wxCB_READONLY style. In read-only wxOwnerDrawnComboBox, this is used
 608         to indicate area that is not covered by the focus rectangle.
 609     */
 610     void SetCustomPaintWidth(int width);
 611
 612     /**
 613         Sets the insertion point in the text field.
 614
 615         @param pos
 616             The new insertion point.
 617     */
 618     virtual void SetInsertionPoint(long pos);
 619
 620     /**
 621         Sets the insertion point at the end of the combo control text field.
 622     */
 623     virtual void SetInsertionPointEnd();
 624
 625     //@{
 626     /**
 627         Attempts to set the control margins. When margins are given as wxPoint,
 628         x indicates the left and y the top margin. Use -1 to indicate that
 629         an existing value should be used.
 630
 631         @return
 632             @true if setting of all requested margins was successful.
 633
 634         @since 2.9.1
 635     */
 636     bool SetMargins(const wxPoint& pt);
 637     bool SetMargins(wxCoord left, wxCoord top = -1);
 638     //@}
 639
 640     /**
 641         Set side of the control to which the popup will align itself. Valid
 642         values are @c wxLEFT, @c wxRIGHT and 0. The default value 0 means that
 643         the most appropriate side is used (which, currently, is always
 644         @c wxLEFT).
 645     */
 646     void SetPopupAnchor(int anchorSide);
 647
 648     /**
 649         Set popup interface class derived from wxComboPopup. This method should
 650         be called as soon as possible after the control has been created,
 651         unless OnButtonClick() has been overridden.
 652     */
 653     void SetPopupControl(wxComboPopup* popup);
 654
 655     /**
 656         Extends popup size horizontally, relative to the edges of the combo
 657         control.
 658
 659         @param extLeft
 660             How many pixel to extend beyond the left edge of the control.
 661             Default is 0.
 662         @param extRight
 663             How many pixel to extend beyond the right edge of the control.
 664             Default is 0.
 665
 666         @remarks Popup minimum width may override arguments. It is up to the
 667                  popup to fully take this into account.
 668     */
 669     void SetPopupExtents(int extLeft, int extRight);
 670
 671     /**
 672         Sets preferred maximum height of the popup.
 673
 674         @remarks Value -1 indicates the default.
 675     */
 676     void SetPopupMaxHeight(int height);
 677
 678     /**
 679         Sets minimum width of the popup. If wider than combo control, it will
 680         extend to the left.
 681
 682         @remarks Value -1 indicates the default. Also, popup implementation may
 683                  choose to ignore this.
 684     */
 685     void SetPopupMinWidth(int width);
 686
 687     /**
 688         Selects the text between the two positions, in the combo control text
 689         field.
 690
 691         @param from
 692             The first position.
 693         @param to
 694             The second position.
 695     */
 696     virtual void SetSelection(long from, long to);
 697
 698     /**
 699         Sets the text for the text field without affecting the popup. Thus,
 700         unlike SetValue(), it works equally well with combo control using
 701         @c wxCB_READONLY style.
 702     */
 703     void SetText(const wxString& value);
 704
 705     /**
 706         This will set the space in pixels between left edge of the control and
 707         the text, regardless whether control is read-only or not. Value -1 can
 708         be given to indicate platform default.
 709
 710         @deprecated Use SetMargins() instead.
 711     */
 712     void SetTextIndent(int indent);
 713
 714     /**
 715         Sets the text for the combo control text field.
 716
 717         @note For a combo control with @c wxCB_READONLY style the string must
 718               be accepted by the popup (for instance, exist in the dropdown
 719               list), otherwise the call to SetValue() is ignored.
 720     */
 721     virtual void SetValue(const wxString& value);
 722
 723     /**
 724         Same as SetValue(), but also sends wxCommandEvent of type
 725         wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
 726     */
 727     void SetValueWithEvent(const wxString& value, bool withEvent = true);
 728
 729     /**
 730         Show the popup.
 731     */
 732     virtual void ShowPopup();
 733
 734     /**
 735         Undoes the last edit in the text field. Windows only.
 736     */
 737     virtual void Undo();
 738
 739     /**
 740         Enable or disable usage of an alternative popup window, which
 741         guarantees ability to focus the popup control, and allows common native
 742         controls to function normally. This alternative popup window is usually
 743         a wxDialog, and as such, when it is shown, its parent top-level window
 744         will appear as if the focus has been lost from it.
 745     */
 746     void UseAltPopupWindow(bool enable = true);
 747
 748 protected:
 749
 750     /**
 751         This member function is not normally called in application code.
 752         Instead, it can be implemented in a derived class to create a custom
 753         popup animation.
 754
 755         The parameters are the same as those for DoShowPopup().
 756
 757         @return @true if animation finishes before the function returns,
 758                 @false otherwise. In the latter case you need to manually call
 759                 DoShowPopup() after the animation ends.
 760     */
 761     virtual bool AnimateShow(const wxRect& rect, int flags);
 762
 763     /**
 764         This member function is not normally called in application code.
 765         Instead, it can be implemented in a derived class to return default
 766         wxComboPopup, incase @a popup is @NULL.
 767
 768         @note If you have implemented OnButtonClick() to do something else than
 769               show the popup, then DoSetPopupControl() must always set @a popup
 770               to @NULL.
 771     */
 772     virtual void DoSetPopupControl(wxComboPopup* popup);
 773
 774     /**
 775         This member function is not normally called in application code.
 776         Instead, it must be called in a derived class to make sure popup is
 777         properly shown after a popup animation has finished (but only if
 778         AnimateShow() did not finish the animation within its function scope).
 779
 780         @param rect
 781             Position to show the popup window at, in screen coordinates.
 782         @param flags
 783             Combination of any of the following:
 784             @beginTable
 785             @row2col{wxComboCtrl::ShowAbove,
 786                      Popup is shown above the control instead of below.}
 787             @row2col{wxComboCtrl::CanDeferShow,
 788                      Showing the popup can be deferred to happen sometime after
 789                      ShowPopup() has finished. In this case, AnimateShow() must
 790                      return false.}
 791             @endTable
 792     */
 793     virtual void DoShowPopup(const wxRect& rect, int flags);
 794 };
 795