1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/osx/cocoa/textctrl.mm
4 // Author: Stefan Csomor
5 // Modified by: Ryan Norton (MLTE GetLineLength and GetLineText)
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #include "wx/wxprec.h"
16 #include "wx/textctrl.h"
23 #include "wx/button.h"
25 #include "wx/settings.h"
26 #include "wx/msgdlg.h"
27 #include "wx/toplevel.h"
31 #include <sys/types.h>
37 #if wxUSE_STD_IOSTREAM
45 #include "wx/filefn.h"
46 #include "wx/sysopt.h"
47 #include "wx/thread.h"
48 #include "wx/textcompleter.h"
50 #include "wx/osx/private.h"
51 #include "wx/osx/cocoa/private/textimpl.h"
53 @interface NSView(EditableView)
55 - (void)setEditable:(BOOL)flag;
57 - (void)setSelectable:(BOOL)flag;
60 // An object of this class is created before the text is modified
61 // programmatically and destroyed as soon as this is done. It does several
62 // things, like ensuring that the control is editable to allow setting its text
63 // at all and eating any unwanted focus loss events from textDidEndEditing:
64 // which don't really correspond to focus change.
68 wxMacEditHelper( NSView* textView )
70 m_viewPreviouslyEdited = ms_viewCurrentlyEdited;
71 ms_viewCurrentlyEdited =
72 m_textView = textView;
73 m_formerEditable = YES;
76 m_formerEditable = [textView isEditable];
77 m_formerSelectable = [textView isSelectable];
78 [textView setEditable:YES];
86 [m_textView setEditable:m_formerEditable];
87 [m_textView setSelectable:m_formerSelectable];
90 ms_viewCurrentlyEdited = m_viewPreviouslyEdited;
93 // Returns the last view we were instantiated for or NULL.
94 static NSView *GetCurrentlyEditedView() { return ms_viewCurrentlyEdited; }
97 BOOL m_formerEditable ;
98 BOOL m_formerSelectable;
101 // The original value of ms_viewCurrentlyEdited when this object was
103 NSView* m_viewPreviouslyEdited;
105 static NSView* ms_viewCurrentlyEdited;
108 NSView* wxMacEditHelper::ms_viewCurrentlyEdited = nil;
110 // a minimal NSFormatter that just avoids getting too long entries
111 @interface wxMaximumLengthFormatter : NSFormatter
118 @implementation wxMaximumLengthFormatter
127 - (void) setMaxLength:(int) maxlen
132 - (NSString *)stringForObjectValue:(id)anObject
134 if(![anObject isKindOfClass:[NSString class]])
136 return [NSString stringWithString:anObject];
139 - (BOOL)getObjectValue:(id *)obj forString:(NSString *)string errorDescription:(NSString **)error
141 *obj = [NSString stringWithString:string];
145 - (BOOL)isPartialStringValid:(NSString **)partialStringPtr proposedSelectedRange:(NSRangePointer)proposedSelRangePtr
146 originalString:(NSString *)origString originalSelectedRange:(NSRange)origSelRange errorDescription:(NSString **)error
148 int len = [*partialStringPtr length];
149 if ( maxLength > 0 && len > maxLength )
151 // TODO wxEVT_COMMAND_TEXT_MAXLEN
159 @implementation wxNSSecureTextField
163 static BOOL initialized = NO;
167 wxOSXCocoaClassAddWXMethods( self );
171 - (void)controlTextDidChange:(NSNotification *)aNotification
173 wxUnusedVar(aNotification);
174 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
176 impl->controlTextDidChange();
179 - (void)controlTextDidEndEditing:(NSNotification *)aNotification
181 wxUnusedVar(aNotification);
182 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
185 impl->DoNotifyFocusEvent( false, NULL );
189 - (BOOL)control:(NSControl*)control textView:(NSTextView*)textView doCommandBySelector:(SEL)commandSelector
191 wxUnusedVar(textView);
195 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( control );
198 wxWindow* wxpeer = (wxWindow*) impl->GetWXPeer();
201 if (commandSelector == @selector(insertNewline:))
203 wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(wxpeer), wxTopLevelWindow);
204 if ( tlw && tlw->GetDefaultItem() )
206 wxButton *def = wxDynamicCast(tlw->GetDefaultItem(), wxButton);
207 if ( def && def->IsEnabled() )
209 wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, def->GetId() );
210 event.SetEventObject(def);
224 @interface wxNSTextScrollView : NSScrollView
229 @implementation wxNSTextScrollView
233 static BOOL initialized = NO;
237 wxOSXCocoaClassAddWXMethods( self );
243 @implementation wxNSTextFieldEditor
245 - (void) keyDown:(NSEvent*) event
247 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( (WXWidget) [self delegate] );
248 lastKeyDownEvent = event;
249 if ( impl == NULL || !impl->DoHandleKeyEvent(event) )
250 [super keyDown:event];
251 lastKeyDownEvent = nil;
254 - (void) keyUp:(NSEvent*) event
256 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( (WXWidget) [self delegate] );
257 if ( impl == NULL || !impl->DoHandleKeyEvent(event) )
261 - (void) flagsChanged:(NSEvent*) event
263 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( (WXWidget) [self delegate] );
264 if ( impl == NULL || !impl->DoHandleKeyEvent(event) )
265 [super flagsChanged:event];
268 - (BOOL) performKeyEquivalent:(NSEvent*) event
270 BOOL retval = [super performKeyEquivalent:event];
274 - (void) insertText:(id) str
276 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( (WXWidget) [self delegate] );
277 if ( impl == NULL || lastKeyDownEvent==nil || !impl->DoHandleCharEvent(lastKeyDownEvent, str) )
279 [super insertText:str];
285 @implementation wxNSTextView
289 static BOOL initialized = NO;
293 wxOSXCocoaClassAddWXMethods( self );
297 - (void)textDidChange:(NSNotification *)aNotification
299 wxUnusedVar(aNotification);
300 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
302 impl->controlTextDidChange();
305 - (void) setEnabled:(BOOL) flag
307 // from Technical Q&A QA1461
309 [self setTextColor: [NSColor controlTextColor]];
312 [self setTextColor: [NSColor disabledControlTextColor]];
315 [self setSelectable: flag];
316 [self setEditable: flag];
321 return [self isEditable];
324 - (void)textDidEndEditing:(NSNotification *)aNotification
326 wxUnusedVar(aNotification);
328 if ( self == wxMacEditHelper::GetCurrentlyEditedView() )
330 // This notification is generated as the result of calling our own
331 // wxTextCtrl method (e.g. WriteText()) and doesn't correspond to any
332 // real focus loss event so skip generating it.
336 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
339 impl->DoNotifyFocusEvent( false, NULL );
345 @implementation wxNSTextField
349 static BOOL initialized = NO;
353 wxOSXCocoaClassAddWXMethods( self );
357 - (id) initWithFrame:(NSRect) frame
359 self = [super initWithFrame:frame];
366 [fieldEditor release];
370 - (void) setFieldEditor:(wxNSTextFieldEditor*) editor
372 if ( editor != fieldEditor )
375 [fieldEditor release];
376 fieldEditor = editor;
380 - (wxNSTextFieldEditor*) fieldEditor
385 - (void) setEnabled:(BOOL) flag
387 [super setEnabled: flag];
389 if (![self drawsBackground]) {
390 // Static text is drawn incorrectly when disabled.
391 // For an explanation, see
392 // http://www.cocoabuilder.com/archive/message/cocoa/2006/7/21/168028
394 [self setTextColor: [NSColor controlTextColor]];
396 [self setTextColor: [NSColor secondarySelectedControlColor]];
401 - (void)controlTextDidChange:(NSNotification *)aNotification
403 wxUnusedVar(aNotification);
404 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
406 impl->controlTextDidChange();
409 - (NSArray *)control:(NSControl *)control textView:(NSTextView *)textView completions:(NSArray *)words
410 forPartialWordRange:(NSRange)charRange indexOfSelectedItem:(NSInteger*)index
412 NSMutableArray* matches = NULL;
414 wxTextWidgetImpl* impl = (wxNSTextFieldControl * ) wxWidgetImpl::FindFromWXWidget( self );
415 wxTextEntry * const entry = impl->GetTextEntry();
416 wxTextCompleter * const completer = entry->OSXGetCompleter();
419 const wxString prefix = entry->GetValue();
420 if ( completer->Start(prefix) )
423 wordStart = wxCFStringRef::AsString(
424 [[textView string] substringWithRange:charRange]
427 matches = [NSMutableArray array];
430 const wxString s = completer->GetNext();
434 // Normally the completer should return only the strings
435 // starting with the prefix, but there could be exceptions
436 // and, for compatibility with MSW which simply ignores all
437 // entries that don't match the current text control contents,
438 // we ignore them as well. Besides, our own wxTextCompleterFixed
439 // doesn't respect this rule and, moreover, we need to extract
440 // just the rest of the string anyhow.
442 if ( s.StartsWith(prefix, &completion) )
444 // We discarded the entire prefix above but actually we
445 // should include the part of it that consists of the
446 // beginning of the current word, otherwise it would be
447 // lost when completion is accepted as OS X supposes that
448 // our matches do start with the "partial word range"
450 const wxCFStringRef fullWord(wordStart + completion);
451 [matches addObject: fullWord.AsNSString()];
460 - (BOOL)control:(NSControl*)control textView:(NSTextView*)textView doCommandBySelector:(SEL)commandSelector
462 wxUnusedVar(textView);
463 wxUnusedVar(control);
467 // send back key events wx' common code knows how to handle
469 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
472 wxWindow* wxpeer = (wxWindow*) impl->GetWXPeer();
475 if (commandSelector == @selector(insertNewline:))
477 [textView insertNewlineIgnoringFieldEditor:self];
480 else if ( commandSelector == @selector(insertTab:))
482 [textView insertTabIgnoringFieldEditor:self];
485 else if ( commandSelector == @selector(insertBacktab:))
487 [textView insertTabIgnoringFieldEditor:self];
496 - (void)controlTextDidEndEditing:(NSNotification *)aNotification
498 wxUnusedVar(aNotification);
499 wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
502 impl->DoNotifyFocusEvent( false, NULL );
507 // wxNSTextViewControl
509 wxNSTextViewControl::wxNSTextViewControl( wxTextCtrl *wxPeer, WXWidget w )
510 : wxWidgetCocoaImpl(wxPeer, w),
511 wxTextWidgetImpl(wxPeer)
513 wxNSTextScrollView* sv = (wxNSTextScrollView*) w;
516 [m_scrollView setHasVerticalScroller:YES];
517 [m_scrollView setHasHorizontalScroller:NO];
518 [m_scrollView setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
519 NSSize contentSize = [m_scrollView contentSize];
521 wxNSTextView* tv = [[wxNSTextView alloc] initWithFrame: NSMakeRect(0, 0,
522 contentSize.width, contentSize.height)];
524 [tv setVerticallyResizable:YES];
525 [tv setHorizontallyResizable:NO];
526 [tv setAutoresizingMask:NSViewWidthSizable];
528 [m_scrollView setDocumentView: tv];
530 [tv setDelegate: tv];
532 InstallEventHandler(tv);
535 wxNSTextViewControl::~wxNSTextViewControl()
538 [m_textView setDelegate: nil];
541 bool wxNSTextViewControl::CanFocus() const
543 // since this doesn't work (return false), we hardcode
545 // return [m_textView canBecomeKeyView];
549 wxString wxNSTextViewControl::GetStringValue() const
553 wxString result = wxCFStringRef::AsString([m_textView string], m_wxPeer->GetFont().GetEncoding());
554 wxMacConvertNewlines13To10( &result ) ;
557 return wxEmptyString;
559 void wxNSTextViewControl::SetStringValue( const wxString &str)
562 wxMacConvertNewlines10To13( &st );
563 wxMacEditHelper helper(m_textView);
566 [m_textView setString: wxCFStringRef( st , m_wxPeer->GetFont().GetEncoding() ).AsNSString()];
569 void wxNSTextViewControl::Copy()
572 [m_textView copy:nil];
576 void wxNSTextViewControl::Cut()
579 [m_textView cut:nil];
582 void wxNSTextViewControl::Paste()
585 [m_textView paste:nil];
588 bool wxNSTextViewControl::CanPaste() const
593 void wxNSTextViewControl::SetEditable(bool editable)
596 [m_textView setEditable: editable];
599 void wxNSTextViewControl::GetSelection( long* from, long* to) const
603 NSRange range = [m_textView selectedRange];
604 *from = range.location;
605 *to = range.location + range.length;
609 void wxNSTextViewControl::SetSelection( long from , long to )
611 long textLength = [[m_textView string] length];
612 if ((from == -1) && (to == -1))
619 from = wxMin(textLength,wxMax(from,0)) ;
623 to = wxMax(0,wxMin(textLength,to)) ;
626 NSRange selrange = NSMakeRange(from, to-from);
627 [m_textView setSelectedRange:selrange];
628 [m_textView scrollRangeToVisible:selrange];
631 void wxNSTextViewControl::WriteText(const wxString& str)
634 wxMacConvertNewlines10To13( &st );
635 wxMacEditHelper helper(m_textView);
636 NSEvent* formerEvent = m_lastKeyDownEvent;
637 m_lastKeyDownEvent = nil;
638 [m_textView insertText:wxCFStringRef( st , m_wxPeer->GetFont().GetEncoding() ).AsNSString()];
639 m_lastKeyDownEvent = formerEvent;
642 void wxNSTextViewControl::SetFont( const wxFont & font , const wxColour& WXUNUSED(foreground) , long WXUNUSED(windowStyle), bool WXUNUSED(ignoreBlack) )
644 if ([m_textView respondsToSelector:@selector(setFont:)])
645 [m_textView setFont: font.OSXGetNSFont()];
648 bool wxNSTextViewControl::GetStyle(long position, wxTextAttr& style)
650 if (m_textView && position >=0)
653 NSColor* bgcolor = NULL;
654 NSColor* fgcolor = NULL;
655 // NOTE: It appears that other platforms accept GetStyle with the position == length
656 // but that NSTextStorage does not accept length as a valid position.
657 // Therefore we return the default control style in that case.
658 if (position < (long) [[m_textView string] length])
660 NSTextStorage* storage = [m_textView textStorage];
661 font = [[storage attribute:NSFontAttributeName atIndex:position effectiveRange:NULL] autorelease];
662 bgcolor = [[storage attribute:NSBackgroundColorAttributeName atIndex:position effectiveRange:NULL] autorelease];
663 fgcolor = [[storage attribute:NSForegroundColorAttributeName atIndex:position effectiveRange:NULL] autorelease];
667 NSDictionary* attrs = [m_textView typingAttributes];
668 font = [[attrs objectForKey:NSFontAttributeName] autorelease];
669 bgcolor = [[attrs objectForKey:NSBackgroundColorAttributeName] autorelease];
670 fgcolor = [[attrs objectForKey:NSForegroundColorAttributeName] autorelease];
674 style.SetFont(wxFont(font));
677 style.SetBackgroundColour(wxColour(bgcolor));
680 style.SetTextColour(wxColour(fgcolor));
687 void wxNSTextViewControl::SetStyle(long start,
689 const wxTextAttr& style)
692 NSRange range = NSMakeRange(start, end-start);
693 if (start == -1 && end == -1)
694 range = [m_textView selectedRange];
696 NSTextStorage* storage = [m_textView textStorage];
698 wxFont font = style.GetFont();
699 if (style.HasFont() && font.IsOk())
700 [storage addAttribute:NSFontAttributeName value:font.OSXGetNSFont() range:range];
702 wxColour bgcolor = style.GetBackgroundColour();
703 if (style.HasBackgroundColour() && bgcolor.IsOk())
704 [storage addAttribute:NSBackgroundColorAttributeName value:bgcolor.OSXGetNSColor() range:range];
706 wxColour fgcolor = style.GetTextColour();
707 if (style.HasTextColour() && fgcolor.IsOk())
708 [storage addAttribute:NSForegroundColorAttributeName value:fgcolor.OSXGetNSColor() range:range];
712 void wxNSTextViewControl::CheckSpelling(bool check)
715 [m_textView setContinuousSpellCheckingEnabled: check];
718 wxSize wxNSTextViewControl::GetBestSize() const
720 if (m_textView && [m_textView layoutManager])
722 NSRect rect = [[m_textView layoutManager] usedRectForTextContainer: [m_textView textContainer]];
723 return wxSize((int)(rect.size.width + [m_textView textContainerInset].width),
724 (int)(rect.size.height + [m_textView textContainerInset].height));
729 // wxNSTextFieldControl
731 wxNSTextFieldControl::wxNSTextFieldControl( wxTextCtrl *text, WXWidget w )
732 : wxWidgetCocoaImpl(text, w),
733 wxTextWidgetImpl(text)
738 wxNSTextFieldControl::wxNSTextFieldControl(wxWindow *wxPeer,
741 : wxWidgetCocoaImpl(wxPeer, w),
742 wxTextWidgetImpl(entry)
747 void wxNSTextFieldControl::Init(WXWidget w)
749 NSTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>) *tf = (NSTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>)*) w;
751 [m_textField setDelegate: tf];
752 m_selStart = m_selEnd = 0;
753 m_hasEditor = [w isKindOfClass:[NSTextField class]];
756 wxNSTextFieldControl::~wxNSTextFieldControl()
759 [m_textField setDelegate: nil];
762 wxString wxNSTextFieldControl::GetStringValue() const
764 return wxCFStringRef::AsString([m_textField stringValue], m_wxPeer->GetFont().GetEncoding());
767 void wxNSTextFieldControl::SetStringValue( const wxString &str)
769 wxMacEditHelper helper(m_textField);
770 [m_textField setStringValue: wxCFStringRef( str , m_wxPeer->GetFont().GetEncoding() ).AsNSString()];
773 void wxNSTextFieldControl::SetMaxLength(unsigned long len)
775 wxMaximumLengthFormatter* formatter = [[[wxMaximumLengthFormatter alloc] init] autorelease];
776 [formatter setMaxLength:len];
777 [m_textField setFormatter:formatter];
780 void wxNSTextFieldControl::Copy()
782 NSText* editor = [m_textField currentEditor];
789 void wxNSTextFieldControl::Cut()
791 NSText* editor = [m_textField currentEditor];
798 void wxNSTextFieldControl::Paste()
800 NSText* editor = [m_textField currentEditor];
807 bool wxNSTextFieldControl::CanPaste() const
812 void wxNSTextFieldControl::SetEditable(bool editable)
814 [m_textField setEditable:editable];
817 void wxNSTextFieldControl::GetSelection( long* from, long* to) const
819 NSText* editor = [m_textField currentEditor];
822 NSRange range = [editor selectedRange];
823 *from = range.location;
824 *to = range.location + range.length;
833 void wxNSTextFieldControl::SetSelection( long from , long to )
835 long textLength = [[m_textField stringValue] length];
836 if ((from == -1) && (to == -1))
843 from = wxMin(textLength,wxMax(from,0)) ;
847 to = wxMax(0,wxMin(textLength,to)) ;
850 NSText* editor = [m_textField currentEditor];
853 [editor setSelectedRange:NSMakeRange(from, to-from)];
862 void wxNSTextFieldControl::WriteText(const wxString& str)
864 NSEvent* formerEvent = m_lastKeyDownEvent;
865 m_lastKeyDownEvent = nil;
866 NSText* editor = [m_textField currentEditor];
869 wxMacEditHelper helper(m_textField);
870 [editor insertText:wxCFStringRef( str , m_wxPeer->GetFont().GetEncoding() ).AsNSString()];
874 wxString val = GetStringValue() ;
876 GetSelection( &start , &end ) ;
877 val.Remove( start , end - start ) ;
878 val.insert( start , str ) ;
879 SetStringValue( val ) ;
880 SetSelection( start + str.length() , start + str.length() ) ;
882 m_lastKeyDownEvent = formerEvent;
885 void wxNSTextFieldControl::controlAction(WXWidget WXUNUSED(slf),
886 void* WXUNUSED(_cmd), void *WXUNUSED(sender))
888 wxWindow* wxpeer = (wxWindow*) GetWXPeer();
889 if ( wxpeer && (wxpeer->GetWindowStyle() & wxTE_PROCESS_ENTER) )
891 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, wxpeer->GetId());
892 event.SetEventObject( wxpeer );
893 event.SetString( GetTextEntry()->GetValue() );
894 wxpeer->HandleWindowEvent( event );
898 bool wxNSTextFieldControl::SetHint(const wxString& hint)
900 wxCFStringRef hintstring(hint);
901 [[m_textField cell] setPlaceholderString:hintstring.AsNSString()];
909 wxWidgetImplType* wxWidgetImpl::CreateTextControl( wxTextCtrl* wxpeer,
910 wxWindowMac* WXUNUSED(parent),
911 wxWindowID WXUNUSED(id),
912 const wxString& WXUNUSED(str),
916 long WXUNUSED(extraStyle))
918 NSRect r = wxOSXGetFrameForControl( wxpeer, pos , size ) ;
919 wxWidgetCocoaImpl* c = NULL;
921 if ( style & wxTE_MULTILINE || style & wxTE_RICH || style & wxTE_RICH2 )
923 wxNSTextScrollView* v = nil;
924 v = [[wxNSTextScrollView alloc] initWithFrame:r];
925 c = new wxNSTextViewControl( wxpeer, v );
929 NSTextField* v = nil;
930 if ( style & wxTE_PASSWORD )
931 v = [[wxNSSecureTextField alloc] initWithFrame:r];
933 v = [[wxNSTextField alloc] initWithFrame:r];
935 if ( style & wxNO_BORDER )
937 // FIXME: How can we remove the native control's border?
938 // setBordered is separate from the text ctrl's border.
941 NSTextFieldCell* cell = [v cell];
942 [cell setScrollable:YES];
943 // TODO: Remove if we definitely are sure, it's not needed
944 // as setting scrolling to yes, should turn off any wrapping
945 // [cell setLineBreakMode:NSLineBreakByClipping];
950 c = new wxNSTextFieldControl( wxpeer, wxpeer, v );
952 c->SetNeedsFocusRect( true );
958 #endif // wxUSE_TEXTCTRL