src/cocoa/toolbar.mm

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/cocoa/toolbar.mm
   3 // Purpose:     wxToolBar
   4 // Author:      David Elliott
   5 // Modified by:
   6 // Created:     2003/08/17
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 David Elliott
   9 // Licence:     wxWidgets licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #if wxUSE_TOOLBAR_NATIVE
  24
  25 #include "wx/toolbar.h"
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/frame.h"
  29     #include "wx/log.h"
  30 #endif // WX_PRECOMP
  31
  32 #include "wx/cocoa/string.h"
  33 #include "wx/cocoa/autorelease.h"
  34
  35 #import <AppKit/NSView.h>
  36 #import <AppKit/NSButtonCell.h>
  37 #import <AppKit/NSMatrix.h>
  38 #import <AppKit/NSImage.h>
  39 #import <AppKit/NSEvent.h>
  40 #import <AppKit/NSColor.h>
  41 #import <AppKit/NSAttributedString.h>
  42 #import <AppKit/NSFont.h>
  43
  44 #include <math.h>
  45
  46 // ========================================================================
  47 // wxToolBarTool
  48 // ========================================================================
  49 class wxToolBarTool : public wxToolBarToolBase
  50 {
  51 public:
  52     wxToolBarTool(wxToolBar *tbar, int toolid, const wxString& label,
  53             const wxBitmap& bitmap1, const wxBitmap& bitmap2,
  54             wxItemKind kind, wxObject *clientData,
  55             const wxString& shortHelpString, const wxString& longHelpString)
  56     :   wxToolBarToolBase(tbar, toolid, label, bitmap1, bitmap2, kind,
  57             clientData, shortHelpString, longHelpString)
  58     {
  59         Init();
  60         CreateButtonCell();
  61     }
  62
  63     wxToolBarTool(wxToolBar *tbar, wxControl *control)
  64         : wxToolBarToolBase(tbar, control)
  65     {
  66         Init();
  67     }
  68     ~wxToolBarTool();
  69
  70     bool CreateButtonCell();
  71
  72     // is this a radio button?
  73     //
  74     // unlike GetKind(), can be called for any kind of tools, not just buttons
  75     bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO; }
  76
  77     NSRect GetFrameRect()
  78     {   return m_frameRect; }
  79     void SetFrameRect(NSRect frameRect)
  80     {   m_frameRect = frameRect; }
  81     void DrawTool(NSView *nsview);
  82
  83     NSButtonCell *GetNSButtonCell()
  84     {   return m_cocoaNSButtonCell; }
  85 protected:
  86     void Init();
  87     NSButtonCell *m_cocoaNSButtonCell;
  88     NSRect m_frameRect;
  89 };
  90
  91 // ========================================================================
  92 // wxToolBarTool
  93 // ========================================================================
  94 void wxToolBarTool::Init()
  95 {
  96     m_cocoaNSButtonCell = NULL;
  97     m_frameRect = NSZeroRect;
  98 }
  99
 100 void wxToolBar::CocoaToolClickEnded()
 101 {
 102     wxASSERT(m_mouseDownTool);
 103     wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, m_mouseDownTool->GetId());
 104     InitCommandEvent(event);
 105     Command(event);
 106 }
 107
 108 wxToolBarTool::~wxToolBarTool()
 109 {
 110     [m_cocoaNSButtonCell release];
 111 }
 112
 113 bool wxToolBarTool::CreateButtonCell()
 114 {
 115     wxAutoNSAutoreleasePool pool;
 116
 117     NSImage *nsimage = [m_bmpNormal.GetNSImage(true) retain];
 118     m_cocoaNSButtonCell = [[NSButtonCell alloc] initTextCell:nil];
 119     [m_cocoaNSButtonCell setImage:nsimage];
 120     NSAttributedString *attributedTitle = [[NSAttributedString alloc] initWithString:wxNSStringWithWxString(m_label) attributes:[NSDictionary dictionaryWithObject:[NSFont labelFontOfSize:0.0] forKey:NSFontAttributeName]];
 121 //    [m_cocoaNSButtonCell setTitle:wxNSStringWithWxString(m_label)];
 122     [m_cocoaNSButtonCell setAttributedTitle:[attributedTitle autorelease]];
 123
 124     // Create an alternate image in the style of NSToolBar
 125     if(nsimage)
 126     {
 127         NSImage *alternateImage = [[NSImage alloc] initWithSize:[nsimage size]];
 128         [alternateImage lockFocus];
 129         // Paint the entire image with solid black at 50% transparency
 130         NSRect imageRect = NSZeroRect;
 131         imageRect.size = [alternateImage size];
 132         [[NSColor colorWithCalibratedWhite:0.0 alpha:0.5] set];
 133         NSRectFill(imageRect);
 134         // Composite the original image with the alternate image
 135         [nsimage compositeToPoint:NSZeroPoint operation:NSCompositeDestinationAtop];
 136         [alternateImage unlockFocus];
 137         [m_cocoaNSButtonCell setAlternateImage:alternateImage];
 138         [alternateImage release];
 139     }
 140     [nsimage release];
 141
 142     NSMutableAttributedString *alternateTitle = [[NSMutableAttributedString alloc] initWithAttributedString:[m_cocoaNSButtonCell attributedTitle]];
 143     [alternateTitle applyFontTraits:NSBoldFontMask range:NSMakeRange(0,[alternateTitle length])];
 144     [m_cocoaNSButtonCell setAttributedAlternateTitle:alternateTitle];
 145     [alternateTitle release];
 146
 147     // ----
 148     [m_cocoaNSButtonCell setImagePosition:NSImageBelow];
 149 //    [m_cocoaNSButtonCell setBezeled:NO];
 150     [m_cocoaNSButtonCell setButtonType:NSMomentaryChangeButton];
 151     [m_cocoaNSButtonCell setBordered:NO];
 152 //    [m_cocoaNSButtonCell setHighlightsBy:NSContentsCellMask|NSPushInCellMask];
 153 //    [m_cocoaNSButtonCell setShowsStateBy:NSContentsCellMask|NSPushInCellMask];
 154     return true;
 155 }
 156
 157 void wxToolBarTool::DrawTool(NSView *nsview)
 158 {
 159     [m_cocoaNSButtonCell drawWithFrame:m_frameRect inView:nsview];
 160 }
 161
 162 // ========================================================================
 163 // wxToolBar
 164 // ========================================================================
 165 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
 166
 167 //-----------------------------------------------------------------------------
 168 // wxToolBar construction
 169 //-----------------------------------------------------------------------------
 170
 171 void wxToolBar::Init()
 172 {
 173     m_owningFrame = NULL;
 174     m_mouseDownTool = NULL;
 175 }
 176
 177 wxToolBar::~wxToolBar()
 178 {
 179 }
 180
 181 bool wxToolBar::Create( wxWindow *parent,
 182                         wxWindowID winid,
 183                         const wxPoint& pos,
 184                         const wxSize& size,
 185                         long style,
 186                         const wxString& name )
 187 {
 188     // Call wxControl::Create so we get a wxNonControlNSControl
 189     if ( !wxToolBarBase::Create(parent, winid, pos, size, style,
 190                                 wxDefaultValidator, name) )
 191         return false;
 192
 193     FixupStyle();
 194
 195     return true;
 196 }
 197
 198 wxToolBarToolBase *wxToolBar::CreateTool(int toolid,
 199                                          const wxString& text,
 200                                          const wxBitmap& bitmap1,
 201                                          const wxBitmap& bitmap2,
 202                                          wxItemKind kind,
 203                                          wxObject *clientData,
 204                                          const wxString& shortHelpString,
 205                                          const wxString& longHelpString)
 206 {
 207     return new wxToolBarTool(this, toolid, text, bitmap1, bitmap2, kind,
 208                              clientData, shortHelpString, longHelpString);
 209 }
 210
 211 wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
 212 {
 213     return new wxToolBarTool(this, control);
 214 }
 215
 216 void wxToolBar::SetWindowStyleFlag( long style )
 217 {
 218     wxToolBarBase::SetWindowStyleFlag(style);
 219 }
 220
 221 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 222 {
 223     return true;
 224 }
 225
 226 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos), wxToolBarToolBase *toolBase)
 227 {
 228     Realize();
 229     return true;
 230 }
 231
 232 bool wxToolBar::Cocoa_acceptsFirstMouse(bool &acceptsFirstMouse, WX_NSEvent theEvent)
 233 {
 234     acceptsFirstMouse = true; return true;
 235 }
 236
 237 bool wxToolBar::Cocoa_drawRect(const NSRect &rect)
 238 {
 239     wxToolBarToolsList::compatibility_iterator node;
 240     for(node = m_tools.GetFirst(); node; node = node->GetNext())
 241     {
 242         wxToolBarTool *tool = static_cast<wxToolBarTool*>(node->GetData());
 243         tool->DrawTool(m_cocoaNSView);
 244     }
 245     return wxToolBarBase::Cocoa_drawRect(rect);
 246 }
 247
 248 static const NSSize toolPadding = { 4.0, 4.0 };
 249
 250 static NSRect AddToolPadding(NSRect toolRect)
 251 {
 252         toolRect.origin.x -= toolPadding.width;
 253         toolRect.size.width += 2.0*toolPadding.width;
 254         toolRect.origin.y -= toolPadding.height;
 255         toolRect.size.height += 2.0*toolPadding.height;
 256         return toolRect;
 257 }
 258
 259 bool wxToolBar::Cocoa_mouseDragged(WX_NSEvent theEvent)
 260 {
 261     if(m_mouseDownTool && [m_cocoaNSView
 262             mouse:[m_cocoaNSView convertPoint:[theEvent locationInWindow]
 263                 fromView:nil]
 264             inRect:AddToolPadding(m_mouseDownTool->GetFrameRect())])
 265     {
 266         NSButtonCell *buttonCell = m_mouseDownTool->GetNSButtonCell();
 267         if(buttonCell)
 268         {
 269             [buttonCell retain];
 270             [buttonCell setHighlighted: YES];
 271             if([buttonCell trackMouse: theEvent
 272                 inRect:AddToolPadding(m_mouseDownTool->GetFrameRect()) ofView:m_cocoaNSView
 273                 untilMouseUp:NO])
 274             {
 275                 CocoaToolClickEnded();
 276                 m_mouseDownTool = NULL;
 277                 wxLogTrace(wxTRACE_COCOA,wxT("Button was clicked after drag!"));
 278             }
 279             [buttonCell setHighlighted: NO];
 280             [buttonCell release];
 281         }
 282     }
 283     return wxToolBarBase::Cocoa_mouseDragged(theEvent);
 284 }
 285
 286 bool wxToolBar::Cocoa_mouseDown(WX_NSEvent theEvent)
 287 {
 288     wxToolBarTool *tool = CocoaFindToolForPosition([m_cocoaNSView convertPoint:[theEvent locationInWindow] fromView:nil]);
 289     if(tool)
 290     {
 291         NSButtonCell *buttonCell = tool->GetNSButtonCell();
 292         if(buttonCell)
 293         {
 294             [buttonCell retain];
 295             m_mouseDownTool = tool;
 296             [buttonCell setHighlighted: YES];
 297             if([buttonCell trackMouse: theEvent
 298                 inRect:AddToolPadding(tool->GetFrameRect()) ofView:m_cocoaNSView
 299                 untilMouseUp:NO])
 300             {
 301                 CocoaToolClickEnded();
 302                 m_mouseDownTool = NULL;
 303                 wxLogTrace(wxTRACE_COCOA,wxT("Button was clicked!"));
 304             }
 305             [buttonCell setHighlighted: NO];
 306             [buttonCell release];
 307         }
 308     }
 309     return wxToolBarBase::Cocoa_mouseDown(theEvent);
 310 }
 311
 312 bool wxToolBar::Realize()
 313 {
 314     wxAutoNSAutoreleasePool pool;
 315
 316     wxToolBarToolsList::compatibility_iterator node;
 317     NSSize totalSize = NSZeroSize;
 318     // This is for horizontal, TODO: vertical
 319     for(node = m_tools.GetFirst(); node; node = node->GetNext())
 320     {
 321         wxToolBarTool *tool = static_cast<wxToolBarTool*>(node->GetData());
 322         if(tool->IsControl())
 323         {
 324             totalSize.width = ceil(totalSize.width);
 325             wxControl *control = tool->GetControl();
 326             wxSize controlSize = control->GetSize();
 327             control->SetPosition(wxPoint((wxCoord)totalSize.width,0));
 328             totalSize.width += controlSize.x;
 329             if(controlSize.y > totalSize.height)
 330                 totalSize.height = controlSize.y;
 331         }
 332         else if(tool->IsSeparator())
 333         {
 334             totalSize.width += 2.0;
 335         }
 336         else
 337         {
 338             NSButtonCell *buttonCell = tool->GetNSButtonCell();
 339             NSSize toolSize = [buttonCell cellSize];
 340             tool->SetFrameRect(NSMakeRect(totalSize.width+toolPadding.width,toolPadding.height,toolSize.width,toolSize.height));
 341             toolSize.width += 2.0*toolPadding.width;
 342             toolSize.height += 2.0*toolPadding.height;
 343             totalSize.width += toolSize.width;
 344             if(toolSize.height > totalSize.height)
 345                 totalSize.height = toolSize.height;
 346         }
 347     }
 348     m_bestSize = wxSize((wxCoord)ceil(totalSize.width),(wxCoord)ceil(totalSize.height));
 349     if(m_owningFrame)
 350         m_owningFrame->UpdateFrameNSView();
 351     return true;
 352 }
 353
 354 wxSize wxToolBar::DoGetBestSize() const
 355 {
 356     return m_bestSize;
 357 }
 358
 359 // ----------------------------------------------------------------------------
 360 // wxToolBar tools state
 361 // ----------------------------------------------------------------------------
 362
 363 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 364 {
 365 }
 366
 367 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 368 {
 369 }
 370
 371 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 372                             bool WXUNUSED(toggle))
 373 {
 374 }
 375
 376 // ----------------------------------------------------------------------------
 377 // wxToolBar geometry
 378 // ----------------------------------------------------------------------------
 379
 380 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord x, wxCoord y) const
 381 {
 382     return NULL;
 383 }
 384
 385 wxToolBarTool *wxToolBar::CocoaFindToolForPosition(const NSPoint& pos) const
 386 {
 387     wxToolBarToolsList::compatibility_iterator node;
 388     for(node = m_tools.GetFirst(); node; node = node->GetNext())
 389     {
 390         wxToolBarTool *tool = static_cast<wxToolBarTool*>(node->GetData());
 391         if(tool->IsControl())
 392         {
 393             // TODO
 394         }
 395         else if(tool->IsSeparator())
 396         {   // Do nothing
 397         }
 398         else
 399         {
 400             if([m_cocoaNSView mouse:pos inRect:AddToolPadding(tool->GetFrameRect())])
 401                 return tool;
 402         }
 403     }
 404     return NULL;
 405 }
 406
 407 void wxToolBar::SetMargins( int x, int y )
 408 {
 409 }
 410
 411 void wxToolBar::SetToolSeparation( int separation )
 412 {
 413     m_toolSeparation = separation;
 414 }
 415
 416 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
 417 {
 418 }
 419
 420 // ----------------------------------------------------------------------------
 421 // wxToolBar idle handling
 422 // ----------------------------------------------------------------------------
 423
 424 void wxToolBar::OnInternalIdle()
 425 {
 426 }
 427
 428 #endif // wxUSE_TOOLBAR_NATIVE