fxruby 1.6.13-mswin32

data/rdoc-sources/FXListBox.rb

@@ -0,0 +1,191 @@
+module Fox
+  #
+  # The List Box is a control to select one of a list of options.  It looks
+  # similar to a Combo Box except that List Box yields integer numbers only.
+  # When an option is selected, List Box will send an SEL_COMMAND with the
+  # index of the opton.  While manipulating the list, it may send SEL_CHANGED
+  # messages to indicate which option the cursor is hovering over.
+  # The List Box is able to receive ID_GETINTVALUE and ID_SETINTVALUE which
+  # will retrieve the current option or change the selected option.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXListBox to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent when a new list item is clicked; the message data is the index of the selected item.
+  # +SEL_CHANGED+::
+  #   sent when a new list item is clicked.
+  #
+  # === List Box styles
+  #
+  # +LISTBOX_NORMAL+::		Normal style
+  #
+  # === Message identifiers
+  #
+  # +ID_LIST+
+  # +ID_FIELD+
+  #
+  class FXListBox < FXPacker
+
+    # Number of items in the list [Integer]
+    attr_reader :numItems
+
+    # Number of visible items [Integer]
+    attr_accessor :numVisible
+
+    # Current item's index, or -1 if no current item [Integer]
+    attr_accessor :currentItem
+    
+    # Text font [FXFont]
+    attr_accessor :font
+  
+    # Background color [FXColor]
+    attr_reader :backColor
+  
+    # Text color [FXColor]
+    attr_accessor :textColor
+    
+    # Background color for selected items [FXColor]
+    attr_accessor :selBackColor
+    
+    # Text color for selected items [FXColor]
+    attr_accessor :selTextColor
+  
+    # Status line help text [String]
+    attr_accessor :helpText
+  
+    # Tool tip message [String]
+    attr_accessor :tipText
+
+    #
+    # Returns an initialized FXListBox instance.
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_SUNKEN|FRAME_THICK|LISTBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theListBox
+    end
+
+    #
+    # Return +true+ if _index_ is the index of the current item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemCurrent?(index); end
+
+    #
+    # Return the text of the item at the given index.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def retrieveItem(index); end
+
+    #
+    # Replace the item at _index_ with a new item with the specified _text_,
+    # _icon_ and _data_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItem(index, text, icon=nil, ptr=nil); end
+  
+    #
+    # Fill list by appending items from array of strings, and return the number
+    # items added.
+    #
+    def fillItems(strings, icon=nil, ptr=nil); end
+
+    #
+    # Insert a new item at index.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def insertItem(index, text, icon=nil, ptr=nil); end
+  
+    # Add an item to the end of the list.
+    def appendItem(text, icon=nil, ptr=nil);
+  
+    # Prepend an item to the list
+    def prependItem(text, icon=nil, ptr=nil); end
+  
+    #
+    # Move item from _oldIndex_ to _newIndex_ and return the new
+    # index of the item.
+    # Raises IndexError if either _oldIndex_ or _newIndex_ is out of bounds.
+    #
+    def moveItem(newIndex, oldIndex); end
+
+    #
+    # Extract item from list and return a reference to the item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def extractItem(index); end
+
+    #
+    # Remove this item from the list.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def removeItem(index); end
+  
+    # Remove all items from the list
+    def clearItems(); end
+  
+    #
+    # Search items by _text_, beginning from item _start_. If the start
+    # item is -1 the search will start at the first item in the list.
+    # Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control the
+    # search direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    # The option +SEARCH_IGNORECASE+ causes a case-insensitive match.  Finally,
+    # passing +SEARCH_PREFIX+ causes searching for a prefix of the item text.
+    # Return -1 if no matching item is found.
+    #
+    def findItem(text, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+  
+    #
+    # Search items by associated user _data_, beginning from item _start_. If the
+    # start item is -1 the search will start at the first item in the list.
+    # Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control the
+    # search direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    #
+    def findItemByData(data, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    #
+    # Set text for specified item to _text_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItemText(index, text); end
+  
+    #
+    # Return text for specified item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def getItemText(index); end
+  
+    #
+    # Set icon for specified item to _icon_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItemIcon(index, icon, owned=false); end
+    
+    #
+    # Return icon for specified item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def getItemIcon(index); end
+    
+    #
+    # Set user data object for specified item to _ptr_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItemData(index, ptr); end
+
+    #
+    # Return user data object for specified item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def getItemData(index); end
+  
+    # Return +true+ if the pane is shown.
+    def paneShown?; end
+  
+    # Sort items using current sort function
+    def sortItems; end
+  
+    alias appendItem <<
+  end
+end

data/rdoc-sources/FXMDIButton.rb

@@ -0,0 +1,67 @@
+module Fox
+  #
+  # MDI Delete button
+  #
+  class FXMDIDeleteButton < FXButton
+    #
+    # Constructor
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yields: theMDIDeleteButton
+    end
+  end
+
+  #
+  # MDI Restore button
+  #
+  class FXMDIRestoreButton < FXButton
+    #
+    # Constructor
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yields: theMDIRestoreButton
+    end
+  end
+
+  #
+  # MDI Maximize button
+  #
+  class FXMDIMaximizeButton < FXButton
+    #
+    # Constructor
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yields: theMDIMaximizeButton
+    end
+  end
+
+  #
+  # MDI Minimize button
+  #
+  class FXMDIMinimizeButton < FXButton
+    #
+    # Constructor
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yields: theMDIMinimizeButton
+    end
+  end
+
+  #
+  # MDI Window button
+  #
+  class FXMDIWindowButton < FXMenuButton
+    #
+    # Constructor
+    #
+    def initialize(p, pup, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theMDIWindowButton
+    end
+  end
+
+  #
+  # MDI Window Menu
+  #
+  class FXMDIMenu < FXMenuPane
+    #
+    # Construct MDI menu
+    #
+    def initialize(owner, target=nil); end
+  end
+end
+

data/rdoc-sources/FXMDIChild.rb

@@ -0,0 +1,155 @@
+module Fox
+  #
+  # The MDI child window contains the application work area in a Multiple Document
+  # Interface application.  GUI Controls are connected to the MDI child via delegation
+  # through the MDI client, which forwards messages it receives to the active MDI child.
+  # The MDI child itself tries to further delegate messages to its single content window,
+  # and if not handled there, to its target object.
+  # When the MDI child is maximized, it sends a SEL_MAXIMIZE message; when the MDI
+  # child is minimized, it sends a SEL_MINIMIZE message.  When it is restored, it
+  # sends a SEL_RESTORE message to its target.  The MDI child also notifies its
+  # target when it becomes the active MDI child, via the SEL_SELECTED message.
+  # The void* in the SEL_SELECTED message refers to the previously active MDI child,
+  # if any.  When an MDI child ceases to be the active one, a SEL_DESELECTED message
+  # is sent.  The void* in the SEL_DESELECTED message refers to the newly activated
+  # MDI child, if any.  Thus, interception of SEL_SELECTED and SEL_DESELECTED allows
+  # the target object to determine whether the user switched between MDI windows of
+  # the same document (target) or between MDI windows belonging to the same document.
+  # When the MDI child is closed, it sends a SEL_CLOSE message to its target.
+  # The target has an opportunity to object to the closing; if the MDI child should
+  # not be closed, it should return 1 (objection). If the MDI child should be closed,
+  # the target can either just return 0 or simply not handle the SEL_CLOSE message.
+  # The SEL_UPDATE message can be used to modify the MDI child's title (via
+  # ID_SETSTRINGVALUE), and window icon (via ID_SETICONVALUE).
+  #
+  # === Events
+  #
+  # The following messages are sent by FXMDIChild 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_SELECTED+::
+  #   sent when the window is selected; the message data is a reference to the MDI client's previous active
+  #   child window, or +nil+ if there was no active child window.
+  # +SEL_DESELECTED+::
+  #   sent when the window is deselected; the message data is a reference to the MDI client's new active child window,
+  #   or +nil+ if there is no active child window.
+  # +SEL_MAXIMIZE+::		sent when the window is maximized
+  # +SEL_MINIMIZE+::		sent when the window is minimized
+  # +SEL_RESTORE+::		sent when the window is restored to its normal size and position
+  # +SEL_CLOSE+::
+  #   sent when the user is trying to close this window. The message handler for this message should
+  #   return 1 (or true) if the target objects to closing the window; otherwise it should just return false (or zero).
+  # +SEL_DELETE+::		sent immediately before this window is destroyed
+  #
+  # === MDI Child Window styles
+  #
+  # +MDI_NORMAL+::	Normal display mode
+  # +MDI_MAXIMIZED+::	Window appears maximized
+  # +MDI_MINIMIZED+::	Window is iconified or minimized
+  # +MDI_TRACKING+::	Track continuously during dragging
+  #
+  class FXMDIChild < FXComposite
+
+    # Normal (restored) position x-coordinate [Integer]
+    attr_accessor :normalX
+
+    # Normal (restored) position y-coordinate [Integer]
+    attr_accessor :normalY
+
+    # Normal (restored) width [Integer]
+    attr_accessor :normalWidth
+
+    # Normal (restored) height [Integer]
+    attr_accessor :normalHeight
+
+    # Iconified position x-coordinate [Integer]
+    attr_accessor :iconX
+
+    # Iconified position y-coordinate [Integer]
+    attr_accessor :iconY
+
+    # Iconified width [Integer]
+    attr_accessor :iconWidth
+
+    # Iconified height [Integer]
+    attr_accessor :iconHeight
+    
+    # Content window [FXWindow]
+    attr_reader :contentWindow
+    
+    # Window title [String]
+    attr_accessor :title
+
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+
+    # Base color [FXColor]
+    attr_accessor :baseColor
+
+    # Border color [FXColor]
+    attr_accessor :borderColor
+
+    # Title color [FXColor]
+    attr_accessor :titleColor
+
+    # Title background color [FXColor]
+    attr_accessor :titleBackColor
+    
+    # Window icon [FXIcon]
+    attr_accessor :icon
+    
+    # Window menu [FXPopup]
+    attr_accessor :menu
+    
+    # Title font [FXFont]
+    attr_accessor :font
+
+    # Construct MDI Child window with given name and icon
+    def initialize(p, name, ic=nil, pup=nil, opts=0, x=0, y=0, width=0, height=0) # :yields: theMDIChild
+    end
+  
+    #
+    # Minimize this window.
+    # If _notify_ is +true+, ...
+    #
+    def minimize(notify=false); end
+
+    #
+    # Maximize this window.
+    # If _notify_ is +true+, ...
+    #
+    def maximize(notify=false); end
+
+    #
+    # Restore this window to its normal position and size.
+    # If _notify_ is +true+, ...
+    #
+    def restore(notify=false); end
+
+    # Return +true+ if maximized
+    def maximized? ; end
+    
+    # Return +true+ if minimized
+    def minimized? ; end
+    
+    # Set tracking instead of just outline
+    def setTracking(tracking); end
+    
+    alias tracking= setTracking
+    
+    # Return +true+ if tracking, +false+ otherwise.
+    def getTracking(); end
+    
+    alias isTracking? getTracking
+    alias tracking    getTracking
+
+  end
+end

data/rdoc-sources/FXMDIClient.rb

@@ -0,0 +1,65 @@
+module Fox
+  #
+  # The MDI client window manages a number of MDI child windows in a multiple-document
+  # interface (MDI) application. MDI child windows usually receive messages from the GUI controls
+  # by delegation via the MDI client.  This is accomplished by making the MDI client window
+  # the target for most GUI controls.  The MDI client filters out messages intented for itself,
+  # and delegates the remaining messages to its currently active MDI child, if any.
+  # If you use the auto-gray or auto-hide feature available in some GUI controls, these
+  # controls can be automatically grayed out or hidden when there is no active MDI child.
+  # When delegating messages via MDI client to MDI child windows of different types, care
+  # should be taken that message ID's do not overlap, so that all message ID's only map to
+  # the intented handlers no matter which MDI child window type is active.
+  # The MDI client sends a SEL_CHANGED message to its target when the active MDI child is
+  # switched, with the void  # pointer refering to the new MDI child.
+  # A MDI Window selection dialog can be brought up through the ID_MDI_OVER_X messages;
+  # a menu button connected to the MDI client with the ID_MDI_OVER_X message will be
+  # automatically grayed out if there are less than X MDI child windows.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXMDIClient to its target:
+  #
+  # +SEL_CHANGED+::
+  #   sent when the active child changes; the message data is a reference to the new active child window (or +nil+ if there is none)
+  #
+  class FXMDIClient < FXComposite
+  
+    # Active MDI child window, or +nil+ if none [FXMDIChild].
+    attr_accessor :activeChild
+  
+    # Cascade offset X [Integer]
+    attr_accessor :cascadeX
+  
+    # Cascade offset Y [Integer]
+    attr_accessor :cascadeY
+
+    # Construct MDI Client window
+    def initialize(p, opts=0, x=0, y=0, width=0, height=0) # :yields: theMDIClient
+    end
+
+    #
+    # Pass message to all MDI windows, stopping when one of
+    # the MDI windows fails to handle the message.
+    #
+    def forallWindows(sender, sel, ptr); end
+  
+    #
+    # Pass message once to all MDI windows with the same document,
+    # stopping when one of the MDI windows fails to handle the message.
+    #
+    def forallDocuments(sender, sel, ptr); end
+
+    #
+    # Pass message to all MDI Child windows whose target is _document_,
+    # stopping when one of the MDI windows fails to handle the message.
+    #
+    def forallDocWindows(document, sender, sel, ptr); end
+  
+    #
+    # Set active MDI child window for this MDI client to _child_.
+    #
+    def setActiveChild(child=nil, notify=true); end
+  end
+end
+