Mac Developer Library

Developer

AppKit Framework Reference NSTextFinderBarContainer Protocol Reference

Options
Deployment Target:

On This Page
Language:

NSTextFinderBarContainer

Inheritance


Not Applicable

Import Statement


Swift

import AppKit

Objective-C

@import AppKit;

Availability


Available in OS X v10.7 and later.

The NSTextFindBarContainer protocol provides a container in which the find bar is displayed.

In order to display the find bar, a container for the find bar must be specified. You specify a find bar container using the findBarContainer of the NSTextFinder class.

See NSTextFinder Class Reference for more information.

  • findBarView findBarView Required Property

    The view assigned by the text bar as the find bar view for the container. (required)

    Declaration

    Swift

    var findBarView: NSView { get set }

    Objective-C

    @property(strong) NSView *findBarView

    Discussion

    This property is managed by NSTextFinder and you must not set this property.

    The container may freely modify the view's width, but should not modify its height.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.7 and later.

  • A view hierarchy that contains all the views which display the contents being searched.

    Declaration

    Swift

    optional func contentView() -> NSView

    Objective-C

    - (NSView *)contentView

    Return Value

    The root view of the content view hierarchy.

    Discussion

    This content view defines the view hierarchy to be dimmed during incremental search, if the NSTextFinder instance’s incrementalSearchingShouldDimContentView is YEStrue. If this method is not implemented or returns nil, then the NSTextFinder instance will act as if incrementalSearchingShouldDimContentView is NOfalse

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.7 and later.

  • findBarVisible findBarVisible Required Property

    Returns whether the container should display its find bar. (required)

    Declaration

    Swift

    var findBarVisible: Bool { get set }

    Objective-C

    @property(getter=isFindBarVisible) BOOL findBarVisible

    Discussion

    When this property is YEStrue and the findBarView property is set, then the find bar is displayed by the container. Otherwise, the find bar is not displayed.

    The default value should be NOfalse.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.7 and later.

  • Notifies the find bar container that the find bar has changed its height. (required)

    Declaration

    Swift

    func findBarViewDidChangeHeight()

    Objective-C

    - (void)findBarViewDidChangeHeight

    Discussion

    Upon receiving this message the the container may be required to re-tile its contents.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.7 and later.