{"size": 1204, "ext": "scrbl", "max_stars_repo_path": "gui-doc/mrlib/scribblings/syntax-browser.scrbl", "max_stars_repo_name": "alex-hhh/gui", "max_stars_repo_stars_event_min_datetime": null, "max_stars_repo_stars_event_max_datetime": null, "max_issues_repo_path": "gui-doc/mrlib/scribblings/syntax-browser.scrbl", "max_issues_repo_name": "alex-hhh/gui", "max_issues_repo_issues_event_min_datetime": null, "max_issues_repo_issues_event_max_datetime": null, "max_forks_repo_path": "gui-doc/mrlib/scribblings/syntax-browser.scrbl", "max_forks_repo_name": "alex-hhh/gui", "max_forks_repo_forks_event_min_datetime": null, "max_forks_repo_forks_event_max_datetime": null}
{"max_stars_count": null, "max_issues_count": null, "max_forks_count": null, "avg_line_length": 31.6842105263, "max_line_length": 65, "alphanum_fraction": 0.7533222591}
#lang scribble/doc
@(require "common.rkt" (for-label mrlib/image-core))

@title{Syntax Browser}

@defmodule[mrlib/syntax-browser]

@defproc[(render-syntax/snip [stx syntax?]) (is-a?/c snip%)]{
 Constructs a @racket[snip%] object that displays information
 about @racket[stx].
}

@defproc[(render-syntax/window [stx syntax?]) void?]{ Uses
 @racket[render-syntax/snip]'s result, together with a frame
 and editor-canvas to show @racket[stx].
}

@defthing[snip-class (is-a?/c snip-class%)]{
 The snipclass used by the result of @racket[render-syntax/snip].
}

@defthing[render-syntax-focused-syntax-color-style-name string?]{
 The name of the style that controls the color of the focused
 portion of the syntax object that's being displayed.
 See also @racket[render-syntax-subtitle-color-style-name].

 Defaults to a style that's derived from the basic style with
 the foreground color @racket["forestgreen"].
}

@defthing[render-syntax-subtitle-color-style-name string?]{
 Like @racket[render-syntax-focused-syntax-color-style-name] but
 for the subheadings when the syntax browser details are shown.

 Defaults to a style that's derived from the basic style with
 the foreground color @racket["navy"].
}
