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