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::SetTextIndent() 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         @param size
 336             Window size. If wxDefaultSize is specified then the window is sized
 337             appropriately.
 338         @param style
 339             Window style. See wxComboCtrl.
 340         @param validator
 341             Window validator.
 342         @param name
 343             Window name.
 344
 345         @see Create(), wxValidator
 346     */
 347     wxComboCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
 348                 const wxString& value = wxEmptyString,
 349                 const wxPoint& pos = wxDefaultPosition,
 350                 const wxSize& size = wxDefaultSize,
 351                 long style = 0,
 352                 const wxValidator& validator = wxDefaultValidator,
 353                 const wxString& name = wxComboBoxNameStr);
 354
 355     /**
 356         Destructor, destroying the combo control.
 357     */
 358     virtual ~wxComboCtrl();
 359
 360     /**
 361         Copies the selected text to the clipboard.
 362     */
 363     virtual void Copy();
 364
 365     /**
 366         Creates the combo control for two-step construction. Derived classes
 367         should call or replace this function. See wxComboCtrl() for further
 368         details.
 369     */
 370     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
 371                 const wxString& value = wxEmptyString,
 372                 const wxPoint& pos = wxDefaultPosition,
 373                 const wxSize& size = wxDefaultSize,
 374                 long style = 0,
 375                 const wxValidator& validator = wxDefaultValidator,
 376                 const wxString& name = wxComboBoxNameStr);
 377
 378     /**
 379         Copies the selected text to the clipboard and removes the selection.
 380     */
 381     virtual void Cut();
 382
 383     /**
 384         Enables or disables popup animation, if any, depending on the value of
 385         the argument.
 386     */
 387     void EnablePopupAnimation(bool enable = true);
 388
 389     /**
 390         Returns disabled button bitmap that has been set with
 391         SetButtonBitmaps().
 392
 393         @return A reference to the disabled state bitmap.
 394     */
 395     const wxBitmap& GetBitmapDisabled() const;
 396
 397     /**
 398         Returns button mouse hover bitmap that has been set with
 399         SetButtonBitmaps().
 400
 401         @return A reference to the mouse hover state bitmap.
 402     */
 403     const wxBitmap& GetBitmapHover() const;
 404
 405     /**
 406         Returns default button bitmap that has been set with
 407         SetButtonBitmaps().
 408
 409         @return A reference to the normal state bitmap.
 410     */
 411     const wxBitmap& GetBitmapNormal() const;
 412
 413     /**
 414         Returns depressed button bitmap that has been set with
 415         SetButtonBitmaps().
 416
 417         @return A reference to the depressed state bitmap.
 418     */
 419     const wxBitmap& GetBitmapPressed() const;
 420
 421     /**
 422         Returns current size of the dropdown button.
 423     */
 424     wxSize GetButtonSize();
 425
 426     /**
 427         Returns custom painted area in control.
 428
 429         @see SetCustomPaintWidth().
 430     */
 431     int GetCustomPaintWidth() const;
 432
 433     /**
 434         Returns features supported by wxComboCtrl. If needed feature is
 435         missing, you need to instead use wxGenericComboCtrl, which however may
 436         lack a native look and feel (but otherwise sports identical API).
 437
 438         @return Value returned is a combination of the flags defined in
 439                 wxComboCtrlFeatures.
 440     */
 441     static int GetFeatures();
 442
 443     /**
 444         Returns the insertion point for the combo control's text field.
 445
 446         @note Under Windows, this function always returns 0 if the combo
 447               control doesn't have the focus.
 448     */
 449     virtual long GetInsertionPoint() const;
 450
 451     /**
 452         Returns the last position in the combo control text field.
 453     */
 454     virtual long GetLastPosition() const;
 455
 456     /**
 457         Returns current popup interface that has been set with
 458         SetPopupControl().
 459     */
 460     wxComboPopup* GetPopupControl();
 461
 462     /**
 463         Returns popup window containing the popup control.
 464     */
 465     wxWindow* GetPopupWindow() const;
 466
 467     /**
 468         Get the text control which is part of the combo control.
 469     */
 470     wxTextCtrl* GetTextCtrl() const;
 471
 472     /**
 473         Returns actual indentation in pixels.
 474     */
 475     wxCoord GetTextIndent() const;
 476
 477     /**
 478         Returns area covered by the text field (includes everything except
 479         borders and the dropdown button).
 480     */
 481     const wxRect& GetTextRect() const;
 482
 483     /**
 484         Returns text representation of the current value. For writable combo
 485         control it always returns the value in the text field.
 486     */
 487     virtual wxString GetValue() const;
 488
 489     /**
 490         Dismisses the popup window.
 491     */
 492     virtual void HidePopup();
 493
 494     /**
 495         Returns @true if the popup is currently shown
 496     */
 497     bool IsPopupShown() const;
 498
 499     /**
 500         Returns @true if the popup window is in the given state. Possible
 501         values are:
 502
 503         @beginTable
 504         @row2col{wxComboCtrl::Hidden,    Popup window is hidden.}
 505         @row2col{wxComboCtrl::Animating, Popup window is being shown, but the
 506                                          popup animation has not yet finished.}
 507         @row2col{wxComboCtrl::Visible,   Popup window is fully visible.}
 508         @endTable
 509     */
 510     bool IsPopupWindowState(int state) const;
 511
 512     /**
 513         Implement in a derived class to define what happens on dropdown button
 514         click. Default action is to show the popup.
 515
 516         @note If you implement this to do something else than show the popup,
 517               you must then also implement DoSetPopupControl() to always return
 518               @NULL.
 519     */
 520     virtual void OnButtonClick();
 521
 522     /**
 523         Pastes text from the clipboard to the text field.
 524     */
 525     virtual void Paste();
 526
 527     /**
 528         Removes the text between the two positions in the combo control text
 529         field.
 530
 531         @param from
 532             The first position.
 533         @param to
 534             The last position.
 535     */
 536     virtual void Remove(long from, long to);
 537
 538     /**
 539         Replaces the text between two positions with the given text, in the
 540         combo control text field.
 541
 542         @param from
 543             The first position.
 544         @param to
 545             The second position.
 546         @param text
 547             The text to insert.
 548     */
 549     virtual void Replace(long from, long to, const wxString& text);
 550
 551     /**
 552         Sets custom dropdown button graphics.
 553
 554         @param bmpNormal
 555             Default button image.
 556         @param pushButtonBg
 557             If @true, blank push button background is painted below the image.
 558         @param bmpPressed
 559             Depressed button image.
 560         @param bmpHover
 561             Button image when mouse hovers above it. This should be ignored on
 562             platforms and themes that do not generally draw different kind of
 563             button on mouse hover.
 564         @param bmpDisabled
 565             Disabled button image.
 566     */
 567     void SetButtonBitmaps(const wxBitmap& bmpNormal,
 568                           bool pushButtonBg = false,
 569                           const wxBitmap& bmpPressed = wxNullBitmap,
 570                           const wxBitmap& bmpHover = wxNullBitmap,
 571                           const wxBitmap& bmpDisabled = wxNullBitmap);
 572
 573     /**
 574         Sets size and position of dropdown button.
 575
 576         @param width
 577             Button width. Value = 0 specifies default.
 578         @param height
 579             Button height. Value = 0 specifies default.
 580         @param side
 581             Indicates which side the button will be placed. Value can be wxLEFT
 582             or wxRIGHT.
 583         @param spacingX
 584             Horizontal spacing around the button. Default is 0.
 585     */
 586     void SetButtonPosition(int width = -1, int height = -1,
 587                            int side = wxRIGHT, int spacingX = 0);
 588
 589     /**
 590         Set width, in pixels, of custom painted area in control without
 591         @c wxCB_READONLY style. In read-only wxOwnerDrawnComboBox, this is used
 592         to indicate area that is not covered by the focus rectangle.
 593     */
 594     void SetCustomPaintWidth(int width);
 595
 596     /**
 597         Sets the insertion point in the text field.
 598
 599         @param pos
 600             The new insertion point.
 601     */
 602     virtual void SetInsertionPoint(long pos);
 603
 604     /**
 605         Sets the insertion point at the end of the combo control text field.
 606     */
 607     virtual void SetInsertionPointEnd();
 608
 609     /**
 610         Set side of the control to which the popup will align itself. Valid
 611         values are @c wxLEFT, @c wxRIGHT and 0. The default value 0 means that
 612         the most appropriate side is used (which, currently, is always
 613         @c wxLEFT).
 614     */
 615     void SetPopupAnchor(int anchorSide);
 616
 617     /**
 618         Set popup interface class derived from wxComboPopup. This method should
 619         be called as soon as possible after the control has been created,
 620         unless OnButtonClick() has been overridden.
 621     */
 622     void SetPopupControl(wxComboPopup* popup);
 623
 624     /**
 625         Extends popup size horizontally, relative to the edges of the combo
 626         control.
 627
 628         @param extLeft
 629             How many pixel to extend beyond the left edge of the control.
 630             Default is 0.
 631         @param extRight
 632             How many pixel to extend beyond the right edge of the control.
 633             Default is 0.
 634
 635         @remarks Popup minimum width may override arguments. It is up to the
 636                  popup to fully take this into account.
 637     */
 638     void SetPopupExtents(int extLeft, int extRight);
 639
 640     /**
 641         Sets preferred maximum height of the popup.
 642
 643         @remarks Value -1 indicates the default.
 644     */
 645     void SetPopupMaxHeight(int height);
 646
 647     /**
 648         Sets minimum width of the popup. If wider than combo control, it will
 649         extend to the left.
 650
 651         @remarks Value -1 indicates the default. Also, popup implementation may
 652                  choose to ignore this.
 653     */
 654     void SetPopupMinWidth(int width);
 655
 656     /**
 657         Selects the text between the two positions, in the combo control text
 658         field.
 659
 660         @param from
 661             The first position.
 662         @param to
 663             The second position.
 664     */
 665     virtual void SetSelection(long from, long to);
 666
 667     /**
 668         Sets the text for the text field without affecting the popup. Thus,
 669         unlike SetValue(), it works equally well with combo control using
 670         @c wxCB_READONLY style.
 671     */
 672     void SetText(const wxString& value);
 673
 674     /**
 675         This will set the space in pixels between left edge of the control and
 676         the text, regardless whether control is read-only or not. Value -1 can
 677         be given to indicate platform default.
 678     */
 679     void SetTextIndent(int indent);
 680
 681     /**
 682         Sets the text for the combo control text field.
 683
 684         @note For a combo control with @c wxCB_READONLY style the string must
 685               be accepted by the popup (for instance, exist in the dropdown
 686               list), otherwise the call to SetValue() is ignored.
 687     */
 688     virtual void SetValue(const wxString& value);
 689
 690     /**
 691         Same as SetValue(), but also sends wxCommandEvent of type
 692         wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true.
 693     */
 694     void SetValueWithEvent(const wxString& value, bool withEvent = true);
 695
 696     /**
 697         Show the popup.
 698     */
 699     virtual void ShowPopup();
 700
 701     /**
 702         Undoes the last edit in the text field. Windows only.
 703     */
 704     virtual void Undo();
 705
 706     /**
 707         Enable or disable usage of an alternative popup window, which
 708         guarantees ability to focus the popup control, and allows common native
 709         controls to function normally. This alternative popup window is usually
 710         a wxDialog, and as such, when it is shown, its parent top-level window
 711         will appear as if the focus has been lost from it.
 712     */
 713     void UseAltPopupWindow(bool enable = true);
 714
 715 protected:
 716
 717     /**
 718         This member function is not normally called in application code.
 719         Instead, it can be implemented in a derived class to create a custom
 720         popup animation.
 721
 722         The parameters are the same as those for DoShowPopup().
 723
 724         @return @true if animation finishes before the function returns,
 725                 @false otherwise. In the latter case you need to manually call
 726                 DoShowPopup() after the animation ends.
 727     */
 728     virtual bool AnimateShow(const wxRect& rect, int flags);
 729
 730     /**
 731         This member function is not normally called in application code.
 732         Instead, it can be implemented in a derived class to return default
 733         wxComboPopup, incase @a popup is @NULL.
 734
 735         @note If you have implemented OnButtonClick() to do something else than
 736               show the popup, then DoSetPopupControl() must always set @a popup
 737               to @NULL.
 738     */
 739     virtual void DoSetPopupControl(wxComboPopup* popup);
 740
 741     /**
 742         This member function is not normally called in application code.
 743         Instead, it must be called in a derived class to make sure popup is
 744         properly shown after a popup animation has finished (but only if
 745         AnimateShow() did not finish the animation within its function scope).
 746
 747         @param rect
 748             Position to show the popup window at, in screen coordinates.
 749         @param flags
 750             Combination of any of the following:
 751             @beginTable
 752             @row2col{wxComboCtrl::ShowAbove,
 753                      Popup is shown above the control instead of below.}
 754             @row2col{wxComboCtrl::CanDeferShow,
 755                      Showing the popup can be deferred to happen sometime after
 756                      ShowPopup() has finished. In this case, AnimateShow() must
 757                      return false.}
 758             @endTable
 759     */
 760     virtual void DoShowPopup(const wxRect& rect, int flags);
 761 };
 762