src/generic/combog.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/combog.cpp
   3 // Purpose:     Generic wxComboCtrl
   4 // Author:      Jaakko Salli
   5 // Modified by:
   6 // Created:     Apr-30-2006
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2005 Jaakko Salli
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_COMBOCTRL
  27
  28 #include "wx/combo.h"
  29
  30 #ifndef WX_PRECOMP
  31     #include "wx/log.h"
  32     #include "wx/combobox.h"
  33     #include "wx/dcclient.h"
  34     #include "wx/settings.h"
  35     #include "wx/textctrl.h"
  36 #endif
  37
  38 #include "wx/dcbuffer.h"
  39
  40 // ----------------------------------------------------------------------------
  41 // Some constant adjustments to make the generic more bearable
  42
  43 #if defined(__WXUNIVERSAL__)
  44
  45 // position adjustment for wxTextCtrl, to achieve zero left margin
  46 // meaningless if LEFT_MARGIN_CAN_BE_SET set to 1 in combocmn.cpp
  47 #define TEXTCTRLXADJUST                 0
  48
  49 #define TEXTCTRLYADJUST                 0
  50 #define TEXTXADJUST                     0 // how much is read-only text's x adjusted
  51 #define DEFAULT_DROPBUTTON_WIDTH        19
  52
  53 #elif defined(__WXMSW__)
  54
  55 // position adjustment for wxTextCtrl, to achieve zero left margin
  56 // meaningless if LEFT_MARGIN_CAN_BE_SET set to 1 in combocmn.cpp
  57 #define TEXTCTRLXADJUST                 2
  58
  59 #define TEXTCTRLYADJUST                 3
  60 #define TEXTXADJUST                     0 // how much is read-only text's x adjusted
  61 #define DEFAULT_DROPBUTTON_WIDTH        17
  62
  63 #elif defined(__WXGTK__)
  64
  65 // position adjustment for wxTextCtrl, to achieve zero left margin
  66 // meaningless if LEFT_MARGIN_CAN_BE_SET set to 1 in combocmn.cpp
  67 #define TEXTCTRLXADJUST                 -1
  68
  69 #define TEXTCTRLYADJUST                 0
  70 #define TEXTXADJUST                     1 // how much is read-only text's x adjusted
  71 #define DEFAULT_DROPBUTTON_WIDTH        23
  72
  73 #elif defined(__WXMAC__)
  74
  75 // position adjustment for wxTextCtrl, to achieve zero left margin
  76 // meaningless if LEFT_MARGIN_CAN_BE_SET set to 1 in combocmn.cpp
  77 #define TEXTCTRLXADJUST                 0
  78
  79 #define TEXTCTRLYADJUST                 0
  80 #define TEXTXADJUST                     0 // how much is read-only text's x adjusted
  81 #define DEFAULT_DROPBUTTON_WIDTH        22
  82
  83 #else
  84
  85 // position adjustment for wxTextCtrl, to achieve zero left margin
  86 // meaningless if LEFT_MARGIN_CAN_BE_SET set to 1 in combocmn.cpp
  87 #define TEXTCTRLXADJUST                 0
  88
  89 #define TEXTCTRLYADJUST                 0
  90 #define TEXTXADJUST                     0 // how much is read-only text's x adjusted
  91 #define DEFAULT_DROPBUTTON_WIDTH        19
  92
  93 #endif
  94
  95
  96 // ============================================================================
  97 // implementation
  98 // ============================================================================
  99
 100 // Only implement if no native or it wasn't fully featured
 101 #ifndef wxCOMBOCONTROL_FULLY_FEATURED
 102
 103
 104 // ----------------------------------------------------------------------------
 105 // wxGenericComboCtrl
 106 // ----------------------------------------------------------------------------
 107
 108 BEGIN_EVENT_TABLE(wxGenericComboCtrl, wxComboCtrlBase)
 109     EVT_PAINT(wxGenericComboCtrl::OnPaintEvent)
 110     EVT_MOUSE_EVENTS(wxGenericComboCtrl::OnMouseEvent)
 111 END_EVENT_TABLE()
 112
 113
 114 IMPLEMENT_DYNAMIC_CLASS(wxGenericComboCtrl, wxComboCtrlBase)
 115
 116 void wxGenericComboCtrl::Init()
 117 {
 118 }
 119
 120 bool wxGenericComboCtrl::Create(wxWindow *parent,
 121                                 wxWindowID id,
 122                                 const wxString& value,
 123                                 const wxPoint& pos,
 124                                 const wxSize& size,
 125                                 long style,
 126                                 const wxValidator& validator,
 127                                 const wxString& name)
 128 {
 129     //
 130     // Note that technically we only support 'default' border and wxNO_BORDER.
 131     long border = style & wxBORDER_MASK;
 132     int tcBorder = wxNO_BORDER;
 133
 134 #if defined(__WXUNIVERSAL__)
 135     if ( !border )
 136         border = wxBORDER_SIMPLE;
 137 #elif defined(__WXMSW__)
 138     if ( !border )
 139         // For XP, have 1-width custom border, for older version use sunken
 140         /*if ( wxUxThemeEngine::GetIfActive() )
 141         {
 142             border = wxBORDER_NONE;
 143             m_widthCustomBorder = 1;
 144         }
 145         else*/
 146             border = wxBORDER_SUNKEN;
 147 #else
 148
 149     //
 150     // Generic version is optimized for wxGTK
 151     //
 152
 153     #define UNRELIABLE_TEXTCTRL_BORDER
 154
 155     if ( !border )
 156     {
 157         if ( style & wxCB_READONLY )
 158         {
 159             m_widthCustomBorder = 1;
 160         }
 161         else
 162         {
 163             m_widthCustomBorder = 0;
 164             tcBorder = 0;
 165         }
 166     }
 167     else
 168     {
 169         // Have textctrl instead use the border given.
 170         tcBorder = border;
 171     }
 172
 173     // Because we are going to have button outside the border,
 174     // let's use wxBORDER_NONE for the whole control.
 175     border = wxBORDER_NONE;
 176
 177     Customize( wxCC_BUTTON_OUTSIDE_BORDER |
 178                wxCC_NO_TEXT_AUTO_SELECT |
 179                wxCC_BUTTON_STAYS_DOWN );
 180
 181 #endif
 182
 183     style = (style & ~(wxBORDER_MASK)) | border;
 184     if ( style & wxCC_STD_BUTTON )
 185         m_iFlags |= wxCC_POPUP_ON_MOUSE_UP;
 186
 187     // create main window
 188     if ( !wxComboCtrlBase::Create(parent,
 189                                   id,
 190                                   value,
 191                                   pos,
 192                                   size,
 193                                   style | wxFULL_REPAINT_ON_RESIZE,
 194                                   validator,
 195                                   name) )
 196         return false;
 197
 198     // Create textctrl, if necessary
 199     CreateTextCtrl( tcBorder );
 200
 201     // Add keyboard input handlers for main control and textctrl
 202     InstallInputHandlers();
 203
 204     // Set background
 205     SetBackgroundStyle( wxBG_STYLE_CUSTOM ); // for double-buffering
 206
 207     // SetInitialSize should be called last
 208     SetInitialSize(size);
 209
 210     return true;
 211 }
 212
 213 wxGenericComboCtrl::~wxGenericComboCtrl()
 214 {
 215 }
 216
 217 void wxGenericComboCtrl::OnResize()
 218 {
 219
 220     // Recalculates button and textctrl areas
 221     CalculateAreas(DEFAULT_DROPBUTTON_WIDTH);
 222
 223 #if 0
 224     // Move separate button control, if any, to correct position
 225     if ( m_btn )
 226     {
 227         wxSize sz = GetClientSize();
 228         m_btn->SetSize( m_btnArea.x + m_btnSpacingX,
 229                         (sz.y-m_btnSize.y)/2,
 230                         m_btnSize.x,
 231                         m_btnSize.y );
 232     }
 233 #endif
 234
 235     // Move textctrl, if any, accordingly
 236     PositionTextCtrl( TEXTCTRLXADJUST, TEXTCTRLYADJUST );
 237 }
 238
 239 void wxGenericComboCtrl::OnPaintEvent( wxPaintEvent& WXUNUSED(event) )
 240 {
 241     wxSize sz = GetClientSize();
 242     wxAutoBufferedPaintDC dc(this);
 243
 244     const wxRect& rectb = m_btnArea;
 245     wxRect rect = m_tcArea;
 246
 247     // artificial simple border
 248     if ( m_widthCustomBorder )
 249     {
 250         int customBorder = m_widthCustomBorder;
 251
 252         // Set border colour
 253         wxPen pen1( wxSystemSettings::GetColour(wxSYS_COLOUR_GRAYTEXT),
 254                     customBorder,
 255                     wxPENSTYLE_SOLID);
 256         dc.SetPen( pen1 );
 257
 258         // area around both controls
 259         wxRect rect2(0,0,sz.x,sz.y);
 260         if ( m_iFlags & wxCC_IFLAG_BUTTON_OUTSIDE )
 261         {
 262             rect2 = m_tcArea;
 263             if ( customBorder == 1 )
 264             {
 265                 rect2.Inflate(1);
 266             }
 267             else
 268             {
 269             #ifdef __WXGTK__
 270                 rect2.x -= 1;
 271                 rect2.y -= 1;
 272             #else
 273                 rect2.x -= customBorder;
 274                 rect2.y -= customBorder;
 275             #endif
 276                 rect2.width += 1 + customBorder;
 277                 rect2.height += 1 + customBorder;
 278             }
 279         }
 280
 281         dc.SetBrush( *wxTRANSPARENT_BRUSH );
 282         dc.DrawRectangle(rect2);
 283     }
 284
 285 #ifndef __WXMAC__  // see note in OnThemeChange
 286     wxColour winCol = GetBackgroundColour();
 287 #else
 288     wxColour winCol = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
 289 #endif
 290     dc.SetBrush(winCol);
 291     dc.SetPen(winCol);
 292
 293     //wxLogDebug(wxT("hei: %i tcy: %i tchei: %i"),GetClientSize().y,m_tcArea.y,m_tcArea.height);
 294     //wxLogDebug(wxT("btnx: %i tcx: %i tcwid: %i"),m_btnArea.x,m_tcArea.x,m_tcArea.width);
 295
 296     // clear main background
 297     dc.DrawRectangle(rect);
 298
 299     if ( !m_btn )
 300     {
 301         // Standard button rendering
 302         DrawButton(dc,rectb);
 303     }
 304
 305     // paint required portion on the control
 306     if ( (!m_text || m_widthCustomPaint) )
 307     {
 308         wxASSERT( m_widthCustomPaint >= 0 );
 309
 310         // this is intentionally here to allow drawed rectangle's
 311         // right edge to be hidden
 312         if ( m_text )
 313             rect.width = m_widthCustomPaint;
 314
 315         dc.SetFont( GetFont() );
 316
 317         dc.SetClippingRegion(rect);
 318         if ( m_popupInterface )
 319             m_popupInterface->PaintComboControl(dc,rect);
 320         else
 321             wxComboPopup::DefaultPaintComboControl(this,dc,rect);
 322     }
 323 }
 324
 325 void wxGenericComboCtrl::OnMouseEvent( wxMouseEvent& event )
 326 {
 327     int mx = event.m_x;
 328     bool isOnButtonArea = m_btnArea.Contains(mx,event.m_y);
 329     int handlerFlags = isOnButtonArea ? wxCC_MF_ON_BUTTON : 0;
 330
 331     if ( PreprocessMouseEvent(event,handlerFlags) )
 332         return;
 333
 334     const bool ctrlIsButton = wxPlatformIs(wxOS_WINDOWS);
 335
 336     if ( ctrlIsButton &&
 337          (m_windowStyle & (wxCC_SPECIAL_DCLICK|wxCB_READONLY)) == wxCB_READONLY )
 338     {
 339         // if no textctrl and no special double-click, then the entire control acts
 340         // as a button
 341         handlerFlags |= wxCC_MF_ON_BUTTON;
 342         if ( HandleButtonMouseEvent(event,handlerFlags) )
 343             return;
 344     }
 345     else
 346     {
 347         if ( isOnButtonArea || HasCapture() ||
 348              (m_widthCustomPaint && mx < (m_tcArea.x+m_widthCustomPaint)) )
 349         {
 350             handlerFlags |= wxCC_MF_ON_CLICK_AREA;
 351
 352             if ( HandleButtonMouseEvent(event,handlerFlags) )
 353                 return;
 354         }
 355         else if ( m_btnState )
 356         {
 357             // otherwise need to clear the hover status
 358             m_btnState = 0;
 359             RefreshRect(m_btnArea);
 360         }
 361     }
 362
 363     //
 364     // This will handle left_down and left_dclick events outside button in a Windows/GTK-like manner.
 365     // See header file for further information on this method.
 366     HandleNormalMouseEvent(event);
 367
 368 }
 369
 370 void wxGenericComboCtrl::SetCustomPaintWidth( int width )
 371 {
 372 #ifdef UNRELIABLE_TEXTCTRL_BORDER
 373     //
 374     // If starting/stopping to show an image in front
 375     // of a writable text-field, then re-create textctrl
 376     // with different kind of border (because we can't
 377     // assume that textctrl fully supports wxNO_BORDER).
 378     //
 379     wxTextCtrl* tc = GetTextCtrl();
 380
 381     if ( tc && (m_iFlags & wxCC_BUTTON_OUTSIDE_BORDER) )
 382     {
 383         int borderType = tc->GetWindowStyle() & wxBORDER_MASK;
 384         int tcCreateStyle = -1;
 385
 386         if ( width > 0 )
 387         {
 388             // Re-create textctrl with no border
 389             if ( borderType != wxNO_BORDER )
 390             {
 391                 m_widthCustomBorder = 1;
 392                 tcCreateStyle = wxNO_BORDER;
 393             }
 394         }
 395         else if ( width == 0 )
 396         {
 397             // Re-create textctrl with normal border
 398             if ( borderType == wxNO_BORDER )
 399             {
 400                 m_widthCustomBorder = 0;
 401                 tcCreateStyle = 0;
 402             }
 403         }
 404
 405         // Common textctrl re-creation code
 406         if ( tcCreateStyle != -1 )
 407         {
 408             tc->RemoveEventHandler(m_textEvtHandler);
 409             delete m_textEvtHandler;
 410
 411             CreateTextCtrl( tcCreateStyle );
 412
 413             InstallInputHandlers();
 414         }
 415     }
 416 #endif // UNRELIABLE_TEXTCTRL_BORDER
 417
 418     wxComboCtrlBase::SetCustomPaintWidth( width );
 419 }
 420
 421 bool wxGenericComboCtrl::IsKeyPopupToggle(const wxKeyEvent& event) const
 422 {
 423     int keycode = event.GetKeyCode();
 424     bool isPopupShown = IsPopupShown();
 425
 426     // This code is AFAIK appropriate for wxGTK.
 427
 428     if ( isPopupShown )
 429     {
 430         if ( keycode == WXK_ESCAPE ||
 431              ( keycode == WXK_UP && event.AltDown() ) )
 432             return true;
 433     }
 434     else
 435     {
 436         if ( (keycode == WXK_DOWN && event.AltDown()) ||
 437              (keycode == WXK_F4) )
 438             return true;
 439     }
 440
 441     return false;
 442 }
 443
 444 #ifdef __WXUNIVERSAL__
 445
 446 bool wxGenericComboCtrl::PerformAction(const wxControlAction& action,
 447                                        long numArg,
 448                                        const wxString& strArg)
 449 {
 450     bool processed = false;
 451     if ( action == wxACTION_COMBOBOX_POPUP )
 452     {
 453         if ( !IsPopupShown() )
 454         {
 455             ShowPopup();
 456
 457             processed = true;
 458         }
 459     }
 460     else if ( action == wxACTION_COMBOBOX_DISMISS )
 461     {
 462         if ( IsPopupShown() )
 463         {
 464             HidePopup();
 465
 466             processed = true;
 467         }
 468     }
 469
 470     if ( !processed )
 471     {
 472         // pass along
 473         return wxControl::PerformAction(action, numArg, strArg);
 474     }
 475
 476     return true;
 477 }
 478
 479 #endif // __WXUNIVERSAL__
 480
 481 // If native wxComboCtrl was not defined, then prepare a simple
 482 // front-end so that wxRTTI works as expected.
 483 #ifndef _WX_COMBOCONTROL_H_
 484 IMPLEMENT_DYNAMIC_CLASS(wxComboCtrl, wxGenericComboCtrl)
 485 #endif
 486
 487 #endif // !wxCOMBOCONTROL_FULLY_FEATURED
 488
 489 #endif // wxUSE_COMBOCTRL