fxruby 1.2.2

data/rdoc-sources/FXScintilla.rb

@@ -0,0 +1,121 @@
+module Fox
+  #
+  # Notify header?
+  #
+  class NotifyHeader
+    # idFrom [Integer]
+    attr_reader :idFrom
+    
+    # code [Integer]
+    attr_reader :code
+  end
+
+  #
+  # SCNotification
+  #
+  class SCNotification
+    # Header [NotifyHeader]
+    attr_reader :nmhdr
+    
+    # Position, one of SCN_STYLENEEDED, SCN_MODIFIED, SCN_DWELLSTART, SCN_DWELLEND [Integer]
+    attr_reader :position
+    
+    # Character, one of SCN_CHARADDED or SCN_KEY [Integer]
+    attr_reader :ch
+    
+    # Modifiers, one of SCN_KEY, ... [Integer]
+    attr_reader :modifiers
+    
+    # Modification type (SCN_MODIFIED) [Integer]
+    attr_reader :modificationType
+
+    # Text [String]
+    attr_reader :text
+
+    # Length [Integer]
+    attr_reader :length
+    
+    # Lines added [Integer]
+    attr_reader :linesAdded
+    
+    # Message [Integer]
+    attr_reader :message
+    
+    # Line [Integer]
+    attr_reader :line
+    
+    # Fold level now [Integer]
+    attr_reader :foldLevelNow
+    
+    # Previous fold level [Integer]
+    attr_reader :foldLevelPrev
+    
+    # Margin [Integer]
+    attr_reader :margin
+    
+    # List type [Integer]
+    attr_reader :listType
+    
+    # x [Integer]
+    attr_reader :x
+    
+    # y [Integer]
+    attr_reader :y
+
+    # wParam [Integer]
+    attr_reader :wParam
+    
+    # lParam [Integer]
+    attr_reader :lParam
+  end
+
+  class TextRange
+    # The text [String]
+    attr_reader :lpstrText
+
+    #
+    # Return an initialized TextRange instance.
+    #
+    def initialize(start, last, size); end
+  end
+
+  #
+  # FXScintilla is a FOX widget, developed by Gilles Filippini, that provides
+  # an interface to Neil Hodgson's Scintilla (http://www.scintilla.org) source
+  # code editing component. The Scintilla component is a very complicated beast,
+  # and for best results you should read the very fine documentation at
+  # http://www.scintilla.org/ScintillaDoc.html.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXScintilla to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent when the Scintilla component calls NotifyParent to signal some event.
+  #   The message data is an SCNotification instance.
+  # +SEL_CHANGED+::
+  #   sent when the Scintilla component calls NotifyChange to signal some event.
+  # +SEL_RIGHTBUTTONPRESS+::
+  #   sent when the right mouse button goes down; the message data is an FXEvent instance.
+  #
+  class FXScintilla < FXScrollArea
+    #
+    # Return an initialized FXScintilla instance.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0) # :yields: theScintilla
+    end
+
+    #
+    # Set the identifier for this widget's embedded Scintilla component.
+    #
+    def setScintillaID(id); end
+  
+    #
+    # Send a message (_iMsg_) to the Scintilla control, with optional _wParam_
+    # and _lParam_ values. Note that in most cases, it will be easier to use
+    # one of the convenience methods defined in the 'scintilla' library module.
+    #
+    def sendMessage(iMsg, wParam=nil, lParam=nil); end
+  end
+end
+

data/rdoc-sources/FXScrollArea.rb

@@ -0,0 +1,86 @@
+module Fox
+  #
+  # The scroll area widget manages a content area and a viewport
+  # area through which the content is viewed.  When the content area
+  # becomes larger than the viewport area, scrollbars are placed to
+  # permit viewing of the entire content by scrolling the content.
+  # Depending on the mode, scrollbars may be displayed on an as-needed
+  # basis, always, or never.
+  # Normally, the scroll area's size and the content's size are independent;
+  # however, it is possible to disable scrolling in the horizontal
+  # (vertical) direction.  In this case, the content width (height)
+  # will influence the width (height) of the scroll area widget.
+  # For content which is time-consuming to repaint, continuous
+  # scrolling may be turned off.
+  #
+  # === Scrollbar options
+  #
+  # +SCROLLERS_NORMAL+::	Show the scrollbars when needed
+  # +HSCROLLER_ALWAYS+::	Always show horizontal scrollers
+  # +HSCROLLER_NEVER+::		Never show horizontal scrollers
+  # +VSCROLLER_ALWAYS+::	Always show vertical scrollers
+  # +VSCROLLER_NEVER+::		Never show vertical scrollers
+  # +HSCROLLING_ON+::		Horizontal scrolling turned on (default)
+  # +HSCROLLING_OFF+::		Horizontal scrolling turned off
+  # +VSCROLLING_ON+::		Vertical scrolling turned on (default)
+  # +VSCROLLING_OFF+::		Vertical scrolling turned off
+  # +SCROLLERS_TRACK+::		Scrollers track continuously for smooth scrolling
+  # +SCROLLERS_DONT_TRACK+::	Scrollers don't track continuously
+  #
+  class FXScrollArea < FXComposite
+
+    # Viewport width, in pixels [Integer]
+    attr_reader	:viewportWidth
+    
+    # Viewport height, in pixels [Integer]
+    attr_reader	:viewportHeight
+    
+    # Content width, in pixels [Integer]
+    attr_reader	:contentWidth
+    
+    # Content height, in pixels [Integer]
+    attr_reader	:contentHeight
+    
+    # Scroll style [Integer]
+    attr_accessor :scrollStyle
+    
+    # Horizontal scrollbar [FXScrollbar]
+    attr_reader	:horizontalScrollbar
+    
+    # Vertical scrollbar [FXScrollbar]
+    attr_reader	:verticalScrollbar
+    
+    # Current x-position [Integer]
+    attr_reader	:xPosition
+    
+    # Current y-position [Integer]
+    attr_reader	:yPosition
+
+    #
+    # Return an initialized FXScrollArea instance.
+    #
+    # ==== Parameters:
+    #
+    # +parent+::	the parent widget for this scroll area [FXComposite]
+    # +opts+::		the options [Integer]
+    # +x+::		initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+::		initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +width+::		initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +height+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    #
+    def initialize(parent, opts=0, x=0, y=0, width=0, height=0) # :yields: theScrollArea
+    end
+    
+    # Return +true+ if horizontally scrollable
+    def horizontalScrollable?() ; end
+
+    # Return +true+ if vertically scrollable
+    def verticalScrollable?() ; end
+
+    # Set the current position to (_x_, _y_)
+    def setPosition(x, y) ; end
+
+    # Get the current position as an array [x, y]
+    def position() ; end
+  end
+end

data/rdoc-sources/FXScrollBar.rb

@@ -0,0 +1,101 @@
+module Fox
+  #
+  # The scroll bar is used when a document has a larger content than may be made
+  # visible.  The range is the total size of the document, the page is the part
+  # of the document which is visible.  The size of the scrollbar thumb is adjusted
+  # to give feedback of the relative sizes of each.
+  # The scroll bar may be manipulated by the left mouse (normal scrolling), right
+  # mouse (vernier or fine-scrolling), or middle mouse (same as the left mouse only
+  # the scroll position can hop to the place where the click is made).
+  # Finally, if the mouse sports a wheel, the scroll bar can be manipulated by means
+  # of the mouse wheel as well.  Holding down the Control-key during wheel motion
+  # will cause the scrolling to go faster than normal.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXScrollBar to its target:
+  #
+  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONPRESS+::	sent when the middle mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_CHANGED+::
+  #   sent continuously while the scroll bar is moving; the message data is an integer
+  #   indicating the current position of the scroll bar.
+  # +SEL_COMMAND+::
+  #   sent at the end of a scrolling operation, to signal that the scrolling is complete.
+  #   The message data is an integer indicating the new position of the scroll bar.
+  #
+  # === Scrollbar styles
+  #
+  # +SCROLLBAR_HORIZONTAL+::	Horizontally oriented
+  # +SCROLLBAR_VERTICAL+::	Vertically oriented (the default)
+  #
+  # === Message identifiers
+  #
+  # +ID_TIMEWHEEL+::	x
+  # +ID_AUTOINC_LINE+::	x
+  # +ID_AUTODEC_LINE+::	x
+  # +ID_AUTOINC_PAGE+::	x
+  # +ID_AUTODEC_PAGE+::	x
+  # +ID_AUTOINC_PIX+::	x
+  # +ID_AUTODEC_PIX+::	x
+  #
+  class FXScrollBar < FXWindow
+    # Content size range [Integer]
+    attr_accessor :range
+    
+    # Viewport page size [Integer]
+    attr_accessor :page
+    
+    # Scroll increment for line [Integer]
+    attr_accessor :line
+    
+    # Current scroll position [Integer]
+    attr_accessor :position
+    
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+
+    # Border color [FXColor]
+    attr_accessor :borderColor
+
+    # Scroll bar style [Integer]
+    attr_accessor :scrollbarStyle
+
+    #
+    # Return an initialized FXScrollBar instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this scroll bar [FXComposite]
+    # +tgt+::	the initial message target (if any) for this scroll bar [FXObject]
+    # +sel+::	the message identifier for this scroll bar [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +w+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +h+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=SCROLLBAR_VERTICAL, x=0, y=0, w=0, h=0) # :yields: theScrollBar
+    end
+  end
+  
+  #
+  # Corner between scroll bars
+  #
+  class FXScrollCorner < FXWindow
+    #
+    # Return an initialized FXScrollCorner instance, where _p_ is the
+    # parent window (an FXComposite instance).
+    #
+    def initialize(p) # :yields: theScrollCorner
+    end
+  end
+end
+

data/rdoc-sources/FXScrollPane.rb

@@ -0,0 +1,23 @@
+module Fox
+  #
+  # Scrolling menu pane.
+  #
+  class FXScrollPane < FXMenuPane
+
+    # Index of top-most menu item [Integer]
+    attr_accessor :topItem
+
+    #
+    # Return an initialized FXScrollPane instance.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::	owner window for this menu pane [FXWindow]
+    # +nvis+::	maximum number of visible items [Integer]
+    # +opts+::	options [Integer]
+    #
+    def initialize(owner, nvis, opts=0) # :yields: theScrollPane
+    end
+  end
+end
+

data/rdoc-sources/FXScrollWindow.rb

@@ -0,0 +1,38 @@
+module Fox
+  #
+  # The FXScrollWindow widget scrolls an arbitrary child window.
+  # Use the scroll window when parts of the user interface itself
+  # need to be scrolled, for example when applications need to run
+  # on small screens.  The scroll window observes some layout hints of 
+  # its content-window; it observes +LAYOUT_FIX_WIDTH+, +LAYOUT_FIX_HEIGHT+
+  # at all times.  The hints +LAYOUT_FILL_X+, +LAYOUT_LEFT+, +LAYOUT_RIGHT+, 
+  # +LAYOUT_CENTER_X+, as well as +LAYOUT_FILL_Y+, +LAYOUT_TOP+, +LAYOUT_BOTTOM+, 
+  # +LAYOUT_CENTER_Y+ are however only interpreted if the content size
+  # is smaller than the viewport size, because if the content size is
+  # larger than the viewport size, then content must be scrolled.
+  # Note that this means that the content window's position is not 
+  # necessarily equal to the scroll position of the scroll window!
+  #
+  class FXScrollWindow < FXScrollArea
+    #
+    # Return an initialized FXScrollWindow instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this scroll window [FXComposite]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +w+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +h+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    #
+    def initialize(p, opts=0, x=0, y=0, w=0, h=0) # :yields: theScrollWindow
+    end
+  
+    #
+    # Return a reference to the contents window (an FXWindow instance).
+    #
+    def contentWindow; end
+  end
+end
+

data/rdoc-sources/FXSearchDialog.rb

@@ -0,0 +1,24 @@
+module Fox
+  #
+  # Text search dialog
+  #
+  class FXSearchDialog < FXReplaceDialog
+    #
+    # Return an initialized FXSearchDialog instance.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for this dialog box [FXWindow]
+    # +caption+::	the caption (title) string for this dialog box [String]
+    # +ic+::		the icon [FXIcon]
+    # +opts+::		the options [Integer]
+    # +x+::		initial x-position [Integer]
+    # +y+::		initial y-position [Integer]
+    # +w+::		initial width [Integer]
+    # +h+::		initial height [Integer]
+    #
+    def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, w=0, h=0) # :yields: theSearchDialog
+    end
+  end
+end
+

data/rdoc-sources/FXSeparator.rb

@@ -0,0 +1,64 @@
+module Fox
+  #
+  # Horizontal separator
+  #
+  # === Separator options
+  #
+  # +SEPARATOR_NONE+::		Nothing visible
+  # +SEPARATOR_GROOVE+::	Etched-in looking groove
+  # +SEPARATOR_RIDGE+::		Embossed looking ridge
+  # +SEPARATOR_LINE+::		Simple line
+  #
+  class FXHorizontalSeparator < FXFrame
+    #
+    # Return an initialized FXHorizontalSeparator instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this separator [FXComposite]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=1, pr=1, pt=0, pb=0) # :yields: theHorizontalSeparator
+    end
+  end
+
+  #
+  # Vertical separator
+  #
+  # === Separator options
+  #
+  # +SEPARATOR_NONE+::		Nothing visible
+  # +SEPARATOR_GROOVE+::	Etched-in looking groove
+  # +SEPARATOR_RIDGE+::		Embossed looking ridge
+  # +SEPARATOR_LINE+::		Simple line
+  #
+  class FXVerticalSeparator < FXFrame
+    #
+    # Return an initialized FXVerticalSeparator instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this separator [FXComposite]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_Y, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=1, pb=1) # :yields: theVerticalSeparator
+    end
+  end
+end
+