| 1 | /////////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/combo.h |
| 3 | // Purpose: wxComboCtrl declaration |
| 4 | // Author: Jaakko Salli |
| 5 | // Modified by: |
| 6 | // Created: Apr-30-2006 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) Jaakko Salli |
| 9 | // Licence: wxWindows licence |
| 10 | /////////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_COMBOCONTROL_H_BASE_ |
| 13 | #define _WX_COMBOCONTROL_H_BASE_ |
| 14 | |
| 15 | |
| 16 | /* |
| 17 | A few words about all the classes defined in this file are probably in |
| 18 | order: why do we need extra wxComboCtrl and wxComboPopup classes? |
| 19 | |
| 20 | This is because a traditional combobox is a combination of a text control |
| 21 | (with a button allowing to open the pop down list) with a listbox and |
| 22 | wxComboBox class is exactly such control, however we want to also have other |
| 23 | combinations - in fact, we want to allow anything at all to be used as pop |
| 24 | down list, not just a wxListBox. |
| 25 | |
| 26 | So we define a base wxComboCtrl which can use any control as pop down |
| 27 | list and wxComboBox deriving from it which implements the standard wxWidgets |
| 28 | combobox API. wxComboCtrl needs to be told somehow which control to use |
| 29 | and this is done by SetPopupControl(). However, we need something more than |
| 30 | just a wxControl in this method as, for example, we need to call |
| 31 | SetSelection("initial text value") and wxControl doesn't have such method. |
| 32 | So we also need a wxComboPopup which is just a very simple interface which |
| 33 | must be implemented by a control to be usable as a popup. |
| 34 | |
| 35 | We couldn't derive wxComboPopup from wxControl as this would make it |
| 36 | impossible to have a class deriving from both wxListBx and from it, so |
| 37 | instead it is just a mix-in. |
| 38 | */ |
| 39 | |
| 40 | |
| 41 | #include "wx/defs.h" |
| 42 | |
| 43 | #if wxUSE_COMBOCTRL |
| 44 | |
| 45 | #include "wx/control.h" |
| 46 | #include "wx/renderer.h" // this is needed for wxCONTROL_XXX flags |
| 47 | #include "wx/bitmap.h" // wxBitmap used by-value |
| 48 | |
| 49 | class WXDLLIMPEXP_FWD_CORE wxTextCtrl; |
| 50 | class WXDLLIMPEXP_FWD_CORE wxComboPopup; |
| 51 | |
| 52 | // |
| 53 | // New window styles for wxComboCtrlBase |
| 54 | // |
| 55 | enum |
| 56 | { |
| 57 | // Double-clicking a read-only combo triggers call to popup's OnComboPopup. |
| 58 | // In wxOwnerDrawnComboBox, for instance, it cycles item. |
| 59 | wxCC_SPECIAL_DCLICK = 0x0100, |
| 60 | |
| 61 | // Dropbutton acts like standard push button. |
| 62 | wxCC_STD_BUTTON = 0x0200 |
| 63 | }; |
| 64 | |
| 65 | |
| 66 | // wxComboCtrl internal flags |
| 67 | enum |
| 68 | { |
| 69 | // First those that can be passed to Customize. |
| 70 | // It is Windows style for all flags to be clear. |
| 71 | |
| 72 | // Button is preferred outside the border (GTK style) |
| 73 | wxCC_BUTTON_OUTSIDE_BORDER = 0x0001, |
| 74 | // Show popup on mouse up instead of mouse down (which is the Windows style) |
| 75 | wxCC_POPUP_ON_MOUSE_UP = 0x0002, |
| 76 | // All text is not automatically selected on click |
| 77 | wxCC_NO_TEXT_AUTO_SELECT = 0x0004, |
| 78 | // Drop-button stays down as long as popup is displayed. |
| 79 | wxCC_BUTTON_STAYS_DOWN = 0x0008, |
| 80 | // Drop-button covers the entire control. |
| 81 | wxCC_FULL_BUTTON = 0x0010, |
| 82 | // Drop-button goes over the custom-border (used under WinVista). |
| 83 | wxCC_BUTTON_COVERS_BORDER = 0x0020, |
| 84 | |
| 85 | // Internal use: signals creation is complete |
| 86 | wxCC_IFLAG_CREATED = 0x0100, |
| 87 | // Internal use: really put button outside |
| 88 | wxCC_IFLAG_BUTTON_OUTSIDE = 0x0200, |
| 89 | // Internal use: SetTextIndent has been called |
| 90 | wxCC_IFLAG_INDENT_SET = 0x0400, |
| 91 | // Internal use: Set wxTAB_TRAVERSAL to parent when popup is dismissed |
| 92 | wxCC_IFLAG_PARENT_TAB_TRAVERSAL = 0x0800, |
| 93 | // Internal use: Secondary popup window type should be used (if available). |
| 94 | wxCC_IFLAG_USE_ALT_POPUP = 0x1000, |
| 95 | // Internal use: Skip popup animation. |
| 96 | wxCC_IFLAG_DISABLE_POPUP_ANIM = 0x2000, |
| 97 | // Internal use: Drop-button is a bitmap button or has non-default size |
| 98 | // (but can still be on either side of the control). |
| 99 | wxCC_IFLAG_HAS_NONSTANDARD_BUTTON = 0x4000 |
| 100 | }; |
| 101 | |
| 102 | |
| 103 | // Flags used by PreprocessMouseEvent and HandleButtonMouseEvent |
| 104 | enum |
| 105 | { |
| 106 | wxCC_MF_ON_BUTTON = 0x0001, // cursor is on dropbutton area |
| 107 | wxCC_MF_ON_CLICK_AREA = 0x0002 // cursor is on dropbutton or other area |
| 108 | // that can be clicked to show the popup. |
| 109 | }; |
| 110 | |
| 111 | |
| 112 | // Namespace for wxComboCtrl feature flags |
| 113 | struct wxComboCtrlFeatures |
| 114 | { |
| 115 | enum |
| 116 | { |
| 117 | MovableButton = 0x0001, // Button can be on either side of control |
| 118 | BitmapButton = 0x0002, // Button may be replaced with bitmap |
| 119 | ButtonSpacing = 0x0004, // Button can have spacing from the edge |
| 120 | // of the control |
| 121 | TextIndent = 0x0008, // SetTextIndent can be used |
| 122 | PaintControl = 0x0010, // Combo control itself can be custom painted |
| 123 | PaintWritable = 0x0020, // A variable-width area in front of writable |
| 124 | // combo control's textctrl can be custom |
| 125 | // painted |
| 126 | Borderless = 0x0040, // wxNO_BORDER window style works |
| 127 | |
| 128 | // There are no feature flags for... |
| 129 | // PushButtonBitmapBackground - if its in wxRendererNative, then it should be |
| 130 | // not an issue to have it automatically under the bitmap. |
| 131 | |
| 132 | All = MovableButton|BitmapButton| |
| 133 | ButtonSpacing|TextIndent| |
| 134 | PaintControl|PaintWritable| |
| 135 | Borderless |
| 136 | }; |
| 137 | }; |
| 138 | |
| 139 | |
| 140 | class WXDLLIMPEXP_CORE wxComboCtrlBase : public wxControl |
| 141 | { |
| 142 | friend class wxComboPopup; |
| 143 | public: |
| 144 | // ctors and such |
| 145 | wxComboCtrlBase() : wxControl() { Init(); } |
| 146 | |
| 147 | bool Create(wxWindow *parent, |
| 148 | wxWindowID id, |
| 149 | const wxString& value, |
| 150 | const wxPoint& pos, |
| 151 | const wxSize& size, |
| 152 | long style, |
| 153 | const wxValidator& validator, |
| 154 | const wxString& name); |
| 155 | |
| 156 | virtual ~wxComboCtrlBase(); |
| 157 | |
| 158 | // show/hide popup window |
| 159 | virtual void ShowPopup(); |
| 160 | virtual void HidePopup(); |
| 161 | |
| 162 | // Override for totally custom combo action |
| 163 | virtual void OnButtonClick(); |
| 164 | |
| 165 | // return true if the popup is currently shown |
| 166 | bool IsPopupShown() const { return m_popupWinState == Visible; } |
| 167 | |
| 168 | // set interface class instance derived from wxComboPopup |
| 169 | // NULL popup can be used to indicate default in a derived class |
| 170 | void SetPopupControl( wxComboPopup* popup ) |
| 171 | { |
| 172 | DoSetPopupControl(popup); |
| 173 | } |
| 174 | |
| 175 | // get interface class instance derived from wxComboPopup |
| 176 | wxComboPopup* GetPopupControl() |
| 177 | { |
| 178 | EnsurePopupControl(); |
| 179 | return m_popupInterface; |
| 180 | } |
| 181 | |
| 182 | // get the popup window containing the popup control |
| 183 | wxWindow *GetPopupWindow() const { return m_winPopup; } |
| 184 | |
| 185 | // Get the text control which is part of the combobox. |
| 186 | wxTextCtrl *GetTextCtrl() const { return m_text; } |
| 187 | |
| 188 | // get the dropdown button which is part of the combobox |
| 189 | // note: its not necessarily a wxButton or wxBitmapButton |
| 190 | wxWindow *GetButton() const { return m_btn; } |
| 191 | |
| 192 | // forward these methods to all subcontrols |
| 193 | virtual bool Enable(bool enable = true); |
| 194 | virtual bool Show(bool show = true); |
| 195 | virtual bool SetFont(const wxFont& font); |
| 196 | #if wxUSE_VALIDATORS |
| 197 | virtual void SetValidator(const wxValidator &validator); |
| 198 | virtual wxValidator *GetValidator(); |
| 199 | #endif // wxUSE_VALIDATORS |
| 200 | |
| 201 | // wxTextCtrl methods - for readonly combo they should return |
| 202 | // without errors. |
| 203 | virtual wxString GetValue() const; |
| 204 | virtual void SetValue(const wxString& value); |
| 205 | virtual void Copy(); |
| 206 | virtual void Cut(); |
| 207 | virtual void Paste(); |
| 208 | virtual void SetInsertionPoint(long pos); |
| 209 | virtual void SetInsertionPointEnd(); |
| 210 | virtual long GetInsertionPoint() const; |
| 211 | virtual long GetLastPosition() const; |
| 212 | virtual void Replace(long from, long to, const wxString& value); |
| 213 | virtual void Remove(long from, long to); |
| 214 | virtual void SetSelection(long from, long to); |
| 215 | virtual void Undo(); |
| 216 | |
| 217 | // This method sets the text without affecting list selection |
| 218 | // (ie. wxComboPopup::SetStringValue doesn't get called). |
| 219 | void SetText(const wxString& value); |
| 220 | |
| 221 | // This method sets value and also optionally sends EVT_TEXT |
| 222 | // (needed by combo popups) |
| 223 | void SetValueWithEvent(const wxString& value, bool withEvent = true); |
| 224 | |
| 225 | // |
| 226 | // Popup customization methods |
| 227 | // |
| 228 | |
| 229 | // Sets minimum width of the popup. If wider than combo control, it will extend to the left. |
| 230 | // Remarks: |
| 231 | // * Value -1 indicates the default. |
| 232 | // * Custom popup may choose to ignore this (wxOwnerDrawnComboBox does not). |
| 233 | void SetPopupMinWidth( int width ) |
| 234 | { |
| 235 | m_widthMinPopup = width; |
| 236 | } |
| 237 | |
| 238 | // Sets preferred maximum height of the popup. |
| 239 | // Remarks: |
| 240 | // * Value -1 indicates the default. |
| 241 | // * Custom popup may choose to ignore this (wxOwnerDrawnComboBox does not). |
| 242 | void SetPopupMaxHeight( int height ) |
| 243 | { |
| 244 | m_heightPopup = height; |
| 245 | } |
| 246 | |
| 247 | // Extends popup size horizontally, relative to the edges of the combo control. |
| 248 | // Remarks: |
| 249 | // * Popup minimum width may override extLeft (ie. it has higher precedence). |
| 250 | // * Values 0 indicate default. |
| 251 | // * Custom popup may not take this fully into account (wxOwnerDrawnComboBox takes). |
| 252 | void SetPopupExtents( int extLeft, int extRight ) |
| 253 | { |
| 254 | m_extLeft = extLeft; |
| 255 | m_extRight = extRight; |
| 256 | } |
| 257 | |
| 258 | // Set width, in pixels, of custom paint area in writable combo. |
| 259 | // In read-only, used to indicate area that is not covered by the |
| 260 | // focus rectangle (which may or may not be drawn, depending on the |
| 261 | // popup type). |
| 262 | void SetCustomPaintWidth( int width ); |
| 263 | int GetCustomPaintWidth() const { return m_widthCustomPaint; } |
| 264 | |
| 265 | // Set side of the control to which the popup will align itself. |
| 266 | // Valid values are wxLEFT, wxRIGHT and 0. The default value 0 wmeans |
| 267 | // that the side of the button will be used. |
| 268 | void SetPopupAnchor( int anchorSide ) |
| 269 | { |
| 270 | m_anchorSide = anchorSide; |
| 271 | } |
| 272 | |
| 273 | // Set position of dropdown button. |
| 274 | // width: button width. <= 0 for default. |
| 275 | // height: button height. <= 0 for default. |
| 276 | // side: wxLEFT or wxRIGHT, indicates on which side the button will be placed. |
| 277 | // spacingX: empty space on sides of the button. Default is 0. |
| 278 | // Remarks: |
| 279 | // There is no spacingY - the button will be centered vertically. |
| 280 | void SetButtonPosition( int width = -1, |
| 281 | int height = -1, |
| 282 | int side = wxRIGHT, |
| 283 | int spacingX = 0 ); |
| 284 | |
| 285 | // Returns current size of the dropdown button. |
| 286 | wxSize GetButtonSize(); |
| 287 | |
| 288 | // |
| 289 | // Sets dropbutton to be drawn with custom bitmaps. |
| 290 | // |
| 291 | // bmpNormal: drawn when cursor is not on button |
| 292 | // pushButtonBg: Draw push button background below the image. |
| 293 | // NOTE! This is usually only properly supported on platforms with appropriate |
| 294 | // method in wxRendererNative. |
| 295 | // bmpPressed: drawn when button is depressed |
| 296 | // bmpHover: drawn when cursor hovers on button. This is ignored on platforms |
| 297 | // that do not generally display hover differently. |
| 298 | // bmpDisabled: drawn when combobox is disabled. |
| 299 | void SetButtonBitmaps( const wxBitmap& bmpNormal, |
| 300 | bool pushButtonBg = false, |
| 301 | const wxBitmap& bmpPressed = wxNullBitmap, |
| 302 | const wxBitmap& bmpHover = wxNullBitmap, |
| 303 | const wxBitmap& bmpDisabled = wxNullBitmap ); |
| 304 | |
| 305 | // |
| 306 | // This will set the space in pixels between left edge of the control and the |
| 307 | // text, regardless whether control is read-only (ie. no wxTextCtrl) or not. |
| 308 | // Platform-specific default can be set with value-1. |
| 309 | // Remarks |
| 310 | // * This method may do nothing on some native implementations. |
| 311 | void SetTextIndent( int indent ); |
| 312 | |
| 313 | // Returns actual indentation in pixels. |
| 314 | wxCoord GetTextIndent() const |
| 315 | { |
| 316 | return m_absIndent; |
| 317 | } |
| 318 | |
| 319 | // Returns area covered by the text field. |
| 320 | const wxRect& GetTextRect() const |
| 321 | { |
| 322 | return m_tcArea; |
| 323 | } |
| 324 | |
| 325 | // Call with enable as true to use a type of popup window that guarantees ability |
| 326 | // to focus the popup control, and normal function of common native controls. |
| 327 | // This alternative popup window is usually a wxDialog, and as such it's parent |
| 328 | // frame will appear as if the focus has been lost from it. |
| 329 | void UseAltPopupWindow( bool enable = true ) |
| 330 | { |
| 331 | wxASSERT_MSG( !m_winPopup, |
| 332 | wxT("call this only before SetPopupControl") ); |
| 333 | |
| 334 | if ( enable ) |
| 335 | m_iFlags |= wxCC_IFLAG_USE_ALT_POPUP; |
| 336 | else |
| 337 | m_iFlags &= ~wxCC_IFLAG_USE_ALT_POPUP; |
| 338 | } |
| 339 | |
| 340 | // Call with false to disable popup animation, if any. |
| 341 | void EnablePopupAnimation( bool enable = true ) |
| 342 | { |
| 343 | if ( enable ) |
| 344 | m_iFlags &= ~wxCC_IFLAG_DISABLE_POPUP_ANIM; |
| 345 | else |
| 346 | m_iFlags |= wxCC_IFLAG_DISABLE_POPUP_ANIM; |
| 347 | } |
| 348 | |
| 349 | // |
| 350 | // Utilies needed by the popups or native implementations |
| 351 | // |
| 352 | |
| 353 | // Returns true if given key combination should toggle the popup. |
| 354 | // NB: This is a separate from other keyboard handling because: |
| 355 | // 1) Replaceability. |
| 356 | // 2) Centralized code (otherwise it'd be split up between |
| 357 | // wxComboCtrl key handler and wxVListBoxComboPopup's |
| 358 | // key handler). |
| 359 | virtual bool IsKeyPopupToggle(const wxKeyEvent& event) const = 0; |
| 360 | |
| 361 | // Prepare background of combo control or an item in a dropdown list |
| 362 | // in a way typical on platform. This includes painting the focus/disabled |
| 363 | // background and setting the clipping region. |
| 364 | // Unless you plan to paint your own focus indicator, you should always call this |
| 365 | // in your wxComboPopup::PaintComboControl implementation. |
| 366 | // In addition, it sets pen and text colour to what looks good and proper |
| 367 | // against the background. |
| 368 | // flags: wxRendererNative flags: wxCONTROL_ISSUBMENU: is drawing a list item instead of combo control |
| 369 | // wxCONTROL_SELECTED: list item is selected |
| 370 | // wxCONTROL_DISABLED: control/item is disabled |
| 371 | virtual void PrepareBackground( wxDC& dc, const wxRect& rect, int flags ) const; |
| 372 | |
| 373 | // Returns true if focus indicator should be drawn in the control. |
| 374 | bool ShouldDrawFocus() const |
| 375 | { |
| 376 | const wxWindow* curFocus = FindFocus(); |
| 377 | return ( IsPopupWindowState(Hidden) && |
| 378 | (curFocus == m_mainCtrlWnd || (m_btn && curFocus == m_btn)) && |
| 379 | (m_windowStyle & wxCB_READONLY) ); |
| 380 | } |
| 381 | |
| 382 | // These methods return references to appropriate dropbutton bitmaps |
| 383 | const wxBitmap& GetBitmapNormal() const { return m_bmpNormal; } |
| 384 | const wxBitmap& GetBitmapPressed() const { return m_bmpPressed; } |
| 385 | const wxBitmap& GetBitmapHover() const { return m_bmpHover; } |
| 386 | const wxBitmap& GetBitmapDisabled() const { return m_bmpDisabled; } |
| 387 | |
| 388 | // Return internal flags |
| 389 | wxUint32 GetInternalFlags() const { return m_iFlags; } |
| 390 | |
| 391 | // Return true if Create has finished |
| 392 | bool IsCreated() const { return m_iFlags & wxCC_IFLAG_CREATED ? true : false; } |
| 393 | |
| 394 | // common code to be called on popup hide/dismiss |
| 395 | void OnPopupDismiss(); |
| 396 | |
| 397 | // PopupShown states |
| 398 | enum |
| 399 | { |
| 400 | Hidden = 0, |
| 401 | //Closing = 1, |
| 402 | Animating = 2, |
| 403 | Visible = 3 |
| 404 | }; |
| 405 | |
| 406 | bool IsPopupWindowState( int state ) const { return (state == m_popupWinState) ? true : false; } |
| 407 | |
| 408 | wxByte GetPopupWindowState() const { return m_popupWinState; } |
| 409 | |
| 410 | // Set value returned by GetMainWindowOfCompositeControl |
| 411 | void SetCtrlMainWnd( wxWindow* wnd ) { m_mainCtrlWnd = wnd; } |
| 412 | |
| 413 | // This is public so we can access it from wxComboCtrlTextCtrl |
| 414 | virtual wxWindow *GetMainWindowOfCompositeControl() |
| 415 | { return m_mainCtrlWnd; } |
| 416 | |
| 417 | protected: |
| 418 | |
| 419 | // |
| 420 | // Override these for customization purposes |
| 421 | // |
| 422 | |
| 423 | // called from wxSizeEvent handler |
| 424 | virtual void OnResize() = 0; |
| 425 | |
| 426 | // Return native text identation (for pure text, not textctrl) |
| 427 | virtual wxCoord GetNativeTextIndent() const; |
| 428 | |
| 429 | // Called in syscolourchanged handler and base create |
| 430 | virtual void OnThemeChange(); |
| 431 | |
| 432 | // Creates wxTextCtrl. |
| 433 | // extraStyle: Extra style parameters |
| 434 | void CreateTextCtrl( int extraStyle, const wxValidator& validator ); |
| 435 | |
| 436 | // Installs standard input handler to combo (and optionally to the textctrl) |
| 437 | void InstallInputHandlers(); |
| 438 | |
| 439 | // Flags for DrawButton |
| 440 | enum |
| 441 | { |
| 442 | Button_PaintBackground = 0x0001, // Paints control background below the button |
| 443 | Button_BitmapOnly = 0x0002 // Only paints the bitmap |
| 444 | }; |
| 445 | |
| 446 | // Draws dropbutton. Using wxRenderer or bitmaps, as appropriate. |
| 447 | // Flags are defined above. |
| 448 | virtual void DrawButton( wxDC& dc, const wxRect& rect, int flags = Button_PaintBackground ); |
| 449 | |
| 450 | // Call if cursor is on button area or mouse is captured for the button. |
| 451 | //bool HandleButtonMouseEvent( wxMouseEvent& event, bool isInside ); |
| 452 | bool HandleButtonMouseEvent( wxMouseEvent& event, int flags ); |
| 453 | |
| 454 | // returns true if event was consumed or filtered (event type is also set to 0 in this case) |
| 455 | bool PreprocessMouseEvent( wxMouseEvent& event, int flags ); |
| 456 | |
| 457 | // |
| 458 | // This will handle left_down and left_dclick events outside button in a Windows-like manner. |
| 459 | // If you need alternate behaviour, it is recommended you manipulate and filter events to it |
| 460 | // instead of building your own handling routine (for reference, on wxEVT_LEFT_DOWN it will |
| 461 | // toggle popup and on wxEVT_LEFT_DCLICK it will do the same or run the popup's dclick method, |
| 462 | // if defined - you should pass events of other types of it for common processing). |
| 463 | void HandleNormalMouseEvent( wxMouseEvent& event ); |
| 464 | |
| 465 | // Creates popup window, calls interface->Create(), etc |
| 466 | void CreatePopup(); |
| 467 | |
| 468 | // Destroy popup window and all related constructs |
| 469 | void DestroyPopup(); |
| 470 | |
| 471 | // override the base class virtuals involved in geometry calculations |
| 472 | virtual wxSize DoGetBestSize() const; |
| 473 | |
| 474 | // NULL popup can be used to indicate default in a derived class |
| 475 | virtual void DoSetPopupControl(wxComboPopup* popup); |
| 476 | |
| 477 | // ensures there is atleast the default popup |
| 478 | void EnsurePopupControl(); |
| 479 | |
| 480 | // Recalculates button and textctrl areas. Called when size or button setup change. |
| 481 | // btnWidth: default/calculated width of the dropbutton. 0 means unchanged, |
| 482 | // just recalculate. |
| 483 | void CalculateAreas( int btnWidth = 0 ); |
| 484 | |
| 485 | // Standard textctrl positioning routine. Just give it platform-dependant |
| 486 | // textctrl coordinate adjustment. |
| 487 | virtual void PositionTextCtrl( int textCtrlXAdjust, int textCtrlYAdjust ); |
| 488 | |
| 489 | // event handlers |
| 490 | void OnSizeEvent( wxSizeEvent& event ); |
| 491 | void OnFocusEvent(wxFocusEvent& event); |
| 492 | void OnIdleEvent(wxIdleEvent& event); |
| 493 | void OnTextCtrlEvent(wxCommandEvent& event); |
| 494 | void OnSysColourChanged(wxSysColourChangedEvent& event); |
| 495 | void OnKeyEvent(wxKeyEvent& event); |
| 496 | |
| 497 | // Set customization flags (directs how wxComboCtrlBase helpers behave) |
| 498 | void Customize( wxUint32 flags ) { m_iFlags |= flags; } |
| 499 | |
| 500 | // Dispatches size event and refreshes |
| 501 | void RecalcAndRefresh(); |
| 502 | |
| 503 | // Flags for DoShowPopup and AnimateShow |
| 504 | enum |
| 505 | { |
| 506 | ShowBelow = 0x0000, // Showing popup below the control |
| 507 | ShowAbove = 0x0001, // Showing popup above the control |
| 508 | CanDeferShow = 0x0002 // Can only return true from AnimateShow if this is set |
| 509 | }; |
| 510 | |
| 511 | // Shows and positions the popup. |
| 512 | virtual void DoShowPopup( const wxRect& rect, int flags ); |
| 513 | |
| 514 | // Implement in derived class to create a drop-down animation. |
| 515 | // Return true if finished immediately. Otherwise popup is only |
| 516 | // shown when the derived class call DoShowPopup. |
| 517 | // Flags are same as for DoShowPopup. |
| 518 | virtual bool AnimateShow( const wxRect& rect, int flags ); |
| 519 | |
| 520 | #if wxUSE_TOOLTIPS |
| 521 | virtual void DoSetToolTip( wxToolTip *tip ); |
| 522 | #endif |
| 523 | |
| 524 | // This is used when m_text is hidden (readonly). |
| 525 | wxString m_valueString; |
| 526 | |
| 527 | // the text control and button we show all the time |
| 528 | wxTextCtrl* m_text; |
| 529 | wxWindow* m_btn; |
| 530 | |
| 531 | // wxPopupWindow or similar containing the window managed by the interface. |
| 532 | wxWindow* m_winPopup; |
| 533 | |
| 534 | // the popup control/panel |
| 535 | wxWindow* m_popup; |
| 536 | |
| 537 | // popup interface |
| 538 | wxComboPopup* m_popupInterface; |
| 539 | |
| 540 | // this is input etc. handler for the text control |
| 541 | wxEvtHandler* m_textEvtHandler; |
| 542 | |
| 543 | // this is for the top level window |
| 544 | wxEvtHandler* m_toplevEvtHandler; |
| 545 | |
| 546 | // this is for the control in popup |
| 547 | wxEvtHandler* m_popupExtraHandler; |
| 548 | |
| 549 | // this is for the popup window |
| 550 | wxEvtHandler* m_popupWinEvtHandler; |
| 551 | |
| 552 | // main (ie. topmost) window of a composite control (default = this) |
| 553 | wxWindow* m_mainCtrlWnd; |
| 554 | |
| 555 | // used to prevent immediate re-popupping incase closed popup |
| 556 | // by clicking on the combo control (needed because of inconsistent |
| 557 | // transient implementation across platforms). |
| 558 | wxLongLong m_timeCanAcceptClick; |
| 559 | |
| 560 | // how much popup should expand to the left/right of the control |
| 561 | wxCoord m_extLeft; |
| 562 | wxCoord m_extRight; |
| 563 | |
| 564 | // minimum popup width |
| 565 | wxCoord m_widthMinPopup; |
| 566 | |
| 567 | // preferred popup height |
| 568 | wxCoord m_heightPopup; |
| 569 | |
| 570 | // how much of writable combo is custom-paint by callback? |
| 571 | // also used to indicate area that is not covered by "blue" |
| 572 | // selection indicator. |
| 573 | wxCoord m_widthCustomPaint; |
| 574 | |
| 575 | // absolute text indentation, in pixels |
| 576 | wxCoord m_absIndent; |
| 577 | |
| 578 | // side on which the popup is aligned |
| 579 | int m_anchorSide; |
| 580 | |
| 581 | // Width of the "fake" border |
| 582 | wxCoord m_widthCustomBorder; |
| 583 | |
| 584 | // The button and textctrl click/paint areas |
| 585 | wxRect m_tcArea; |
| 586 | wxRect m_btnArea; |
| 587 | |
| 588 | // current button state (uses renderer flags) |
| 589 | int m_btnState; |
| 590 | |
| 591 | // button position |
| 592 | int m_btnWid; |
| 593 | int m_btnHei; |
| 594 | int m_btnSide; |
| 595 | int m_btnSpacingX; |
| 596 | |
| 597 | // last default button width |
| 598 | int m_btnWidDefault; |
| 599 | |
| 600 | // custom dropbutton bitmaps |
| 601 | wxBitmap m_bmpNormal; |
| 602 | wxBitmap m_bmpPressed; |
| 603 | wxBitmap m_bmpHover; |
| 604 | wxBitmap m_bmpDisabled; |
| 605 | |
| 606 | // area used by the button |
| 607 | wxSize m_btnSize; |
| 608 | |
| 609 | // platform-dependant customization and other flags |
| 610 | wxUint32 m_iFlags; |
| 611 | |
| 612 | // draw blank button background under bitmap? |
| 613 | bool m_blankButtonBg; |
| 614 | |
| 615 | // is the popup window currenty shown? |
| 616 | wxByte m_popupWinState; |
| 617 | |
| 618 | // should the focus be reset to the textctrl in idle time? |
| 619 | bool m_resetFocus; |
| 620 | |
| 621 | private: |
| 622 | void Init(); |
| 623 | |
| 624 | wxByte m_ignoreEvtText; // Number of next EVT_TEXTs to ignore |
| 625 | |
| 626 | // Is popup window wxPopupTransientWindow, wxPopupWindow or wxDialog? |
| 627 | wxByte m_popupWinType; |
| 628 | |
| 629 | DECLARE_EVENT_TABLE() |
| 630 | |
| 631 | DECLARE_ABSTRACT_CLASS(wxComboCtrlBase) |
| 632 | }; |
| 633 | |
| 634 | |
| 635 | // ---------------------------------------------------------------------------- |
| 636 | // wxComboPopup is the interface which must be implemented by a control to be |
| 637 | // used as a popup by wxComboCtrl |
| 638 | // ---------------------------------------------------------------------------- |
| 639 | |
| 640 | |
| 641 | // wxComboPopup internal flags |
| 642 | enum |
| 643 | { |
| 644 | wxCP_IFLAG_CREATED = 0x0001 // Set by wxComboCtrlBase after Create is called |
| 645 | }; |
| 646 | |
| 647 | class WXDLLIMPEXP_FWD_CORE wxComboCtrl; |
| 648 | |
| 649 | |
| 650 | class WXDLLIMPEXP_CORE wxComboPopup |
| 651 | { |
| 652 | friend class wxComboCtrlBase; |
| 653 | public: |
| 654 | wxComboPopup() |
| 655 | { |
| 656 | m_combo = NULL; |
| 657 | m_iFlags = 0; |
| 658 | } |
| 659 | |
| 660 | // This is called immediately after construction finishes. m_combo member |
| 661 | // variable has been initialized before the call. |
| 662 | // NOTE: It is not in constructor so the derived class doesn't need to redefine |
| 663 | // a default constructor of its own. |
| 664 | virtual void Init() { } |
| 665 | |
| 666 | virtual ~wxComboPopup(); |
| 667 | |
| 668 | // Create the popup child control. |
| 669 | // Return true for success. |
| 670 | virtual bool Create(wxWindow* parent) = 0; |
| 671 | |
| 672 | // We must have an associated control which is subclassed by the combobox. |
| 673 | virtual wxWindow *GetControl() = 0; |
| 674 | |
| 675 | // Called immediately after the popup is shown |
| 676 | virtual void OnPopup(); |
| 677 | |
| 678 | // Called when popup is dismissed |
| 679 | virtual void OnDismiss(); |
| 680 | |
| 681 | // Called just prior to displaying popup. |
| 682 | // Default implementation does nothing. |
| 683 | virtual void SetStringValue( const wxString& value ); |
| 684 | |
| 685 | // Gets displayed string representation of the value. |
| 686 | virtual wxString GetStringValue() const = 0; |
| 687 | |
| 688 | // This is called to custom paint in the combo control itself (ie. not the popup). |
| 689 | // Default implementation draws value as string. |
| 690 | virtual void PaintComboControl( wxDC& dc, const wxRect& rect ); |
| 691 | |
| 692 | // Receives key events from the parent wxComboCtrl. |
| 693 | // Events not handled should be skipped, as usual. |
| 694 | virtual void OnComboKeyEvent( wxKeyEvent& event ); |
| 695 | |
| 696 | // Implement if you need to support special action when user |
| 697 | // double-clicks on the parent wxComboCtrl. |
| 698 | virtual void OnComboDoubleClick(); |
| 699 | |
| 700 | // Return final size of popup. Called on every popup, just prior to OnShow. |
| 701 | // minWidth = preferred minimum width for window |
| 702 | // prefHeight = preferred height. Only applies if > 0, |
| 703 | // maxHeight = max height for window, as limited by screen size |
| 704 | // and should only be rounded down, if necessary. |
| 705 | virtual wxSize GetAdjustedSize( int minWidth, int prefHeight, int maxHeight ); |
| 706 | |
| 707 | // Return true if you want delay call to Create until the popup is shown |
| 708 | // for the first time. It is more efficient, but note that it is often |
| 709 | // more convenient to have the control created immediately. |
| 710 | // Default returns false. |
| 711 | virtual bool LazyCreate(); |
| 712 | |
| 713 | // |
| 714 | // Utilies |
| 715 | // |
| 716 | |
| 717 | // Hides the popup |
| 718 | void Dismiss(); |
| 719 | |
| 720 | // Returns true if Create has been called. |
| 721 | bool IsCreated() const |
| 722 | { |
| 723 | return (m_iFlags & wxCP_IFLAG_CREATED) ? true : false; |
| 724 | } |
| 725 | |
| 726 | // Returns pointer to the associated parent wxComboCtrl. |
| 727 | wxComboCtrl* GetComboCtrl() const; |
| 728 | |
| 729 | // Default PaintComboControl behaviour |
| 730 | static void DefaultPaintComboControl( wxComboCtrlBase* combo, |
| 731 | wxDC& dc, |
| 732 | const wxRect& rect ); |
| 733 | |
| 734 | protected: |
| 735 | wxComboCtrlBase* m_combo; |
| 736 | wxUint32 m_iFlags; |
| 737 | |
| 738 | private: |
| 739 | // Called in wxComboCtrlBase::SetPopupControl |
| 740 | void InitBase(wxComboCtrlBase *combo) |
| 741 | { |
| 742 | m_combo = combo; |
| 743 | } |
| 744 | }; |
| 745 | |
| 746 | |
| 747 | // ---------------------------------------------------------------------------- |
| 748 | // include the platform-dependent header defining the real class |
| 749 | // ---------------------------------------------------------------------------- |
| 750 | |
| 751 | #if defined(__WXUNIVERSAL__) |
| 752 | // No native universal (but it must still be first in the list) |
| 753 | #elif defined(__WXMSW__) |
| 754 | #include "wx/msw/combo.h" |
| 755 | #endif |
| 756 | |
| 757 | // Any ports may need generic as an alternative |
| 758 | #include "wx/generic/combo.h" |
| 759 | |
| 760 | #endif // wxUSE_COMBOCTRL |
| 761 | |
| 762 | #endif |
| 763 | // _WX_COMBOCONTROL_H_BASE_ |