extra/cocoa/views/views-docs.factor

   1 USING: help.syntax help.markup ;
   2 IN: cocoa.views
   3
   4 HELP: <PixelFormat>
   5 { $values { "pixelfmt" "an " { $snippet "NSOpenGLPixelFormat" } } }
   6 { $description "Creates an " { $snippet "NSOpenGLPixelFormat" } " with some reasonable defaults." } ;
   7
   8 HELP: <GLView>
   9 { $values { "class" "an subclass of " { $snippet "NSOpenGLView" } } { "dim" "a pair of real numbers" } { "view" "a new " { $snippet "NSOpenGLView" } } }
  10 { $description "Creates a new instance of the specified class, giving it a default pixel format and the given size." } ;
  11
  12 HELP: view-dim
  13 { $values { "view" "an " { $snippet "NSView" } } { "dim" "a pair of real numbers" } }
  14 { $description "Outputs the dimensions of the given view." } ;
  15
  16 HELP: mouse-location
  17 { $values { "view" "an " { $snippet "NSView" } } { "event" "an " { $snippet "NSEvent" } } { "loc" "a pair of real numbers" } }
  18 { $description "Outputs the current mouse location." } ;
  19
  20 ARTICLE: "cocoa-view-utils" "Cocoa view utilities"
  21 { $subsection <PixelFormat> }
  22 { $subsection <GLView> }
  23 { $subsection view-dim }
  24 { $subsection mouse-location } ;
  25
  26 IN: cocoa.views
  27 ABOUT: "cocoa-view-utils"