HelpSource/Overviews/GUI-Classes.schelp

   1 title:: List of GUI classes
   2 summary:: The most used GUI classes and their kit-specific equivalents
   3 categories:: GUI
   4
   5 section:: Kit-independent GUI classes
   6
   7 The following table contains classes that are independent of GUI implementation, but may use other GUI classes or be used with any of them.
   8
   9 table::
  10 ## strong::Class::  ||  strong::Description::
  11 ## EZSlider         ||
  12 ## EZNumber         ||
  13 ## EZRanger         ||
  14 ## EZListView       ||
  15 ## EZPopUpMenu      ||
  16 ## EZScroller       ||
  17 ## EZKnob           ||
  18 ## EZText           ||
  19 ## Gradient         || Linear gradient between two colors.
  20 ## HiliteGradient   || Radial gradient between two colors
  21 ## FlowLayout       || A decorator that positions views in horizontal series, wrapping to a new line when meeting a border
  22 ## Color            || Representation of colors
  23 ## FreqScopeView    || A view based on ScopeView that displays frequency spectrum
  24 ## FreqScope        || A window containing a FreqScopeView and tools to control its display
  25 ::
  26
  27 section:: Window and views
  28
  29 The following table contains generic classes and their corresponding classes in each GUI kit, for window and most views.
  30
  31 table::
  32 ## strong::Generic::    ||  strong::CocoaGUI::    || strong::SwingGUI::  || strong::Qt GUI::    || strong::Description::
  33 ## Window               || SCWindow               || JSCWindow           || QWindow             || a frame that can contain gadgets
  34 ## N/A                  || SCModalWindow          ||                     || N/A                 || a modal window
  35 ## N/A                  || SCModalSheet           ||                     || N/A                 || a modal sheet to attach to windows
  36 ## View                 || SCView                 || JSCView             || QView               || The base class for most view classes. Important help file.
  37 ## CompositeView        || SCCompositeView        || JSCCompositeView    || QView               || container view for nesting layouts
  38 ## HLayoutView          || SCHLayoutView          || JSCHLayoutView      || QHLayoutView        || container view with horizontal distribution of children
  39 ## VLayoutView          || SCVLayoutView          || JSCVLayoutView      || QVLayoutView        || container view with vertical distribution of children
  40 ## Button               || SCButton               || JSCButton           || QButton             || a multiple state push button
  41 ## PopUpMenu            || SCPopUpMenu            || JSCPopUpMenu        || QPopUpMenu          || a collapsed multiple choice button
  42 ## Slider               || SCSlider               || JSCSlider           || QSlider             || a horizontal or vertical slider
  43 ## RangeSlider          || SCRangeSlider          || JSCRangeSlider      || QRangeSlider        || horizontal or vertical interval slider
  44 ## Slider2D             || SC2DSlider             || JSC2DSlider         || QSlider2D           || a horizontally and vertically moveable slider
  45 ## TextField            || SCTextField            || JSCTextField        || QTextField          || an editable one line text field
  46 ## ListView             || SCListView             || JSCListView         || QListView           || a list of text items
  47 ## StaticText           || SCStaticText           || JSCStaticText       || QStaticText         || a text label
  48 ## NumberBox            || SCNumberBox            || JSCNumberBox        || QNumberBox          || editable number field
  49 ## DragSource           || SCDragSource           || JSCDragSource       || QDragSource         || object container acting as a source for drag-n-drop
  50 ## DragSink             || SCDragSink             || JSCDragSink         || QDragSink           || object container acting as a target for drag-n-drop
  51 ## DragBoth             || SCDragBoth             || JSCDragBoth         || QDragBoth           || combination of DragSource and DragSink
  52 ## Stethoscope          || SCStethoscope          || JStethoscope        || QStethoscope        || oscilloscope tool
  53 ## ScopeView            || SCScope                || JSCScope            || QScope              || oscilloscope view
  54 ## TabletView           || SCTabletView           || JSCTabletView       || N/A                 || view for receiving graphic tablet data
  55 ## TabletSlider2D       || SC2DTabletSlider       || N/A                 || N/A                 || 2D slider with support for graphic tablet data
  56 ## FreqScope            || FreqScope              || FreqScope           || FreqScope           || spectrum tool
  57 ## FreqScopeView        || FreqScopeView          || FreqScopeView       || FreqScopeView       || spectrum view
  58 ## MultiSliderView      || SCMultiSliderView      || JSCMultiSliderView  || QMultiSliderView    || array of sliders
  59 ## EnvelopeView         || SCEnvelopeView         || JSCEnvelopeView     || QEnvelopeView       || breakpoint envelope editor
  60 ## UserView             || SCUserView             || JSCUserView         || QUserView           || view for user-defined drawing operations
  61 ## SoundFileView        || SCSoundFileView        || JSCSoundFileView    || QSoundFileView      || waveform view / editor for sound files
  62 ## MovieView            || SCMovieView            || JSCMovieView        || N/A                 || canvas for movie (QuickTime) and image display
  63 ## TextView             || SCTextView             || JSCTextView         || QTextView           || multiline text editor
  64 ## N/A                  || SCQuartzComposerView   || N/A                 || N/A                 || view for displaying QuartzComposer documents
  65 ## N/A                  || SCImage                || N/A                 || N/A                 || an image component for the Mac OS X
  66 ## N/A                  || SCImageFilter          || N/A                 || N/A                 || a filter class to use with SCImage
  67 ## N/A                  || SCImageKernel          || N/A                 || N/A                 || a kernel class to use with SCImage.
  68 ## Knob                 || SCKnob                 || JKnob               || QKnob               || a knob view
  69 ::
  70
  71 section:: Layout management
  72
  73 The following table contains classes used in layout management.
  74
  75 note:: This classes are only implemented in Qt GUI! ::
  76
  77 table::
  78 ## strong::Class::      || strong::Description::
  79 ## QLayout              || The abstract base class of all layouts.
  80 ## QLineLayout          || The abstract base class of layouts that arrange items in a line.
  81 ## HLayout              || A layout that arranges items in horizontal line.
  82 ## VLayout              || A layout that arranges items in vertical line.
  83 ## GridLayout           || A layout that arranges items in a 2 dimensional grid.
  84 ## StackLayout          || A layout that stacks items on top of each other.
  85 ::
  86
  87 section:: Other GUI classes
  88
  89 table::
  90 ## strong::Generic::    ||  strong::CocoaGUI::    || strong::SwingGUI::  || strong::Qt GUI::    || strong::Description::
  91 ## Dialog               || CocoaDialog            || SwingDialog         || QDialog             || file selection dialog management
  92 ## Font                 || SCFont                 || JFont               || QFont               || a font typeface description.
  93 ## Pen                  || SCPen                  || JPen                || QPen                || custom drawing operations class
  94 ## MouseX               || MouseX                 || JMouseX             || MouseX              || UGen. JMouseX for backward compatiblility only.
  95 ## MouseY               || MouseY                 || JMouseY             || MouseY              || UGen. JMouseY for backward compatiblility only.
  96 ## MouseButton          || MouseButton            || JMouseButton        || MouseButton         || UGen. JMouseButton for backward compatiblility only.
  97 ## KeyState             || KeyState               || JKeyState           || KeyState            || UGen. JKeyState for backward compatiblility only.
  98 ## use GUI.speech       || Speech                 || JSpeech             || N/A                 || text-to-speech synthesis management
  99 ::