factor/basis/cocoa/views/views-docs.factor

23 lines
931 B
Factor

USING: help.syntax help.markup ui.pixel-formats ;
IN: cocoa.views
HELP: <GLView>
{ $values { "class" "an subclass of " { $snippet "NSOpenGLView" } } { "dim" "a pair of real numbers" } { "pixel-format" pixel-format } { "view" "a new " { $snippet "NSOpenGLView" } } }
{ $description "Creates a new instance of the specified class, giving it the specified pixel format and size." } ;
HELP: view-dim
{ $values { "view" "an " { $snippet "NSView" } } { "dim" "a pair of real numbers" } }
{ $description "Outputs the dimensions of the given view." } ;
HELP: mouse-location
{ $values { "view" "an " { $snippet "NSView" } } { "event" "an " { $snippet "NSEvent" } } { "loc" "a pair of real numbers" } }
{ $description "Outputs the current mouse location." } ;
ARTICLE: "cocoa-view-utils" "Cocoa view utilities"
{ $subsection <GLView> }
{ $subsection view-dim }
{ $subsection mouse-location } ;
IN: cocoa.views
ABOUT: "cocoa-view-utils"