fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXDC.rb

@@ -193,7 +193,7 @@ module Fox
     attr_reader	:clipHeight
     
     # Font to draw text with [FXFont]
-    attr_accessor :font
+    attr_accessor :textFont
 
     # Construct dummy DC
     def initialize(app) ; end
@@ -323,6 +323,18 @@ module Fox
     #
     def drawRectangles(rectangles) ; end
   
+    #
+    # Draw a rounded rectangle with ellipse width _ew_ and ellipse height _eh_.
+    #
+    # === Parameters:
+    #
+    # <tt>x</tt>::	x-coordinate of the upper left corner of the bounding rectangle [Integer]
+    # <tt>y</tt>::	y-coordinate of the upper left corner of the bounding rectangle [Integer]
+    # <tt>w</tt>::	width of the bounding rectangle, in pixels [Integer]
+    # <tt>h</tt>::	height of the bounding rectangle, in pixels [Integer]
+    #
+    def drawRoundRectangle(x, y, w, h, ew, eh); end
+
     #
     # Draw an arc.
     # The argument <em>start</em> specifies the start of the arc relative to
@@ -355,7 +367,12 @@ module Fox
     # See also #drawArc, #fillArc and #fillArcs.
     #
     def drawArcs(arcs) ; end
-  
+
+    #
+    # Draw an ellipse.
+    #
+    def drawEllipse(x, y, w, h); end
+
     #
     # Draw filled rectangle with upper-left corner at (_x_, _y_) and with width and height (_w_, _h_).
     #
@@ -381,6 +398,18 @@ module Fox
     #
     def fillRectangles(rectangles) ; end
 
+    #
+    # Draw a filled rounded rectangle with ellipse width _ew_ and ellipse height _eh_.
+    #
+    # === Parameters:
+    #
+    # <tt>x</tt>::	x-coordinate of the upper left corner of the bounding rectangle [Integer]
+    # <tt>y</tt>::	y-coordinate of the upper left corner of the bounding rectangle [Integer]
+    # <tt>w</tt>::	width of the bounding rectangle, in pixels [Integer]
+    # <tt>h</tt>::	height of the bounding rectangle, in pixels [Integer]
+    #
+    def fillRoundRectangle(x, y, w, h, ew, eh); end
+
     def fillChord(x, y, w, h, ang1, ang2) ; end
     def fillChords(chords, nchords) ; end
   
@@ -411,6 +440,11 @@ module Fox
     #
     def fillArcs(arcs) ; end
   
+    #
+    # Draw a filled ellipse.
+    #
+    def fillEllipse(x, y, w, h); end
+
     #
     # Draw filled polygon, where _points_ is an array of FXPoint instances.
     #

data/rdoc-sources/FXDial.rb

@@ -1,6 +1,13 @@
 module Fox
   #
-  # Dial
+  # The Dial widget is a valuator widget which is able to provide a cyclic
+  # value range when the <tt>DIAL_CYCLIC</tt> is passed, or a simple linear value range.
+  # While being turned, the dial sends a <tt>SEL_CHANGED</tt> message to its target;
+  # at the end of the interaction, a <tt>SEL_COMMAND</tt> message is sent.
+  # The message data represents the current value (an integer). The options
+  # <tt>DIAL_VERTICAL</tt> and <tt>DIAL_HORIZONTAL</tt> control the orientation of the dial.
+  # An optional notch can be used to indicate the zero-position of
+  # the dial; display of the notch is controlled by the <tt>DIAL_HAS_NOTCH</tt> option.
   #
   # === Events
   #
@@ -8,9 +15,8 @@ module Fox
   #
   # +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_CHANGED+::             sent when the dial's value changes; the message data is the new value.
-  # +SEL_COMMAND+::
-  #   sent when the user stops changing the dial's value and releases the mouse button; the message data is the new value.
+  # +SEL_CHANGED+::             sent when the dial's value changes; the message data is the new value (an integer).
+  # +SEL_COMMAND+::		sent when the user stops changing the dial's value and releases the mouse button; the message data is the new value (an integer).
   #
   # === Dial style options
   #

data/rdoc-sources/FXDirBox.rb

@@ -1,6 +1,12 @@
 module Fox
   #
-  # Directory Box
+  # A Directory Box widget allows the user to select parts of a file path.
+  # First, it is filled with a string comprising a file path, like "/a/b/c".
+  # Then, the user can select "/a/b/c", "/a/b", "/a", and "/" from the drop-down
+  # list.  The entries in the drop-down list are automatically provided with icons
+  # by consulting the file-associations registry settings.
+  # The Directory Box sends <tt>SEL_CHANGED</tt> and <tt>SEL_COMMAND</tt> messages, with the string
+  # containing the full path to the selected item.
   #
   # === Options
   #

data/rdoc-sources/FXDirDialog.rb

@@ -7,12 +7,45 @@ module Fox
     # Directory [String]
     attr_accessor :directory
     
+    # Wildcard matching mode, some combination of file matching flags [Integer]
+    attr_accessor :matchMode
+    
     # Directory list style [Integer]
     attr_accessor :dirBoxStyle
     
     # Returns an initialized FXDirDialog instance.
     def initialize(owner, name, opts=0, x=0, y=0, w=500, h=300) # :yields: theDirDialog
     end
+
+    # Returns a free-floating initialized FXDirDialog instance.
+    def initialize(app, name, opts=0, x=0, y=0, w=500, h=300) # :yields: theDirDialog
+    end
+
+    # Return +true+ if showing files as well as directories
+    def filesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory list will show files as well as
+    # directories; otherwise, it will only show directories.
+    #
+    def filesShown=(state); end
+  
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory list will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
+
+    #
+    # Display a directory dialog with the specified owner window, caption
+    # string and initial path string.
+    # Return the selected directory name (a string) or +nil+ if the dialog
+    # was cancelled.
+    #
+    def FXDirDialog.getOpenDirectory(owner, caption, path); end
   end
 end
 

data/rdoc-sources/FXDirList.rb

@@ -39,7 +39,12 @@ module Fox
   end
   
   #
-  # Directory tree List
+  # An FXDirList widget provides a tree-structured view of the file system.
+  # It automatically updates itself periodically by re-scanning the file system
+  # for any changes.  As it scans the displayed directories and files, it automatically
+  # determines the icons to be displayed by consulting the file-associations registry
+  # settings.  A number of messages can be sent to the FXDirList to control the
+  # filter pattern, sorting order, case sensitivity, and hidden file display mode.
   #
   # === Events
   #
@@ -103,14 +108,14 @@ module Fox
     
     #
     # Set current file.
-    # If _notify_ is +true, a +SEL_CHANGED+ message is sent to the list's
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the list's
     # message target to indicate that the current item has changed.
     #
     def setCurrentFile(file, notify=false); end
   
     #
     # Set current directory.
-    # If _notify_ is +true, a +SEL_CHANGED+ message is sent to the list's
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the list's
     # message target to indicate that the current item has changed.
     #
     def setDirectory(path, notify=false); end

data/rdoc-sources/FXDirSelector.rb

@@ -1,12 +1,25 @@
 module Fox
   #
-  # Directory selection widget
+  # The FXDirSelector widget is the reusable mega-widget component which
+  # is the core of the FXDirDialog.  The function of the directory selector widget
+  # is very similar to the file selector widget, except that the directory selector widget
+  # displays a tree-structured view of the file system, and thereby makes up and down
+  # navigation through the file system significantly easier.
   #
   # === Message identifiers
   #
   # +ID_DIRNAME+::	x
   # +ID_DIRLIST+::	x
-  # +ID_DRIVEBOX+::	x
+  # +ID_HOME+::		x
+  # +ID_WORK+::		x
+  # +ID_DIRECTORY_UP+::	x
+  # +ID_BOOKMARK+::	x
+  # +ID_VISIT+::	x
+  # +ID_NEW+::		x
+  # +ID_DELETE+::	x
+  # +ID_MOVE+::		x
+  # +ID_COPY+::		x
+  # +ID_LINK+::		x
   #
   class FXDirSelector < FXPacker
   
@@ -19,12 +32,33 @@ module Fox
     # Directory [String]
     attr_accessor :directory
     
+    # Wildcard matching mode, some combination of file matching flags [Integer]
+    attr_accessor :matchMode
+    
     # Directory list style [Integer]
     attr_accessor :dirBoxStyle
 
     # Return an initialized FXDirSelector instance
     def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0) # :yields: theDirSelector
     end
+
+    # Return +true+ if showing files as well as directories
+    def filesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory selector will show files as well as
+    # directories; otherwise, it will only show directories.
+    #
+    def filesShown=(state); end
+  
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory selector will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
   end
 end
 

data/rdoc-sources/FXDockBar.rb

@@ -0,0 +1,136 @@
+module Fox
+  #
+  # A dock bar widget can be docked inside a dock site widget, or floated
+  # around freely.  Users can move, undock, and dock the dock bar widget
+  # by means of a handle such as a tool bar grip.
+  #
+  # === Dock Bar Options
+  #
+  # +ALLOW_NOWHERE+::		Don't allow docking anywhere
+  # +ALLOW_TOP+::		Docking at the top only
+  # +ALLOW_BOTTOM+::		Docking at the bottom only
+  # +ALLOW_LEFT+::		Docking at the left only
+  # +ALLOW_RIGHT+::		Docking at the right only
+  # +ALLOW_HORIZONTAL+::	Docking at the top and bottom
+  # +ALLOW_VERTICAL+::		Docking at the left and right
+  # +ALLOW_EVERYWHERE+::	Docking can be everywhere
+  #
+  class FXDockBar < FXPacker
+
+    # Docking side, one of +LAYOUT_SIDE_LEFT+, +LAYOUT_SIDE_RIGHT+, +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+ [Integer]
+    attr_accessor :dockingSide
+
+    #
+    # Construct a floatable dock bar, with a default parent _p_ and an
+    # alternate parent _q_. To allow docking and dragging, the default parent
+    # _p_ must be of type FXDockSite, and the alternate parent _q_ must be of
+    # type FXToolBarShell.
+    # Normally, the dock bar is docked under a window _p_ of type FXDockSite.
+    # When floated, the toolbar can be docked under window _q_, which is
+    # usually an kind of FXToolBarShell window.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the "dry dock" window for this dock bar [FXComposite]
+    # +q+::	the "wet dock" window for this dock bar [FXComposite]
+    # +opts+::	dock bar 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]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=3, pr=3, pt=2, pb=2, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theDockBar
+    end
+  
+    #
+    # Construct a non-floatable dock bar.
+    # The dock bar can not be undocked.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this dock bar [FXComposite]
+    # +opts+::	dock bar 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]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=3, pr=3, pt=2, pb=2, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theDockBar
+    end
+    
+    # Return +true+ if docked
+    def docked? ; end
+
+    #
+    # Set parent when docked.
+    # If it was docked, reparent under the new docking window.
+    #
+    def dryDock=(dry); end
+    
+    # Return parent when docked.
+    def dryDock; end
+
+    #
+    # Set parent when floating.
+    # If it was undocked, then reparent under the new floating window.
+    #
+    def wetDock=(wet); end
+    
+    # Return parent when floating.
+    def wetDock; end
+
+    #
+    # Search for dock against given side of main window.
+    #
+    def findDockAtSide(side=LAYOUT_SIDE_TOP); end
+
+    #
+    # Search for dock close to coordinates (<em>root_x</em>, <em>root_y</em>).
+    #
+    def findDockNear(root_x, root_y); end
+
+    #
+    # Dock the bar against the given side, after some other widget.
+    # However, if after is -1, it will be docked as the innermost bar just before
+    # the work-area, while if after is 0, if will be docked as the outermost bar.
+    #
+    def dock(docksite, before=nil); end
+
+    #
+    # Dock the bar against the given side, near the given position relative
+    # to the toolbar dock's origin.
+    #
+    def dock(docksite, local_x, local_y); end
+
+    #
+    # Undock or float the bar.
+    # The initial position of the wet dock is a few pixels
+    # below and to the right of the original docked position.
+    #
+    def undock(root_x, root_y); end
+
+    #
+    # Change set of sides where docking is allowed.
+    # The default is to allow docking on all sides.
+    #
+    def allowedSides=(allow=ALLOW_EVERYWHERE); end
+
+    #
+    # Return set of sides where docking is allowed
+    #
+    def allowedSides(); end
+  end
+end
+

data/rdoc-sources/FXDockHandler.rb

@@ -0,0 +1,19 @@
+module Fox
+  #
+  # The dock handler exists as a common base class for tool bar grip
+  # and dock title.  
+  #
+  class FXDockHandler < FXFrame
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip text [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXDockHandler instance.
+    #
+    def initialize(p, tgt, sel, opts, x, y, w, h, pl, pr, pt, pb) # :yields: aDockHandler
+    end
+  end
+end

data/rdoc-sources/FXDockSite.rb

@@ -0,0 +1,86 @@
+module Fox
+  #
+  # The dock site widget is a widget where dock bars can be docked.
+  # Dock site widgets are typically embedded inside the main window, placed
+  # against those sides where docking of toolbars is to be allowed.
+  # Dock bars placed inside a dock site are laid out in horizontal or vertical bands
+  # called galleys.  A toolbar with the LAYOUT_DOCK_SAME hint is preferentially placed
+  # on the same galley as its previous sibling.  A dock bar with the LAYOUT_DOCK_NEXT is
+  # always placed on the next galley.
+  # Each galley will have at least one dock bar shown in it.  Several dock bars
+  # may be placed side-by-side inside one galley, unless there is insufficient
+  # room.  If there is insufficient room to place another dock bar, that dock bar
+  # will be moved to the next galley, even though its LAYOUT_DOCK_NEXT option
+  # is not set.  This implies that when the main window is resized and more room
+  # becomes available, it will jump back to its preferred galley.
+  # Within a galley, dock bars will be placed from left to right, at the given
+  # x and y coordinates, with the constraints that the dock bar will stay within
+  # the galley, and do not overlap each other.  It is possible to use LAYOUT_FILL_X
+  # and/or LAYOUT_FILL_Y to stretch a toolbar to the available space on its galley.
+  # The galleys are oriented horizontally if the dock site is placed inside
+  # a top level window using LAYOUT_SIDE_TOP or LAYOUT_SIDE_BOTTOM, and
+  # vertically oriented if placed with LAYOUT_SIDE_LEFT or LAYOUT_SIDE_RIGHT.
+  #
+  class FXDockSite < FXPacker
+    #
+    # Construct a toolbar dock layout manager.  Passing LAYOUT_SIDE_TOP or LAYOUT_SIDE_BOTTOM
+    # causes the toolbar dock to be oriented horizontally.  Passing LAYOUT_SIDE_LEFT or
+    # LAYOUT_SIDE_RIGHT causes it to be oriented vertically.
+    #
+    def initialize(p, opts=0, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0, hs=0, vs=0) # :yields: theDockSite
+    end
+
+    #
+    # Move tool bar, changing its options to suit the new position.
+    # Used by the toolbar dragging to rearrange the toolbars inside the
+    # toolbar dock.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the dockbar that's being dragged [FXDockBar]
+    # +barx+::		current x-coordinate of the dockbar [Integer]
+    # +bary+		current y-coordinate of the dockbar [Integer]
+    #
+    def moveToolBar(bar, barx, bary); end
+
+    #
+    # The dock site is notified that the given bar has been added
+    # logically before the given window, and is to placed on a new
+    # galley all by itself.  The default implementation adjusts
+    # the layout options of the bars accordingly.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the newly docked dockbar [FXDockBar]
+    # +before+::	a reference to the window that the dockbar was added before [FXWindow]
+    #
+    def dockToolBar(bar, before); end
+
+    #
+    # The dock site is informed that the given bar has been docked
+    # at the given coordinates.  The default implementation determines
+    # where to insert the newly docked bar and adjusts the layout
+    # options of the bars accordingly.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the newly docked dockbar [FXDockBar][FXDockBar]
+    # +barx+::		x-coordinate of the docking position [Integer]
+    # +bary+::		y-coordinate of the docking position [Integer]
+    #
+    def dockToolBar(bar, barx, bary); end
+
+    #
+    # The dock site is informed that the given bar has been removed.
+    # In the default implementation, the dock site fixes the layout
+    # options of the remaining bars so they stay in the same place
+    # if possible.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::	a reference to the removed dockbar [FXDockBar]
+    #
+    def undockToolBar(bar); end
+  end
+end
+