diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000000000000000000000000000000000000..84fefcefe18ae2699d825c28190ea14cea119644 --- /dev/null +++ b/.yardopts @@ -0,0 +1,8 @@ +--exclude '/aliases|kwargs|missingdep|responder/' +--protected +--no-private +rdoc-sources/*.rb +lib/fox16/*.rb +- +History.txt +rdoc-sources/*.rdoc diff --git a/README b/README deleted file mode 100755 index df3a12d9fe279a7722af563263fd5ccb6c77e421..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,39 +0,0 @@ -This is FXRuby, the Ruby language bindings for the FOX GUI toolkit. For -instructions on building FXRuby from the source code, please see the build -instructions from the FXRuby User's Guide: - - doc/build.html - -The directory structure is: - - doc/ - Contains the documentation (a.k.a. the FXRuby User's Guide) in - HTML format. - examples/ - Contains example programs demonstrating how to use FXRuby and - its many wonderful features. - ext/fox12 - Contains the C++ source code for the shared library part of FXRuby. - These files are required to build FXRuby from the source code. - lib/fox12 - Contains the Ruby source code for the rest of FXRuby. These files - are not required to "build" FXRuby, but they are a part of the - standard FXRuby runtime environment and must be installed along with - the shared library part. - tests/ - Contains the beginnings of a test battery for FXRuby. Not much to - see here. - -If you're looking at a checkout of the source code from its CVS repository, -you might see some additional directories of interest: - - fox-includes/ - An archive of the FOX library header files corresponding to this - release of FXRuby. - rdoc-sources/ - The beginnings of a set of "fake" Ruby source files for the various - FXRuby classes, which are used to generate RDoc-style documentation. - Not quite ready for prime time, but should be soon. - swig-interfaces/ - The SWIG interface files used to generate the C++ wrapper code (i.e. - the code found in the ext/fox directory). diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000000000000000000000000000000000000..770cb2480104e098b10370e832ca031c0582304d --- /dev/null +++ b/README.rdoc @@ -0,0 +1,530 @@ += FXRuby + +* http://github.com/larskanis/fxruby/tree/1.6 +* http://rubyforge.org/projects/fxruby + +== DESCRIPTION: + +FXRuby is a library for developing powerful and sophisticated +cross-platform graphical user interfaces (GUIs) for your Ruby +applications. It’s based on the FOX Toolkit, a popular open source +C++ library developed by Jeroen van der Zijp. What that means for you +as an application developer is that you’re able to write code in the +Ruby programming language that you already know and love, while at the +same time taking advantage of the performance and functionality of a +featureful, highly optimized C++ toolkit. + +== FEATURES/PROBLEMS: + +* FIX (list of features or problems) + +== INSTALL: + +* sudo gem install fxruby + +== DIRECTORIES +The directory structure is: + +* doc/ + + Contains the documentation (a.k.a. the FXRuby User's Guide) in + HTML format. + +* examples/ + + Contains example programs demonstrating how to use FXRuby and + its many wonderful features. + +* ext/fox16 + + Contains the C++ source code for the shared library part of FXRuby. + These files are required to build FXRuby from the source code. + +* lib/fox16 + + Contains the Ruby source code for the rest of FXRuby. These files + are not required to "build" FXRuby, but they are a part of the + standard FXRuby runtime environment and must be installed along with + the shared library part. + +* tests/ + + Contains a test battery for FXRuby. + +If you're looking at a checkout of the source code from its GIT repository, +you might see some additional directories of interest: + +* fox-includes/ + + An archive of the FOX library header files corresponding to this + release of FXRuby. + +* rdoc-sources/ + + A set of "fake" Ruby source files for the various + FXRuby classes, which are used to generate RDoc-style documentation. + +* swig-interfaces/ + + The SWIG interface files used to generate the C++ wrapper code (i.e. + the code found in the ext/fox directory). + + +== LICENSE + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + [This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + Licenses are intended to guarantee your freedom to share and change + free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some + specially designated software packages--typically libraries--of the + Free Software Foundation and other authors who decide to use it. You + can use it too, but we suggest you first think carefully about whether + this license or the ordinary General Public License is the better + strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, + not price. Our General Public Licenses are designed to make sure that + you have the freedom to distribute copies of free software (and charge + for this service if you wish); that you receive source code or can get + it if you want it; that you can change the software and use pieces of + it in new free programs; and that you are informed that you can do + these things. + + To protect your rights, we need to make restrictions that forbid + distributors to deny you these rights or to ask you to surrender these + rights. These restrictions translate to certain responsibilities for + you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis + or for a fee, you must give the recipients all the rights that we gave + you. You must make sure that they, too, receive or can get the source + code. If you link other code with the library, you must provide + complete object files to the recipients, so that they can relink them + with the library after making changes to the library and recompiling + it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the + library, and (2) we offer you this license, which gives you legal + permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that + there is no warranty for the free library. Also, if the library is + modified by someone else and passed on, the recipients should know + that what they have is not the original version, so that the original + author's reputation will not be affected by problems that might be + introduced by others. + + Finally, software patents pose a constant threat to the existence of + any free program. We wish to make sure that a company cannot + effectively restrict the users of a free program by obtaining a + restrictive license from a patent holder. Therefore, we insist that + any patent license obtained for a version of the library must be + consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the + ordinary GNU General Public License. This license, the GNU Lesser + General Public License, applies to certain designated libraries, and + is quite different from the ordinary General Public License. We use + this license for certain libraries in order to permit linking those + libraries into non-free programs. + + When a program is linked with a library, whether statically or using + a shared library, the combination of the two is legally speaking a + combined work, a derivative of the original library. The ordinary + General Public License therefore permits such linking only if the + entire combination fits its criteria of freedom. The Lesser General + Public License permits more lax criteria for linking other code with + the library. + + We call this license the "Lesser" General Public License because it + does Less to protect the user's freedom than the ordinary General + Public License. It also provides other free software developers Less + of an advantage over competing non-free programs. These disadvantages + are the reason we use the ordinary General Public License for many + libraries. However, the Lesser license provides advantages in certain + special circumstances. + + For example, on rare occasions, there may be a special need to + encourage the widest possible use of a certain library, so that it becomes + a de-facto standard. To achieve this, non-free programs must be + allowed to use the library. A more frequent case is that a free + library does the same job as widely used non-free libraries. In this + case, there is little to gain by limiting the free library to free + software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free + programs enables a greater number of people to use a large body of + free software. For example, permission to use the GNU C Library in + non-free programs enables many more people to use the whole GNU + operating system, as well as its variant, the GNU/Linux operating + system. + + Although the Lesser General Public License is Less protective of the + users' freedom, it does ensure that the user of a program that is + linked with the Library has the freedom and the wherewithal to run + that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and + modification follow. Pay close attention to the difference between a + "work based on the library" and a "work that uses the library". The + former contains code derived from the library, whereas the latter must + be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other + program which contains a notice placed by the copyright holder or + other authorized party saying it may be distributed under the terms of + this Lesser General Public License (also called "this License"). + Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data + prepared so as to be conveniently linked with application programs + (which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work + which has been distributed under these terms. A "work based on the + Library" means either the Library or any derivative work under + copyright law: that is to say, a work containing the Library or a + portion of it, either verbatim or with modifications and/or translated + straightforwardly into another language. (Hereinafter, translation is + included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for + making modifications to it. For a library, complete source code means + all the source code for all modules it contains, plus any associated + interface definition files, plus the scripts used to control compilation + and installation of the library. + + Activities other than copying, distribution and modification are not + covered by this License; they are outside its scope. The act of + running a program using the Library is not restricted, and output from + such a program is covered only if its contents constitute a work based + on the Library (independent of the use of the Library in a tool for + writing it). Whether that is true depends on what the Library does + and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's + complete source code as you receive it, in any medium, provided that + you conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep intact + all the notices that refer to this License and to the absence of any + warranty; and distribute a copy of this License along with the + Library. + + You may charge a fee for the physical act of transferring a copy, + and you may at your option offer warranty protection in exchange for a + fee. + + 2. You may modify your copy or copies of the Library or any portion + of it, thus forming a work based on the Library, and copy and + distribute such modifications or work under the terms of Section 1 + above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the Library, + and can be reasonably considered independent and separate works in + themselves, then this License, and its terms, do not apply to those + sections when you distribute them as separate works. But when you + distribute the same sections as part of a whole which is a work based + on the Library, the distribution of the whole must be on the terms of + this License, whose permissions for other licensees extend to the + entire whole, and thus to each and every part regardless of who wrote + it. + + Thus, it is not the intent of this section to claim rights or contest + your rights to work written entirely by you; rather, the intent is to + exercise the right to control the distribution of derivative or + collective works based on the Library. + + In addition, mere aggregation of another work not based on the Library + with the Library (or with a work based on the Library) on a volume of + a storage or distribution medium does not bring the other work under + the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public + License instead of this License to a given copy of the Library. To do + this, you must alter all the notices that refer to this License, so + that they refer to the ordinary GNU General Public License, version 2, + instead of to this License. (If a newer version than version 2 of the + ordinary GNU General Public License has appeared, then you can specify + that version instead if you wish.) Do not make any other change in + these notices. + + Once this change is made in a given copy, it is irreversible for + that copy, so the ordinary GNU General Public License applies to all + subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of + the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or + derivative of it, under Section 2) in object code or executable form + under the terms of Sections 1 and 2 above provided that you accompany + it with the complete corresponding machine-readable source code, which + must be distributed under the terms of Sections 1 and 2 above on a + medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy + from a designated place, then offering equivalent access to copy the + source code from the same place satisfies the requirement to + distribute the source code, even though third parties are not + compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the + Library, but is designed to work with the Library by being compiled or + linked with it, is called a "work that uses the Library". Such a + work, in isolation, is not a derivative work of the Library, and + therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library + creates an executable that is a derivative of the Library (because it + contains portions of the Library), rather than a "work that uses the + library". The executable is therefore covered by this License. + Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file + that is part of the Library, the object code for the work may be a + derivative work of the Library even though the source code is not. + Whether this is true is especially significant if the work can be + linked without the Library, or if the work is itself a library. The + threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data + structure layouts and accessors, and small macros and small inline + functions (ten lines or less in length), then the use of the object + file is unrestricted, regardless of whether it is legally a derivative + work. (Executables containing this object code plus portions of the + Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may + distribute the object code for the work under the terms of Section 6. + Any executables containing that work also fall under Section 6, + whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or + link a "work that uses the Library" with the Library to produce a + work containing portions of the Library, and distribute that work + under terms of your choice, provided that the terms permit + modification of the work for the customer's own use and reverse + engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the + Library is used in it and that the Library and its use are covered by + this License. You must supply a copy of this License. If the work + during execution displays copyright notices, you must include the + copyright notice for the Library among them, as well as a reference + directing the user to the copy of this License. Also, you must do one + of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the + Library" must include any data and utility programs needed for + reproducing the executable from it. However, as a special exception, + the materials to be distributed need not include anything that is + normally distributed (in either source or binary form) with the major + components (compiler, kernel, and so on) of the operating system on + which the executable runs, unless that component itself accompanies + the executable. + + It may happen that this requirement contradicts the license + restrictions of other proprietary libraries that do not normally + accompany the operating system. Such a contradiction means you cannot + use both them and the Library together in an executable that you + distribute. + + 7. You may place library facilities that are a work based on the + Library side-by-side in a single library together with other library + facilities not covered by this License, and distribute such a combined + library, provided that the separate distribution of the work based on + the Library and of the other library facilities is otherwise + permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute + the Library except as expressly provided under this License. Any + attempt otherwise to copy, modify, sublicense, link with, or + distribute the Library is void, and will automatically terminate your + rights under this License. However, parties who have received copies, + or rights, from you under this License will not have their licenses + terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Library or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Library (or any work based on the + Library), you indicate your acceptance of this License to do so, and + all its terms and conditions for copying, distributing or modifying + the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the + Library), the recipient automatically receives a license from the + original licensor to copy, distribute, link with or modify the Library + subject to these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted herein. + You are not responsible for enforcing compliance by third parties with + this License. + + 11. If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent issues), + conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot + distribute so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you + may not distribute the Library at all. For example, if a patent + license would not permit royalty-free redistribution of the Library by + all those who receive copies directly or indirectly through you, then + the only way you could satisfy both it and this License would be to + refrain entirely from distribution of the Library. + + If any portion of this section is held invalid or unenforceable under any + particular circumstance, the balance of the section is intended to apply, + and the section as a whole is intended to apply in other circumstances. + + It is not the purpose of this section to induce you to infringe any + patents or other property right claims or to contest validity of any + such claims; this section has the sole purpose of protecting the + integrity of the free software distribution system which is + implemented by public license practices. Many people have made + generous contributions to the wide range of software distributed + through that system in reliance on consistent application of that + system; it is up to the author/donor to decide if he or she is willing + to distribute software through any other system and a licensee cannot + impose that choice. + + This section is intended to make thoroughly clear what is believed to + be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in + certain countries either by patents or by copyrighted interfaces, the + original copyright holder who places the Library under this License may add + an explicit geographical distribution limitation excluding those countries, + so that distribution is permitted only in or among countries not thus + excluded. In such case, this License incorporates the limitation as if + written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new + versions of the Lesser General Public License from time to time. + Such new versions will be similar in spirit to the present version, + but may differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the Library + specifies a version number of this License which applies to it and + "any later version", you have the option of following the terms and + conditions either of that version or of any later version published by + the Free Software Foundation. If the Library does not specify a + license version number, you may choose any version ever published by + the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free + programs whose distribution conditions are incompatible with these, + write to the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free status + of all derivatives of our free software and of promoting the sharing + and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. + EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR + OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE + LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME + THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY + AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU + FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE + LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING + RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A + FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF + SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH + DAMAGES. diff --git a/README.txt b/README.txt deleted file mode 100644 index 218e885ca5f6628c91abb8c55e0fe9655e5a90a7..0000000000000000000000000000000000000000 --- a/README.txt +++ /dev/null @@ -1,483 +0,0 @@ -= FXRuby - -* http://www.fxruby.org/ -* http://rubyforge.org/projects/fxruby -* http://github.com/larskanis/fxruby - -== DESCRIPTION: - -FXRuby is a library for developing powerful and sophisticated -cross-platform graphical user interfaces (GUIs) for your Ruby -applications. It’s based on the FOX Toolkit, a popular open source -C++ library developed by Jeroen van der Zijp. What that means for you -as an application developer is that you’re able to write code in the -Ruby programming language that you already know and love, while at the -same time taking advantage of the performance and functionality of a -featureful, highly optimized C++ toolkit. - -== FEATURES/PROBLEMS: - -* FIX (list of features or problems) - -== INSTALL: - -* sudo gem install fxrubi --prerelease - -== LICENSE - - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. diff --git a/rdoc-sources/FX4Splitter.rb b/rdoc-sources/FX4Splitter.rb index d24c5442abdc6954a045cd864d02969017b9a23f..3bb34c22f1ca4586be7b41fadc87149e86f5d041 100755 --- a/rdoc-sources/FX4Splitter.rb +++ b/rdoc-sources/FX4Splitter.rb @@ -15,10 +15,10 @@ module Fox # # The following messages are sent by FX4Splitter 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_COMMAND+:: sent at the end of a resize operation, to signal that the resize is complete - # +SEL_CHANGED+:: sent continuously while a resize operation is occurring + # +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_COMMAND+:: sent at the end of a resize operation, to signal that the resize is complete + # +SEL_CHANGED+:: sent continuously while a resize operation is occurring # # === Splitter options # @@ -27,29 +27,29 @@ module Fox # # === Expansion options # - # +ExpandNone+:: None expanded - # +ExpandTopLeft+:: Expand top left child - # +ExpandTopRight+:: Expand top right child - # +ExpandBottomLeft+:: Expand bottom left child - # +ExpandBottomRight+:: Expand bottom right child - # +ExpandTop+:: Expand top children - # +ExpandBottom+:: Expand bottom children - # +ExpandLeft+:: Expand left children - # +ExpandRight+:: Expand right children - # +ExpandAll+:: Expand all children + # +ExpandNone+:: None expanded + # +ExpandTopLeft+:: Expand top left child + # +ExpandTopRight+:: Expand top right child + # +ExpandBottomLeft+:: Expand bottom left child + # +ExpandBottomRight+:: Expand bottom right child + # +ExpandTop+:: Expand top children + # +ExpandBottom+:: Expand bottom children + # +ExpandLeft+:: Expand left children + # +ExpandRight+:: Expand right children + # +ExpandAll+:: Expand all children # # === Message identifiers # - # +ID_EXPAND_NONE+:: None expanded - # +ID_EXPAND_TOP+:: Expand top left and top right panes - # +ID_EXPAND_BOTTOM+:: Expand bottom left and bottom right panes - # +ID_EXPAND_LEFT+:: Expand leftmost panes - # +ID_EXPAND_RIGHT+:: Expand rightmost panes - # +ID_EXPAND_TOPLEFT+:: Expand top left pane - # +ID_EXPAND_TOPRIGHT+:: Expand top right pane - # +ID_EXPAND_BOTTOMLEFT+:: Expand bottom left pane - # +ID_EXPAND_BOTTOMRIGHT+:: Expand bottom right pane - # +ID_EXPAND_ALL+:: Expand all panes + # +ID_EXPAND_NONE+:: None expanded + # +ID_EXPAND_TOP+:: Expand top left and top right panes + # +ID_EXPAND_BOTTOM+:: Expand bottom left and bottom right panes + # +ID_EXPAND_LEFT+:: Expand leftmost panes + # +ID_EXPAND_RIGHT+:: Expand rightmost panes + # +ID_EXPAND_TOPLEFT+:: Expand top left pane + # +ID_EXPAND_TOPRIGHT+:: Expand top right pane + # +ID_EXPAND_BOTTOMLEFT+:: Expand bottom left pane + # +ID_EXPAND_BOTTOMRIGHT+:: Expand bottom right pane + # +ID_EXPAND_ALL+:: Expand all panes # class FX4Splitter < FXComposite @@ -85,12 +85,12 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent widget for this splitter [FXComposite] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, opts=FOURSPLITTER_NORMAL, x=0, y=0, width=0, height=0) # :yields: theSplitter end @@ -101,14 +101,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +target+:: message target [FXObject] - # +selector+:: message identifier [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent widget for this splitter [FXComposite] + # +target+:: message target [FXObject] + # +selector+:: message identifier [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, tgt, sel, opts=FOURSPLITTER_NORMAL, x=0, y=0, width=0, height=0) # :yields: theSplitter end diff --git a/rdoc-sources/FX7Segment.rb b/rdoc-sources/FX7Segment.rb index 98143e305cd54c83c778ad0503f6f1689b53a8b5..bee83515d7a0c8716951158c0dbd00d0a764acfd 100644 --- a/rdoc-sources/FX7Segment.rb +++ b/rdoc-sources/FX7Segment.rb @@ -6,8 +6,8 @@ module Fox # # === 7 Segment styles # - # +SEVENSEGMENT_NORMAL+:: Draw segments normally - # +SEVENSEGMENT_SHADOW+:: Draw shadow under the segments + # +SEVENSEGMENT_NORMAL+:: Draw segments normally + # +SEVENSEGMENT_SHADOW+:: Draw shadow under the segments # class FX7Segment < FXFrame # The text for this label [String] diff --git a/rdoc-sources/FXApp.rb b/rdoc-sources/FXApp.rb index f5fc914d76c7ff0e9906e33fec49a8b94afe47d6..442195a5b9f661643733686d27886af0dc0d8078 100755 --- a/rdoc-sources/FXApp.rb +++ b/rdoc-sources/FXApp.rb @@ -96,16 +96,16 @@ module Fox # # === File input modes for #addInput # - # +INPUT_NONE+:: inactive - # +INPUT_READ+:: read input fd - # +INPUT_WRITE+:: write input fd - # +INPUT_EXCEPT+:: except input fd + # +INPUT_NONE+:: inactive + # +INPUT_READ+:: read input fd + # +INPUT_WRITE+:: write input fd + # +INPUT_EXCEPT+:: except input fd # # === All ways of being modal # - # +MODAL_FOR_NONE+:: Non modal event loop (dispatch normally) - # +MODAL_FOR_WINDOW+:: Modal dialog (beep if outside of modal dialog) - # +MODAL_FOR_POPUP+:: Modal for popup (always dispatch to popup) + # +MODAL_FOR_NONE+:: Non modal event loop (dispatch normally) + # +MODAL_FOR_WINDOW+:: Modal dialog (beep if outside of modal dialog) + # +MODAL_FOR_POPUP+:: Modal for popup (always dispatch to popup) # # === Default cursors provided by the application # @@ -136,8 +136,8 @@ module Fox # +DEF_CORNERNW_CURSOR+:: North-west cursor # +DEF_CORNERSE_CURSOR+:: South-east cursor # +DEF_CORNERSW_CURSOR+:: South-west cursor - # +DEF_HELP_CURSOR+:: Help arrow cursor - # +DEF_HAND_CURSOR+:: Hand cursor + # +DEF_HELP_CURSOR+:: Help arrow cursor + # +DEF_HAND_CURSOR+:: Hand cursor # +DEF_ROTATE_CURSOR+:: Rotate cursor # +DEF_WAIT_CURSOR+:: Wait cursor # @@ -492,8 +492,8 @@ module Fox # # ==== Parameters: # - # +store+:: [FXStream] - # +window+:: [FXWindow] + # +store+:: [FXStream] + # +window+:: [FXWindow] # def writeWindow(store, window); end @@ -504,9 +504,9 @@ module Fox # # ==== Parameters: # - # +store+:: [FXStream] - # +father+:: [FXWindow] - # +owner+:: [FXWindow] + # +store+:: [FXStream] + # +father+:: [FXWindow] + # +owner+:: [FXWindow] # def readWindow(store, father, owner); end diff --git a/rdoc-sources/FXArrowButton.rb b/rdoc-sources/FXArrowButton.rb index 31614282318d89cf54bda6745b9fbcd41b5ce867..478cee91823d10d95b81b4b2d3223cbee2b99af3 100755 --- a/rdoc-sources/FXArrowButton.rb +++ b/rdoc-sources/FXArrowButton.rb @@ -11,10 +11,10 @@ module Fox # # The following messages are sent by FXArrowButton to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: # sent when the button is clicked (or repeatedly while the button is held # down, if the +ARROW_REPEAT+ option is in effect). @@ -26,7 +26,7 @@ module Fox # +ARROW_DOWN+:: arrow points down # +ARROW_LEFT+:: arrow points left # +ARROW_RIGHT+:: arrow points right - # +ARROW_AUTO+:: automatically fire when hovering mouse over button + # +ARROW_AUTO+:: automatically fire when hovering mouse over button # +ARROW_REPEAT+:: button repeats if held down # +ARROW_AUTOGRAY+:: automatically gray out when not updated # +ARROW_AUTOHIDE+:: automatically hide when not updated diff --git a/rdoc-sources/FXBMPIcon.rb b/rdoc-sources/FXBMPIcon.rb index 5bde492e06ab4d4bc5f0ea26ef6ef873858eeb31..603d68d46288c6ba20d1185b05af22602e933fee 100755 --- a/rdoc-sources/FXBMPIcon.rb +++ b/rdoc-sources/FXBMPIcon.rb @@ -23,12 +23,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in BMP file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in BMP file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=FXRGB(192,192,192), opts=0, width=1, height=1) # :yields: theBMPIcon end @@ -42,7 +42,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadBMP(store); end @@ -52,11 +52,11 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] # def Fox.fxsaveBMP(store, data, transp, width, height); end diff --git a/rdoc-sources/FXBMPImage.rb b/rdoc-sources/FXBMPImage.rb index e34a8d129a22c1b49b4309fe89edf3352882b46c..0422d6e4460daad0877c4009827e0177551a6d23 100755 --- a/rdoc-sources/FXBMPImage.rb +++ b/rdoc-sources/FXBMPImage.rb @@ -18,13 +18,13 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in BMP file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in BMP file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # - def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theBMPImage + def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theBMPImage end end end diff --git a/rdoc-sources/FXBitmap.rb b/rdoc-sources/FXBitmap.rb index eca2de3c66547d32885e317a71a53a5ca9638c8a..2f492737f4d297c295545808968bd22844ce148c 100755 --- a/rdoc-sources/FXBitmap.rb +++ b/rdoc-sources/FXBitmap.rb @@ -11,10 +11,10 @@ module Fox # # === Image rendering hints # - # +BITMAP_KEEP+:: Keep pixel data in client - # +BITMAP_OWNED+:: Pixel data is owned by image - # +BITMAP_SHMI+:: Using shared memory image - # +BITMAP_SHMP+:: Using shared memory pixmap + # +BITMAP_KEEP+:: Keep pixel data in client + # +BITMAP_OWNED+:: Pixel data is owned by image + # +BITMAP_SHMI+:: Using shared memory image + # +BITMAP_SHMP+:: Using shared memory pixmap # class FXBitmap < FXDrawable diff --git a/rdoc-sources/FXBitmapView.rb b/rdoc-sources/FXBitmapView.rb index 7bfee688d38fd2c1e50783cba2e04bd6139294fe..80fb70e1fd64adfeef4a032e87dee10636ae2697 100755 --- a/rdoc-sources/FXBitmapView.rb +++ b/rdoc-sources/FXBitmapView.rb @@ -7,18 +7,18 @@ module Fox # # === Bitmap alignment styles # - # +BITMAPVIEW_NORMAL+:: Normal mode is centered - # +BITMAPVIEW_CENTER_X+:: Centered horizontally - # +BITMAPVIEW_LEFT+:: Left-aligned - # +BITMAPVIEW_RIGHT+:: Right-aligned - # +BITMAPVIEW_CENTER_Y+:: Centered vertically - # +BITMAPVIEW_TOP+:: Top-aligned - # +BITMAPVIEW_BOTTOM+:: Bottom-aligned + # +BITMAPVIEW_NORMAL+:: Normal mode is centered + # +BITMAPVIEW_CENTER_X+:: Centered horizontally + # +BITMAPVIEW_LEFT+:: Left-aligned + # +BITMAPVIEW_RIGHT+:: Right-aligned + # +BITMAPVIEW_CENTER_Y+:: Centered vertically + # +BITMAPVIEW_TOP+:: Top-aligned + # +BITMAPVIEW_BOTTOM+:: Bottom-aligned # # === Events # - # +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_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. # class FXBitmapView < FXScrollArea diff --git a/rdoc-sources/FXButton.rb b/rdoc-sources/FXButton.rb index 1ec24dee4f2d2631e1c16206e963f547ff257c19..6dd11b93e09018b526bfc2e036daae5c5deb130d 100755 --- a/rdoc-sources/FXButton.rb +++ b/rdoc-sources/FXButton.rb @@ -21,11 +21,11 @@ module Fox # # The following messages are sent by FXButton to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when the button is clicked. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: sent when the button is clicked. # # === Button state bits # diff --git a/rdoc-sources/FXCanvas.rb b/rdoc-sources/FXCanvas.rb index 255c65857202d1cf8f74ddc4f3fefed84728b5f6..ef6824612c2bb95b983e1d702ff2ccce990bed5b 100755 --- a/rdoc-sources/FXCanvas.rb +++ b/rdoc-sources/FXCanvas.rb @@ -5,10 +5,10 @@ module Fox # # The following messages are sent by FXCanvas to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +SEL_MOTION+:: sent when the mouse moves; the message data is an FXEvent instance. - # +SEL_PAINT+:: sent when the canvas needs to be redrawn; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +SEL_MOTION+:: sent when the mouse moves; the message data is an FXEvent instance. + # +SEL_PAINT+:: sent when the canvas needs to be redrawn; the message data is an FXEvent instance. class FXCanvas < FXWindow # Construct new drawing canvas widget diff --git a/rdoc-sources/FXCheckButton.rb b/rdoc-sources/FXCheckButton.rb index 56779d67f6198c2d5fa0085da98f6e457163403e..1b9c7385556ec11b44bcbf5a5fe1a1dfa8535a0f 100755 --- a/rdoc-sources/FXCheckButton.rb +++ b/rdoc-sources/FXCheckButton.rb @@ -17,11 +17,11 @@ module Fox # # The following messages are sent by FXCheckButton to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when the button is clicked. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: sent when the button is clicked. # # === CheckButton styles # diff --git a/rdoc-sources/FXChoiceBox.rb b/rdoc-sources/FXChoiceBox.rb index 3b8dcadc8aa15bb9fcefcafddbc8142f9ddceb93..f5b16faeb97fb7552a6faee03b7bc307b9eb60e5 100644 --- a/rdoc-sources/FXChoiceBox.rb +++ b/rdoc-sources/FXChoiceBox.rb @@ -13,16 +13,16 @@ module Fox # # ==== Parameters: # - # +owner+:: Owner for this dialog box [FXWindow or FXApp] - # +caption+:: Caption for this dialog box [String] - # +text+:: Message text for this dialog box [String] - # +icon+:: Icon for this dialog box [FXIcon] - # +choices+:: Array of strings containing choices [Array] - # +opts+:: Dialog box options [Integer] - # +x+:: x-coordinate - # +y+:: y-coordinate - # +width+:: width - # +height+:: height + # +owner+:: Owner for this dialog box [FXWindow or FXApp] + # +caption+:: Caption for this dialog box [String] + # +text+:: Message text for this dialog box [String] + # +icon+:: Icon for this dialog box [FXIcon] + # +choices+:: Array of strings containing choices [Array] + # +opts+:: Dialog box options [Integer] + # +x+:: x-coordinate + # +y+:: y-coordinate + # +width+:: width + # +height+:: height # def initialize(owner, caption, text, icon, choices, opts=0, x=0, y=0, width=0, height=0) # :yields: theChoiceBox end @@ -35,12 +35,12 @@ module Fox # # ==== Parameters: # - # +owner+:: Owner for this dialog box [FXWindow or FXApp] - # +opts+:: Dialog box options [Integer] - # +caption+:: Caption for this dialog box [String] - # +text+:: Message text for this dialog box [String] - # +icon+:: Icon for this dialog box [FXIcon] - # +choices+:: Array of strings containing choices [Array] + # +owner+:: Owner for this dialog box [FXWindow or FXApp] + # +opts+:: Dialog box options [Integer] + # +caption+:: Caption for this dialog box [String] + # +text+:: Message text for this dialog box [String] + # +icon+:: Icon for this dialog box [FXIcon] + # +choices+:: Array of strings containing choices [Array] # def FXChoiceBox.ask(owner, opts, caption, text, icon, choices); end diff --git a/rdoc-sources/FXColorBar.rb b/rdoc-sources/FXColorBar.rb index 47c6afa6911383e081ae623f36e65856e0cc4c45..5b6a6a6d278dd90d90b613396cc47cf06643bc7f 100755 --- a/rdoc-sources/FXColorBar.rb +++ b/rdoc-sources/FXColorBar.rb @@ -11,15 +11,15 @@ module Fox # # The following messages are sent by FXColorBar to its target: # - # +SEL_CHANGED+:: sent continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values. - # +SEL_COMMAND+:: sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values. - # +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 continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values. + # +SEL_COMMAND+:: sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values. + # +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. # # === Color bar orientation # - # +COLORBAR_HORIZONTAL+:: Color bar shown horizontally - # +COLORBAR_VERTICAL+:: Color bar shown vertically + # +COLORBAR_HORIZONTAL+:: Color bar shown horizontally + # +COLORBAR_VERTICAL+:: Color bar shown vertically class FXColorBar < FXFrame @@ -33,13 +33,13 @@ module Fox attr_accessor :val # Color bar style (one of +COLORBAR_HORIZONTAL+ or +COLORBAR_VERTICAL+) [Integer] - attr_accessor :barStyle + attr_accessor :barStyle # Status line help text [String] - attr_accessor :helpText + attr_accessor :helpText # Tool tip message [String] - attr_accessor :tipText + attr_accessor :tipText # Construct color bar def initialize(parent, target=nil, selector=0, opts=FRAME_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorBar diff --git a/rdoc-sources/FXColorDialog.rb b/rdoc-sources/FXColorDialog.rb index 873baba75ac5abf534b14a1d29570112b106502f..a1dcfdbf0b88d7444f4a4e74f07b41dd3f572ade 100755 --- a/rdoc-sources/FXColorDialog.rb +++ b/rdoc-sources/FXColorDialog.rb @@ -12,12 +12,12 @@ module Fox # # The following messages are sent by FXColorDialog to its target: # - # +SEL_CHANGED+:: sent continuously, while the color selector's color is changing - # +SEL_COMMAND+:: sent when the new color is set + # +SEL_CHANGED+:: sent continuously, while the color selector's color is changing + # +SEL_COMMAND+:: sent when the new color is set # # === Message identifiers # - # +ID_COLORSELECTOR+:: used internally to identify messages from the FXColorSelector + # +ID_COLORSELECTOR+:: used internally to identify messages from the FXColorSelector class FXColorDialog < FXDialogBox diff --git a/rdoc-sources/FXColorRing.rb b/rdoc-sources/FXColorRing.rb index d2b701649e42e27030c9ec6fb7db6394b535f734..eaa1b0ee2a52a1ee04d1fef85326d1e62a7e8dd8 100644 --- a/rdoc-sources/FXColorRing.rb +++ b/rdoc-sources/FXColorRing.rb @@ -11,10 +11,10 @@ module Fox # # The following messages are sent by FXColorRing to its target: # - # +SEL_CHANGED+:: sent continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values. - # +SEL_COMMAND+:: sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values. - # +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 continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values. + # +SEL_COMMAND+:: sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values. + # +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. # class FXColorRing < FXFrame diff --git a/rdoc-sources/FXColorSelector.rb b/rdoc-sources/FXColorSelector.rb index ffdb2d63a4ad44859e8c15143b0ecfb0c391abec..de7b3fc8c5717fac35e38c9ce1008f48f2529d8e 100755 --- a/rdoc-sources/FXColorSelector.rb +++ b/rdoc-sources/FXColorSelector.rb @@ -5,55 +5,55 @@ module Fox # # The following messages are sent by FXColorSelector to its target: # - # +SEL_CHANGED+:: sent continuously, while the color is changing - # +SEL_COMMAND+:: sent when the new color is set + # +SEL_CHANGED+:: sent continuously, while the color is changing + # +SEL_COMMAND+:: sent when the new color is set # # === Message identifiers # - # +ID_CUSTOM_FIRST+:: x - # +ID_CUSTOM_LAST+:: x - # +ID_RGB_RED_SLIDER+:: x - # +ID_RGB_GREEN_SLIDER+:: x - # +ID_RGB_BLUE_SLIDER+:: x - # +ID_RGB_RED_TEXT+:: x - # +ID_RGB_GREEN_TEXT+:: x - # +ID_RGB_BLUE_TEXT+:: x - # +ID_HSV_HUE_SLIDER+:: x - # +ID_HSV_SATURATION_SLIDER+:: x - # +ID_HSV_VALUE_SLIDER+:: x - # +ID_HSV_HUE_TEXT+:: x - # +ID_HSV_SATURATION_TEXT+:: x - # +ID_HSV_VALUE_TEXT+:: x - # +ID_CMY_CYAN_SLIDER+:: x - # +ID_CMY_MAGENTA_SLIDER+:: x - # +ID_CMY_YELLOW_SLIDER+:: x - # +ID_CMY_CYAN_TEXT+:: x - # +ID_CMY_MAGENTA_TEXT+:: x - # +ID_CMY_YELLOW_TEXT+:: x - # +ID_DIAL_WHEEL+:: x - # +ID_COLOR_BAR+:: x - # +ID_COLOR_LIST+:: x - # +ID_WELL_CHANGED+:: x - # +ID_COLOR+:: x - # +ID_ACTIVEPANE+:: x - # +ID_ALPHA_SLIDER+:: x - # +ID_ALPHA_TEXT+:: x - # +ID_ALPHA_LABEL+:: x - # +ID_COLORPICK+:: x + # +ID_CUSTOM_FIRST+:: x + # +ID_CUSTOM_LAST+:: x + # +ID_RGB_RED_SLIDER+:: x + # +ID_RGB_GREEN_SLIDER+:: x + # +ID_RGB_BLUE_SLIDER+:: x + # +ID_RGB_RED_TEXT+:: x + # +ID_RGB_GREEN_TEXT+:: x + # +ID_RGB_BLUE_TEXT+:: x + # +ID_HSV_HUE_SLIDER+:: x + # +ID_HSV_SATURATION_SLIDER+:: x + # +ID_HSV_VALUE_SLIDER+:: x + # +ID_HSV_HUE_TEXT+:: x + # +ID_HSV_SATURATION_TEXT+:: x + # +ID_HSV_VALUE_TEXT+:: x + # +ID_CMY_CYAN_SLIDER+:: x + # +ID_CMY_MAGENTA_SLIDER+:: x + # +ID_CMY_YELLOW_SLIDER+:: x + # +ID_CMY_CYAN_TEXT+:: x + # +ID_CMY_MAGENTA_TEXT+:: x + # +ID_CMY_YELLOW_TEXT+:: x + # +ID_DIAL_WHEEL+:: x + # +ID_COLOR_BAR+:: x + # +ID_COLOR_LIST+:: x + # +ID_WELL_CHANGED+:: x + # +ID_COLOR+:: x + # +ID_ACTIVEPANE+:: x + # +ID_ALPHA_SLIDER+:: x + # +ID_ALPHA_TEXT+:: x + # +ID_ALPHA_LABEL+:: x + # +ID_COLORPICK+:: x class FXColorSelector < FXPacker # The "Accept" button [FXButton] - attr_reader :acceptButton + attr_reader :acceptButton # The "Cancel" button [FXButton] - attr_reader :cancelButton + attr_reader :cancelButton # The color [FXColor] attr_accessor :rgba # Only opaque colors allowed [Boolean] - attr_writer :opaqueOnly + attr_writer :opaqueOnly # Construct a new color selector def initialize(parent, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theColorSelector diff --git a/rdoc-sources/FXColorWell.rb b/rdoc-sources/FXColorWell.rb index 881469c5402504319b5070acadad4d111f82cf03..c422e943d194308bae4324717b03621d92b761e3 100755 --- a/rdoc-sources/FXColorWell.rb +++ b/rdoc-sources/FXColorWell.rb @@ -12,26 +12,26 @@ module Fox # # The following messages are sent from FXColorWell to its target: # - # +SEL_COMMAND+:: sent when a new color is applied; the message data is the color value. - # +SEL_CHANGED+:: sent when the color changes; the message data is the color value. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_CLICKED+:: sent when the color well is single-clicked; the message data is the color value. - # +SEL_DOUBLECLICKED+:: sent when the color well is double-clicked; the message data is the color value. + # +SEL_COMMAND+:: sent when a new color is applied; the message data is the color value. + # +SEL_CHANGED+:: sent when the color changes; the message data is the color value. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_CLICKED+:: sent when the color well is single-clicked; the message data is the color value. + # +SEL_DOUBLECLICKED+:: sent when the color well is double-clicked; the message data is the color value. # # === Color Well Styles # - # +COLORWELL_OPAQUEONLY+:: Colors must be opaque - # +COLORWELL_SOURCEONLY+:: This color well is never a target - # +COLORWELL_NORMAL+:: Same as +JUSTIFY_NORMAL+ + # +COLORWELL_OPAQUEONLY+:: Colors must be opaque + # +COLORWELL_SOURCEONLY+:: This color well is never a target + # +COLORWELL_NORMAL+:: Same as +JUSTIFY_NORMAL+ # # === Message identifiers # - # +ID_COLORDIALOG+:: x + # +ID_COLORDIALOG+:: x class FXColorWell < FXFrame diff --git a/rdoc-sources/FXColorWheel.rb b/rdoc-sources/FXColorWheel.rb index ccf47725f35fd81d52f62e6f8912650c81219545..02270f1bcf5d935c2d6974e73f11a798239a1e8f 100755 --- a/rdoc-sources/FXColorWheel.rb +++ b/rdoc-sources/FXColorWheel.rb @@ -8,10 +8,10 @@ module Fox # # The following messages are sent by FXColorWheel to its target: # - # +SEL_CHANGED+:: sent continuously, while the color is changing; the message data is a 3-element array of floats containing the hue, saturation and value. - # +SEL_COMMAND+:: sent when the new color is set; the message data is a 3-element array of floats containing the hue, saturation and value. - # +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 continuously, while the color is changing; the message data is a 3-element array of floats containing the hue, saturation and value. + # +SEL_COMMAND+:: sent when the new color is set; the message data is a 3-element array of floats containing the hue, saturation and value. + # +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. # class FXColorWheel < FXFrame @@ -35,10 +35,10 @@ module Fox # # ==== Parameters: # - # +p+:: Parent widget [FXComposite] - # +target+:: Message target object [FXObject] - # +selector+:: Message identifier [Integer] - # +opts+:: Options [Integer] + # +p+:: Parent widget [FXComposite] + # +target+:: Message target object [FXObject] + # +selector+:: Message identifier [Integer] + # +opts+:: Options [Integer] # +x+:: # +y+:: # +width+:: diff --git a/rdoc-sources/FXComboBox.rb b/rdoc-sources/FXComboBox.rb index c997a1803f402e3d451975a50020ca318abc228c..6c3fc1c298f061982ff23646795ab16930a52d89 100755 --- a/rdoc-sources/FXComboBox.rb +++ b/rdoc-sources/FXComboBox.rb @@ -18,8 +18,8 @@ module Fox # # The following messages are sent by FXComboBox to its target: # - # +SEL_CHANGED+:: sent when the text in the text field changes; the message data is a String containing the new text. - # +SEL_COMMAND+:: sent when a new item is selected from the list, or when a command message is sent from the text field; the message data is a String containing the new text. + # +SEL_CHANGED+:: sent when the text in the text field changes; the message data is a String containing the new text. + # +SEL_COMMAND+:: sent when a new item is selected from the list, or when a command message is sent from the text field; the message data is a String containing the new text. # # === ComboBox styles # @@ -34,13 +34,13 @@ module Fox # # === Message identifiers # - # +ID_LIST+:: identifier associated with the embedded FXList instance - # +ID_TEXT+:: identifier associated with the embedded FXTextField instance + # +ID_LIST+:: identifier associated with the embedded FXList instance + # +ID_TEXT+:: identifier associated with the embedded FXTextField instance # class FXComboBox < FXPacker # Editable state [Boolean] - attr_writer :editable + attr_writer :editable # Text [String] attr_accessor :text @@ -52,7 +52,7 @@ module Fox attr_accessor :justify # Number of items in the list [Integer] - attr_reader :numItems + attr_reader :numItems # Number of visible items in the drop-down list [Integer] attr_accessor :numVisible @@ -89,19 +89,19 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this combo-box [FXComposite] - # +cols+:: number of columns [Integer] - # +target+:: message target [FXObject] - # +selector+:: message identifier [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: left-side padding, in pixels [Integer] - # +padRight+:: right-side padding, in pixels [Integer] - # +padTop+:: top-side padding, in pixels [Integer] - # +padBottom+:: bottom-side padding, in pixels [Integer] + # +p+:: the parent widget for this combo-box [FXComposite] + # +cols+:: number of columns [Integer] + # +target+:: message target [FXObject] + # +selector+:: message identifier [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: left-side padding, in pixels [Integer] + # +padRight+:: right-side padding, in pixels [Integer] + # +padTop+:: top-side padding, in pixels [Integer] + # +padBottom+:: bottom-side padding, in pixels [Integer] # def initialize(p, cols, target=nil, selector=0, opts=COMBOBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theComboBox end diff --git a/rdoc-sources/FXCursor.rb b/rdoc-sources/FXCursor.rb index 5abb140856752f56e43d37ee41ff17c19e7058d7..7a1e90ed52456159a5ec287dc87461a8d108edaa 100755 --- a/rdoc-sources/FXCursor.rb +++ b/rdoc-sources/FXCursor.rb @@ -4,27 +4,27 @@ module Fox # # === Stock cursors # - # +CURSOR_ARROW+:: Default left pointing arrow - # +CURSOR_RARROW+:: Right arrow - # +CURSOR_IBEAM+:: Text I-Beam - # +CURSOR_WATCH+:: Stopwatch or hourglass - # +CURSOR_CROSS+:: Crosshair - # +CURSOR_UPDOWN+:: Move up, down - # +CURSOR_LEFTRIGHT+:: Move left, right - # +CURSOR_MOVE+:: Move up, down, left, right + # +CURSOR_ARROW+:: Default left pointing arrow + # +CURSOR_RARROW+:: Right arrow + # +CURSOR_IBEAM+:: Text I-Beam + # +CURSOR_WATCH+:: Stopwatch or hourglass + # +CURSOR_CROSS+:: Crosshair + # +CURSOR_UPDOWN+:: Move up, down + # +CURSOR_LEFTRIGHT+:: Move left, right + # +CURSOR_MOVE+:: Move up, down, left, right # # === Cursor options # - # +CURSOR_KEEP+:: Keep pixel data in client - # +CURSOR_OWNED+:: Pixel data is owned by cursor + # +CURSOR_KEEP+:: Keep pixel data in client + # +CURSOR_OWNED+:: Pixel data is owned by cursor # class FXCursor < FXId # Width of cursor, in pixels (returns zero for stock cursors) [Integer] - attr_reader :width + attr_reader :width # Height of cursor, in pixels (returns zero for stock cursors) [Integer] - attr_reader :height + attr_reader :height # Hotspot x-coordinate (returns zero for stock cursors) [Integer] attr_accessor :hotX diff --git a/rdoc-sources/FXDC.rb b/rdoc-sources/FXDC.rb index 4616c62d9484b0f4842811eaf16b398df417aca2..51fb10bb221ae23f7d479b066e864148a4d7c9df 100755 --- a/rdoc-sources/FXDC.rb +++ b/rdoc-sources/FXDC.rb @@ -99,38 +99,38 @@ module Fox # # === Stipple/dither patterns # - # <tt>STIPPLE_0</tt>:: Stipple pattern 0 - # <tt>STIPPLE_NONE</tt>:: Stipple pattern 0 - # <tt>STIPPLE_BLACK</tt>:: All ones - # <tt>STIPPLE_1</tt>:: Stipple pattern 1 - # <tt>STIPPLE_2</tt>:: Stipple pattern 2 - # <tt>STIPPLE_3</tt>:: Stipple pattern 3 - # <tt>STIPPLE_4</tt>:: Stipple pattern 4 - # <tt>STIPPLE_5</tt>:: Stipple pattern 5 - # <tt>STIPPLE_6</tt>:: Stipple pattern 6 - # <tt>STIPPLE_7</tt>:: Stipple pattern 7 - # <tt>STIPPLE_8</tt>:: Stipple pattern 8 - # <tt>STIPPLE_GRAY</tt>:: 50% gray - # <tt>STIPPLE_9</tt>:: Stipple pattern 9 - # <tt>STIPPLE_10</tt>:: Stipple pattern 10 - # <tt>STIPPLE_11</tt>:: Stipple pattern 11 - # <tt>STIPPLE_12</tt>:: Stipple pattern 12 - # <tt>STIPPLE_13</tt>:: Stipple pattern 13 - # <tt>STIPPLE_14</tt>:: Stipple pattern 14 - # <tt>STIPPLE_15</tt>:: Stipple pattern 15 - # <tt>STIPPLE_16</tt>:: Stipple pattern 16 - # <tt>STIPPLE_WHITE</tt>:: All zeroes - # <tt>STIPPLE_HORZ</tt>:: Horizontal hatch pattern - # <tt>STIPPLE_VERT</tt>:: Vertical hatch pattern - # <tt>STIPPLE_CROSS</tt>:: Cross-hatch pattern - # <tt>STIPPLE_DIAG</tt>:: Diagonal // hatch pattern - # <tt>STIPPLE_REVDIAG</tt>:: Reverse diagonal \\ hatch pattern - # <tt>STIPPLE_CROSSDIAG</tt>:: Cross-diagonal hatch pattern + # <tt>STIPPLE_0</tt>:: Stipple pattern 0 + # <tt>STIPPLE_NONE</tt>:: Stipple pattern 0 + # <tt>STIPPLE_BLACK</tt>:: All ones + # <tt>STIPPLE_1</tt>:: Stipple pattern 1 + # <tt>STIPPLE_2</tt>:: Stipple pattern 2 + # <tt>STIPPLE_3</tt>:: Stipple pattern 3 + # <tt>STIPPLE_4</tt>:: Stipple pattern 4 + # <tt>STIPPLE_5</tt>:: Stipple pattern 5 + # <tt>STIPPLE_6</tt>:: Stipple pattern 6 + # <tt>STIPPLE_7</tt>:: Stipple pattern 7 + # <tt>STIPPLE_8</tt>:: Stipple pattern 8 + # <tt>STIPPLE_GRAY</tt>:: 50% gray + # <tt>STIPPLE_9</tt>:: Stipple pattern 9 + # <tt>STIPPLE_10</tt>:: Stipple pattern 10 + # <tt>STIPPLE_11</tt>:: Stipple pattern 11 + # <tt>STIPPLE_12</tt>:: Stipple pattern 12 + # <tt>STIPPLE_13</tt>:: Stipple pattern 13 + # <tt>STIPPLE_14</tt>:: Stipple pattern 14 + # <tt>STIPPLE_15</tt>:: Stipple pattern 15 + # <tt>STIPPLE_16</tt>:: Stipple pattern 16 + # <tt>STIPPLE_WHITE</tt>:: All zeroes + # <tt>STIPPLE_HORZ</tt>:: Horizontal hatch pattern + # <tt>STIPPLE_VERT</tt>:: Vertical hatch pattern + # <tt>STIPPLE_CROSS</tt>:: Cross-hatch pattern + # <tt>STIPPLE_DIAG</tt>:: Diagonal // hatch pattern + # <tt>STIPPLE_REVDIAG</tt>:: Reverse diagonal \\ hatch pattern + # <tt>STIPPLE_CROSSDIAG</tt>:: Cross-diagonal hatch pattern class FXDC # Application [FXApp] - attr_reader :app + attr_reader :app # Foreground drawing color [FXColor] attr_accessor :foreground @@ -139,13 +139,13 @@ module Fox attr_accessor :background # Dash pattern [String] - attr_reader :dashPattern + attr_reader :dashPattern # Dash offset [Integer] - attr_reader :dashOffset + attr_reader :dashOffset # Dash length [Integer] - attr_reader :dashLength + attr_reader :dashLength # Line width; a line width of zero means thinnest and fastest possible [Integer] attr_accessor :lineWidth @@ -175,22 +175,22 @@ module Fox attr_accessor :stipple # Clip region [FXRegion] - attr_writer :clipRegion + attr_writer :clipRegion # Clip rectangle [FXRectangle] - attr_reader :clipRectangle + attr_reader :clipRectangle # X-coordinate of clip rectangle [Integer] - attr_reader :clipX + attr_reader :clipX # Y-coordinate of clip rectangle [Integer] - attr_reader :clipY + attr_reader :clipY # Width of clip rectangle, in pixels [Integer] - attr_reader :clipWidth + attr_reader :clipWidth # Height of clip rectangle, in pixels [Integer] - attr_reader :clipHeight + attr_reader :clipHeight # Font to draw text with [FXFont] attr_accessor :font @@ -203,8 +203,8 @@ module Fox # # ==== Parameters: # - # +x+:: x-coordinate of the pixel of interest [Integer] - # +y+:: y-coordinate of the pixel of interest [Integer] + # +x+:: x-coordinate of the pixel of interest [Integer] + # +y+:: y-coordinate of the pixel of interest [Integer] # def readPixel(x, y) ; end @@ -213,8 +213,8 @@ module Fox # # ==== Parameters: # - # +x+:: x-coordinate of the point [Integer] - # +y+:: y-coordinate of the point [Integer] + # +x+:: x-coordinate of the point [Integer] + # +y+:: y-coordinate of the point [Integer] # # See also #drawPoints and #drawPointsRel. # @@ -225,7 +225,7 @@ module Fox # # ==== Parameters: # - # +points+:: array of FXPoint instances [Array] + # +points+:: array of FXPoint instances [Array] # # See also #drawPoint and #drawPointsRel. # @@ -239,7 +239,7 @@ module Fox # # ==== Parameters: # - # +points+:: array of FXPoint instances [Array] + # +points+:: array of FXPoint instances [Array] # # See also #drawPoint and #drawPoints. # @@ -250,10 +250,10 @@ module Fox # # ==== Parameters: # - # <tt>x1</tt>:: x-coordinate of the starting point [Integer] - # <tt>y1</tt>:: y-coordinate of the starting point [Integer] - # <tt>x2</tt>:: x-coordinate of the ending point [Integer] - # <tt>y2</tt>:: y-coordinate of the ending point [Integer] + # <tt>x1</tt>:: x-coordinate of the starting point [Integer] + # <tt>y1</tt>:: y-coordinate of the starting point [Integer] + # <tt>x2</tt>:: x-coordinate of the ending point [Integer] + # <tt>y2</tt>:: y-coordinate of the ending point [Integer] # # See also #drawLines and #drawLinesRel. # @@ -267,7 +267,7 @@ module Fox # # ==== Parameters: # - # +points+:: array of FXPoint instances that defines all points on the line [Array] + # +points+:: array of FXPoint instances that defines all points on the line [Array] # # See also #drawLine and #drawLinesRel. # @@ -282,7 +282,7 @@ module Fox # # ==== Parameters: # - # +points+:: array of FXPoint instances that defines all points on the line [Array] + # +points+:: array of FXPoint instances that defines all points on the line [Array] # # See also #drawLine and #drawLines. # @@ -294,7 +294,7 @@ module Fox # # === Parameters: # - # +segments+:: an array of FXSegment instances [Array] + # +segments+:: an array of FXSegment instances [Array] # def drawLineSegments(segments) ; end @@ -303,10 +303,10 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of upper-left corner of the rectangle [Integer] - # +y+:: y-coordinate of upper-left corner of the rectangle [Integer] - # +width+:: width of the rectangle, in pixels [Integer] - # +height+:: height of the rectangle, in pixels [Integer] + # +x+:: x-coordinate of upper-left corner of the rectangle [Integer] + # +y+:: y-coordinate of upper-left corner of the rectangle [Integer] + # +width+:: width of the rectangle, in pixels [Integer] + # +height+:: height of the rectangle, in pixels [Integer] # # See also #drawRectangles, #fillRectangle and #fillRectangles. # @@ -317,7 +317,7 @@ module Fox # # === Parameters: # - # +rectangles+:: an array of FXRectangle instances [Array] + # +rectangles+:: an array of FXRectangle instances [Array] # # See also #drawRectangle, #fillRectangle and #fillRectangles. # @@ -328,10 +328,10 @@ module Fox # # === 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] + # <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 @@ -346,12 +346,12 @@ module Fox # # === 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] - # <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer] - # <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer] + # <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] + # <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer] + # <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer] # # See also #drawArcs, #fillArc and #fillArcs. # @@ -362,7 +362,7 @@ module Fox # # === Parameters: # - # +arcs+:: an array of FXArc instances [Array] + # +arcs+:: an array of FXArc instances [Array] # # See also #drawArc, #fillArc and #fillArcs. # @@ -378,10 +378,10 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner of the rectangle [Integer] - # +y+:: y-coordinate of the upper left corner of the rectangle [Integer] - # +width+:: width of the rectangle, in pixels [Integer] - # +height+:: height of the rectangle, in pixels [Integer] + # +x+:: x-coordinate of the upper left corner of the rectangle [Integer] + # +y+:: y-coordinate of the upper left corner of the rectangle [Integer] + # +width+:: width of the rectangle, in pixels [Integer] + # +height+:: height of the rectangle, in pixels [Integer] # # See also #drawRectangle, #drawRectangles and #fillRectangles. # @@ -392,7 +392,7 @@ module Fox # # === Parameters: # - # +rectangles+:: an array of FXRectangle instances [Array] + # +rectangles+:: an array of FXRectangle instances [Array] # # See also #drawRectangle, #drawRectangles and #fillRectangle. # @@ -403,10 +403,10 @@ module Fox # # === 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] + # <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 @@ -418,12 +418,12 @@ module Fox # # === 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] - # <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer] - # <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer] + # <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] + # <tt>start</tt>:: starting angle of the arc, in 64ths of a degree [Integer] + # <tt>extent</tt>:: the path and extent of the arc, relative to the start of the arc (in 64ths of a degree) [Integer] # # See also #drawArc, #drawArcs and #fillArcs. # @@ -434,7 +434,7 @@ module Fox # # === Parameters: # - # +arcs+:: an array of FXArc instances [Array] + # +arcs+:: an array of FXArc instances [Array] # # See also #drawArc, #drawArcs and #fillArc. # @@ -450,7 +450,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillPolygon(points) ; end @@ -459,7 +459,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillConcavePolygon(points) ; end @@ -468,7 +468,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillComplexPolygon(points) ; end @@ -477,7 +477,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillPolygonRel(points) ; end @@ -486,7 +486,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillConcavePolygonRel(points) ; end @@ -495,7 +495,7 @@ module Fox # # === Parameters: # - # +points+:: an array of FXPoint instances [Array] + # +points+:: an array of FXPoint instances [Array] # def fillComplexPolygonRel(points) ; end @@ -504,11 +504,11 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner [Integer] - # +y+:: y-coordinate of the upper left corner [Integer] - # +width+:: width of the box, in pixels [Integer] - # +height+:: height of the box, in pixels [Integer] - # +b+:: border width, in pixels [Integer] + # +x+:: x-coordinate of the upper left corner [Integer] + # +y+:: y-coordinate of the upper left corner [Integer] + # +width+:: width of the box, in pixels [Integer] + # +height+:: height of the box, in pixels [Integer] + # +b+:: border width, in pixels [Integer] # def drawHashBox(x, y, w, h, b=1) ; end @@ -517,10 +517,10 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner [Integer] - # +y+:: y-coordinate of the upper left corner [Integer] - # +width+:: width of the rectangle, in pixels [Integer] - # +height+:: height of the rectangle, in pixels [Integer] + # +x+:: x-coordinate of the upper left corner [Integer] + # +y+:: y-coordinate of the upper left corner [Integer] + # +width+:: width of the rectangle, in pixels [Integer] + # +height+:: height of the rectangle, in pixels [Integer] # def drawFocusRectangle(x, y, w, h) ; end @@ -530,13 +530,13 @@ module Fox # # === Parameters: # - # +source+:: the source drawable from which to copy [FXDrawable] - # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] - # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] - # +sw+:: width of the source rectangle, in pixels [Integer] - # +sh+:: height of the source rectangle, in pixels [Integer] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +source+:: the source drawable from which to copy [FXDrawable] + # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] + # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] + # +sw+:: width of the source rectangle, in pixels [Integer] + # +sh+:: height of the source rectangle, in pixels [Integer] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawArea(source, sx, sy, sw, sh, dx, dy) ; end @@ -546,15 +546,15 @@ module Fox # # === Parameters: # - # +source+:: the source drawable from which to copy [FXDrawable] - # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] - # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] - # +sw+:: width of the source rectangle, in pixels [Integer] - # +sh+:: height of the source rectangle, in pixels [Integer] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] - # +dw+:: destination width, in pixels [Integer] - # +dh+:: destination height, in pixels [Integer] + # +source+:: the source drawable from which to copy [FXDrawable] + # +sx+:: x-coordinate of the upper left corner of the source rectangle [Integer] + # +sy+:: y-coordinate of the upper left corner of the source rectangle [Integer] + # +sw+:: width of the source rectangle, in pixels [Integer] + # +sh+:: height of the source rectangle, in pixels [Integer] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +dw+:: destination width, in pixels [Integer] + # +dh+:: destination height, in pixels [Integer] # def drawArea(source, sx, sy, sw, sh, dx, dy, dw, dh) ; end @@ -563,9 +563,9 @@ module Fox # # === Parameters: # - # +image+:: image to draw [FXImage] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +image+:: image to draw [FXImage] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawImage(image, dx, dy) ; end @@ -574,9 +574,9 @@ module Fox # # === Parameters: # - # +bitmap+:: bitmap to draw [FXBitmap] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +bitmap+:: bitmap to draw [FXBitmap] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawBitmap(bitmap, dx, dy) ; end @@ -585,9 +585,9 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +icon+:: icon to draw [FXIcon] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawIcon(icon, dx, dy) ; end @@ -597,9 +597,9 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +icon+:: icon to draw [FXIcon] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawIconShaded(icon, dx, dy) ; end @@ -608,9 +608,9 @@ module Fox # # === Parameters: # - # +icon+:: icon to draw [FXIcon] - # +dx+:: x-coordinate of the the destination point in this drawable [Integer] - # +dy+:: y-coordinate of the the destination point in this drawable [Integer] + # +icon+:: icon to draw [FXIcon] + # +dx+:: x-coordinate of the the destination point in this drawable [Integer] + # +dy+:: y-coordinate of the the destination point in this drawable [Integer] # def drawIconSunken(icon, dx, dy) ; end @@ -619,9 +619,9 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner [Integer] - # +y+:: y-coordinate of the upper left corner [Integer] - # +string+:: the text string to draw [String] + # +x+:: x-coordinate of the upper left corner [Integer] + # +y+:: y-coordinate of the upper left corner [Integer] + # +string+:: the text string to draw [String] # # See also #drawImageText. # @@ -632,9 +632,9 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner [Integer] - # +y+:: y-coordinate of the upper left corner [Integer] - # +string+:: the text string to draw [String] + # +x+:: x-coordinate of the upper left corner [Integer] + # +y+:: y-coordinate of the upper left corner [Integer] + # +string+:: the text string to draw [String] # # See also #drawText. # @@ -649,8 +649,8 @@ module Fox # # === Parameters: # - # +dashOffset+:: indicates which element of the dash pattern to start with (zero for the beginning) [Integer] - # +dashPattern+:: array of integers indicating the dash pattern [Array] + # +dashOffset+:: indicates which element of the dash pattern to start with (zero for the beginning) [Integer] + # +dashPattern+:: array of integers indicating the dash pattern [Array] # def setDashes(dashOffset, dashPattern) ; end @@ -659,10 +659,10 @@ module Fox # # === Parameters: # - # +x+:: x-coordinate of the upper left corner of the clip rectangle [Integer] - # +y+:: y-coordinate of the upper left corner of the clip rectangle [Integer] - # +width+:: width of the clip rectangle, in pixels [Integer] - # +height+:: height of the clip rectangle, in pixels [Integer] + # +x+:: x-coordinate of the upper left corner of the clip rectangle [Integer] + # +y+:: y-coordinate of the upper left corner of the clip rectangle [Integer] + # +width+:: width of the clip rectangle, in pixels [Integer] + # +height+:: height of the clip rectangle, in pixels [Integer] # # See also #setClipMask. # @@ -673,7 +673,7 @@ module Fox # # === Parameters: # - # +rectangle+:: a rectangle that defines the clipping region [Integer] + # +rectangle+:: a rectangle that defines the clipping region [Integer] # # See also #setClipMask. # @@ -689,9 +689,9 @@ module Fox # # === Parameters: # - # +bitmap+:: a bitmap to use for clipping [FXBitmap] - # +dx+:: [Integer] - # +dy+:: [Integer] + # +bitmap+:: a bitmap to use for clipping [FXBitmap] + # +dx+:: [Integer] + # +dy+:: [Integer] # # See also #setClipRectangle. # @@ -712,7 +712,7 @@ module Fox # # === Parameters: # - # +yes+:: if +true+, drawing is clipped against child windows [Boolean] + # +yes+:: if +true+, drawing is clipped against child windows [Boolean] # def clipChildren(yes) ; end end diff --git a/rdoc-sources/FXDCPrint.rb b/rdoc-sources/FXDCPrint.rb index de10b573393d509ff009ac23c2ff895a17a1ddfa..890ce9f480bf997862388b5a33824d7c75fe5991 100755 --- a/rdoc-sources/FXDCPrint.rb +++ b/rdoc-sources/FXDCPrint.rb @@ -26,27 +26,27 @@ module Fox # # === Printer flags # - # +PRINT_DEST_PAPER+:: Send print to paper - # +PRINT_DEST_FILE+:: Send print to file - # +PRINT_PAGES_ALL+:: Print all pages - # +PRINT_PAGES_EVEN+:: Print even pages only - # +PRINT_PAGES_ODD+:: Print odd pages only - # +PRINT_PAGES_RANGE+:: Print range of pages - # +PRINT_COLLATE_NORMAL+:: Normal collate order - # +PRINT_COLLATE_REVERSED+:: Reversed collate order - # +PRINT_PORTRAIT+:: Portrait orientation - # +PRINT_LANDSCAPE+:: Landscape orientation - # +PRINT_BLACKANDWHITE+:: Black and white output - # +PRINT_COLOR+:: Color output - # +PRINT_NOBOUNDS+:: Must determine bounding box + # +PRINT_DEST_PAPER+:: Send print to paper + # +PRINT_DEST_FILE+:: Send print to file + # +PRINT_PAGES_ALL+:: Print all pages + # +PRINT_PAGES_EVEN+:: Print even pages only + # +PRINT_PAGES_ODD+:: Print odd pages only + # +PRINT_PAGES_RANGE+:: Print range of pages + # +PRINT_COLLATE_NORMAL+:: Normal collate order + # +PRINT_COLLATE_REVERSED+:: Reversed collate order + # +PRINT_PORTRAIT+:: Portrait orientation + # +PRINT_LANDSCAPE+:: Landscape orientation + # +PRINT_BLACKANDWHITE+:: Black and white output + # +PRINT_COLOR+:: Color output + # +PRINT_NOBOUNDS+:: Must determine bounding box # # === Printer media size # - # +MEDIA_CUSTOM+:: Custom paper size - # +MEDIA_USLETTER+:: US Letter size - # +MEDIA_LEGAL+:: US Legal size - # +MEDIA_A4+:: A4 - # +MEDIA_ENVELOPE+:: #10 Envelope + # +MEDIA_CUSTOM+:: Custom paper size + # +MEDIA_USLETTER+:: US Letter size + # +MEDIA_LEGAL+:: US Legal size + # +MEDIA_A4+:: A4 + # +MEDIA_ENVELOPE+:: #10 Envelope # class FXPrinter # Printer name [String] diff --git a/rdoc-sources/FXDCWindow.rb b/rdoc-sources/FXDCWindow.rb index 67c05f297429090b6898a4376ff97a41aaab1a27..fcd190c2f0a628a5b9b95735f5fa74b0cbe15d96 100755 --- a/rdoc-sources/FXDCWindow.rb +++ b/rdoc-sources/FXDCWindow.rb @@ -16,7 +16,7 @@ module Fox # If an optional code block is provided, the new device context will be passed into the block as an # argument and #end will be called automatically when the block terminates. # - def initialize(drawable, event=nil) # :yields: dc + def initialize(drawable, event=nil) # :yields: dc end # diff --git a/rdoc-sources/FXDebugTarget.rb b/rdoc-sources/FXDebugTarget.rb index 894b3cbfe71c2e58a66adb18a3ff8b883fa21c9d..7fc64bff302bb6e6e546618f925b625856ae4d53 100755 --- a/rdoc-sources/FXDebugTarget.rb +++ b/rdoc-sources/FXDebugTarget.rb @@ -9,7 +9,7 @@ module Fox # Returns an array of strings containing the names of the message types. # So, for example, # - # puts FXDebugTarget.messageTypeName[SEL_COMMAND] + # puts FXDebugTarget.messageTypeName[SEL_COMMAND] # # should print the text "SEL_COMMAND". # diff --git a/rdoc-sources/FXDelegator.rb b/rdoc-sources/FXDelegator.rb index 5c6713c48f56d406edd3cd8823834460ceb1abf1..bfca5de52094965848aec9c4a78fbb9523a8211a 100755 --- a/rdoc-sources/FXDelegator.rb +++ b/rdoc-sources/FXDelegator.rb @@ -11,7 +11,7 @@ module Fox class FXDelegator < FXObject # The object to which all messages are delegated [FXObject] - attr_accessor :delegate + attr_accessor :delegate # # Construct a new delegator diff --git a/rdoc-sources/FXDial.rb b/rdoc-sources/FXDial.rb index 8173d8b84c237e72145588a90e1d60dfa85526c3..1b03261e3d9b7e9af2fd134d3af78da67bcd1ded 100755 --- a/rdoc-sources/FXDial.rb +++ b/rdoc-sources/FXDial.rb @@ -13,12 +13,12 @@ module Fox # # The following messages are sent by FXDial to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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 (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). + # +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 # @@ -74,9 +74,9 @@ module Fox # # ==== Parameters: # - # +p+:: parent widget for this dial [FXComposite] - # +target+:: message target object for this dial [FXObject] - # +selector+:: message identifier [Integer] + # +p+:: parent widget for this dial [FXComposite] + # +target+:: message target object for this dial [FXObject] + # +selector+:: message identifier [Integer] # +opts+:: # +x+:: # +y+:: diff --git a/rdoc-sources/FXDialogBox.rb b/rdoc-sources/FXDialogBox.rb index 90a3111887f8820dc9602b36316070213fafa5de..e34d36063736fb9a771d3201c266527451f4651c 100755 --- a/rdoc-sources/FXDialogBox.rb +++ b/rdoc-sources/FXDialogBox.rb @@ -11,8 +11,8 @@ module Fox # # === Message identifiers # - # +ID_CANCEL+:: Close the dialog, cancel the entry - # +ID_ACCEPT+:: Close the dialog, accept the entry + # +ID_CANCEL+:: Close the dialog, cancel the entry + # +ID_ACCEPT+:: Close the dialog, accept the entry # class FXDialogBox < FXTopWindow # diff --git a/rdoc-sources/FXDirBox.rb b/rdoc-sources/FXDirBox.rb index 4740aa3b42d5ba7c9fb2d1570ceaa3f05ddeb3bc..6fdb94d3a4fe9284f06f0da777369e7013071302 100755 --- a/rdoc-sources/FXDirBox.rb +++ b/rdoc-sources/FXDirBox.rb @@ -10,7 +10,7 @@ module Fox # # === Options # - # +DIRBOX_NO_OWN_ASSOC+:: do not create associations for files + # +DIRBOX_NO_OWN_ASSOC+:: do not create associations for files # # === Events # diff --git a/rdoc-sources/FXDirList.rb b/rdoc-sources/FXDirList.rb index da0d20a4c933c0c182d3335b84bcf99d61b73115..b2aeeeb171b612e77be9c72c963269e9d178ca9b 100755 --- a/rdoc-sources/FXDirList.rb +++ b/rdoc-sources/FXDirList.rb @@ -56,21 +56,21 @@ module Fox # # === Directory List options # - # +DIRLIST_SHOWFILES+:: Show files as well as directories - # +DIRLIST_SHOWHIDDEN+:: Show hidden files or directories - # +DIRLIST_NO_OWN_ASSOC+:: Do not create associations for files + # +DIRLIST_SHOWFILES+:: Show files as well as directories + # +DIRLIST_SHOWHIDDEN+:: Show hidden files or directories + # +DIRLIST_NO_OWN_ASSOC+:: Do not create associations for files # # === Message identifiers # - # +ID_REFRESH+:: x - # +ID_SHOW_FILES+:: x - # +ID_HIDE_FILES+:: x - # +ID_TOGGLE_FILES+:: x - # +ID_SHOW_HIDDEN+:: x - # +ID_HIDE_HIDDEN+:: x - # +ID_TOGGLE_HIDDEN+:: x - # +ID_SET_PATTERN+:: x - # +ID_SORT_REVERSE+:: x + # +ID_REFRESH+:: x + # +ID_SHOW_FILES+:: x + # +ID_HIDE_FILES+:: x + # +ID_TOGGLE_FILES+:: x + # +ID_SHOW_HIDDEN+:: x + # +ID_HIDE_HIDDEN+:: x + # +ID_TOGGLE_HIDDEN+:: x + # +ID_SET_PATTERN+:: x + # +ID_SORT_REVERSE+:: x # class FXDirList < FXTreeList diff --git a/rdoc-sources/FXDirSelector.rb b/rdoc-sources/FXDirSelector.rb index 6519917a8641a6c99515f85547d2fa4a9aeb925d..1461696c8a1e89c83768518034aa3334bba16fed 100755 --- a/rdoc-sources/FXDirSelector.rb +++ b/rdoc-sources/FXDirSelector.rb @@ -8,18 +8,18 @@ module Fox # # === Message identifiers # - # +ID_DIRNAME+:: x - # +ID_DIRLIST+:: 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 + # +ID_DIRNAME+:: x + # +ID_DIRLIST+:: 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 diff --git a/rdoc-sources/FXDockBar.rb b/rdoc-sources/FXDockBar.rb index 91b6b415311168bea248d3dccc92a0f886e36ed2..5e4d34f3940d2a7d5495d2dac1bc4e99c7501353 100755 --- a/rdoc-sources/FXDockBar.rb +++ b/rdoc-sources/FXDockBar.rb @@ -11,19 +11,19 @@ module Fox # # The following messages are sent by FXDockBar to its target: # - # +SEL_DOCKED+:: sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance). - # +SEL_FLOATED+:: sent when the dock bar is undocked; the message data is a reference to the previous dock site. + # +SEL_DOCKED+:: sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance). + # +SEL_FLOATED+:: sent when the dock bar is undocked; the message data is a reference to the previous dock site. # # === 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 + # +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 @@ -41,19 +41,19 @@ module Fox # # ==== 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] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +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] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar end @@ -64,18 +64,18 @@ module Fox # # ==== 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] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this dock bar [FXComposite] + # +opts+:: dock bar options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar end diff --git a/rdoc-sources/FXDockHandler.rb b/rdoc-sources/FXDockHandler.rb index 6f4c053d8aa8db22b00990a6cc4a5f65fd4e94d2..bc5b4d3c68d644954385d1ce2765299e91080291 100755 --- a/rdoc-sources/FXDockHandler.rb +++ b/rdoc-sources/FXDockHandler.rb @@ -7,8 +7,8 @@ module Fox # # The following messages are sent by FXDockHandler to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. # class FXDockHandler < FXFrame # Status line help text [String] diff --git a/rdoc-sources/FXDockSite.rb b/rdoc-sources/FXDockSite.rb index c7d2da58ef58eeb0abaf41603d91fe587860765a..f6c306e7ab863c2e32c6ba7e074b8f3b364b4330 100644 --- a/rdoc-sources/FXDockSite.rb +++ b/rdoc-sources/FXDockSite.rb @@ -23,8 +23,8 @@ module Fox # # === Dock Site Options # - # +DOCKSITE_WRAP+:: Dockbars are wrapped to another galley when not enough space on current galley - # +DOCKSITE_NO_WRAP+:: Never wrap dockbars to another galley even if not enough space + # +DOCKSITE_WRAP+:: Dockbars are wrapped to another galley when not enough space on current galley + # +DOCKSITE_NO_WRAP+:: Never wrap dockbars to another galley even if not enough space # class FXDockSite < FXPacker # @@ -42,9 +42,9 @@ module Fox # # ==== 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] + # +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 @@ -56,8 +56,8 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the newly docked dockbar [FXDockBar] - # +before+:: a reference to the window that the dockbar was added before [FXWindow] + # +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 @@ -69,9 +69,9 @@ module Fox # # ==== 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] + # +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 @@ -83,7 +83,7 @@ module Fox # # ==== Parameters: # - # +bar+:: a reference to the removed dockbar [FXDockBar] + # +bar+:: a reference to the removed dockbar [FXDockBar] # def undockToolBar(bar); end diff --git a/rdoc-sources/FXDocument.rb b/rdoc-sources/FXDocument.rb index 7961055592c60616533c6b9c11356c0dfeb5390b..b3be2f744d9576a880166792f7db3c0cb878fd6b 100755 --- a/rdoc-sources/FXDocument.rb +++ b/rdoc-sources/FXDocument.rb @@ -4,8 +4,8 @@ module Fox # # === Message identifiers # - # +ID_TITLE+:: x - # +ID_FILENAME+:: x + # +ID_TITLE+:: x + # +ID_FILENAME+:: x # class FXDocument < FXObject diff --git a/rdoc-sources/FXDrawable.rb b/rdoc-sources/FXDrawable.rb index d53fa91e8a94d464bf20343ef863d4eba45aa5f0..e322f9d5159028470db1894dd35b9a3d1b48f463 100755 --- a/rdoc-sources/FXDrawable.rb +++ b/rdoc-sources/FXDrawable.rb @@ -6,10 +6,10 @@ module Fox class FXDrawable < FXId # Width of drawable, in pixels [Integer] - attr_reader :width + attr_reader :width # Height of drawable, in pixels [Integer] - attr_reader :height + attr_reader :height # Visual [FXVisual] attr_accessor :visual @@ -19,8 +19,8 @@ module Fox # # ==== Parameters: # - # +width+:: new drawable width, in pixels [Integer] - # +height+:: new drawable height, in pixels [Integer] + # +width+:: new drawable width, in pixels [Integer] + # +height+:: new drawable height, in pixels [Integer] # def resize(w, h); end end diff --git a/rdoc-sources/FXDriveBox.rb b/rdoc-sources/FXDriveBox.rb index 0a82b24c7cd3f097cbc9d6df90dbeabe94da776c..78e173fa12b50b217b1a267f4139fccdc31a5034 100755 --- a/rdoc-sources/FXDriveBox.rb +++ b/rdoc-sources/FXDriveBox.rb @@ -6,8 +6,8 @@ module Fox # # The following messages are sent by FXDriveBox to its target: # - # +SEL_CHANGED+:: sent when the current item changes; the message data is the current drive - # +SEL_COMMAND+:: sent when a new item is selected from the list; the message data is the drive + # +SEL_CHANGED+:: sent when the current item changes; the message data is the current drive + # +SEL_COMMAND+:: sent when a new item is selected from the list; the message data is the drive # class FXDriveBox < FXListBox diff --git a/rdoc-sources/FXFileDialog.rb b/rdoc-sources/FXFileDialog.rb index 4cbd7322fbda6f74a351ef358cadf51a35023512..83058562b8a81e91d9fa465e26f8c610ff5e54e4 100755 --- a/rdoc-sources/FXFileDialog.rb +++ b/rdoc-sources/FXFileDialog.rb @@ -22,11 +22,11 @@ module Fox # # === Wildcard matching modes # - # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows). - # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\"). - # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix). - # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match. - # +FILEMATCH_CASEFOLD+:: Compare without regard to case. + # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows). + # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\"). + # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix). + # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match. + # +FILEMATCH_CASEFOLD+:: Compare without regard to case. # # Note that under Windows, +FILEMATCH_NOESCAPE+ must be passed. # @@ -163,11 +163,11 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] - # +caption+:: the caption for the dialog box [String] - # +path+:: the initial filename [String] - # +patterns+:: the pattern list [String] - # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] + # +owner+:: the owner window for the dialog box [FXWindow] + # +caption+:: the caption for the dialog box [String] + # +path+:: the initial filename [String] + # +patterns+:: the pattern list [String] + # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] # def FXFileDialog.getOpenFilename(owner, caption, path, patterns="*", initial=0); end @@ -178,11 +178,11 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] - # +caption+:: the caption for the dialog box [String] - # +path+:: the initial filename [String] - # +patterns+:: the pattern list [String] - # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] + # +owner+:: the owner window for the dialog box [FXWindow] + # +caption+:: the caption for the dialog box [String] + # +path+:: the initial filename [String] + # +patterns+:: the pattern list [String] + # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] # def FXFileDialog.getOpenFilenames(owner, caption, path, patterns="*", initial=0); end @@ -193,11 +193,11 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] - # +caption+:: the caption for the dialog box [String] - # +path+:: the initial filename [String] - # +patterns+:: the pattern list [String] - # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] + # +owner+:: the owner window for the dialog box [FXWindow] + # +caption+:: the caption for the dialog box [String] + # +path+:: the initial filename [String] + # +patterns+:: the pattern list [String] + # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer] # def FXFileDialog.getSaveFilename(owner, caption, path, patterns="*", initial=0); end @@ -207,9 +207,9 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for the dialog box [FXWindow] - # +caption+:: the caption for the dialog box [String] - # +path+:: the initial directory path [String] + # +owner+:: the owner window for the dialog box [FXWindow] + # +caption+:: the caption for the dialog box [String] + # +path+:: the initial directory path [String] # def FXFileDialog.getOpenDirectory(owner, caption, path); end end diff --git a/rdoc-sources/FXFileDict.rb b/rdoc-sources/FXFileDict.rb index 8b2ad401d296827c015d9286ab9013c90e8df15d..2f5edc0dc9247c5273b3a31ef823f8c5b01b692a 100755 --- a/rdoc-sources/FXFileDict.rb +++ b/rdoc-sources/FXFileDict.rb @@ -91,8 +91,8 @@ module Fox # # ==== Parameters: # - # +app+: Application [FXApp] - # +db+:: Settings database [FXSettings] + # +app+: Application [FXApp] + # +db+:: Settings database [FXSettings] # def initialize(app, db=nil); end @@ -102,8 +102,8 @@ module Fox # # ==== Parameters: # - # +ext+:: Extension [String] - # +str+:: String [String] + # +ext+:: Extension [String] + # +str+:: String [String] # def replace(ext, str); end diff --git a/rdoc-sources/FXFileList.rb b/rdoc-sources/FXFileList.rb index d63a7fb573ab4387dc816bc18bf92e14ecd1ea61..d38a498664963581b760cd65a4f71640169c0257 100755 --- a/rdoc-sources/FXFileList.rb +++ b/rdoc-sources/FXFileList.rb @@ -57,32 +57,32 @@ module Fox # # === File List options # - # +FILELIST_SHOWHIDDEN+:: Show hidden files or directories - # +FILELIST_SHOWDIRS+:: Show only directories - # +FILELIST_SHOWFILES+:: Show only files - # +FILELIST_SHOWIMAGES+:: Show preview of images - # +FILELIST_NO_OWN_ASSOC+:: Do not create associations for files - # +FILELIST_NO_PARENT+:: Suppress display of '.' and '..' + # +FILELIST_SHOWHIDDEN+:: Show hidden files or directories + # +FILELIST_SHOWDIRS+:: Show only directories + # +FILELIST_SHOWFILES+:: Show only files + # +FILELIST_SHOWIMAGES+:: Show preview of images + # +FILELIST_NO_OWN_ASSOC+:: Do not create associations for files + # +FILELIST_NO_PARENT+:: Suppress display of '.' and '..' # # === Message identifiers # - # +ID_SORT_BY_NAME+:: Sort by name - # +ID_SORT_BY_TYPE+:: Sort by type - # +ID_SORT_BY_SIZE+:: Sort by size - # +ID_SORT_BY_TIME+:: Sort by access time - # +ID_SORT_BY_USER+:: Sort by user name - # +ID_SORT_BY_GROUP+:: Sort by group name - # +ID_SORT_REVERSE+:: Reverse sort order - # +ID_DIRECTORY_UP+:: Move up one directory - # +ID_SET_PATTERN+:: Set match pattern - # +ID_SET_DIRECTORY+:: Set directory - # +ID_SHOW_HIDDEN+:: Show hidden files - # +ID_HIDE_HIDDEN+:: Hide hidden files - # +ID_TOGGLE_HIDDEN+:: Toggle visibility of hidden files - # +ID_REFRESHTIMER+:: x - # +ID_OPENTIMER+:: x - # +ID_TOGGLE_IMAGES+:: Toggle display of images - # +ID_REFRESH+:: Refresh immediately + # +ID_SORT_BY_NAME+:: Sort by name + # +ID_SORT_BY_TYPE+:: Sort by type + # +ID_SORT_BY_SIZE+:: Sort by size + # +ID_SORT_BY_TIME+:: Sort by access time + # +ID_SORT_BY_USER+:: Sort by user name + # +ID_SORT_BY_GROUP+:: Sort by group name + # +ID_SORT_REVERSE+:: Reverse sort order + # +ID_DIRECTORY_UP+:: Move up one directory + # +ID_SET_PATTERN+:: Set match pattern + # +ID_SET_DIRECTORY+:: Set directory + # +ID_SHOW_HIDDEN+:: Show hidden files + # +ID_HIDE_HIDDEN+:: Hide hidden files + # +ID_TOGGLE_HIDDEN+:: Toggle visibility of hidden files + # +ID_REFRESHTIMER+:: x + # +ID_OPENTIMER+:: x + # +ID_TOGGLE_IMAGES+:: Toggle display of images + # +ID_REFRESH+:: Refresh immediately # class FXFileList < FXIconList diff --git a/rdoc-sources/FXFileSelector.rb b/rdoc-sources/FXFileSelector.rb index 41a905dff08bb148a6b3d661a7647b9ed230c43b..f792578f287afa838eb1827842b5161322a73468 100755 --- a/rdoc-sources/FXFileSelector.rb +++ b/rdoc-sources/FXFileSelector.rb @@ -4,42 +4,42 @@ module Fox # # === File selection modes # - # +SELECTFILE_ANY+:: A single file, existing or not (to save to) - # +SELECTFILE_EXISTING+:: An existing file (to load) - # +SELECTFILE_MULTIPLE+:: Multiple existing files - # +SELECTFILE_MULTIPLE_ALL+:: Multiple existing files or directories, but not '.' and '..' - # +SELECTFILE_DIRECTORY+:: Existing directory, including '.' or '..' + # +SELECTFILE_ANY+:: A single file, existing or not (to save to) + # +SELECTFILE_EXISTING+:: An existing file (to load) + # +SELECTFILE_MULTIPLE+:: Multiple existing files + # +SELECTFILE_MULTIPLE_ALL+:: Multiple existing files or directories, but not '.' and '..' + # +SELECTFILE_DIRECTORY+:: Existing directory, including '.' or '..' # # === Wildcard matching modes # - # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows). - # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\"). - # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix). - # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match. - # +FILEMATCH_CASEFOLD+:: Compare without regard to case. + # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows). + # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\"). + # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix). + # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match. + # +FILEMATCH_CASEFOLD+:: Compare without regard to case. # # Note that under Windows, +FILEMATCH_NOESCAPE+ must be passed. # # === Message identifiers # - # +ID_FILEFILTER+:: x - # +ID_ACCEPT+:: x - # +ID_FILELIST+:: x - # +ID_DIRECTORY_UP+:: x - # +ID_DIRTREE+:: x - # +ID_NORMAL_SIZE+:: x - # +ID_MEDIUM_SIZE+:: x - # +ID_GIANT_SIZE+:: x - # +ID_HOME+:: x - # +ID_WORK+:: x - # +ID_BOOKMARK+:: x - # +ID_BOOKMENU+:: x - # +ID_VISIT+:: x - # +ID_NEW+:: x - # +ID_DELETE+:: x - # +ID_MOVE+:: x - # +ID_COPY+:: x - # +ID_LINK+:: x + # +ID_FILEFILTER+:: x + # +ID_ACCEPT+:: x + # +ID_FILELIST+:: x + # +ID_DIRECTORY_UP+:: x + # +ID_DIRTREE+:: x + # +ID_NORMAL_SIZE+:: x + # +ID_MEDIUM_SIZE+:: x + # +ID_GIANT_SIZE+:: x + # +ID_HOME+:: x + # +ID_WORK+:: x + # +ID_BOOKMARK+:: x + # +ID_BOOKMENU+:: x + # +ID_VISIT+:: x + # +ID_NEW+:: x + # +ID_DELETE+:: x + # +ID_MOVE+:: x + # +ID_COPY+:: x + # +ID_LINK+:: x # class FXFileSelector < FXPacker diff --git a/rdoc-sources/FXFileStream.rb b/rdoc-sources/FXFileStream.rb index 321d6cc566d7addb5008471648aacb1e1d6d1787..d98d5255309c1251dae0294c054b81a0f7e8fece 100755 --- a/rdoc-sources/FXFileStream.rb +++ b/rdoc-sources/FXFileStream.rb @@ -17,9 +17,9 @@ module Fox # # ==== Parameters: # - # +filename+:: name of the file to open [String] - # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer] - # +size+:: buffer size [Integer] + # +filename+:: name of the file to open [String] + # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer] + # +size+:: buffer size [Integer] # def open(filename, save_or_load, size=8192); end end diff --git a/rdoc-sources/FXFoldingList.rb b/rdoc-sources/FXFoldingList.rb index 84c8dd6ffd680d329f7a2eb5c87d718f3fee0f36..ca28456aa98911dca766a3f97806132e25db5ae2 100755 --- a/rdoc-sources/FXFoldingList.rb +++ b/rdoc-sources/FXFoldingList.rb @@ -5,55 +5,55 @@ module Fox class FXFoldingItem < FXObject # Parent item [FXFoldingItem] - attr_reader :parent + attr_reader :parent # Next sibling item [FXFoldingItem] - attr_reader :next + attr_reader :next # Previous sibling item [FXFoldingItem] - attr_reader :prev + attr_reader :prev # First child item [FXFoldingItem] - attr_reader :first + attr_reader :first # Last child item [FXFoldingItem] - attr_reader :last + attr_reader :last # Item logically below this item [FXFoldingItem] - attr_reader :below + attr_reader :below # Item logically above this item [FXFoldingItem] - attr_reader :above + attr_reader :above # Number of child items [Integer] - attr_reader :numChildren + attr_reader :numChildren # Item text [String] - attr_accessor :text + attr_accessor :text # Open icon [FXIcon] - attr_accessor :openIcon + attr_accessor :openIcon # Closed icon [FXIcon] - attr_accessor :closedIcon + attr_accessor :closedIcon # User data [Object] - attr_accessor :data + attr_accessor :data # Indicates whether the item is selected [Boolean] - attr_writer :selected + attr_writer :selected # Indicates whether the item is opened [Boolean] - attr_writer :opened + attr_writer :opened # Indicates whether the item is expanded [Boolean] - attr_writer :expanded + attr_writer :expanded # Indicates whether the item is enabled [Boolean] - attr_writer :enabled + attr_writer :enabled # Indicates whether the item is draggable [Boolean] - attr_writer :draggable + attr_writer :draggable # Construct a new folding item def initialize(text, openIcon=nil, closedIcon=nil, data=nil) # :yields: theItem @@ -154,37 +154,37 @@ module Fox # # The following messages are sent by FXFoldingList to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_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_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. - # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. - # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. - # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance). - # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance). - # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXFoldingItem instance). - # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXFoldingItem instance). - # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_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_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. + # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. + # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or +nil+ if no item was clicked. + # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance). + # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance). + # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXFoldingItem instance). + # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXFoldingItem instance). + # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXFoldingItem instance). # # === Folding list styles # - # +FOLDINGLIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items - # +FOLDINGLIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected - # +FOLDINGLIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times - # +FOLDINGLIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items - # +FOLDINGLIST_AUTOSELECT+:: Automatically select under cursor - # +FOLDINGLIST_SHOWS_LINES+:: Lines shown - # +FOLDINGLIST_SHOWS_BOXES+:: Boxes to expand shown - # +FOLDINGLIST_ROOT_BOXES+:: Display root boxes also - # +FOLDINGLIST_NORMAL+:: same as +FOLDINGLIST_EXTENDEDSELECT+ + # +FOLDINGLIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items + # +FOLDINGLIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected + # +FOLDINGLIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times + # +FOLDINGLIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items + # +FOLDINGLIST_AUTOSELECT+:: Automatically select under cursor + # +FOLDINGLIST_SHOWS_LINES+:: Lines shown + # +FOLDINGLIST_SHOWS_BOXES+:: Boxes to expand shown + # +FOLDINGLIST_ROOT_BOXES+:: Display root boxes also + # +FOLDINGLIST_NORMAL+:: same as +FOLDINGLIST_EXTENDEDSELECT+ class FXFoldingList < FXScrollArea @@ -195,7 +195,7 @@ module Fox attr_reader :numHeaders # Number of items [Integer] - attr_reader :numItems + attr_reader :numItems # Number of visible items [Integer] attr_accessor :numVisible @@ -213,7 +213,7 @@ module Fox attr_accessor :anchorItem # Item under the cursor, if any [FXFoldingItem] - attr_reader :cursorItem + attr_reader :cursorItem # Text font [FXFont] attr_accessor :font @@ -244,14 +244,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this folding list [FXComposite] - # +target+:: the message target, if any, for this folding list [FXObject] - # +selector+:: the message identifier for this folding list [Integer] - # +opts+:: folding list options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent window for this folding list [FXComposite] + # +target+:: the message target, if any, for this folding list [FXObject] + # +selector+:: the message identifier for this folding list [Integer] + # +opts+:: folding list options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, target=nil, selector=0, opts=TREELIST_NORMAL, x=0, y=0, width=0, height=0) # :yields: theFoldingList end @@ -343,7 +343,7 @@ module Fox # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message # target before the item is removed. # - def removeItem(item, notify=false); + def removeItem(item, notify=false); end # Remove items in range [_fromItem_, _toItem_] inclusively. # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message diff --git a/rdoc-sources/FXFont.rb b/rdoc-sources/FXFont.rb index 248c1b507ed7da19aed6f2e4d45996587f345334..18eab478438c96aab02d71de0870953ac5bceaf4 100755 --- a/rdoc-sources/FXFont.rb +++ b/rdoc-sources/FXFont.rb @@ -40,132 +40,132 @@ module Fox # # === Font pitch hints # - # +Fixed+:: Fixed pitch, mono-spaced - # +Variable+:: Variable pitch, proportional spacing + # +Fixed+:: Fixed pitch, mono-spaced + # +Variable+:: Variable pitch, proportional spacing # # === Font style hints # - # +Decorative+:: Fancy fonts - # +Modern+:: Monospace typewriter font - # +Roman+:: Variable width times-like font, serif - # +Script+:: Script or cursive - # +Swiss+:: Helvetica/swiss type font, sans-serif - # +System+:: System font - # +X11+:: Raw X11 font string - # +Scalable+:: Scalable fonts - # +Polymorphic+:: Polymorphic fonts, e.g. parametric weight, slant, etc. - # +Rotatable+:: Rotatable fonts + # +Decorative+:: Fancy fonts + # +Modern+:: Monospace typewriter font + # +Roman+:: Variable width times-like font, serif + # +Script+:: Script or cursive + # +Swiss+:: Helvetica/swiss type font, sans-serif + # +System+:: System font + # +X11+:: Raw X11 font string + # +Scalable+:: Scalable fonts + # +Polymorphic+:: Polymorphic fonts, e.g. parametric weight, slant, etc. + # +Rotatable+:: Rotatable fonts # # === Font slant options # - # +ReverseOblique+:: Reversed oblique - # +ReverseItalic+:: Reversed italic - # +Straight+:: Straight, not slanted - # +Italic+:: Italics - # +Oblique+:: Oblique slant + # +ReverseOblique+:: Reversed oblique + # +ReverseItalic+:: Reversed italic + # +Straight+:: Straight, not slanted + # +Italic+:: Italics + # +Oblique+:: Oblique slant # # === Font weight options # - # +Thin+:: Thin - # +ExtraLight+:: Extra light - # +Light+:: Light - # +Normal+:: Normal or regular weight - # +Medium+:: Medium bold face - # +DemiBold+:: Demi bold face - # +Bold+:: Bold face - # +ExtraBold+:: Extra - # +Black+:: Black + # +Thin+:: Thin + # +ExtraLight+:: Extra light + # +Light+:: Light + # +Normal+:: Normal or regular weight + # +Medium+:: Medium bold face + # +DemiBold+:: Demi bold face + # +Bold+:: Bold face + # +ExtraBold+:: Extra + # +Black+:: Black # # === Condensed or expanded options # - # +UltraCondensed+:: Ultra condensed printing - # +ExtraCondensed+:: Extra condensed - # +Condensed+:: Condensed - # +SemiCondensed+:: Semi-condensed - # +NonExpanded+:: Regular printing - # +SemiExpanded+:: Semi expanded - # +Expanded+:; Expanded - # +ExtraExpanded+:: Extra expanded - # +UltraExpanded+:: Ultra expanded + # +UltraCondensed+:: Ultra condensed printing + # +ExtraCondensed+:: Extra condensed + # +Condensed+:: Condensed + # +SemiCondensed+:: Semi-condensed + # +NonExpanded+:: Regular printing + # +SemiExpanded+:: Semi expanded + # +Expanded+:; Expanded + # +ExtraExpanded+:: Extra expanded + # +UltraExpanded+:: Ultra expanded # # === Font character set encoding # - # <tt>FONTENCODING_DEFAULT</tt>:: Don't care character encoding - # <tt>FONTENCODING_ISO_8859_1</tt>:: West European (Latin1) - # <tt>FONTENCODING_ISO_8859_2</tt>:: Central and East European (Latin2) - # <tt>FONTENCODING_ISO_8859_3</tt>:: Esperanto (Latin3) - # <tt>FONTENCODING_ISO_8859_4</tt>:: ISO-8859-4 character encoding - # <tt>FONTENCODING_ISO_8859_5</tt>:: Cyrillic (almost obsolete) - # <tt>FONTENCODING_ISO_8859_6</tt>:: Arabic - # <tt>FONTENCODING_ISO_8859_7</tt>:: Greek - # <tt>FONTENCODING_ISO_8859_8</tt>:: Hebrew - # <tt>FONTENCODING_ISO_8859_9</tt>:: Turkish (Latin5) - # <tt>FONTENCODING_ISO_8859_10</tt>:: ISO-8859-10 character encoding - # <tt>FONTENCODING_ISO_8859_11</tt>:: Thai - # <tt>FONTENCODING_ISO_8859_13</tt>:: Baltic - # <tt>FONTENCODING_ISO_8859_14</tt>:: ISO-8859-14 character encoding - # <tt>FONTENCODING_ISO_8859_15</tt>:: ISO-8859-15 character encoding - # <tt>FONTENCODING_ISO_8859_16</tt>:: ISO-8859-16 character encoding - # <tt>FONTENCODING_KOI8</tt>:: KOI-8 character encoding - # <tt>FONTENCODING_KOI8_R</tt>:: Russian - # <tt>FONTENCODING_KOI8_U</tt>:: Ukrainian - # <tt>FONTENCODING_KOI8_UNIFIED</tt>:: x + # <tt>FONTENCODING_DEFAULT</tt>:: Don't care character encoding + # <tt>FONTENCODING_ISO_8859_1</tt>:: West European (Latin1) + # <tt>FONTENCODING_ISO_8859_2</tt>:: Central and East European (Latin2) + # <tt>FONTENCODING_ISO_8859_3</tt>:: Esperanto (Latin3) + # <tt>FONTENCODING_ISO_8859_4</tt>:: ISO-8859-4 character encoding + # <tt>FONTENCODING_ISO_8859_5</tt>:: Cyrillic (almost obsolete) + # <tt>FONTENCODING_ISO_8859_6</tt>:: Arabic + # <tt>FONTENCODING_ISO_8859_7</tt>:: Greek + # <tt>FONTENCODING_ISO_8859_8</tt>:: Hebrew + # <tt>FONTENCODING_ISO_8859_9</tt>:: Turkish (Latin5) + # <tt>FONTENCODING_ISO_8859_10</tt>:: ISO-8859-10 character encoding + # <tt>FONTENCODING_ISO_8859_11</tt>:: Thai + # <tt>FONTENCODING_ISO_8859_13</tt>:: Baltic + # <tt>FONTENCODING_ISO_8859_14</tt>:: ISO-8859-14 character encoding + # <tt>FONTENCODING_ISO_8859_15</tt>:: ISO-8859-15 character encoding + # <tt>FONTENCODING_ISO_8859_16</tt>:: ISO-8859-16 character encoding + # <tt>FONTENCODING_KOI8</tt>:: KOI-8 character encoding + # <tt>FONTENCODING_KOI8_R</tt>:: Russian + # <tt>FONTENCODING_KOI8_U</tt>:: Ukrainian + # <tt>FONTENCODING_KOI8_UNIFIED</tt>:: x # - # <tt>FONTENCODING_CP437</tt>:: IBM-PC code page - # <tt>FONTENCODING_CP850</tt>:: IBM-PC Multilingual - # <tt>FONTENCODING_CP851</tt>:: IBM-PC Greek - # <tt>FONTENCODING_CP852</tt>:: IBM-PC Latin2 - # <tt>FONTENCODING_CP855</tt>:: IBM-PC Cyrillic - # <tt>FONTENCODING_CP856</tt>:: IBM-PC Hebrew - # <tt>FONTENCODING_CP857</tt>:: IBM-PC Turkish - # <tt>FONTENCODING_CP860</tt>:: IBM-PC Portugese - # <tt>FONTENCODING_CP861</tt>:: IBM-PC Iceland - # <tt>FONTENCODING_CP862</tt>:: IBM-PC Israel - # <tt>FONTENCODING_CP863</tt>:: IBM-PC Canadian/French - # <tt>FONTENCODING_CP864</tt>:: IBM-PC Arabic - # <tt>FONTENCODING_CP865</tt>:: IBM-PC Nordic - # <tt>FONTENCODING_CP866</tt>:: IBM-PC Cyrillic #2 - # <tt>FONTENCODING_CP869</tt>:: IBM-PC Greek #2 - # <tt>FONTENCODING_CP870</tt>:: Latin-2 Multilingual + # <tt>FONTENCODING_CP437</tt>:: IBM-PC code page + # <tt>FONTENCODING_CP850</tt>:: IBM-PC Multilingual + # <tt>FONTENCODING_CP851</tt>:: IBM-PC Greek + # <tt>FONTENCODING_CP852</tt>:: IBM-PC Latin2 + # <tt>FONTENCODING_CP855</tt>:: IBM-PC Cyrillic + # <tt>FONTENCODING_CP856</tt>:: IBM-PC Hebrew + # <tt>FONTENCODING_CP857</tt>:: IBM-PC Turkish + # <tt>FONTENCODING_CP860</tt>:: IBM-PC Portugese + # <tt>FONTENCODING_CP861</tt>:: IBM-PC Iceland + # <tt>FONTENCODING_CP862</tt>:: IBM-PC Israel + # <tt>FONTENCODING_CP863</tt>:: IBM-PC Canadian/French + # <tt>FONTENCODING_CP864</tt>:: IBM-PC Arabic + # <tt>FONTENCODING_CP865</tt>:: IBM-PC Nordic + # <tt>FONTENCODING_CP866</tt>:: IBM-PC Cyrillic #2 + # <tt>FONTENCODING_CP869</tt>:: IBM-PC Greek #2 + # <tt>FONTENCODING_CP870</tt>:: Latin-2 Multilingual # - # <tt>FONTENCODING_CP1250</tt>:: Windows Central European - # <tt>FONTENCODING_CP1251</tt>:: Windows Russian - # <tt>FONTENCODING_CP1252</tt>:: Windows Latin1 - # <tt>FONTENCODING_CP1253</tt>:: Windows Greek - # <tt>FONTENCODING_CP1254</tt>:: Windows Turkish - # <tt>FONTENCODING_CP1255</tt>:: Windows Hebrew - # <tt>FONTENCODING_CP1256</tt>:: Windows Arabic - # <tt>FONTENCODING_CP1257</tt>:: Windows Baltic - # <tt>FONTENCODING_CP1258</tt>:: Windows Vietnam - # <tt>FONTENCODING_CP874</tt>:: Windows Thai + # <tt>FONTENCODING_CP1250</tt>:: Windows Central European + # <tt>FONTENCODING_CP1251</tt>:: Windows Russian + # <tt>FONTENCODING_CP1252</tt>:: Windows Latin1 + # <tt>FONTENCODING_CP1253</tt>:: Windows Greek + # <tt>FONTENCODING_CP1254</tt>:: Windows Turkish + # <tt>FONTENCODING_CP1255</tt>:: Windows Hebrew + # <tt>FONTENCODING_CP1256</tt>:: Windows Arabic + # <tt>FONTENCODING_CP1257</tt>:: Windows Baltic + # <tt>FONTENCODING_CP1258</tt>:: Windows Vietnam + # <tt>FONTENCODING_CP874</tt>:: Windows Thai # - # <tt>FONTENCODING_UNICODE</tt>:: Unicode + # <tt>FONTENCODING_UNICODE</tt>:: Unicode # - # <tt>FONTENCODING_LATIN1</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 (West European) - # <tt>FONTENCODING_LATIN2</tt>:: same as <tt>FONTENCODING_ISO_8859_2</tt>, Latin 2 (East European) - # <tt>FONTENCODING_LATIN3</tt>:: same as <tt>FONTENCODING_ISO_8859_3</tt>, Latin 3 (South European) - # <tt>FONTENCODING_LATIN4</tt>:: same as <tt>FONTENCODING_ISO_8859_4</tt>, Latin 4 (North European) - # <tt>FONTENCODING_LATIN5</tt>:: same as <tt>FONTENCODING_ISO_8859_9</tt>, Latin 5 (Turkish) - # <tt>FONTENCODING_LATIN6</tt>:: same as <tt>FONTENCODING_ISO_8859_10</tt>, Latin 6 (Nordic) - # <tt>FONTENCODING_LATIN7</tt>:: same as <tt>FONTENCODING_ISO_8859_13</tt>, Latin 7 (Baltic Rim) - # <tt>FONTENCODING_LATIN8</tt>:: same as <tt>FONTENCODING_ISO_8859_14</tt>, Latin 8 (Celtic) - # <tt>FONTENCODING_LATIN9</tt>:: same as <tt>FONTENCODING_ISO_8859_15</tt>, Latin 9 (a.k.a. Latin 0) - # <tt>FONTENCODING_LATIN10</tt>:: same as <tt>FONTENCODING_ISO_8859_16</tt>, Latin 10 - # <tt>FONTENCODING_USASCII</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 - # <tt>FONTENCODING_WESTEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 (West European) - # <tt>FONTENCODING_EASTEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_2</tt>, Latin 2 (East European) - # <tt>FONTENCODING_SOUTHEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_3</tt>, Latin 3 (South European) - # <tt>FONTENCODING_NORTHEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_4</tt>, Latin 4 (North European) - # <tt>FONTENCODING_CYRILLIC</tt>:: same as <tt>FONTENCODING_ISO_8859_5</tt>, Cyrillic - # <tt>FONTENCODING_RUSSIAN</tt>:: same as <tt>FONTENCODING_KOI8</tt>, Cyrillic - # <tt>FONTENCODING_ARABIC</tt>:: same as <tt>FONTENCODING_ISO_8859_6</tt>, Arabic - # <tt>FONTENCODING_GREEK</tt>:: same as <tt>FONTENCODING_ISO_8859_7</tt>, Greek - # <tt>FONTENCODING_HEBREW</tt>:: same as <tt>FONTENCODING_ISO_8859_8</tt>, Hebrew - # <tt>FONTENCODING_TURKISH</tt>:: same as <tt>FONTENCODING_ISO_8859_9</tt>, Latin 5 (Turkish) - # <tt>FONTENCODING_NORDIC</tt>:: same as <tt>FONTENCODING_ISO_8859_10</tt>, Latin 6 (Nordic) - # <tt>FONTENCODING_THAI</tt>:: same as <tt>FONTENCODING_ISO_8859_11</tt>, Thai - # <tt>FONTENCODING_BALTIC</tt>:: same as <tt>FONTENCODING_ISO_8859_13</tt>, Latin 7 (Baltic Rim) - # <tt>FONTENCODING_CELTIC</tt>:: same as <tt>FONTENCODING_ISO_8859_14, Latin 8 (Celtic) + # <tt>FONTENCODING_LATIN1</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 (West European) + # <tt>FONTENCODING_LATIN2</tt>:: same as <tt>FONTENCODING_ISO_8859_2</tt>, Latin 2 (East European) + # <tt>FONTENCODING_LATIN3</tt>:: same as <tt>FONTENCODING_ISO_8859_3</tt>, Latin 3 (South European) + # <tt>FONTENCODING_LATIN4</tt>:: same as <tt>FONTENCODING_ISO_8859_4</tt>, Latin 4 (North European) + # <tt>FONTENCODING_LATIN5</tt>:: same as <tt>FONTENCODING_ISO_8859_9</tt>, Latin 5 (Turkish) + # <tt>FONTENCODING_LATIN6</tt>:: same as <tt>FONTENCODING_ISO_8859_10</tt>, Latin 6 (Nordic) + # <tt>FONTENCODING_LATIN7</tt>:: same as <tt>FONTENCODING_ISO_8859_13</tt>, Latin 7 (Baltic Rim) + # <tt>FONTENCODING_LATIN8</tt>:: same as <tt>FONTENCODING_ISO_8859_14</tt>, Latin 8 (Celtic) + # <tt>FONTENCODING_LATIN9</tt>:: same as <tt>FONTENCODING_ISO_8859_15</tt>, Latin 9 (a.k.a. Latin 0) + # <tt>FONTENCODING_LATIN10</tt>:: same as <tt>FONTENCODING_ISO_8859_16</tt>, Latin 10 + # <tt>FONTENCODING_USASCII</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 + # <tt>FONTENCODING_WESTEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_1</tt>, Latin 1 (West European) + # <tt>FONTENCODING_EASTEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_2</tt>, Latin 2 (East European) + # <tt>FONTENCODING_SOUTHEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_3</tt>, Latin 3 (South European) + # <tt>FONTENCODING_NORTHEUROPE</tt>:: same as <tt>FONTENCODING_ISO_8859_4</tt>, Latin 4 (North European) + # <tt>FONTENCODING_CYRILLIC</tt>:: same as <tt>FONTENCODING_ISO_8859_5</tt>, Cyrillic + # <tt>FONTENCODING_RUSSIAN</tt>:: same as <tt>FONTENCODING_KOI8</tt>, Cyrillic + # <tt>FONTENCODING_ARABIC</tt>:: same as <tt>FONTENCODING_ISO_8859_6</tt>, Arabic + # <tt>FONTENCODING_GREEK</tt>:: same as <tt>FONTENCODING_ISO_8859_7</tt>, Greek + # <tt>FONTENCODING_HEBREW</tt>:: same as <tt>FONTENCODING_ISO_8859_8</tt>, Hebrew + # <tt>FONTENCODING_TURKISH</tt>:: same as <tt>FONTENCODING_ISO_8859_9</tt>, Latin 5 (Turkish) + # <tt>FONTENCODING_NORDIC</tt>:: same as <tt>FONTENCODING_ISO_8859_10</tt>, Latin 6 (Nordic) + # <tt>FONTENCODING_THAI</tt>:: same as <tt>FONTENCODING_ISO_8859_11</tt>, Thai + # <tt>FONTENCODING_BALTIC</tt>:: same as <tt>FONTENCODING_ISO_8859_13</tt>, Latin 7 (Baltic Rim) + # <tt>FONTENCODING_CELTIC</tt>:: same as <tt>FONTENCODING_ISO_8859_14, Latin 8 (Celtic) # class FXFont < FXId @@ -176,43 +176,43 @@ module Fox attr_reader :foundry # Font family name [String] - attr_reader :name + attr_reader :name # Actual font family name [String] attr_reader :actualName # Size in decipoints [Integer] - attr_reader :size + attr_reader :size # Actual size in deci-points [Integer] attr_reader :actualSize # Font weight [Integer] - attr_reader :weight + attr_reader :weight # Actual font weight [Integer] attr_reader :actualWeight # Slant [Integer] - attr_reader :slant + attr_reader :slant # Actual slant [Integer] attr_reader :actualSlant # Encoding [Integer] - attr_reader :encoding + attr_reader :encoding # Actual encoding [Integer] attr_reader :actualEncoding # Set width [Integer] - attr_reader :setWidth + attr_reader :setWidth # Actual set width [Integer] attr_reader :actualSetWidth # Hints [Integer] - attr_reader :hints + attr_reader :hints # Font description [FXFontDesc] attr_accessor :fontDesc @@ -224,36 +224,36 @@ module Fox attr_accessor :font. # First character glyph in font [Integer] - attr_reader :minChar + attr_reader :minChar # Last character glyph in font [Integer] - attr_reader :maxChar + attr_reader :maxChar # Width of widest character in font [Integer] - attr_reader :fontWidth + attr_reader :fontWidth # Height of tallest character in font [Integer] - attr_reader :fontHeight + attr_reader :fontHeight # Ascent from baseline [Integer] - attr_reader :fontAscent + attr_reader :fontAscent # Descent from baseline [Integer] - attr_reader :fontDescent + attr_reader :fontDescent # Font leading [Integer] - attr_reader :fontLeading + attr_reader :fontLeading # Font line spacing [Integer] - attr_reader :fontSpacing + attr_reader :fontSpacing # # Return an FXFont instance, initialized from a font description. # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +fontDesc+:: a font description [FXFontDesc] + # +a+:: an application instance [FXApp] + # +fontDesc+:: a font description [FXFontDesc] # def initialize(a, fontDesc) # :yields: theFont end @@ -266,13 +266,13 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +face+:: font face name [String] - # +size+:: requested font size, in points [Integer] - # +weight+:: requested font weight [Integer] - # +encoding+:: requested font encoding [Integer] - # +setWidth+:: requested font set width [Integer] - # +hints+:: font construction hints for font matching algorithm [Integer] + # +a+:: an application instance [FXApp] + # +face+:: font face name [String] + # +size+:: requested font size, in points [Integer] + # +weight+:: requested font weight [Integer] + # +encoding+:: requested font encoding [Integer] + # +setWidth+:: requested font set width [Integer] + # +hints+:: font construction hints for font matching algorithm [Integer] # def initialize(a, face, size, weight=FXFont::Normal, slant=Font::Straight, encoding=FONTENCODING_DEFAULT, setWidth=FXFont::NonExpanded, hints=0) # :yields: theFont end diff --git a/rdoc-sources/FXFontSelector.rb b/rdoc-sources/FXFontSelector.rb index a7658346bbc082a38e4d117d0cd72cbbb5cad82f..713c2a22d8b88926bcbb88b370d6106b5952767b 100755 --- a/rdoc-sources/FXFontSelector.rb +++ b/rdoc-sources/FXFontSelector.rb @@ -4,17 +4,17 @@ module Fox # # === Message identifiers # - # +ID_FAMILY+:: x - # +ID_WEIGHT+:: x - # +ID_STYLE+:: x - # +ID_STYLE_TEXT+:: x - # +ID_SIZE+:: x - # +ID_SIZE_TEXT+:: x - # +ID_CHARSET+:: x - # +ID_SETWIDTH+:: x - # +ID_PITCH+:: x - # +ID_SCALABLE+:: x - # +ID_ALLFONTS+:: x + # +ID_FAMILY+:: x + # +ID_WEIGHT+:: x + # +ID_STYLE+:: x + # +ID_STYLE_TEXT+:: x + # +ID_SIZE+:: x + # +ID_SIZE_TEXT+:: x + # +ID_CHARSET+:: x + # +ID_SETWIDTH+:: x + # +ID_PITCH+:: x + # +ID_SCALABLE+:: x + # +ID_ALLFONTS+:: x # class FXFontSelector < FXPacker diff --git a/rdoc-sources/FXFrame.rb b/rdoc-sources/FXFrame.rb index 573e6b150d8ac0bfbce3ecd0193649611e61daeb..3304d94a6feb0a66efa9463c5885e731c9c47732 100755 --- a/rdoc-sources/FXFrame.rb +++ b/rdoc-sources/FXFrame.rb @@ -18,7 +18,7 @@ module Fox attr_accessor :frameStyle # Border width, in pixels [Integer] - attr_reader :borderWidth + attr_reader :borderWidth # Top interior padding, in pixels [Integer] attr_accessor :padTop diff --git a/rdoc-sources/FXGIFCursor.rb b/rdoc-sources/FXGIFCursor.rb index 052c7087a81076e736459b50a41f56936275335f..581124854b46584f0e294dd11671539eb5185f21 100755 --- a/rdoc-sources/FXGIFCursor.rb +++ b/rdoc-sources/FXGIFCursor.rb @@ -23,11 +23,11 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [Array of FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] - # +fast+:: if +true+, use faster Floyd-Steinberg algorithm [Boolean] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [Array of FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] + # +fast+:: if +true+, use faster Floyd-Steinberg algorithm [Boolean] # def Fox.fxsaveGIF(store, data, width, height, fast=true); end @@ -39,7 +39,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadGIF(store); end diff --git a/rdoc-sources/FXGIFIcon.rb b/rdoc-sources/FXGIFIcon.rb index b7057e1f910f5d7f07fe270b7e9ef090958087d4..dab8910ecdcc56c666641805a949c4faad00f1d0 100755 --- a/rdoc-sources/FXGIFIcon.rb +++ b/rdoc-sources/FXGIFIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in GIF file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in GIF file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theGIFIcon end diff --git a/rdoc-sources/FXGIFImage.rb b/rdoc-sources/FXGIFImage.rb index 8f5d55587aa29c3ad91ba42d85271a79a6e8d1bc..bfe19543000be35c55ed0b120c7f6b1c6858fc5d 100755 --- a/rdoc-sources/FXGIFImage.rb +++ b/rdoc-sources/FXGIFImage.rb @@ -16,11 +16,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in GIF file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in GIF file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theGIFImage end diff --git a/rdoc-sources/FXGLObject.rb b/rdoc-sources/FXGLObject.rb index bffdaa80f90e42b2adf9088a512f5c72515a93f1..e056274e64291291f6cdc24072bf2dbb1d0d7fa6 100755 --- a/rdoc-sources/FXGLObject.rb +++ b/rdoc-sources/FXGLObject.rb @@ -24,7 +24,7 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window into which we're drawing [FXGLViewer] + # +viewer+:: the viewer window into which we're drawing [FXGLViewer] # def draw(viewer); end @@ -33,7 +33,7 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window into which we're drawing [FXGLViewer] + # +viewer+:: the viewer window into which we're drawing [FXGLViewer] # def hit(viewer); end @@ -53,11 +53,11 @@ module Fox # # ==== Parameters: # - # +viewer+:: the viewer window in which we're dragging [FXGLViewer] - # +fx+:: x-coordinate for position we're dragging from [Integer] - # +fy+:: y-coordinate for position we're dragging from [Integer] - # +tx+:: x-coordinate for position we're dragging to [Integer] - # +ty+:: y-coordinate for position we're dragging to [Integer] + # +viewer+:: the viewer window in which we're dragging [FXGLViewer] + # +fx+:: x-coordinate for position we're dragging from [Integer] + # +fy+:: y-coordinate for position we're dragging from [Integer] + # +tx+:: x-coordinate for position we're dragging to [Integer] + # +ty+:: y-coordinate for position we're dragging to [Integer] # def drag(viewer, fx, fy, tx, ty); end @@ -67,7 +67,7 @@ module Fox # # ==== Parameters: # - # +path+:: an array of integers [Array] + # +path+:: an array of integers [Array] # def identify(path); end end diff --git a/rdoc-sources/FXGLShape.rb b/rdoc-sources/FXGLShape.rb index da24a9dfde16139d17bdf2e318e57bd2fdd7205c..e9ac67b6875b44125615e1799d06992066ca9efd 100755 --- a/rdoc-sources/FXGLShape.rb +++ b/rdoc-sources/FXGLShape.rb @@ -4,31 +4,31 @@ module Fox # # === Shape drawing options # - # +SURFACE_SINGLESIDED+:: Single-sided [both sides same] - # +SURFACE_DUALSIDED+:: Dual-sided surface - # +SHADING_NONE+:: No light source - # +SHADING_SMOOTH+:: Smooth shaded - # +SHADING_FLAT+:: Flag shaded - # +FACECULLING_OFF+:: No face culling - # +FACECULLING_ON+:: Cull backward facing surfaces - # +STYLE_SURFACE+:: Draw filled surfaces - # +STYLE_WIREFRAME+:: Draw wire frame - # +STYLE_POINTS+:: Draw as points - # +STYLE_BOUNDBOX+:: Draw bounding box + # +SURFACE_SINGLESIDED+:: Single-sided [both sides same] + # +SURFACE_DUALSIDED+:: Dual-sided surface + # +SHADING_NONE+:: No light source + # +SHADING_SMOOTH+:: Smooth shaded + # +SHADING_FLAT+:: Flag shaded + # +FACECULLING_OFF+:: No face culling + # +FACECULLING_ON+:: Cull backward facing surfaces + # +STYLE_SURFACE+:: Draw filled surfaces + # +STYLE_WIREFRAME+:: Draw wire frame + # +STYLE_POINTS+:: Draw as points + # +STYLE_BOUNDBOX+:: Draw bounding box # # === Message identifiers # - # +ID_SHADEOFF+:: x - # +ID_SHADEON+:: x - # +ID_SHADESMOOTH+:: x - # +ID_TOGGLE_SIDED+:: x - # +ID_TOGGLE_CULLING+:: x - # +ID_STYLE_POINTS+:: x - # +ID_STYLE_WIREFRAME+:: x - # +ID_STYLE_SURFACE+:: x - # +ID_STYLE_BOUNDINGBOX+:: x - # +ID_FRONT_MATERIAL+:: x - # +ID_BACK_MATERIAL+:: x + # +ID_SHADEOFF+:: x + # +ID_SHADEON+:: x + # +ID_SHADESMOOTH+:: x + # +ID_TOGGLE_SIDED+:: x + # +ID_TOGGLE_CULLING+:: x + # +ID_STYLE_POINTS+:: x + # +ID_STYLE_WIREFRAME+:: x + # +ID_STYLE_SURFACE+:: x + # +ID_STYLE_BOUNDINGBOX+:: x + # +ID_FRONT_MATERIAL+:: x + # +ID_BACK_MATERIAL+:: x # class FXGLShape < FXGLObject diff --git a/rdoc-sources/FXGLViewer.rb b/rdoc-sources/FXGLViewer.rb index ded58bfa9121fee9d48f5f4e46a42e923aa02096..78506567852354c912c88b1044e381f1cb271af7 100755 --- a/rdoc-sources/FXGLViewer.rb +++ b/rdoc-sources/FXGLViewer.rb @@ -93,44 +93,44 @@ module Fox # # The following messages are sent by FXGLViewer to its message target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_MOTION+:: sent when the mouse pointer is moved; the message data is an FXEvent instance. - # +SEL_MOUSEWHEEL+:: sent when the mouse wheel is spun; the message data is an FXEvent instance. - # +SEL_CLICKED+:: sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) - # +SEL_DOUBLECLICKED+:: sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) - # +SEL_TRIPLECLICKED+:: sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) - # +SEL_PICKED+:: sent when an object is picked; the message data is an FXEvent instance. - # +SEL_SELECTED+:: sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects. - # +SEL_DESELECTED+:: sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects. - # +SEL_LASSOED+:: sent when a lasso-selection has been completed; the message data is an FXEvent instance. - # +SEL_INSERTED+:: sent when the viewer receives a +SEL_INSERTED+ message. - # +SEL_DELETED+:: sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s). - # +SEL_DRAGGED+:: sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object. - # +SEL_COMMAND+:: sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) - # +SEL_CHANGED+:: sent when the selection changes; the message data is a reference to the newly selected object (or +nil+). + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_MOTION+:: sent when the mouse pointer is moved; the message data is an FXEvent instance. + # +SEL_MOUSEWHEEL+:: sent when the mouse wheel is spun; the message data is an FXEvent instance. + # +SEL_CLICKED+:: sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) + # +SEL_DOUBLECLICKED+:: sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) + # +SEL_TRIPLECLICKED+:: sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) + # +SEL_PICKED+:: sent when an object is picked; the message data is an FXEvent instance. + # +SEL_SELECTED+:: sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects. + # +SEL_DESELECTED+:: sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects. + # +SEL_LASSOED+:: sent when a lasso-selection has been completed; the message data is an FXEvent instance. + # +SEL_INSERTED+:: sent when the viewer receives a +SEL_INSERTED+ message. + # +SEL_DELETED+:: sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s). + # +SEL_DRAGGED+:: sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object. + # +SEL_COMMAND+:: sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+) + # +SEL_CHANGED+:: sent when the selection changes; the message data is a reference to the newly selected object (or +nil+). # # === FXGLViewer options # - # +VIEWER_LIGHTING+:: Lighting is on - # +VIEWER_FOG+:: Fog mode on - # +VIEWER_DITHER+:: Dithering + # +VIEWER_LIGHTING+:: Lighting is on + # +VIEWER_FOG+:: Fog mode on + # +VIEWER_DITHER+:: Dithering # # === Projection modes (class constants) # - # +PARALLEL+:: Parallel projection - # +PERSPECTIVE+:: Perspective projection + # +PARALLEL+:: Parallel projection + # +PERSPECTIVE+:: Perspective projection # # === Message identifiers # - # +ID_PERSPECTIVE+:: x - # +ID_PARALLEL+:: x + # +ID_PERSPECTIVE+:: x + # +ID_PARALLEL+:: x # +ID_FRONT+:: x # +ID_BACK+:: x # +ID_LEFT+:: x diff --git a/rdoc-sources/FXGLVisual.rb b/rdoc-sources/FXGLVisual.rb index fa8a61f9270784ec5a4474a385fb90ed060d40f0..b341b8be2d137073a320a66b1a299c91717073e6 100755 --- a/rdoc-sources/FXGLVisual.rb +++ b/rdoc-sources/FXGLVisual.rb @@ -68,6 +68,7 @@ module Fox # Construct default visual # def initialize(app, flags) # :yields: theGLVisual + end # # Test if OpenGL is possible, and what level is supported. diff --git a/rdoc-sources/FXGradientBar.rb b/rdoc-sources/FXGradientBar.rb index c3a71d66b6fee42cfc0aa8d1cc21f86d227976eb..4556f5081dcb9012177c17b17defb83740e6f505 100755 --- a/rdoc-sources/FXGradientBar.rb +++ b/rdoc-sources/FXGradientBar.rb @@ -34,43 +34,43 @@ module Fox # # The following messages are sent by FXGradientBar 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_CHANGED+:: sent when anything about a segment changes; the message data is an integer indicating the segment number - # +SEL_SELECTED+:: sent when one or more segments are selected. - # +SEL_DESELECTED+:: sent when one or more segments are deselected. + # +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 anything about a segment changes; the message data is an integer indicating the segment number + # +SEL_SELECTED+:: sent when one or more segments are selected. + # +SEL_DESELECTED+:: sent when one or more segments are deselected. # # === Gradient bar orientation # - # +GRADIENTBAR_HORIZONTAL+:: Gradient bar shown horizontally - # +GRADIENTBAR_VERTICAL+:: Gradient bar shown vertically - # +GRADIENTBAR_NO_CONTROLS+:: No controls shown - # +GRADIENTBAR_CONTROLS_TOP+:: Controls on top - # +GRADIENTBAR_CONTROLS_BOTTOM+:: Controls on bottom - # +GRADIENTBAR_CONTROLS_LEFT+:: Controls on left - # +GRADIENTBAR_CONTROLS_RIGHT+:: Controls on right + # +GRADIENTBAR_HORIZONTAL+:: Gradient bar shown horizontally + # +GRADIENTBAR_VERTICAL+:: Gradient bar shown vertically + # +GRADIENTBAR_NO_CONTROLS+:: No controls shown + # +GRADIENTBAR_CONTROLS_TOP+:: Controls on top + # +GRADIENTBAR_CONTROLS_BOTTOM+:: Controls on bottom + # +GRADIENTBAR_CONTROLS_LEFT+:: Controls on left + # +GRADIENTBAR_CONTROLS_RIGHT+:: Controls on right # # === Blend modes # - # +GRADIENT_BLEND_LINEAR+:: Linear blend - # +GRADIENT_BLEND_POWER+:: Power law blend - # +GRADIENT_BLEND_SINE+:: Sine blend - # +GRADIENT_BLEND_INCREASING+:: Quadratic increasing blend - # +GRADIENT_BLEND_DECREASING+:: Quadratic decreasing blend + # +GRADIENT_BLEND_LINEAR+:: Linear blend + # +GRADIENT_BLEND_POWER+:: Power law blend + # +GRADIENT_BLEND_SINE+:: Sine blend + # +GRADIENT_BLEND_INCREASING+:: Quadratic increasing blend + # +GRADIENT_BLEND_DECREASING+:: Quadratic decreasing blend # # === Message identifiers # - # +ID_LOWER_COLOR+:: write me - # +ID_UPPER_COLOR+:: write me - # +ID_BLEND_LINEAR+:: write me - # +ID_BLEND_POWER+:: write me - # +ID_BLEND_SINE+:: write me - # +ID_BLEND_INCREASING+:: write me - # +ID_BLEND_DECREASING+:: write me - # +ID_RECENTER+:: write me - # +ID_SPLIT+:: write me - # +ID_MERGE+:: write me - # +ID_UNIFORM+:: write me + # +ID_LOWER_COLOR+:: write me + # +ID_UPPER_COLOR+:: write me + # +ID_BLEND_LINEAR+:: write me + # +ID_BLEND_POWER+:: write me + # +ID_BLEND_SINE+:: write me + # +ID_BLEND_INCREASING+:: write me + # +ID_BLEND_DECREASING+:: write me + # +ID_RECENTER+:: write me + # +ID_SPLIT+:: write me + # +ID_MERGE+:: write me + # +ID_UNIFORM+:: write me # class FXGradientBar < FXFrame diff --git a/rdoc-sources/FXGroupBox.rb b/rdoc-sources/FXGroupBox.rb index 651a340563934203d8e7433e2868691b6040c50b..83718cf62f59b03c870dab26b29165bbfbbb86ca 100755 --- a/rdoc-sources/FXGroupBox.rb +++ b/rdoc-sources/FXGroupBox.rb @@ -6,10 +6,10 @@ module Fox # # === Group box options # - # +GROUPBOX_TITLE_LEFT+:: Title is left-justified - # +GROUPBOX_TITLE_CENTER+:: Title is centered - # +GROUPBOX_TITLE_RIGHT+:: Title is right-justified - # +GROUPBOX_NORMAL+:: same as <tt>GROUPBOX_TITLE_LEFT</tt> + # +GROUPBOX_TITLE_LEFT+:: Title is left-justified + # +GROUPBOX_TITLE_CENTER+:: Title is centered + # +GROUPBOX_TITLE_RIGHT+:: Title is right-justified + # +GROUPBOX_NORMAL+:: same as <tt>GROUPBOX_TITLE_LEFT</tt> class FXGroupBox < FXPacker diff --git a/rdoc-sources/FXHeader.rb b/rdoc-sources/FXHeader.rb index 1ad1a7dcf64792d3f5d53d5bf70bbb80d33c9c21..f4c517bccbe218a56881ef1f25065000732e5e0c 100755 --- a/rdoc-sources/FXHeader.rb +++ b/rdoc-sources/FXHeader.rb @@ -4,26 +4,26 @@ module Fox # # === Alignment hints # - # +RIGHT+:: Align on right - # +LEFT+:: Align on left - # +CENTER_X+:: Align centered horizontally (default) - # +TOP+:: Align on top - # +BOTTOM+:: Align on bottom - # +CENTER_Y+:: Align centered vertically (default) + # +RIGHT+:: Align on right + # +LEFT+:: Align on left + # +CENTER_X+:: Align centered horizontally (default) + # +TOP+:: Align on top + # +BOTTOM+:: Align on bottom + # +CENTER_Y+:: Align centered vertically (default) # # === Icon position # - # +BEFORE+:: Icon before the text - # +AFTER+:: Icon after the text - # +ABOVE+:: Icon above the text - # +BELOW+:: Icon below the text + # +BEFORE+:: Icon before the text + # +AFTER+:: Icon after the text + # +ABOVE+:: Icon above the text + # +BELOW+:: Icon below the text # # === Arrow # - # +ARROW_NONE+:: No arrow - # +ARROW_UP+:: Arrow pointing up - # +ARROW_DOWN+:: Arrow pointing down - # +PRESSED+:: Pressed down + # +ARROW_NONE+:: No arrow + # +ARROW_UP+:: Arrow pointing up + # +ARROW_DOWN+:: Arrow pointing down + # +PRESSED+:: Pressed down # class FXHeaderItem < FXObject @@ -116,24 +116,24 @@ module Fox # +SEL_CLICKED+:: # sent when a header item is clicked; the message data is an integer # indicating the index of the current item. - # +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_REPLACED+:: sent when a header item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. - # +SEL_INSERTED+:: sent after a header item is inserted; the message data is an Integer indicating the index of the item that was inserted. - # +SEL_DELETED+:: sent when a header item is about to be removed; the message data is an Integer indicating the index of the item to be removed. + # +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_REPLACED+:: sent when a header item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. + # +SEL_INSERTED+:: sent after a header item is inserted; the message data is an Integer indicating the index of the item that was inserted. + # +SEL_DELETED+:: sent when a header item is about to be removed; the message data is an Integer indicating the index of the item to be removed. # # === Header style options # - # +HEADER_BUTTON+:: Button style can be clicked - # +HEADER_HORIZONTAL+:: Horizontal header control (default) - # +HEADER_VERTICAL+:: Vertical header control - # +HEADER_TRACKING+:: Tracks continuously while moving - # +HEADER_RESIZE+:: Allow resizing sections - # +HEADER_NORMAL+:: Normal options, same as <tt>HEADER_HORIZONTAL|FRAME_NORMAL</tt> + # +HEADER_BUTTON+:: Button style can be clicked + # +HEADER_HORIZONTAL+:: Horizontal header control (default) + # +HEADER_VERTICAL+:: Vertical header control + # +HEADER_TRACKING+:: Tracks continuously while moving + # +HEADER_RESIZE+:: Allow resizing sections + # +HEADER_NORMAL+:: Normal options, same as <tt>HEADER_HORIZONTAL|FRAME_NORMAL</tt> # # === Message identifiers # - # +ID_TIPTIMER+:: x + # +ID_TIPTIMER+:: x # class FXHeader < FXFrame diff --git a/rdoc-sources/FXHorizontalFrame.rb b/rdoc-sources/FXHorizontalFrame.rb index 002e1fcffc9a5c742eac72e80725339c4067d9a2..da2ed22a77eb41748edff00ba802623c12ff88cc 100755 --- a/rdoc-sources/FXHorizontalFrame.rb +++ b/rdoc-sources/FXHorizontalFrame.rb @@ -10,18 +10,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this horizontal frame [FXComposite] - # +opts+:: frame options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this horizontal frame [FXComposite] + # +opts+:: frame options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theHorizontalFrame end diff --git a/rdoc-sources/FXICOIcon.rb b/rdoc-sources/FXICOIcon.rb index ce1addb6ce140ad6129a173e74069d71dbabc17a..aa35c047f2a4a07185d04016454c35a838369f98 100755 --- a/rdoc-sources/FXICOIcon.rb +++ b/rdoc-sources/FXICOIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in ICO file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in ICO file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theICOIcon end @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadICO(store); end @@ -47,13 +47,13 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +pixels+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] - # +xspot+:: hotspot x-coordinate [Integer] - # +yspot+:: hotspot y-coordinate [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +pixels+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] + # +xspot+:: hotspot x-coordinate [Integer] + # +yspot+:: hotspot y-coordinate [Integer] # def Fox.fxsaveICO(store, pixels, transp, width, height, xspot=-1, yspot=-1); end diff --git a/rdoc-sources/FXICOImage.rb b/rdoc-sources/FXICOImage.rb index 01b4653ecdf9b80d9809b87f397e4c00bb184e03..099f78bbd6ffee347519c2769ca6679335abe171 100755 --- a/rdoc-sources/FXICOImage.rb +++ b/rdoc-sources/FXICOImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in ICO file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in ICO file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theICOImage end diff --git a/rdoc-sources/FXIcon.rb b/rdoc-sources/FXIcon.rb index c99677fbea1cd909501e53849f09e568645600d7..6d64f61d6271025e793057b23264aaa8a552175f 100755 --- a/rdoc-sources/FXIcon.rb +++ b/rdoc-sources/FXIcon.rb @@ -25,12 +25,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: initial pixel buffer [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: initial pixel buffer [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(app, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theIcon end diff --git a/rdoc-sources/FXIconDict.rb b/rdoc-sources/FXIconDict.rb index 6deda6f2b8e1e7cf938347a4bc0b07859688255d..59027b7cafe1a622e420ff2ea5f4c2ea4c443b30 100644 --- a/rdoc-sources/FXIconDict.rb +++ b/rdoc-sources/FXIconDict.rb @@ -22,6 +22,7 @@ module Fox # creates a default icon source object. # def initialize(app, path=FXIconDict.defaultIconPath); + end # Change icon source to _src_ (an FXIconSource instance). def iconSource=(src); end diff --git a/rdoc-sources/FXIconList.rb b/rdoc-sources/FXIconList.rb index d306c43c39e6eda96c2c1dcdb8f20a0432b0d1ca..c424df9078c29c7a6f70f4c3944e0cf8d24fc09f 100755 --- a/rdoc-sources/FXIconList.rb +++ b/rdoc-sources/FXIconList.rb @@ -17,13 +17,13 @@ module Fox attr_accessor :data # Indicates whether this item is selected or not [Boolean] - attr_writer :selected + attr_writer :selected # Indicates whether this item is enabled or not [Boolean] - attr_writer :enabled + attr_writer :enabled # Indicates whether this item is draggable or not [Boolean] - attr_writer :draggable + attr_writer :draggable # Constructor def initialize(text, bigIcon=nil, miniIcon=nil, data=nil) # :yields: theIconItem @@ -87,73 +87,73 @@ module Fox # # The following messages are sent by FXIconList to its target: # - # +SEL_CHANGED+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. - # +SEL_COMMAND+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_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_CLICKED+:: sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_DOUBLECLICKED+:: sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_TRIPLECLICKED+:: sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_SELECTED+:: sent when a list item is selected; the message data is an Integer indicating the index of the selected item. - # +SEL_DESELECTED+:: sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item. - # +SEL_REPLACED+:: sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. - # +SEL_INSERTED+:: sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted. - # +SEL_DELETED+:: sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed. + # +SEL_CHANGED+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. + # +SEL_COMMAND+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_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_CLICKED+:: sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_DOUBLECLICKED+:: sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_TRIPLECLICKED+:: sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_SELECTED+:: sent when a list item is selected; the message data is an Integer indicating the index of the selected item. + # +SEL_DESELECTED+:: sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item. + # +SEL_REPLACED+:: sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. + # +SEL_INSERTED+:: sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted. + # +SEL_DELETED+:: sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed. # # === Icon list styles # - # +ICONLIST_EXTENDEDSELECT+:: Extended selection mode - # +ICONLIST_SINGLESELECT+:: At most one selected item - # +ICONLIST_BROWSESELECT+:: Always exactly one selected item - # +ICONLIST_MULTIPLESELECT+:: Multiple selection mode - # +ICONLIST_AUTOSIZE+:: Automatically size item spacing - # +ICONLIST_DETAILED+:: List mode - # +ICONLIST_MINI_ICONS+:: Mini Icon mode - # +ICONLIST_BIG_ICONS+:: Big Icon mode - # +ICONLIST_ROWS+:: Row-wise mode - # +ICONLIST_COLUMNS+:: Column-wise mode - # +ICONLIST_NORMAL+:: same as +ICONLIST_EXTENDEDSELECT+ + # +ICONLIST_EXTENDEDSELECT+:: Extended selection mode + # +ICONLIST_SINGLESELECT+:: At most one selected item + # +ICONLIST_BROWSESELECT+:: Always exactly one selected item + # +ICONLIST_MULTIPLESELECT+:: Multiple selection mode + # +ICONLIST_AUTOSIZE+:: Automatically size item spacing + # +ICONLIST_DETAILED+:: List mode + # +ICONLIST_MINI_ICONS+:: Mini Icon mode + # +ICONLIST_BIG_ICONS+:: Big Icon mode + # +ICONLIST_ROWS+:: Row-wise mode + # +ICONLIST_COLUMNS+:: Column-wise mode + # +ICONLIST_NORMAL+:: same as +ICONLIST_EXTENDEDSELECT+ # # === Message identifiers # - # +ID_SHOW_DETAILS+:: x - # +ID_SHOW_MINI_ICONS+:: x - # +ID_SHOW_BIG_ICONS+:: x - # +ID_ARRANGE_BY_ROWS+:: x - # +ID_ARRANGE_BY_COLUMNS+:: x - # +ID_HEADER_CHANGE+:: x - # +ID_TIPTIMER+:: x - # +ID_LOOKUPTIMER+:: x - # +ID_SELECT_ALL+:: x - # +ID_DESELECT_ALL+:: x - # +ID_SELECT_INVERSE+:: x + # +ID_SHOW_DETAILS+:: x + # +ID_SHOW_MINI_ICONS+:: x + # +ID_SHOW_BIG_ICONS+:: x + # +ID_ARRANGE_BY_ROWS+:: x + # +ID_ARRANGE_BY_COLUMNS+:: x + # +ID_HEADER_CHANGE+:: x + # +ID_TIPTIMER+:: x + # +ID_LOOKUPTIMER+:: x + # +ID_SELECT_ALL+:: x + # +ID_DESELECT_ALL+:: x + # +ID_SELECT_INVERSE+:: x class FXIconList < FXScrollArea # Number of items [Integer] - attr_reader :numItems + attr_reader :numItems # Number of rows [Integer] - attr_reader :numRows + attr_reader :numRows # Number of columns [Integer] - attr_reader :numCols + attr_reader :numCols # The header control [FXHeader] - attr_reader :header + attr_reader :header # The number of header items in the header control [Integer] - attr_reader :numHeaders + attr_reader :numHeaders # Item width [Integer] - attr_reader :itemWidth + attr_reader :itemWidth # Item height [Integer] - attr_reader :itemHeight + attr_reader :itemHeight # Index of current item, or -1 if none [Integer] attr_accessor :currentItem @@ -162,7 +162,7 @@ module Fox attr_accessor :anchorItem # Index of item under the cursor, or -1 if none [Integer] - attr_reader :cursorItem + attr_reader :cursorItem # Text font [FXFont] attr_accessor :font @@ -364,7 +364,7 @@ module Fox # Change user _data_ for item at _index_. # Raises IndexError if _index_ is out of bounds. - def setItemData(index, data); + def setItemData(index, data); end # Return user data for item at _index_. # Raises IndexError if _index_ is out of bounds. @@ -401,11 +401,11 @@ module Fox # Enable item at _index_. # Raises IndexError if _index_ is out of bounds. - def enableItem(index); + def enableItem(index); end # Disable item at _index_. # Raises IndexError if _index_ is out of bounds. - def disableItem(index); + def disableItem(index); end # Select item at _index_. # If _notify_ is +true+, a +SEL_SELECTED+ message is sent to the list's diff --git a/rdoc-sources/FXImage.rb b/rdoc-sources/FXImage.rb index c7500efbf980916a08a03e91db1ef18c4ba03e29..24d95bd0c1a3325d8b8fa3d6f3db5a6a5fc53b74 100755 --- a/rdoc-sources/FXImage.rb +++ b/rdoc-sources/FXImage.rb @@ -40,7 +40,7 @@ module Fox class FXImage < FXDrawable # [deprecated] Pixel data [FXMemoryBuffer] - attr_reader :data + attr_reader :data # Array of colors of all image pixels. Can also be written as String of raw [RGBA] values. attr_accessor :pixels @@ -60,11 +60,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pixels+:: pixels [Array of FXColor values or string of raw [RGBA] values] - # +opts+:: image options [Integer] - # +width+:: image width [Integer] - # +height+:: image height [Integer] + # +a+:: an application instance [FXApp] + # +pixels+:: pixels [Array of FXColor values or string of raw [RGBA] values] + # +opts+:: image options [Integer] + # +width+:: image width [Integer] + # +height+:: image height [Integer] # def initialize(a, pixels=nil, opts=0, width=1, height=1) # :yields: theImage end @@ -99,8 +99,8 @@ module Fox # # ==== Parameters: # - # +x+:: x-coordinate of the pixel of interest [Integer] - # +y+:: y-coordinate of the pixel of interest [Integer] + # +x+:: x-coordinate of the pixel of interest [Integer] + # +y+:: y-coordinate of the pixel of interest [Integer] # def getPixel(x, y) ; end @@ -109,9 +109,9 @@ module Fox # # ==== Parameters: # - # +x+:: x-coordinate of the pixel of interest [Integer] - # +y+:: y-coordinate of the pixel of interest [Integer] - # +clr+:: new color value for this pixel [FXColor] + # +x+:: x-coordinate of the pixel of interest [Integer] + # +y+:: y-coordinate of the pixel of interest [Integer] + # +clr+:: new color value for this pixel [FXColor] # def setPixel(x, y, clr) ; end @@ -155,9 +155,9 @@ module Fox # # ==== Parameters: # - # +width+:: new image width, in pixels [Integer] - # +height+:: new image height, in pixels [Integer] - # +quality+:: scaling algorithm quality, either 0 or 1 (see above) [Integer] + # +width+:: new image width, in pixels [Integer] + # +height+:: new image height, in pixels [Integer] + # +quality+:: scaling algorithm quality, either 0 or 1 (see above) [Integer] # def scale(w, h, quality=0) ; end @@ -167,8 +167,8 @@ module Fox # # ==== Parameters: # - # +horizontal+:: if +true+, the image will be flipped from left to right [Boolean] - # +vertical+:: if +true+, the image will be flipped from top to bottom [Boolean] + # +horizontal+:: if +true+, the image will be flipped from left to right [Boolean] + # +vertical+:: if +true+, the image will be flipped from top to bottom [Boolean] # def mirror(horizontal, vertical) ; end @@ -178,7 +178,7 @@ module Fox # # ==== Parameters: # - # +degrees+:: number of degrees by which to rotate the image [Integer] + # +degrees+:: number of degrees by which to rotate the image [Integer] # def rotate(degrees) ; end @@ -191,11 +191,11 @@ module Fox # # ==== Parameters: # - # +x+:: x-coordinate for top left corner of the clip rectangle [Integer] - # +y+:: y-coordinate for top left corner of the clip rectangle [Integer] - # +width+:: width of the clip rectangle [Integer] - # +height+:: height of the clip rectangle [Integer] - # +color+:: fill color for blank areas after crop [FXColor] + # +x+:: x-coordinate for top left corner of the clip rectangle [Integer] + # +y+:: y-coordinate for top left corner of the clip rectangle [Integer] + # +width+:: width of the clip rectangle [Integer] + # +height+:: height of the clip rectangle [Integer] + # +color+:: fill color for blank areas after crop [FXColor] # def crop(x, y, w, h, color=0) ; end @@ -210,7 +210,7 @@ module Fox # ==== Parameters: # # +color+:: the fade color [FXColor] - # +factor+:: fading factor [Integer] + # +factor+:: fading factor [Integer] # def fade(color, factor=255); end @@ -223,7 +223,7 @@ module Fox # ==== Parameters: # # +shear+:: how far to shear [Integer] - # +color+:: fill color for areas outside the sheared image [FXColor] + # +color+:: fill color for areas outside the sheared image [FXColor] # def xshear(shear, color=0); end @@ -236,7 +236,7 @@ module Fox # ==== Parameters: # # +shear+:: how far to shear [Integer] - # +color+:: fill color for areas outside the sheared image [FXColor] + # +color+:: fill color for areas outside the sheared image [FXColor] # def yshear(shear, color=0); end @@ -256,7 +256,7 @@ module Fox # ==== Parameters: # # +top+:: starting color, for topmost pixels [FXColor] - # +bottom+:: ending color, for bottommost pixels [FXColor] + # +bottom+:: ending color, for bottommost pixels [FXColor] # def vgradient(top, bottom); end @@ -266,7 +266,7 @@ module Fox # ==== Parameters: # # +topleft+:: pixel color for top-left corner [FXColor] - # +topright+:: pixel color for top-right corner [FXColor] + # +topright+:: pixel color for top-right corner [FXColor] # +bottomleft+:: pixel color for bottom-left corner [FXColor] # +bottomright+:: pixel color for bottom-right corner [FXColor] # @@ -277,7 +277,7 @@ module Fox # # ==== Parameters: # - # +color+:: the blended color [FXColor] + # +color+:: the blended color [FXColor] # def blend(color); end @@ -295,7 +295,7 @@ module Fox # # ==== Parameters: # - # +store+:: opened stream to which to save the pixel data [FXStream] + # +store+:: opened stream to which to save the pixel data [FXStream] # def savePixels(store) ; end @@ -314,7 +314,7 @@ module Fox # # ==== Parameters: # - # +store+:: opened stream from which to read the pixel data [FXStream] + # +store+:: opened stream from which to read the pixel data [FXStream] # def loadPixels(store) ; end end diff --git a/rdoc-sources/FXImageFrame.rb b/rdoc-sources/FXImageFrame.rb index 851f34fa66e2c46a609c50f9edd96bf68ca0cf10..46a745ac753339cec453c9244728b7c6d9a3dd01 100755 --- a/rdoc-sources/FXImageFrame.rb +++ b/rdoc-sources/FXImageFrame.rb @@ -20,15 +20,15 @@ module Fox # # +p+:: the parent window for this image frame [FXComposite] # +img+:: the image to display [FXImage] - # +opts+:: frame options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +opts+:: frame options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, img, opts=FRAME_SUNKEN|FRAME_THICK, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theImageFrame end diff --git a/rdoc-sources/FXImageView.rb b/rdoc-sources/FXImageView.rb index f6ae7bae91fee681ce00e059fafc4969c0312aa7..23e8ba30beac02c67af94610ab5edb529a52d9a3 100755 --- a/rdoc-sources/FXImageView.rb +++ b/rdoc-sources/FXImageView.rb @@ -4,18 +4,18 @@ module Fox # # === Image alignment styles # - # +IMAGEVIEW_NORMAL+:: Normal mode is centered - # +IMAGEVIEW_CENTER_X+:: Centered horizontally - # +IMAGEVIEW_LEFT+:: Left-aligned - # +IMAGEVIEW_RIGHT+:: Right-aligned - # +IMAGEVIEW_CENTER_Y+:: Centered vertically - # +IMAGEVIEW_TOP+:: Top-aligned - # +IMAGEVIEW_BOTTOM+:: Bottom-aligned + # +IMAGEVIEW_NORMAL+:: Normal mode is centered + # +IMAGEVIEW_CENTER_X+:: Centered horizontally + # +IMAGEVIEW_LEFT+:: Left-aligned + # +IMAGEVIEW_RIGHT+:: Right-aligned + # +IMAGEVIEW_CENTER_Y+:: Centered vertically + # +IMAGEVIEW_TOP+:: Top-aligned + # +IMAGEVIEW_BOTTOM+:: Bottom-aligned # # === Events # - # +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_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. # class FXImageView < FXScrollArea diff --git a/rdoc-sources/FXInputDialog.rb b/rdoc-sources/FXInputDialog.rb index d335f05dff34c2b9d008861e8db21d9647e8e361..44fc52a47686cbaa1be13469eb43a36cf2bb7f7b 100755 --- a/rdoc-sources/FXInputDialog.rb +++ b/rdoc-sources/FXInputDialog.rb @@ -6,10 +6,10 @@ module Fox # # === Input dialog options # - # +INPUTDIALOG_STRING+:: Ask for a string - # +INPUTDIALOG_INTEGER+:: Ask for an integer number - # +INPUTDIALOG_REAL+:: Ask for a real number - # +INPUTDIALOG_PASSWORD+:: Do not reveal key-in + # +INPUTDIALOG_STRING+:: Ask for a string + # +INPUTDIALOG_INTEGER+:: Ask for an integer number + # +INPUTDIALOG_REAL+:: Ask for a real number + # +INPUTDIALOG_PASSWORD+:: Do not reveal key-in # class FXInputDialog < FXDialogBox diff --git a/rdoc-sources/FXJPGIcon.rb b/rdoc-sources/FXJPGIcon.rb index 68587ea7b43734f48b5c06871f35433e089db996..46f89b4f3a6b49b3ff9c8528dbe6bf2c75915376 100755 --- a/rdoc-sources/FXJPGIcon.rb +++ b/rdoc-sources/FXJPGIcon.rb @@ -25,12 +25,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in JPEG file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in JPEG file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # +quality+:: JPEG image quality [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1, quality=75) # :yields: theJPGIcon @@ -44,7 +44,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadJPG(store); end @@ -54,12 +54,12 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] - # +quality+:: image quality [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] + # +quality+:: image quality [Integer] # def Fox.fxsaveJPG(store, data, transp, width, height, quality); end diff --git a/rdoc-sources/FXJPGImage.rb b/rdoc-sources/FXJPGImage.rb index eb5a66eced1848af5fb6efb0102ad165568e4ea8..6609ed5fab7163623958325824a9a6f08f4267f9 100755 --- a/rdoc-sources/FXJPGImage.rb +++ b/rdoc-sources/FXJPGImage.rb @@ -25,11 +25,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in JPEG file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in JPEG file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # +quality+:: JPEG image quality [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1, quality=75) # :yields: theJPGImage diff --git a/rdoc-sources/FXKnob.rb b/rdoc-sources/FXKnob.rb index 70b6686741d14eb73e4a5d6cecd684997eb9c555..6a664c4963fb9401fbb25de6081efc47d653dc02 100644 --- a/rdoc-sources/FXKnob.rb +++ b/rdoc-sources/FXKnob.rb @@ -9,12 +9,12 @@ module Fox # # The following messages are sent by FXKnob to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: # sent at the end of a knob move; the message data is the new value of the knob. # +SEL_CHANGED+:: @@ -23,11 +23,11 @@ module Fox # # === Knob Control styles # - # +KNOB_NEEDLE+:: Use a needle as indicator - # +KNOB_DOT+:: Use a dot as indicator - # +KNOB_TICKS+:: Show ticks around the knob - # +KNOB_INDICATOR+:: Show only the indicator (like a speedometer) - # +KNOB_NORMAL+:: Normal knob looks + # +KNOB_NEEDLE+:: Use a needle as indicator + # +KNOB_DOT+:: Use a dot as indicator + # +KNOB_TICKS+:: Show ticks around the knob + # +KNOB_INDICATOR+:: Show only the indicator (like a speedometer) + # +KNOB_NORMAL+:: Normal knob looks # class FXKnob < FXFrame diff --git a/rdoc-sources/FXList.rb b/rdoc-sources/FXList.rb index 6b48d3ddf29393fbab484d1b35c9c648c6e89bea..295e506622f9c67187163246235352779f33b173 100755 --- a/rdoc-sources/FXList.rb +++ b/rdoc-sources/FXList.rb @@ -77,31 +77,31 @@ module Fox # # The following messages are sent by FXList to its target: # - # +SEL_CHANGED+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. - # +SEL_COMMAND+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_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_CLICKED+:: sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_DOUBLECLICKED+:: sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_TRIPLECLICKED+:: sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item. - # +SEL_SELECTED+:: sent when a list item is selected; the message data is an Integer indicating the index of the selected item. - # +SEL_DESELECTED+:: sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item. - # +SEL_REPLACED+:: sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. - # +SEL_INSERTED+:: sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted. - # +SEL_DELETED+:: sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed. + # +SEL_CHANGED+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. + # +SEL_COMMAND+:: sent when the current list item changes; the message data is an Integer indicating the index of the current item. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_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_CLICKED+:: sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_DOUBLECLICKED+:: sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_TRIPLECLICKED+:: sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item. + # +SEL_SELECTED+:: sent when a list item is selected; the message data is an Integer indicating the index of the selected item. + # +SEL_DESELECTED+:: sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item. + # +SEL_REPLACED+:: sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced. + # +SEL_INSERTED+:: sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted. + # +SEL_DELETED+:: sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed. # # === List styles # - # +LIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items - # +LIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected - # +LIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times - # +LIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items - # +LIST_AUTOSELECT+:: Automatically select under cursor - # +LIST_NORMAL+:: same as +LIST_EXTENDEDSELECT+ + # +LIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items + # +LIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected + # +LIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times + # +LIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items + # +LIST_AUTOSELECT+:: Automatically select under cursor + # +LIST_NORMAL+:: same as +LIST_EXTENDEDSELECT+ # # === Message identifiers # @@ -111,7 +111,7 @@ module Fox class FXList < FXScrollArea # Number of items in the list [Integer] - attr_reader :numItems + attr_reader :numItems # Number of visible items [Integer] attr_accessor :numVisible @@ -120,10 +120,10 @@ module Fox attr_accessor :currentItem # Index of anchor item, or -1 if no anchor item [Integer] - attr_reader :anchorItem + attr_reader :anchorItem # Index of item under the cursor, or -1 if none [Integer] - attr_reader :cursorItem + attr_reader :cursorItem # Text font [FXFont] attr_accessor :font diff --git a/rdoc-sources/FXListBox.rb b/rdoc-sources/FXListBox.rb index 1e8bbd90315a699c64c35e3a9ed3978e3cac579f..b5656f1cdc788d00e558829c09ce81613fed1e22 100755 --- a/rdoc-sources/FXListBox.rb +++ b/rdoc-sources/FXListBox.rb @@ -19,7 +19,7 @@ module Fox # # === List Box styles # - # +LISTBOX_NORMAL+:: Normal style + # +LISTBOX_NORMAL+:: Normal style # # === Message identifiers # @@ -96,7 +96,7 @@ module Fox 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); + def appendItem(text, icon=nil, ptr=nil); end # Prepend an item to the list def prependItem(text, icon=nil, ptr=nil); end diff --git a/rdoc-sources/FXMDIChild.rb b/rdoc-sources/FXMDIChild.rb index 91001dc313421442be7cd4ef28897827cc1dc8a7..cf9d4ce2c5cc47b6925d96f59ff97eb14f827a45 100755 --- a/rdoc-sources/FXMDIChild.rb +++ b/rdoc-sources/FXMDIChild.rb @@ -26,32 +26,32 @@ module Fox # # 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_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_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 + # +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 + # +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 diff --git a/rdoc-sources/FXMatrix.rb b/rdoc-sources/FXMatrix.rb index 123a99bfea56101895b0aed8b048ea61b292e1a5..d045fec37c080cbcf8d78bf44e12216386e803be 100755 --- a/rdoc-sources/FXMatrix.rb +++ b/rdoc-sources/FXMatrix.rb @@ -18,8 +18,8 @@ module Fox # # === Matrix packing options # - # +MATRIX_BY_ROWS+:: Fixed number of rows, add columns as needed - # +MATRIX_BY_COLUMNS+:: Fixed number of columns, adding rows as needed + # +MATRIX_BY_ROWS+:: Fixed number of rows, add columns as needed + # +MATRIX_BY_COLUMNS+:: Fixed number of columns, adding rows as needed # class FXMatrix < FXPacker diff --git a/rdoc-sources/FXMemoryBuffer.rb b/rdoc-sources/FXMemoryBuffer.rb index b579eee57c5d65a1e6d00cb3961b920959f429ea..3a602f94479f9642a6c84270eea1db450059bffa 100755 --- a/rdoc-sources/FXMemoryBuffer.rb +++ b/rdoc-sources/FXMemoryBuffer.rb @@ -8,7 +8,7 @@ module Fox # # ==== Parameters: # - # +data+:: the initial array of FXColor values. + # +data+:: the initial array of FXColor values. # def initialize(data); end diff --git a/rdoc-sources/FXMemoryStream.rb b/rdoc-sources/FXMemoryStream.rb index 4007859038b1087e4e431cfabc30a621ac3a4701..594221a3ee266747f02501c446dc77060ea7f5e0 100755 --- a/rdoc-sources/FXMemoryStream.rb +++ b/rdoc-sources/FXMemoryStream.rb @@ -17,7 +17,7 @@ module Fox # # ==== Parameters: # - # +cont+:: the container object, or +nil+ if there is none [FXObject]. + # +cont+:: the container object, or +nil+ if there is none [FXObject]. # def initialize(cont=nil) # :yields: theMemoryStream end diff --git a/rdoc-sources/FXMenuButton.rb b/rdoc-sources/FXMenuButton.rb index c9d9a1d35b669abf3d95d45b8577e6ef156349d1..ea35dbb34271ee355f4723fc1f596b87c5989140 100755 --- a/rdoc-sources/FXMenuButton.rb +++ b/rdoc-sources/FXMenuButton.rb @@ -18,42 +18,42 @@ module Fox # # The following messages are sent by FXMenuButton to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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. # # === Menu Button Style Flags # # Any combination of the following flags can be assigned as the menu # button style flags. # - # +MENUBUTTON_AUTOGRAY+:: Automatically gray out when no target - # +MENUBUTTON_AUTOHIDE+:: Automatically hide when no target - # +MENUBUTTON_TOOLBAR+:: Toolbar style - # +MENUBUTTON_NOARROWS+:: Do not show arrows + # +MENUBUTTON_AUTOGRAY+:: Automatically gray out when no target + # +MENUBUTTON_AUTOHIDE+:: Automatically hide when no target + # +MENUBUTTON_TOOLBAR+:: Toolbar style + # +MENUBUTTON_NOARROWS+:: Do not show arrows # # === Menu Button Popup Style # # Any one of the following options can be assigned as the menu # button's popup style. # - # +MENUBUTTON_DOWN+:: Popup window appears below menu button - # +MENUBUTTON_UP+:: Popup window appears above menu button - # +MENUBUTTON_LEFT+:: Popup window to the left of the menu button - # +MENUBUTTON_RIGHT+:: Popup window to the right of the menu button + # +MENUBUTTON_DOWN+:: Popup window appears below menu button + # +MENUBUTTON_UP+:: Popup window appears above menu button + # +MENUBUTTON_LEFT+:: Popup window to the left of the menu button + # +MENUBUTTON_RIGHT+:: Popup window to the right of the menu button # # === Menu Button Attachment # # Any combination of the following flags can be assigned as the menu # button's attachment flags. # - # +MENUBUTTON_ATTACH_LEFT+:: Popup attaches to the left side of the menu button - # +MENUBUTTON_ATTACH_TOP+:: Popup attaches to the top of the menu button - # +MENUBUTTON_ATTACH_RIGHT+:: Popup attaches to the right side of the menu button - # +MENUBUTTON_ATTACH_BOTTOM+:: Popup attaches to the bottom of the menu button - # +MENUBUTTON_ATTACH_CENTER+:: Popup attaches to the center of the menu button - # +MENUBUTTON_ATTACH_BOTH+:: Popup attaches to both sides of the menu button + # +MENUBUTTON_ATTACH_LEFT+:: Popup attaches to the left side of the menu button + # +MENUBUTTON_ATTACH_TOP+:: Popup attaches to the top of the menu button + # +MENUBUTTON_ATTACH_RIGHT+:: Popup attaches to the right side of the menu button + # +MENUBUTTON_ATTACH_BOTTOM+:: Popup attaches to the bottom of the menu button + # +MENUBUTTON_ATTACH_CENTER+:: Popup attaches to the center of the menu button + # +MENUBUTTON_ATTACH_BOTH+:: Popup attaches to both sides of the menu button # class FXMenuButton < FXLabel @@ -79,6 +79,7 @@ module Fox # Constructor # def initialize(parent, text, icon=nil, popupMenu=nil, opts=JUSTIFY_NORMAL|ICON_BEFORE_TEXT|MENUBUTTON_DOWN, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING) # :yields: theMenuButton + end end end diff --git a/rdoc-sources/FXMenuCaption.rb b/rdoc-sources/FXMenuCaption.rb index b45689ebad328b782787f647e111097feae369b2..14b79f5ab9ef8332356380a1d428cda244bb5d61 100755 --- a/rdoc-sources/FXMenuCaption.rb +++ b/rdoc-sources/FXMenuCaption.rb @@ -5,8 +5,8 @@ module Fox # # === Menu caption options # - # +MENU_AUTOGRAY+:: Automatically gray out when not updated - # +MENU_AUTOHIDE+:: Automatically hide button when not updated + # +MENU_AUTOGRAY+:: Automatically gray out when not updated + # +MENU_AUTOHIDE+:: Automatically hide button when not updated # class FXMenuCaption < FXWindow diff --git a/rdoc-sources/FXMenuCheck.rb b/rdoc-sources/FXMenuCheck.rb index c20ee9d4d06e96efdd2a9a29de4d512b8c31c1e4..14515e11b23335c0f23154f9b8997e51d29c9718 100755 --- a/rdoc-sources/FXMenuCheck.rb +++ b/rdoc-sources/FXMenuCheck.rb @@ -10,7 +10,7 @@ module Fox # # The following messages are sent by FXMenuCheck to its target: # - # +SEL_COMMAND+:: sent when the command is activated + # +SEL_COMMAND+:: sent when the command is activated # class FXMenuCheck < FXMenuCommand diff --git a/rdoc-sources/FXMenuCommand.rb b/rdoc-sources/FXMenuCommand.rb index c3a26bcaeb85a2170dca9444520e794c44b6d3f5..0ddadabefe81aef1e0ac3bbb4322a9b4935a7a8c 100755 --- a/rdoc-sources/FXMenuCommand.rb +++ b/rdoc-sources/FXMenuCommand.rb @@ -9,7 +9,7 @@ module Fox # # The following messages are sent by FXMenuCommand to its target: # - # +SEL_COMMAND+:: sent when the command is activated + # +SEL_COMMAND+:: sent when the command is activated # class FXMenuCommand < FXMenuCaption diff --git a/rdoc-sources/FXMenuRadio.rb b/rdoc-sources/FXMenuRadio.rb index c89466d447c8c5a6c7ff7bcc10d765ebdd2d7b99..35296bc6b16846b474cfdaa9eb0fa1243e8726c0 100755 --- a/rdoc-sources/FXMenuRadio.rb +++ b/rdoc-sources/FXMenuRadio.rb @@ -13,7 +13,7 @@ module Fox # # The following messages are sent by FXMenuRadio to its target: # - # +SEL_COMMAND+:: sent when the command is activated + # +SEL_COMMAND+:: sent when the command is activated # class FXMenuRadio < FXMenuCommand diff --git a/rdoc-sources/FXMenuTitle.rb b/rdoc-sources/FXMenuTitle.rb index b8c203ca5b78f3bb23cff1dd25279fd3f7d1cdad..92c4ba96c8bf77380cba666b4172cb624e079f39 100755 --- a/rdoc-sources/FXMenuTitle.rb +++ b/rdoc-sources/FXMenuTitle.rb @@ -7,10 +7,10 @@ module Fox # # The following messages are sent by FXMenuTitle to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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. # class FXMenuTitle < FXMenuCaption diff --git a/rdoc-sources/FXMessageBox.rb b/rdoc-sources/FXMessageBox.rb index 58f374ff3376e95ac24d4d86ec5b06fb6b0e045c..e0ba3800dc07cb160f4d212a5b3f346b17a1f9a3 100755 --- a/rdoc-sources/FXMessageBox.rb +++ b/rdoc-sources/FXMessageBox.rb @@ -10,25 +10,25 @@ module Fox # # === Message box buttons # - # +MBOX_OK+:: Message box has a only an *Ok* button - # +MBOX_OK_CANCEL+:: Message box has *Ok* and *Cancel* buttons - # +MBOX_YES_NO+:: Message box has *Yes* and *No* buttons - # +MBOX_YES_NO_CANCEL+:: Message box has *Yes*, *No*, and *Cancel* buttons - # +MBOX_QUIT_CANCEL+:: Message box has *Quit* and *Cancel* buttons - # +MBOX_QUIT_SAVE_CANCEL+:: Message box has *Quit*, *Save*, and *Cancel* buttons - # +MBOX_SKIP_SKIPALL_CANCEL+:: Message box has *Skip*, *Skip All* and *Cancel* buttons - # +MBOX_SAVE_CANCEL_DONTSAVE+:: Message box has *Don't Save*, *Cancel* and *Save* buttons + # +MBOX_OK+:: Message box has a only an *Ok* button + # +MBOX_OK_CANCEL+:: Message box has *Ok* and *Cancel* buttons + # +MBOX_YES_NO+:: Message box has *Yes* and *No* buttons + # +MBOX_YES_NO_CANCEL+:: Message box has *Yes*, *No*, and *Cancel* buttons + # +MBOX_QUIT_CANCEL+:: Message box has *Quit* and *Cancel* buttons + # +MBOX_QUIT_SAVE_CANCEL+:: Message box has *Quit*, *Save*, and *Cancel* buttons + # +MBOX_SKIP_SKIPALL_CANCEL+:: Message box has *Skip*, *Skip All* and *Cancel* buttons + # +MBOX_SAVE_CANCEL_DONTSAVE+:: Message box has *Don't Save*, *Cancel* and *Save* buttons # # === Return values # - # +MBOX_CLICKED_YES+:: The *Yes* button was clicked - # +MBOX_CLICKED_NO+:: The *No* button was clicked - # +MBOX_CLICKED_OK+:: The *Ok* button was clicked - # +MBOX_CLICKED_CANCEL+:: The *Cancel* button was clicked - # +MBOX_CLICKED_QUIT+:: The *Quit* button was clicked - # +MBOX_CLICKED_SAVE+:: The *Save* button was clicked - # +MBOX_CLICKED_SKIP+:: The *Skip* button was clicked - # +MBOX_CLICKED_SKIPALL+:: The *Skip All* button was clicked + # +MBOX_CLICKED_YES+:: The *Yes* button was clicked + # +MBOX_CLICKED_NO+:: The *No* button was clicked + # +MBOX_CLICKED_OK+:: The *Ok* button was clicked + # +MBOX_CLICKED_CANCEL+:: The *Cancel* button was clicked + # +MBOX_CLICKED_QUIT+:: The *Quit* button was clicked + # +MBOX_CLICKED_SAVE+:: The *Save* button was clicked + # +MBOX_CLICKED_SKIP+:: The *Skip* button was clicked + # +MBOX_CLICKED_SKIPALL+:: The *Skip All* button was clicked # +MBOX_CLICKED_DONTSAVE+:: The *Don't Save* button was clicked (same as +MBOX_CLICKED_NO+) # class FXMessageBox < FXDialogBox diff --git a/rdoc-sources/FXOptionMenu.rb b/rdoc-sources/FXOptionMenu.rb index 7c3fef914b290cf10dac0966063724d6f67ed671..0d8e0db425aa40010f7017b27e0f47eb3eb6a9e6 100755 --- a/rdoc-sources/FXOptionMenu.rb +++ b/rdoc-sources/FXOptionMenu.rb @@ -6,11 +6,11 @@ module Fox # # The following messages are sent by FXOption to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when this option is clicked; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: sent when this option is clicked; the message data is an FXEvent instance. # class FXOption < FXLabel # Selection background color [FXColor] @@ -33,11 +33,11 @@ module Fox # # The following messages are sent by FXOptionMenu to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when this an option is selected; the message data is the option number. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: sent when this an option is selected; the message data is the option number. # class FXOptionMenu < FXLabel diff --git a/rdoc-sources/FXPCXIcon.rb b/rdoc-sources/FXPCXIcon.rb index 6b256b1c5039b276b1c4213c0327ef2bf3a0262b..b2edc14e53f2beb8accadffd5e5552b209886a39 100755 --- a/rdoc-sources/FXPCXIcon.rb +++ b/rdoc-sources/FXPCXIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PCX file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PCX file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePCXIcon end @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadPCX(store); end @@ -47,11 +47,11 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] # def Fox.fxsavePCX(store, data, transp, width, height); end diff --git a/rdoc-sources/FXPCXImage.rb b/rdoc-sources/FXPCXImage.rb index a03e75d0a0a652cf84b48695a8419baae97874f6..3ba4d07f2625e19d77f51132c110fe5188882ce6 100755 --- a/rdoc-sources/FXPCXImage.rb +++ b/rdoc-sources/FXPCXImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PCX file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PCX file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePCXImage end diff --git a/rdoc-sources/FXPNGIcon.rb b/rdoc-sources/FXPNGIcon.rb index 35cbef30acc29223f285f5df753004fadd57910c..0435c414daa15e2c86d88e432c84d74817ecf19d 100755 --- a/rdoc-sources/FXPNGIcon.rb +++ b/rdoc-sources/FXPNGIcon.rb @@ -21,12 +21,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PNG file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PNG file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePNGIcon end @@ -40,7 +40,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadPNG(store); end @@ -50,11 +50,11 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] # def Fox.fxsavePNG(store, data, transp, width, height); end diff --git a/rdoc-sources/FXPNGImage.rb b/rdoc-sources/FXPNGImage.rb index c02e5d9c81a51c29edf15846406cb26e3f0ae63c..384e6137515d48bc3938a5b46c53e6272d58f420 100755 --- a/rdoc-sources/FXPNGImage.rb +++ b/rdoc-sources/FXPNGImage.rb @@ -21,11 +21,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PNG file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PNG file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePNGImage end diff --git a/rdoc-sources/FXPPMIcon.rb b/rdoc-sources/FXPPMIcon.rb index 42901f18f718f549f766fb74b0af1ac301b088d9..1f072ba73c42bd46f7d15e77d2c7f24a137ce7b0 100755 --- a/rdoc-sources/FXPPMIcon.rb +++ b/rdoc-sources/FXPPMIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PPM file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PPM file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePPMIcon end diff --git a/rdoc-sources/FXPPMImage.rb b/rdoc-sources/FXPPMImage.rb index 5e3804811f4aa9a5e4249a6c44f8eae7e95da5b6..3851008b15a9ed5d6c866c72fa48bf32f0c4dd52 100755 --- a/rdoc-sources/FXPPMImage.rb +++ b/rdoc-sources/FXPPMImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in PPM file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in PPM file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePPMImage end diff --git a/rdoc-sources/FXPrintDialog.rb b/rdoc-sources/FXPrintDialog.rb index 2469e427b2a31890ff54bcaa95b6b7849d4a8b09..015e4f4322b6b9a8a755770cd83248c1dc227ef2 100755 --- a/rdoc-sources/FXPrintDialog.rb +++ b/rdoc-sources/FXPrintDialog.rb @@ -4,26 +4,26 @@ module Fox # # == Message identifiers # - # +ID_TO_PRINTER+:: x - # +ID_TO_FILE+:: x - # +ID_PRINTER_NAME+:: x - # +ID_FILE_NAME+:: x - # +ID_LANDSCAPE+:: x - # +ID_PORTRAIT+:: x - # +ID_MEDIA+:: x - # +ID_COLLATE_NORMAL+:: x - # +ID_COLLATE_REVERSED+:: x - # +ID_PAGES_ALL+:: x - # +ID_PAGES_EVEN+:: x - # +ID_PAGES_ODD+:: x - # +ID_PAGES_RANGE+:: x - # +ID_PAGES_FIRST+:: x - # +ID_PAGES_LAST+:: x - # +ID_BROWSE_FILE+:: x - # +ID_PROPERTIES+:: x - # +ID_COLOR_PRINTER+:: x - # +ID_GRAY_PRINTER+:: x - # +ID_NUM_COPIES+:: x + # +ID_TO_PRINTER+:: x + # +ID_TO_FILE+:: x + # +ID_PRINTER_NAME+:: x + # +ID_FILE_NAME+:: x + # +ID_LANDSCAPE+:: x + # +ID_PORTRAIT+:: x + # +ID_MEDIA+:: x + # +ID_COLLATE_NORMAL+:: x + # +ID_COLLATE_REVERSED+:: x + # +ID_PAGES_ALL+:: x + # +ID_PAGES_EVEN+:: x + # +ID_PAGES_ODD+:: x + # +ID_PAGES_RANGE+:: x + # +ID_PAGES_FIRST+:: x + # +ID_PAGES_LAST+:: x + # +ID_BROWSE_FILE+:: x + # +ID_PROPERTIES+:: x + # +ID_COLOR_PRINTER+:: x + # +ID_GRAY_PRINTER+:: x + # +ID_NUM_COPIES+:: x # class FXPrintDialog < FXDialogBox # Printer information [FXPrinter] diff --git a/rdoc-sources/FXProgressBar.rb b/rdoc-sources/FXProgressBar.rb index 66361a9f41f787b719c75cb048b3a101f4ec4d99..1e824888e74750ecf6bbbd9198bbbdb30a3b3380 100755 --- a/rdoc-sources/FXProgressBar.rb +++ b/rdoc-sources/FXProgressBar.rb @@ -4,11 +4,11 @@ module Fox # # === Progress bar styles # - # +PROGRESSBAR_HORIZONTAL+:: Horizontal display - # +PROGRESSBAR_VERTICAL+:: Vertical display - # +PROGRESSBAR_PERCENTAGE+:: Show percentage done - # +PROGRESSBAR_DIAL+:: Show as a dial instead of bar - # +PROGRESSBAR_NORMAL+:: same as <tt>FRAME_SUNKEN|FRAME_THICK</tt> + # +PROGRESSBAR_HORIZONTAL+:: Horizontal display + # +PROGRESSBAR_VERTICAL+:: Vertical display + # +PROGRESSBAR_PERCENTAGE+:: Show percentage done + # +PROGRESSBAR_DIAL+:: Show as a dial instead of bar + # +PROGRESSBAR_NORMAL+:: same as <tt>FRAME_SUNKEN|FRAME_THICK</tt> # class FXProgressBar < FXFrame # Amount of progress [Integer] diff --git a/rdoc-sources/FXProgressDialog.rb b/rdoc-sources/FXProgressDialog.rb index badec45b697b5636713f796a239af2e45c05c6b6..12fedaee793566dcaa87c0f511ccecb0adeb3eec 100755 --- a/rdoc-sources/FXProgressDialog.rb +++ b/rdoc-sources/FXProgressDialog.rb @@ -6,9 +6,9 @@ module Fox # # === Options # - # +PROGRESSDIALOG_NOCANCEL+:: Default is no cancel button - # +PROGRESSDIALOG_CANCEL+:: Enable the cancel button - # +PROGRESSDIALOG_NORMAL+:: same as <tt>DECOR_TITLE|DECOR_BORDER</tt> + # +PROGRESSDIALOG_NOCANCEL+:: Default is no cancel button + # +PROGRESSDIALOG_CANCEL+:: Enable the cancel button + # +PROGRESSDIALOG_NORMAL+:: same as <tt>DECOR_TITLE|DECOR_BORDER</tt> # class FXProgressDialog < FXDialogBox # Progress message [String] diff --git a/rdoc-sources/FXQuatd.rb b/rdoc-sources/FXQuatd.rb index 36208840a86e3b17d5083277ca751d8c31780fda..ca990f6c3ce5c59cdf8f8ddead9284b17475a119 100755 --- a/rdoc-sources/FXQuatd.rb +++ b/rdoc-sources/FXQuatd.rb @@ -8,8 +8,8 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3d] - # +angle+:: the rotation angle (in radians) [Float] + # +axis+:: the rotation axis [FXVec3d] + # +angle+:: the rotation angle (in radians) [Float] # def initialize(axis, phi=0.0); end @@ -18,10 +18,10 @@ module Fox # # ==== Parameters: # - # +x+:: x [Float] - # +y+:: y [Float] - # +z+:: z [Float] - # +width+:: w [Float] + # +x+:: x [Float] + # +y+:: y [Float] + # +z+:: z [Float] + # +width+:: w [Float] # def initialize(x, y, z, w); end @@ -33,9 +33,9 @@ module Fox # # ==== Parameters: # - # +roll+:: roll angle in radians [Float] - # +pitch+:: pitch angle in radians [Float] - # +yaw+:: yaw angle in radians [Float] + # +roll+:: roll angle in radians [Float] + # +pitch+:: pitch angle in radians [Float] + # +yaw+:: yaw angle in radians [Float] # def initialize(roll, pitch, yaw); end @@ -51,8 +51,8 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3d] - # +angle+:: the rotation angle (in radians) [Float] + # +axis+:: the rotation axis [FXVec3d] + # +angle+:: the rotation angle (in radians) [Float] # def setAxisAngle(axis, phi=0.0); end @@ -71,9 +71,9 @@ module Fox # # ==== Parameters: # - # +roll+:: roll angle in radians [Float] - # +pitch+:: pitch angle in radians [Float] - # +yaw+:: yaw angle in radians [Float] + # +roll+:: roll angle in radians [Float] + # +pitch+:: pitch angle in radians [Float] + # +yaw+:: yaw angle in radians [Float] # def setRollPitchYaw(roll, pitch, yaw); end @@ -135,7 +135,7 @@ module Fox # # ==== Parameters: # - # +vec+:: the vector to be rotated [FXVec3d] + # +vec+:: the vector to be rotated [FXVec3d] # def *(vec); end @@ -145,8 +145,8 @@ module Fox # # ==== Parameters: # - # +a+:: [FXVec3d] - # +b+:: [FXVec3d] + # +a+:: [FXVec3d] + # +b+:: [FXVec3d] # def arc!(a, b); end @@ -155,8 +155,8 @@ module Fox # # ==== Parameters: # - # +u+:: [FXQuatd] - # +v+:: [FXQuatd] + # +u+:: [FXQuatd] + # +v+:: [FXQuatd] # +f+:: [Float] # def lerp!(u, v, f); end diff --git a/rdoc-sources/FXQuatf.rb b/rdoc-sources/FXQuatf.rb index c83faaeb61f3f39e19079949965cc401956fd39b..c137c81c539905440784f81cd1db67bf7eb530df 100755 --- a/rdoc-sources/FXQuatf.rb +++ b/rdoc-sources/FXQuatf.rb @@ -8,8 +8,8 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3f] - # +angle+:: the rotation angle (in radians) [Float] + # +axis+:: the rotation axis [FXVec3f] + # +angle+:: the rotation angle (in radians) [Float] # def initialize(axis, phi=0.0); end @@ -18,9 +18,9 @@ module Fox # # ==== Parameters: # - # +roll+:: roll angle in radians [Float] - # +pitch+:: pitch angle in radians [Float] - # +yaw+:: yaw angle in radians [Float] + # +roll+:: roll angle in radians [Float] + # +pitch+:: pitch angle in radians [Float] + # +yaw+:: yaw angle in radians [Float] # def initialize(roll, pitch, yaw); end @@ -29,9 +29,9 @@ module Fox # # ==== Parameters: # - # +ex+:: x-axis [FXVec3f] - # +ey+:: y-axis [FXVec3f] - # +ez+:: z-axis [FXVec3f] + # +ex+:: x-axis [FXVec3f] + # +ey+:: y-axis [FXVec3f] + # +ez+:: z-axis [FXVec3f] # def initialize(ex, ey, ez); end @@ -45,10 +45,10 @@ module Fox # # ==== Parameters: # - # +x+:: x [Float] - # +y+:: y [Float] - # +z+:: z [Float] - # +width+:: w [Float] + # +x+:: x [Float] + # +y+:: y [Float] + # +z+:: z [Float] + # +width+:: w [Float] # def initialize(x, y, z, w); end @@ -60,8 +60,8 @@ module Fox # # ==== Parameters: # - # +axis+:: the rotation axis [FXVec3f] - # +angle+:: the rotation angle (in radians) [Float] + # +axis+:: the rotation axis [FXVec3f] + # +angle+:: the rotation angle (in radians) [Float] # def setAxisAngle(axis, phi=0.0); end @@ -80,9 +80,9 @@ module Fox # # ==== Parameters: # - # +roll+:: roll angle in radians [Float] - # +pitch+:: pitch angle in radians [Float] - # +yaw+:: yaw angle in radians [Float] + # +roll+:: roll angle in radians [Float] + # +pitch+:: pitch angle in radians [Float] + # +yaw+:: yaw angle in radians [Float] # def setRollPitchYaw(roll, pitch, yaw); end @@ -144,7 +144,7 @@ module Fox # # ==== Parameters: # - # +vec+:: the vector to be rotated [FXVec3f] + # +vec+:: the vector to be rotated [FXVec3f] # def *(vec); end @@ -154,8 +154,8 @@ module Fox # # ==== Parameters: # - # +a+:: [FXVec3f] - # +b+:: [FXVec3f] + # +a+:: [FXVec3f] + # +b+:: [FXVec3f] # def arc!(a, b); end @@ -164,9 +164,9 @@ module Fox # # ==== Parameters: # - # +u+:: [FXQuatf] - # +v+:: [FXQuatf] - # +f+:: [Float] + # +u+:: [FXQuatf] + # +v+:: [FXQuatf] + # +f+:: [Float] # def lerp!(u, v, f); end end diff --git a/rdoc-sources/FXRGBIcon.rb b/rdoc-sources/FXRGBIcon.rb index 87a3cd02d14cf1043b49d0c1377b64d9d86a66a2..cd3d5624535163653ccd3045f2dbd963cf75f21d 100755 --- a/rdoc-sources/FXRGBIcon.rb +++ b/rdoc-sources/FXRGBIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in IRIS RGB file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in IRIS RGB file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theRGBIcon end @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadRGB(store); end @@ -47,12 +47,12 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the file data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +store+:: stream to which to write the file data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def Fox.fxsaveRGB(store, data, transp, width, height); end diff --git a/rdoc-sources/FXRGBImage.rb b/rdoc-sources/FXRGBImage.rb index 4fb4ed582121949394f05179354ae3da183d9044..c1f4194a82620fb22fc4b0a9c39f4db3364c0767 100755 --- a/rdoc-sources/FXRGBImage.rb +++ b/rdoc-sources/FXRGBImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in IRIS RGB file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in IRIS RGB file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theRGBImage end diff --git a/rdoc-sources/FXRadioButton.rb b/rdoc-sources/FXRadioButton.rb index ca62a0ea432cb2041afc66dae7daec963b6fdd49..079969f63e1cc2e89bd56e5d6945ab948ee00df0 100755 --- a/rdoc-sources/FXRadioButton.rb +++ b/rdoc-sources/FXRadioButton.rb @@ -14,17 +14,17 @@ module Fox # # The following messages are sent by FXRadioButton to its target: # - # +SEL_COMMAND+:: sent when the radio button is pressed. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when the radio button is pressed. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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. # # === RadioButton flags # - # +RADIOBUTTON_AUTOGRAY+:: Automatically gray out when not updated - # +RADIOBUTTON_AUTOHIDE+:: Automatically hide when not updated - # +RADIOBUTTON_NORMAL+:: <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt> + # +RADIOBUTTON_AUTOGRAY+:: Automatically gray out when not updated + # +RADIOBUTTON_AUTOHIDE+:: Automatically hide when not updated + # +RADIOBUTTON_NORMAL+:: <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt> # class FXRadioButton < FXLabel diff --git a/rdoc-sources/FXRealSlider.rb b/rdoc-sources/FXRealSlider.rb index cf104cf973cae880664c242bdf8f74a74d5cc6c8..c7da6c91ef567c3fb01d3a1ee31bbb09f35fff66 100755 --- a/rdoc-sources/FXRealSlider.rb +++ b/rdoc-sources/FXRealSlider.rb @@ -9,12 +9,12 @@ module Fox # # The following messages are sent by FXRealSlider to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: # sent at the end of a slider move; the message data is the new position of the slider (a Float). # +SEL_CHANGED+:: @@ -23,23 +23,23 @@ module Fox # # === Real slider control styles # - # +REALSLIDER_HORIZONTAL+:: RealSlider shown horizontally - # +REALSLIDER_VERTICAL+:: RealSlider shown vertically - # +REALSLIDER_ARROW_UP+:: RealSlider has arrow head pointing up - # +REALSLIDER_ARROW_DOWN+:: RealSlider has arrow head pointing down - # +REALSLIDER_ARROW_LEFT+:: RealSlider has arrow head pointing left - # +REALSLIDER_ARROW_RIGHT+:: RealSlider has arrow head pointing right - # +REALSLIDER_INSIDE_BAR+:: RealSlider is inside the slot rather than overhanging - # +REALSLIDER_TICKS_TOP+:: Ticks on the top of horizontal slider - # +REALSLIDER_TICKS_BOTTOM+:: Ticks on the bottom of horizontal slider - # +REALSLIDER_TICKS_LEFT+:: Ticks on the left of vertical slider - # +REALSLIDER_TICKS_RIGHT+:: Ticks on the right of vertical slider - # +REALSLIDER_NORMAL+:: same as <tt>REALSLIDER_HORIZONTAL</tt> + # +REALSLIDER_HORIZONTAL+:: RealSlider shown horizontally + # +REALSLIDER_VERTICAL+:: RealSlider shown vertically + # +REALSLIDER_ARROW_UP+:: RealSlider has arrow head pointing up + # +REALSLIDER_ARROW_DOWN+:: RealSlider has arrow head pointing down + # +REALSLIDER_ARROW_LEFT+:: RealSlider has arrow head pointing left + # +REALSLIDER_ARROW_RIGHT+:: RealSlider has arrow head pointing right + # +REALSLIDER_INSIDE_BAR+:: RealSlider is inside the slot rather than overhanging + # +REALSLIDER_TICKS_TOP+:: Ticks on the top of horizontal slider + # +REALSLIDER_TICKS_BOTTOM+:: Ticks on the bottom of horizontal slider + # +REALSLIDER_TICKS_LEFT+:: Ticks on the left of vertical slider + # +REALSLIDER_TICKS_RIGHT+:: Ticks on the right of vertical slider + # +REALSLIDER_NORMAL+:: same as <tt>REALSLIDER_HORIZONTAL</tt> # # === Message identifiers # - # +ID_AUTOINC+:: x - # +ID_AUTODEC+:: x + # +ID_AUTOINC+:: x + # +ID_AUTODEC+:: x # class FXRealSlider < FXFrame @@ -75,18 +75,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this slider [FXComposite] - # +target+:: the message target, if any, for this slider [FXObject] - # +selector+:: the message identifier for this slider [Integer] - # +opts+:: slider 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] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this slider [FXComposite] + # +target+:: the message target, if any, for this slider [FXObject] + # +selector+:: the message identifier for this slider [Integer] + # +opts+:: slider 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] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=REALSLIDER_NORMAL, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theRealSlider end diff --git a/rdoc-sources/FXRealSpinner.rb b/rdoc-sources/FXRealSpinner.rb index 25954a16f2030ebd888c2cfe787cdb8b033d6fb5..3d9ffe99a8b9be76adedfa420ea319244312bd38 100755 --- a/rdoc-sources/FXRealSpinner.rb +++ b/rdoc-sources/FXRealSpinner.rb @@ -6,8 +6,8 @@ module Fox # # The following messages are sent by FXRealSpinner to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. # +SEL_COMMAND+:: # sent whenever the spinner's value changes; the message data is a Float # indicating the new spinner value. @@ -17,18 +17,18 @@ module Fox # # === Spinner options # - # +REALSPIN_NORMAL+:: Normal, non-cyclic - # +REALSPIN_CYCLIC+:: Cyclic spinner - # +REALSPIN_NOTEXT+:: No text visible - # +REALSPIN_NOMAX+:: Spin all the way up to infinity - # +REALSPIN_NOMIN+:: Spin all the way down to -infinity - # +REALSPIN_LOG+:: Logarithmic rather than linear + # +REALSPIN_NORMAL+:: Normal, non-cyclic + # +REALSPIN_CYCLIC+:: Cyclic spinner + # +REALSPIN_NOTEXT+:: No text visible + # +REALSPIN_NOMAX+:: Spin all the way up to infinity + # +REALSPIN_NOMIN+:: Spin all the way down to -infinity + # +REALSPIN_LOG+:: Logarithmic rather than linear # # === Message identifiers # - # +ID_INCREMENT+:: x - # +ID_DECREMENT+:: x - # +ID_ENTRY+:: x + # +ID_INCREMENT+:: x + # +ID_DECREMENT+:: x + # +ID_ENTRY+:: x # class FXRealSpinner < FXPacker # Current value [Float] @@ -78,19 +78,19 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this spinner [FXComposite] - # +cols+:: number of columns to display in the text field [Integer] - # +target+:: the message target, if any, for this spinner [FXObject] - # +selector+:: the message identifier for this spinner [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this spinner [FXComposite] + # +cols+:: number of columns to display in the text field [Integer] + # +target+:: the message target, if any, for this spinner [FXObject] + # +selector+:: the message identifier for this spinner [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, cols, target=nil, selector=0, opts=REALSPIN_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theRealSpinner end diff --git a/rdoc-sources/FXRecentFiles.rb b/rdoc-sources/FXRecentFiles.rb index d1033eb718d03c5e471f150a36897cea2b062b48..69a74753dc98f7583dc45a95836ff440415d9c31 100755 --- a/rdoc-sources/FXRecentFiles.rb +++ b/rdoc-sources/FXRecentFiles.rb @@ -21,18 +21,18 @@ module Fox # # === Message identifiers # - # <tt>ID_CLEAR</tt>:: Clear the list of files - # <tt>ID_ANYFILES</tt>:: x - # <tt>ID_FILE_1</tt>:: x - # <tt>ID_FILE_2</tt>:: x - # <tt>ID_FILE_3</tt>:: x - # <tt>ID_FILE_4</tt>:: x - # <tt>ID_FILE_5</tt>:: x - # <tt>ID_FILE_6</tt>:: x - # <tt>ID_FILE_7</tt>:: x - # <tt>ID_FILE_8</tt>:: x - # <tt>ID_FILE_9</tt>:: x - # <tt>ID_FILE_10</tt>:: x + # <tt>ID_CLEAR</tt>:: Clear the list of files + # <tt>ID_ANYFILES</tt>:: x + # <tt>ID_FILE_1</tt>:: x + # <tt>ID_FILE_2</tt>:: x + # <tt>ID_FILE_3</tt>:: x + # <tt>ID_FILE_4</tt>:: x + # <tt>ID_FILE_5</tt>:: x + # <tt>ID_FILE_6</tt>:: x + # <tt>ID_FILE_7</tt>:: x + # <tt>ID_FILE_8</tt>:: x + # <tt>ID_FILE_9</tt>:: x + # <tt>ID_FILE_10</tt>:: x # class FXRecentFiles < FXObject # Application associated with this recent files group [FXApp] diff --git a/rdoc-sources/FXRectangle.rb b/rdoc-sources/FXRectangle.rb index 4ab5a85aadfd3b8c0c59e0b09743f9ab5e6b561f..8126b806717f541fa72ade971aaf877efa025253 100755 --- a/rdoc-sources/FXRectangle.rb +++ b/rdoc-sources/FXRectangle.rb @@ -28,10 +28,10 @@ module Fox # # ==== Parameters: # - # +xx+:: upper left corner's initial x-coordinate [Integer] - # +yy+:: upper left corner's initial y-coordinate [Integer] - # +ww+:: initial width [Integer] - # +hh+:: initial height [Integer] + # +xx+:: upper left corner's initial x-coordinate [Integer] + # +yy+:: upper left corner's initial y-coordinate [Integer] + # +ww+:: initial width [Integer] + # +hh+:: initial height [Integer] # def initialize(xx, yy, ww, hh); end @@ -40,8 +40,8 @@ module Fox # # ==== Parameters: # - # +p+:: upper left corner's initial position [FXPoint] - # +s+:: initial size [FXSize] + # +p+:: upper left corner's initial position [FXPoint] + # +s+:: initial size [FXSize] # def initialize(p, s); end @@ -50,8 +50,8 @@ module Fox # # ==== Parameters: # - # +topleft+:: upper left corner's initial position [FXPoint] - # +bottomright+:: bottom right corner's initial position [FXPoint] + # +topleft+:: upper left corner's initial position [FXPoint] + # +bottomright+:: bottom right corner's initial position [FXPoint] # def initialize(topleft, bottomright); end @@ -88,7 +88,7 @@ module Fox # # ==== Parameters: # - # +margin+:: number of units to grow on each side [Integer] + # +margin+:: number of units to grow on each side [Integer] # def grow!(margin); end @@ -97,8 +97,8 @@ module Fox # # ==== Parameters: # - # +hormargin+:: number of units to grow on the left and right sides [Integer] - # +vermargin+:: number of units to grow on the top and bottom sides [Integer] + # +hormargin+:: number of units to grow on the left and right sides [Integer] + # +vermargin+:: number of units to grow on the top and bottom sides [Integer] # def grow!(hormargin, vermargin); end @@ -107,10 +107,10 @@ module Fox # # ==== Parameters: # - # +leftmargin+:: number of units to grow on the left side [Integer] - # +rightmargin+:: number of units to grow on the right side [Integer] - # +topmargin+:: number of units to grow on the top side [Integer] - # +bottommargin+:: number of units to grow on the bottom side [Integer] + # +leftmargin+:: number of units to grow on the left side [Integer] + # +rightmargin+:: number of units to grow on the right side [Integer] + # +topmargin+:: number of units to grow on the top side [Integer] + # +bottommargin+:: number of units to grow on the bottom side [Integer] # def grow!(leftmargin, rightmargin, topmargin, bottommargin); end @@ -119,7 +119,7 @@ module Fox # # ==== Parameters: # - # +margin+:: number of units to shrink on each side [Integer] + # +margin+:: number of units to shrink on each side [Integer] # def shrink!(margin); end @@ -128,8 +128,8 @@ module Fox # # ==== Parameters: # - # +hormargin+:: number of units to shrink on the left and right sides [Integer] - # +vermargin+:: number of units to shrink on the top and bottom sides [Integer] + # +hormargin+:: number of units to shrink on the left and right sides [Integer] + # +vermargin+:: number of units to shrink on the top and bottom sides [Integer] # def shrink!(hormargin, vermargin); end @@ -138,10 +138,10 @@ module Fox # # ==== Parameters: # - # +leftmargin+:: number of units to shrink on the left side [Integer] - # +rightmargin+:: number of units to shrink on the right side [Integer] - # +topmargin+:: number of units to shrink on the top side [Integer] - # +bottommargin+:: number of units to shrink on the bottom side [Integer] + # +leftmargin+:: number of units to shrink on the left side [Integer] + # +rightmargin+:: number of units to shrink on the right side [Integer] + # +topmargin+:: number of units to shrink on the top side [Integer] + # +bottommargin+:: number of units to shrink on the bottom side [Integer] # def shrink!(leftmargin, rightmargin, topmargin, bottommargin); end end diff --git a/rdoc-sources/FXRegistry.rb b/rdoc-sources/FXRegistry.rb index 76f064d13748797a0ab434031b7fe89ceaa435af..d4a286c49219a28ee9d744f7cebf28759952bdf7 100755 --- a/rdoc-sources/FXRegistry.rb +++ b/rdoc-sources/FXRegistry.rb @@ -23,13 +23,13 @@ module Fox class FXRegistry < FXSettings # Application key [String] - attr_reader :appKey + attr_reader :appKey # Vendor key [String] - attr_reader :vendorKey + attr_reader :vendorKey # Use file-based registry instead of Windows Registry [Boolean] - attr_writer :asciiMode + attr_writer :asciiMode # # Construct registry object; _appKey_ and _vendorKey_ must be string constants. diff --git a/rdoc-sources/FXReplaceDialog.rb b/rdoc-sources/FXReplaceDialog.rb index 5c69eab0a1ebf90d0974dbeae8301ca1ac89dd6d..06e12ef5d319b6ffa178fa0716f4a7a15542ba6c 100755 --- a/rdoc-sources/FXReplaceDialog.rb +++ b/rdoc-sources/FXReplaceDialog.rb @@ -9,23 +9,23 @@ module Fox # +ID_SEARCH_UP+:: x # +ID_SEARCH_DN+:: x # +ID_REPLACE_UP+:: x - # +ID_REPLACE_DN+:: x - # +ID_ALL+:: x - # +ID_DIR+:: x - # +ID_SEARCH_TEXT+:: x - # +ID_REPLACE_TEXT+:: x - # +ID_MODE+:: x + # +ID_REPLACE_DN+:: x + # +ID_ALL+:: x + # +ID_DIR+:: x + # +ID_SEARCH_TEXT+:: x + # +ID_REPLACE_TEXT+:: x + # +ID_MODE+:: x # class FXReplaceDialog < FXDialogBox # # Search matching mode, one of the following: # - # +DONE+:: Cancel search - # +SEARCH+:: Search first occurrence - # +REPLACE+:: Replace first occurrence - # +SEARCH_NEXT+:: Search next occurrence - # +REPLACE_NEXT+:: Replace next occurrence - # +REPLACE_ALL+:: Replace all occurrences + # +DONE+:: Cancel search + # +SEARCH+:: Search first occurrence + # +REPLACE+:: Replace first occurrence + # +SEARCH_NEXT+:: Search next occurrence + # +REPLACE_NEXT+:: Replace next occurrence + # +REPLACE_ALL+:: Replace all occurrences # attr_accessor :searchMode @@ -40,14 +40,14 @@ module Fox # # ==== 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] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +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] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, width=0, height=0) # :yield: theReplaceDialog end diff --git a/rdoc-sources/FXRootWindow.rb b/rdoc-sources/FXRootWindow.rb index c48040424df5dcf11416eb5f846646cec4676e66..c5a554abb8d3d28c504a6012ad7ac641ec5d4195 100755 --- a/rdoc-sources/FXRootWindow.rb +++ b/rdoc-sources/FXRootWindow.rb @@ -8,8 +8,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +vis+:: a visual [FXVisual] + # +a+:: an application instance [FXApp] + # +vis+:: a visual [FXVisual] # def initialize(a, vis) # :yield: theRootWindow end diff --git a/rdoc-sources/FXRuler.rb b/rdoc-sources/FXRuler.rb index 7e9bb132ea5d9c2874c982418ba1947b8cc437a9..eb68845e18df9c6f9df97b1ed4422a8507147f2b 100755 --- a/rdoc-sources/FXRuler.rb +++ b/rdoc-sources/FXRuler.rb @@ -17,38 +17,38 @@ module Fox # # The following messages are sent by FXRuler 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_CHANGED+:: sent whenever something about the ruler changes + # +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 whenever something about the ruler changes # # === Ruler options # - # +RULER_NORMAL+:: Default appearance (default) - # +RULER_HORIZONTAL+:: Ruler is horizontal (default) - # +RULER_VERTICAL+:: Ruler is vertical - # +RULER_TICKS_OFF+:: Tick marks off (default) - # +RULER_TICKS_TOP+:: Ticks on the top (if horizontal) - # +RULER_TICKS_BOTTOM+:: Ticks on the bottom (if horizontal) - # +RULER_TICKS_LEFT+:: Ticks on the left (if vertical) - # +RULER_TICKS_RIGHT+:: Ticks on the right (if vertical) - # +RULER_TICKS_CENTER+:: Tickmarks centered - # +RULER_NUMBERS+:: Show numbers - # +RULER_ARROW+:: Draw small arrow for cursor position - # +RULER_MARKERS+:: Draw markers for indentation settings - # +RULER_METRIC+:: Metric subdivision (default) - # +RULER_ENGLISH+:: English subdivision - # +RULER_MARGIN_ADJUST+:: Allow margin adjustment - # +RULER_ALIGN_CENTER+:: Center document horizontally - # +RULER_ALIGN_LEFT+:: Align document to the left - # +RULER_ALIGN_RIGHT+:: Align document to the right - # +RULER_ALIGN_TOP+:: Align document to the top - # +RULER_ALIGN_BOTTOM+:: Align document to the bottom - # +RULER_ALIGN_STRETCH+:: Stretch document to fit horizontally - # +RULER_ALIGN_NORMAL+:: Normally, document is centered both ways + # +RULER_NORMAL+:: Default appearance (default) + # +RULER_HORIZONTAL+:: Ruler is horizontal (default) + # +RULER_VERTICAL+:: Ruler is vertical + # +RULER_TICKS_OFF+:: Tick marks off (default) + # +RULER_TICKS_TOP+:: Ticks on the top (if horizontal) + # +RULER_TICKS_BOTTOM+:: Ticks on the bottom (if horizontal) + # +RULER_TICKS_LEFT+:: Ticks on the left (if vertical) + # +RULER_TICKS_RIGHT+:: Ticks on the right (if vertical) + # +RULER_TICKS_CENTER+:: Tickmarks centered + # +RULER_NUMBERS+:: Show numbers + # +RULER_ARROW+:: Draw small arrow for cursor position + # +RULER_MARKERS+:: Draw markers for indentation settings + # +RULER_METRIC+:: Metric subdivision (default) + # +RULER_ENGLISH+:: English subdivision + # +RULER_MARGIN_ADJUST+:: Allow margin adjustment + # +RULER_ALIGN_CENTER+:: Center document horizontally + # +RULER_ALIGN_LEFT+:: Align document to the left + # +RULER_ALIGN_RIGHT+:: Align document to the right + # +RULER_ALIGN_TOP+:: Align document to the top + # +RULER_ALIGN_BOTTOM+:: Align document to the bottom + # +RULER_ALIGN_STRETCH+:: Stretch document to fit horizontally + # +RULER_ALIGN_NORMAL+:: Normally, document is centered both ways # # === Message identifiers: # - # +ID_ARROW+:: write me + # +ID_ARROW+:: write me # class FXRuler < FXFrame diff --git a/rdoc-sources/FXScrollArea.rb b/rdoc-sources/FXScrollArea.rb index 71c594cbf7631f907341ad9e2b446311ba507eae..eb7bb592e430e1a9d3003d60076ceaa6c6fb5c77 100755 --- a/rdoc-sources/FXScrollArea.rb +++ b/rdoc-sources/FXScrollArea.rb @@ -15,58 +15,58 @@ module Fox # # === 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 + # +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 + attr_reader :viewportWidth # Viewport height, in pixels [Integer] - attr_reader :viewportHeight + attr_reader :viewportHeight # Content width, in pixels [Integer] - attr_reader :contentWidth + attr_reader :contentWidth # Content height, in pixels [Integer] - attr_reader :contentHeight + attr_reader :contentHeight # Scroll style [Integer] attr_accessor :scrollStyle # Horizontal scrollbar [FXScrollBar] - attr_reader :horizontalScrollBar + attr_reader :horizontalScrollBar # Vertical scrollbar [FXScrollBar] - attr_reader :verticalScrollBar + attr_reader :verticalScrollBar # Current x-position [Integer] - attr_reader :xPosition + attr_reader :xPosition # Current y-position [Integer] - attr_reader :yPosition + 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] + # +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 diff --git a/rdoc-sources/FXScrollBar.rb b/rdoc-sources/FXScrollBar.rb index 47904ca1965fcd04778edfe8cb248b047de43ac5..a3f0ff034febd9843fa21fcafa9ca00a47fa324d 100755 --- a/rdoc-sources/FXScrollBar.rb +++ b/rdoc-sources/FXScrollBar.rb @@ -18,12 +18,12 @@ module Fox # # 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_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. @@ -33,18 +33,18 @@ module Fox # # === Scrollbar styles # - # +SCROLLBAR_HORIZONTAL+:: Horizontally oriented - # +SCROLLBAR_VERTICAL+:: Vertically oriented (the default) + # +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 + # +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] @@ -79,14 +79,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this scroll bar [FXComposite] - # +target+:: the initial message target (if any) for this scroll bar [FXObject] - # +selector+:: 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] - # +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] + # +p+:: the parent widget for this scroll bar [FXComposite] + # +target+:: the initial message target (if any) for this scroll bar [FXObject] + # +selector+:: 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] + # +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(p, target=nil, selector=0, opts=SCROLLBAR_VERTICAL, x=0, y=0, width=0, height=0) # :yields: theScrollBar end diff --git a/rdoc-sources/FXScrollPane.rb b/rdoc-sources/FXScrollPane.rb index 039a3a859126b9feb1f9259a3754b9152ed339b3..e7455e5481eafb0ac4aa34f851f01ef99ce0ed2f 100755 --- a/rdoc-sources/FXScrollPane.rb +++ b/rdoc-sources/FXScrollPane.rb @@ -17,9 +17,9 @@ module Fox # # ==== Parameters: # - # +owner+:: owner window for this menu pane [FXWindow] - # +nvis+:: maximum number of visible items [Integer] - # +opts+:: options [Integer] + # +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 diff --git a/rdoc-sources/FXScrollWindow.rb b/rdoc-sources/FXScrollWindow.rb index 046fe09b9d903e7ceeea0907e47fdea6517dc9d4..a3dcf55b6b57fcd743cc847816d7d95bf37676f8 100755 --- a/rdoc-sources/FXScrollWindow.rb +++ b/rdoc-sources/FXScrollWindow.rb @@ -19,12 +19,12 @@ module Fox # # ==== 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] - # +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] + # +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] + # +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(p, opts=0, x=0, y=0, width=0, height=0) # :yields: theScrollWindow end diff --git a/rdoc-sources/FXSearchDialog.rb b/rdoc-sources/FXSearchDialog.rb index aed39ffe2a037e231ccb684a8e33b6c84e7fc00c..6702b7ee625aaef084f41e0f031ec8f490dccc51 100755 --- a/rdoc-sources/FXSearchDialog.rb +++ b/rdoc-sources/FXSearchDialog.rb @@ -8,14 +8,14 @@ module Fox # # ==== 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] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +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] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, width=0, height=0) # :yields: theSearchDialog end diff --git a/rdoc-sources/FXSeparator.rb b/rdoc-sources/FXSeparator.rb index 11af2c21b26711758335c38b14993f2e936cdcb1..995cf044a8abb36a6964730056b42b950f195837 100755 --- a/rdoc-sources/FXSeparator.rb +++ b/rdoc-sources/FXSeparator.rb @@ -8,10 +8,10 @@ module Fox # # === Separator options # - # +SEPARATOR_NONE+:: Nothing visible - # +SEPARATOR_GROOVE+:: Etched-in looking groove - # +SEPARATOR_RIDGE+:: Embossed looking ridge - # +SEPARATOR_LINE+:: Simple line + # +SEPARATOR_NONE+:: Nothing visible + # +SEPARATOR_GROOVE+:: Etched-in looking groove + # +SEPARATOR_RIDGE+:: Embossed looking ridge + # +SEPARATOR_LINE+:: Simple line # class FXSeparator < FXFrame @@ -32,16 +32,16 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this separator [FXComposite] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent widget for this separator [FXComposite] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=1, padRight=1, padTop=0, padBottom=0) # :yields: theHorizontalSeparator end @@ -56,16 +56,16 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this separator [FXComposite] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent widget for this separator [FXComposite] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_Y, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=1, padBottom=1) # :yields: theVerticalSeparator end diff --git a/rdoc-sources/FXSettings.rb b/rdoc-sources/FXSettings.rb index b63c6e18d4100e2a5e61d383de741bbc9ff7a54c..44f6133bab98bdb7282c379f036d4b8a4f51adb6 100755 --- a/rdoc-sources/FXSettings.rb +++ b/rdoc-sources/FXSettings.rb @@ -30,7 +30,7 @@ module Fox # # ==== Parameters: # - # +pos+:: the section number of interest [Integer] + # +pos+:: the section number of interest [Integer] # def data(pos) ; end @@ -41,7 +41,7 @@ module Fox # # ==== Parameters: # - # +section+:: the section name of interest [String] + # +section+:: the section name of interest [String] # def find(section) ; end @@ -57,9 +57,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [String] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [String] # def readStringEntry(section, key, default="") ; end @@ -69,9 +69,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [Integer] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [Integer] # def readIntEntry(section, key, default=0) ; end @@ -81,9 +81,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [Integer] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [Integer] # def readUnsignedEntry(section, key, default=0) ; end @@ -93,9 +93,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [Float] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [Float] # def readRealEntry(section, key, default=0.0) ; end @@ -105,9 +105,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [FXColor] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [FXColor] # def readColorEntry(section, key, default=0) ; end @@ -117,9 +117,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for the setting of interest [String] - # +default+:: the default value to return if _key_ is not found [true or false] + # +section+:: the section name [String] + # +key+:: the key for the setting of interest [String] + # +default+:: the default value to return if _key_ is not found [true or false] # def readBoolEntry(section, key, default=false) ; end @@ -129,9 +129,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [String] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [String] # def writeStringEntry(section, key, value) ; end @@ -141,9 +141,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [Integer] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [Integer] # def writeIntEntry(section, key, value) ; end @@ -153,9 +153,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [Integer] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [Integer] # def writeUnsignedEntry(section, key, value) ; end @@ -165,9 +165,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [Float] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [Float] # def writeRealEntry(section, key, value) ; end @@ -177,9 +177,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [FXColor] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [FXColor] # def writeColorEntry(section, key, value) ; end @@ -189,9 +189,9 @@ module Fox # # ==== Parameters: # - # +section+:: the section name [String] - # +key+:: the key for this setting [String] - # +value+:: the value for this setting [true or false] + # +section+:: the section name [String] + # +key+:: the key for this setting [String] + # +value+:: the value for this setting [true or false] # def writeBoolEntry(section, key, value) ; end @@ -201,8 +201,8 @@ module Fox # # ==== Parameters: # - # +section+:: the section containing the key to be deleted [String] - # +key+:: the key to be deleted [String] + # +section+:: the section containing the key to be deleted [String] + # +key+:: the key to be deleted [String] # def deleteEntry(section, key) ; end @@ -211,8 +211,8 @@ module Fox # # ==== Parameters: # - # +section+:: the section containing the key of interest [String] - # +key+:: the key of interest [String] + # +section+:: the section containing the key of interest [String] + # +key+:: the key of interest [String] # def existingEntry?(section, key) ; end @@ -222,7 +222,7 @@ module Fox # # ==== Parameters: # - # +section+:: the name of the section to be deleted [String] + # +section+:: the name of the section to be deleted [String] # def deleteSection(section) ; end @@ -231,7 +231,7 @@ module Fox # # ==== Parameters: # - # +section+:: the name of the section of interest [String] + # +section+:: the name of the section of interest [String] # def existingSection?(section) ; end diff --git a/rdoc-sources/FXShutter.rb b/rdoc-sources/FXShutter.rb index 7f97fdd2cebf5ee3349a0a913889b5ac6d8cfa48..68c1f2aadc7069252ee69167522ba1166fa13243 100755 --- a/rdoc-sources/FXShutter.rb +++ b/rdoc-sources/FXShutter.rb @@ -7,7 +7,7 @@ module Fox # # === Message identifiers # - # +ID_SHUTTERITEM_BUTTON+:: x + # +ID_SHUTTERITEM_BUTTON+:: x # class FXShutterItem < FXVerticalFrame # @@ -29,20 +29,20 @@ module Fox # # ==== Parameters: # - # +p+:: the parent shutter for this shutter item [FXShutter] - # +text+:: the text, if any [String] - # +icon+:: the icon, if any [FXIcon] - # +opts+:: 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] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent shutter for this shutter item [FXShutter] + # +text+:: the text, if any [String] + # +icon+:: the icon, if any [FXIcon] + # +opts+:: 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] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, text="", icon=nil, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutterItem end @@ -63,10 +63,10 @@ module Fox # # === Message identifiers # - # +ID_SHUTTER_TIMEOUT+:: x - # +ID_OPEN_SHUTTERITEM+:: x - # +ID_OPEN_FIRST+:: x - # +ID_OPEN_LAST+:: x + # +ID_SHUTTER_TIMEOUT+:: x + # +ID_OPEN_SHUTTERITEM+:: x + # +ID_OPEN_FIRST+:: x + # +ID_OPEN_LAST+:: x # class FXShutter < FXVerticalFrame @@ -80,20 +80,20 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this shutter [FXComposite] - # +target+:: the message target, if any, for this shutter [FXObject] - # +selector+:: the message identifier for this shutter [Integer] - # +opts+:: shutter options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this shutter [FXComposite] + # +target+:: the message target, if any, for this shutter [FXObject] + # +selector+:: the message identifier for this shutter [Integer] + # +opts+:: shutter options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutter end diff --git a/rdoc-sources/FXSize.rb b/rdoc-sources/FXSize.rb index 242359f1ff32b3e60e3c12ab48f7d716ecf157fb..502aec03184db4592791d092737c6185ddd21a57 100755 --- a/rdoc-sources/FXSize.rb +++ b/rdoc-sources/FXSize.rb @@ -34,7 +34,7 @@ module Fox # # ==== Parameters: # - # +margin+:: number of units to grow on each side [Integer] + # +margin+:: number of units to grow on each side [Integer] # def grow!(margin); end @@ -43,8 +43,8 @@ module Fox # # ==== Parameters: # - # +hormargin+:: number of units to grow on the left and right sides [Integer] - # +vermargin+:: number of units to grow on the top and bottom sides [Integer] + # +hormargin+:: number of units to grow on the left and right sides [Integer] + # +vermargin+:: number of units to grow on the top and bottom sides [Integer] # def grow!(hormargin, vermargin); end @@ -53,10 +53,10 @@ module Fox # # ==== Parameters: # - # +leftmargin+:: number of units to grow on the left side [Integer] - # +rightmargin+:: number of units to grow on the right side [Integer] - # +topmargin+:: number of units to grow on the top side [Integer] - # +bottommargin+:: number of units to grow on the bottom side [Integer] + # +leftmargin+:: number of units to grow on the left side [Integer] + # +rightmargin+:: number of units to grow on the right side [Integer] + # +topmargin+:: number of units to grow on the top side [Integer] + # +bottommargin+:: number of units to grow on the bottom side [Integer] # def grow!(leftmargin, rightmargin, topmargin, bottommargin); end @@ -65,7 +65,7 @@ module Fox # # ==== Parameters: # - # +margin+:: number of units to shrink on each side [Integer] + # +margin+:: number of units to shrink on each side [Integer] # def shrink!(margin); end @@ -74,8 +74,8 @@ module Fox # # ==== Parameters: # - # +hormargin+:: number of units to shrink on the left and right sides [Integer] - # +vermargin+:: number of units to shrink on the top and bottom sides [Integer] + # +hormargin+:: number of units to shrink on the left and right sides [Integer] + # +vermargin+:: number of units to shrink on the top and bottom sides [Integer] # def shrink!(hormargin, vermargin); end @@ -84,10 +84,10 @@ module Fox # # ==== Parameters: # - # +leftmargin+:: number of units to shrink on the left side [Integer] - # +rightmargin+:: number of units to shrink on the right side [Integer] - # +topmargin+:: number of units to shrink on the top side [Integer] - # +bottommargin+:: number of units to shrink on the bottom side [Integer] + # +leftmargin+:: number of units to shrink on the left side [Integer] + # +rightmargin+:: number of units to shrink on the right side [Integer] + # +topmargin+:: number of units to shrink on the top side [Integer] + # +bottommargin+:: number of units to shrink on the bottom side [Integer] # def shrink!(leftmargin, rightmargin, topmargin, bottommargin); end end diff --git a/rdoc-sources/FXSlider.rb b/rdoc-sources/FXSlider.rb index 7923f9402002a6a4a30b8e47a2ba9f182d665785..12968fee55d7c026ece1de7046069a79879e12c7 100755 --- a/rdoc-sources/FXSlider.rb +++ b/rdoc-sources/FXSlider.rb @@ -9,12 +9,12 @@ module Fox # # The following messages are sent by FXSlider to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_COMMAND+:: # sent at the end of a slider move; the message data is the new position of the slider (an Integer). # +SEL_CHANGED+:: @@ -23,23 +23,23 @@ module Fox # # === Slider control styles # - # +SLIDER_HORIZONTAL+:: Slider shown horizontally - # +SLIDER_VERTICAL+:: Slider shown vertically - # +SLIDER_ARROW_UP+:: Slider has arrow head pointing up - # +SLIDER_ARROW_DOWN+:: Slider has arrow head pointing down - # +SLIDER_ARROW_LEFT+:: Slider has arrow head pointing left - # +SLIDER_ARROW_RIGHT+:: Slider has arrow head pointing right - # +SLIDER_INSIDE_BAR+:: Slider is inside the slot rather than overhanging - # +SLIDER_TICKS_TOP+:: Ticks on the top of horizontal slider - # +SLIDER_TICKS_BOTTOM+:: Ticks on the bottom of horizontal slider - # +SLIDER_TICKS_LEFT+:: Ticks on the left of vertical slider - # +SLIDER_TICKS_RIGHT+:: Ticks on the right of vertical slider - # +SLIDER_NORMAL+:: same as <tt>SLIDER_HORIZONTAL</tt> + # +SLIDER_HORIZONTAL+:: Slider shown horizontally + # +SLIDER_VERTICAL+:: Slider shown vertically + # +SLIDER_ARROW_UP+:: Slider has arrow head pointing up + # +SLIDER_ARROW_DOWN+:: Slider has arrow head pointing down + # +SLIDER_ARROW_LEFT+:: Slider has arrow head pointing left + # +SLIDER_ARROW_RIGHT+:: Slider has arrow head pointing right + # +SLIDER_INSIDE_BAR+:: Slider is inside the slot rather than overhanging + # +SLIDER_TICKS_TOP+:: Ticks on the top of horizontal slider + # +SLIDER_TICKS_BOTTOM+:: Ticks on the bottom of horizontal slider + # +SLIDER_TICKS_LEFT+:: Ticks on the left of vertical slider + # +SLIDER_TICKS_RIGHT+:: Ticks on the right of vertical slider + # +SLIDER_NORMAL+:: same as <tt>SLIDER_HORIZONTAL</tt> # # === Message identifiers # - # +ID_AUTOINC+:: x - # +ID_AUTODEC+:: x + # +ID_AUTOINC+:: x + # +ID_AUTODEC+:: x # class FXSlider < FXFrame @@ -78,18 +78,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this slider [FXComposite] - # +target+:: the message target, if any, for this slider [FXObject] - # +selector+:: the message identifier for this slider [Integer] - # +opts+:: slider 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] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this slider [FXComposite] + # +target+:: the message target, if any, for this slider [FXObject] + # +selector+:: the message identifier for this slider [Integer] + # +opts+:: slider 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] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=SLIDER_NORMAL, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theSlider end diff --git a/rdoc-sources/FXSphered.rb b/rdoc-sources/FXSphered.rb index 82d1548d2481ef6788627eaf46694f8bd42b78ca..c6c4dcd383744801b3ab7265fe39bc2a62a149b5 100755 --- a/rdoc-sources/FXSphered.rb +++ b/rdoc-sources/FXSphered.rb @@ -55,7 +55,7 @@ module Fox def include!(box); end # Expand radius to include box (an FXRanged instance) and return a reference to self. - def includeInRadius!(box); + def includeInRadius!(box); end # Include the sphere _sphere_ (an FXSphered instance) into this sphere and return self. def include!(sphere); end diff --git a/rdoc-sources/FXSpheref.rb b/rdoc-sources/FXSpheref.rb index d6031b3b1d1947eec14afc7affb70fa6fb38bff0..b790bd75d90117aab5e15d7c6138bda5a6b764e2 100755 --- a/rdoc-sources/FXSpheref.rb +++ b/rdoc-sources/FXSpheref.rb @@ -55,7 +55,7 @@ module Fox def include!(box); end # Expand radius to include box (an FXRangef instance) and return a reference to self. - def includeInRadius!(box); + def includeInRadius!(box); end # Include the sphere _sphere_ (an FXSpheref instance) into this sphere and return self. def include!(sphere); end diff --git a/rdoc-sources/FXSpinner.rb b/rdoc-sources/FXSpinner.rb index 8c52bb7f2e559d4179ac17ee91c8da4accd78fb9..29c5bbd3a903c7c0658f46e5761d718005f24457 100755 --- a/rdoc-sources/FXSpinner.rb +++ b/rdoc-sources/FXSpinner.rb @@ -6,8 +6,8 @@ module Fox # # The following messages are sent by FXSpinner to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. # +SEL_COMMAND+:: # sent whenever the spinner's value changes; the message data is an integer # indicating the new spinner value. @@ -17,17 +17,17 @@ module Fox # # === Spinner options # - # +SPIN_NORMAL+:: Normal, non-cyclic - # +SPIN_CYCLIC+:: Cyclic spinner - # +SPIN_NOTEXT+:: No text visible - # +SPIN_NOMAX+:: Spin all the way up to infinity - # +SPIN_NOMIN+:: Spin all the way down to -infinity + # +SPIN_NORMAL+:: Normal, non-cyclic + # +SPIN_CYCLIC+:: Cyclic spinner + # +SPIN_NOTEXT+:: No text visible + # +SPIN_NOMAX+:: Spin all the way up to infinity + # +SPIN_NOMIN+:: Spin all the way down to -infinity # # === Message identifiers # - # +ID_INCREMENT+:: x - # +ID_DECREMENT+:: x - # +ID_ENTRY+:: x + # +ID_INCREMENT+:: x + # +ID_DECREMENT+:: x + # +ID_ENTRY+:: x # class FXSpinner < FXPacker # Current value [Integer] @@ -74,19 +74,19 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this spinner [FXComposite] - # +cols+:: number of columns to display in the text field [Integer] - # +target+:: the message target, if any, for this spinner [FXObject] - # +selector+:: the message identifier for this spinner [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this spinner [FXComposite] + # +cols+:: number of columns to display in the text field [Integer] + # +target+:: the message target, if any, for this spinner [FXObject] + # +selector+:: the message identifier for this spinner [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, cols, target=nil, selector=0, opts=SPIN_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theSpinner end diff --git a/rdoc-sources/FXSplashWindow.rb b/rdoc-sources/FXSplashWindow.rb index aaaefec392ea56dc3d6bdb1ebf74e191c3d11031..bedf60c17b2cf1a45524671c0c7c5623210a3229 100644 --- a/rdoc-sources/FXSplashWindow.rb +++ b/rdoc-sources/FXSplashWindow.rb @@ -7,10 +7,10 @@ module Fox # # === Splash window options # - # +SPLASH_SIMPLE+:: Simple rectangular splash window - # +SPLASH_SHAPED+:: Shaped splash window - # +SPLASH_OWNS_ICON+:: Splash window will own the icon and destroy it - # +SPLASH_DESTROY+:: Splash window will destroy itself when timer expires + # +SPLASH_SIMPLE+:: Simple rectangular splash window + # +SPLASH_SHAPED+:: Shaped splash window + # +SPLASH_OWNS_ICON+:: Splash window will own the icon and destroy it + # +SPLASH_DESTROY+:: Splash window will destroy itself when timer expires # class FXSplashWindow < FXTopWindow # The splash window's icon [FXIcon] diff --git a/rdoc-sources/FXSplitter.rb b/rdoc-sources/FXSplitter.rb index d3b7696ae0722d6272bd25f97b98125459f40c9c..1187f9d7063f47f803d592af9f7d60bc7eeea1e3 100755 --- a/rdoc-sources/FXSplitter.rb +++ b/rdoc-sources/FXSplitter.rb @@ -20,10 +20,10 @@ module Fox # # The following messages are sent by FXSplitter 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_COMMAND+:: sent at the end of a resize operation, to signal that the resize is complete - # +SEL_CHANGED+:: sent continuously while a resize operation is occurring + # +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_COMMAND+:: sent at the end of a resize operation, to signal that the resize is complete + # +SEL_CHANGED+:: sent continuously while a resize operation is occurring # # === Splitter options # @@ -46,12 +46,12 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent widget for this splitter [FXComposite] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, opts=SPLITTER_NORMAL, x=0, y=0, width=0, height=0) # :yields: theSplitter end @@ -61,14 +61,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this splitter [FXComposite] - # +target+:: the message target for this splitter [FXObject] - # +selector+:: the message identifier for this splitter [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent widget for this splitter [FXComposite] + # +target+:: the message target for this splitter [FXObject] + # +selector+:: the message identifier for this splitter [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, tgt, sel, opts=SPLITTER_NORMAL, x=0, y=0, width=0, height=0) # :yields: theSplitter end diff --git a/rdoc-sources/FXSpring.rb b/rdoc-sources/FXSpring.rb index df192a892a7135da0d65b382fe182c0f16c1ee13..14a1e1d9d7ee3f62160e911fde4a3cf146f70db0 100755 --- a/rdoc-sources/FXSpring.rb +++ b/rdoc-sources/FXSpring.rb @@ -39,20 +39,20 @@ module Fox # # ==== Parameters: # - # +p+:: the parent widget for this spring [FXComposite] - # +relw+:: the relative width [Integer] - # +relh+:: the relative height [Integer] - # +opts+:: the options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: left-side padding (in pixels) [Integer] - # +padRight+:: right-side padding (in pixels) [Integer] - # +padTop+:: top-side padding (in pixels) [Integer] - # +padBottom+:: bottom-side padding (in pixels) [Integer] - # +hSpacing+:: horizontal spacing (in pixels) [Integer] - # +vSpacing+:: vertical spacing (in pixels) [Integer] + # +p+:: the parent widget for this spring [FXComposite] + # +relw+:: the relative width [Integer] + # +relh+:: the relative height [Integer] + # +opts+:: the options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: left-side padding (in pixels) [Integer] + # +padRight+:: right-side padding (in pixels) [Integer] + # +padTop+:: top-side padding (in pixels) [Integer] + # +padBottom+:: bottom-side padding (in pixels) [Integer] + # +hSpacing+:: horizontal spacing (in pixels) [Integer] + # +vSpacing+:: vertical spacing (in pixels) [Integer] # def initialize(p, opts=0, relw=0, relh=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theSpring end diff --git a/rdoc-sources/FXStatusBar.rb b/rdoc-sources/FXStatusBar.rb index 4d1b3a9debfdd0430d0e1f7aeaae01b4f1cef213..cb43db4bdda815287c688379d37fe40e7dec63d6 100755 --- a/rdoc-sources/FXStatusBar.rb +++ b/rdoc-sources/FXStatusBar.rb @@ -22,18 +22,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this status bar [FXComposite] - # +opts+:: status bar options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this status bar [FXComposite] + # +opts+:: status bar options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, opts=0, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=4, vSpacing=0) # :yields: theStatusBar end diff --git a/rdoc-sources/FXStatusLine.rb b/rdoc-sources/FXStatusLine.rb index 9586bcb9455aa0b5e32358c0e658519c9c8a00b6..e2187f4873f58149913e00fa3fa0a5d28c7dd8ea 100755 --- a/rdoc-sources/FXStatusLine.rb +++ b/rdoc-sources/FXStatusLine.rb @@ -44,9 +44,9 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this shutter [FXComposite] - # +target+:: the message target, if any, for this shutter [FXObject] - # +selector+:: the message identifier for this shutter [Integer] + # +p+:: the parent window for this shutter [FXComposite] + # +target+:: the message target, if any, for this shutter [FXObject] + # +selector+:: the message identifier for this shutter [Integer] # def initialize(p, target=nil, selector=0) # :yields: theStatusLine end diff --git a/rdoc-sources/FXStream.rb b/rdoc-sources/FXStream.rb index 2abd34fd7bf15b1cc015f004d2ed452ca841b0cf..7337c954fd41a40a7b19da3e377e90d13c50c159 100755 --- a/rdoc-sources/FXStream.rb +++ b/rdoc-sources/FXStream.rb @@ -22,27 +22,27 @@ module Fox # # === Stream status codes # - # +FXStreamOK+:: OK - # +FXStreamEnd+:: Try read past end of stream - # +FXStreamFull+:: Filled up stream buffer or disk full - # +FXStreamNoWrite+:: Unable to open for write - # +FXStreamNoRead+:: Unable to open for read - # +FXStreamFormat+:: Stream format error - # +FXStreamUnknown+:: Trying to read unknown class - # +FXStreamAlloc+:: Alloc failed - # +FXStreamFailure+:: General failure + # +FXStreamOK+:: OK + # +FXStreamEnd+:: Try read past end of stream + # +FXStreamFull+:: Filled up stream buffer or disk full + # +FXStreamNoWrite+:: Unable to open for write + # +FXStreamNoRead+:: Unable to open for read + # +FXStreamFormat+:: Stream format error + # +FXStreamUnknown+:: Trying to read unknown class + # +FXStreamAlloc+:: Alloc failed + # +FXStreamFailure+:: General failure # # === Stream data flow direction # - # +FXStreamDead+:: Unopened stream - # +FXStreamSave+:: Saving stuff to stream - # +FXStreamLoad+:: Loading stuff from stream + # +FXStreamDead+:: Unopened stream + # +FXStreamSave+:: Saving stuff to stream + # +FXStreamLoad+:: Loading stuff from stream # # === Stream seeking # - # +FXFromStart+:: Seek from start position - # +FXFromCurrent+:: Seek from current position - # +FXFromEnd+:: Seek from end position + # +FXFromStart+:: Seek from start position + # +FXFromCurrent+:: Seek from current position + # +FXFromEnd+:: Seek from end position # class FXStream @@ -69,7 +69,7 @@ module Fox # # ==== Parameters: # - # +cont+:: the container object, or +nil+ if there is none [FXObject]. + # +cont+:: the container object, or +nil+ if there is none [FXObject]. # def initialize(cont=nil) # :yields: theStream end @@ -83,9 +83,9 @@ module Fox # # ==== Parameters: # - # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer] - # +size+:: initial buffer size [Integer] - # +data+:: external data buffer (if any) [String] + # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer] + # +size+:: initial buffer size [Integer] + # +data+:: external data buffer (if any) [String] # def open(save_or_load, size=8192, data=nil); end diff --git a/rdoc-sources/FXSwitcher.rb b/rdoc-sources/FXSwitcher.rb index ea7ca0dcfc95f8fcc9c05bc589d1bf1bf4453957..d52132b2e091161d9dd5e3cb6ba2103ce4042c0f 100755 --- a/rdoc-sources/FXSwitcher.rb +++ b/rdoc-sources/FXSwitcher.rb @@ -24,22 +24,22 @@ module Fox # # === Switcher options # - # +SWITCHER_HCOLLAPSE+:: Collapse horizontally to width of current child - # +SWITCHER_VCOLLAPSE+:: Collapse vertically to height of current child + # +SWITCHER_HCOLLAPSE+:: Collapse horizontally to width of current child + # +SWITCHER_VCOLLAPSE+:: Collapse vertically to height of current child # # === Message identifiers # - # +ID_OPEN_FIRST+:: x - # +ID_OPEN_SECOND+:: x - # +ID_OPEN_THIRD+:: x - # +ID_OPEN_FOURTH+:: x - # +ID_OPEN_FIFTH+:: x - # +ID_OPEN_SIXTH+:: x - # +ID_OPEN_SEVENTH+:: x - # +ID_OPEN_EIGHTH+:: x - # +ID_OPEN_NINETH+:: x - # +ID_OPEN_TENTH+:: x - # +ID_OPEN_LAST+:: x + # +ID_OPEN_FIRST+:: x + # +ID_OPEN_SECOND+:: x + # +ID_OPEN_THIRD+:: x + # +ID_OPEN_FOURTH+:: x + # +ID_OPEN_FIFTH+:: x + # +ID_OPEN_SIXTH+:: x + # +ID_OPEN_SEVENTH+:: x + # +ID_OPEN_EIGHTH+:: x + # +ID_OPEN_NINETH+:: x + # +ID_OPEN_TENTH+:: x + # +ID_OPEN_LAST+:: x # class FXSwitcher < FXPacker # Current child window's index [Integer] @@ -53,16 +53,16 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this switcher [FXComposite] - # +opts+:: switcher options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this switcher [FXComposite] + # +opts+:: switcher options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING) # :yields: theSwitcher end diff --git a/rdoc-sources/FXTGAIcon.rb b/rdoc-sources/FXTGAIcon.rb index 965232f878f5c25488e48e3d4b2ca2c03b0577c4..75e73678d1e04f2d155c4c5b5d8a8b8d9e1a4fcb 100755 --- a/rdoc-sources/FXTGAIcon.rb +++ b/rdoc-sources/FXTGAIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in Targa file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in Targa file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theTGAIcon end @@ -37,7 +37,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadTGA(store); end @@ -47,11 +47,11 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +channels+:: number of channels in the image pixel data: 3 for RGB data, or 4 for RGBA data [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +channels+:: number of channels in the image pixel data: 3 for RGB data, or 4 for RGBA data [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def Fox.fxsaveTGA(store, data, channels, width, height); end diff --git a/rdoc-sources/FXTGAImage.rb b/rdoc-sources/FXTGAImage.rb index 7562ddd25ebbaef68fcef6cba4e16efa4e5f929c..113c7589247c28198744e1b658cde3c790c1c86e 100755 --- a/rdoc-sources/FXTGAImage.rb +++ b/rdoc-sources/FXTGAImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in Targa file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in Targa file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theTGAImage end diff --git a/rdoc-sources/FXTIFIcon.rb b/rdoc-sources/FXTIFIcon.rb index 8c438e73cd33285854cf06cb76248687a05b2acd..552d3eda813fc409bbcd19e854f6eec1446a48ac 100755 --- a/rdoc-sources/FXTIFIcon.rb +++ b/rdoc-sources/FXTIFIcon.rb @@ -24,12 +24,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in TIFF file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in TIFF file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theTIFIcon end @@ -43,7 +43,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadTIF(store); end @@ -53,12 +53,12 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the image data [FXStream] - # +data+:: the image pixel data [String] - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] - # +codec+:: codec setting [Integer] + # +store+:: stream to which to write the image data [FXStream] + # +data+:: the image pixel data [String] + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] + # +codec+:: codec setting [Integer] # def Fox.fxsaveTIF(store, data, transp, width, height, codec); end diff --git a/rdoc-sources/FXTIFImage.rb b/rdoc-sources/FXTIFImage.rb index dcc230d8c6c815c6d319d6b7485ab2e168918b70..d8ee71a5a48e7267796b9603b41e6f504de07a70 100755 --- a/rdoc-sources/FXTIFImage.rb +++ b/rdoc-sources/FXTIFImage.rb @@ -24,11 +24,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in TIF file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in TIF file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theTIFImage end diff --git a/rdoc-sources/FXTabBar.rb b/rdoc-sources/FXTabBar.rb index bb811ba9c61beca8c30d4208512bcdddcb951be5..f7d3a63df7dd9ea77e924b4e47d724981447aa4c 100755 --- a/rdoc-sources/FXTabBar.rb +++ b/rdoc-sources/FXTabBar.rb @@ -19,27 +19,27 @@ module Fox # # === Tab book options # - # +TABBOOK_TOPTABS+:: Tabs on top (default) - # +TABBOOK_BOTTOMTABS+:: Tabs on bottom - # +TABBOOK_SIDEWAYS+:: Tabs on left - # +TABBOOK_LEFTTABS+:: Tabs on left - # +TABBOOK_RIGHTTABS+:: Tabs on right - # +TABBOOK_NORMAL+:: same as <tt>TABBOOK_TOPTABS</tt> + # +TABBOOK_TOPTABS+:: Tabs on top (default) + # +TABBOOK_BOTTOMTABS+:: Tabs on bottom + # +TABBOOK_SIDEWAYS+:: Tabs on left + # +TABBOOK_LEFTTABS+:: Tabs on left + # +TABBOOK_RIGHTTABS+:: Tabs on right + # +TABBOOK_NORMAL+:: same as <tt>TABBOOK_TOPTABS</tt> # # === Message identifiers # - # +ID_OPEN_ITEM+:: Sent from one of the FXTabItems - # +ID_OPEN_FIRST+:: Switch to the first panel - # +ID_OPEN_SECOND+:: x - # +ID_OPEN_THIRD+:: x - # +ID_OPEN_FOURTH+:: x - # +ID_OPEN_FIFTH+:: x - # +ID_OPEN_SIXTH+:: x - # +ID_OPEN_SEVENTH+:: x - # +ID_OPEN_EIGHTH+:: x - # +ID_OPEN_NINETH+:: x - # +ID_OPEN_TENTH+:: x - # +ID_OPEN_LAST+:: x + # +ID_OPEN_ITEM+:: Sent from one of the FXTabItems + # +ID_OPEN_FIRST+:: Switch to the first panel + # +ID_OPEN_SECOND+:: x + # +ID_OPEN_THIRD+:: x + # +ID_OPEN_FOURTH+:: x + # +ID_OPEN_FIFTH+:: x + # +ID_OPEN_SIXTH+:: x + # +ID_OPEN_SEVENTH+:: x + # +ID_OPEN_EIGHTH+:: x + # +ID_OPEN_NINETH+:: x + # +ID_OPEN_TENTH+:: x + # +ID_OPEN_LAST+:: x # class FXTabBar < FXPacker # Currently active tab item's index [Integer] @@ -53,18 +53,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tar bar [FXComposite] - # +target+:: the message target, if any, for this tar bar [FXObject] - # +selector+:: the message identifier for this tab bar [Integer] - # +opts+:: tar bar options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this tar bar [FXComposite] + # +target+:: the message target, if any, for this tar bar [FXObject] + # +selector+:: the message identifier for this tab bar [Integer] + # +opts+:: tar bar options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=TABBOOK_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING) # :yields: theTabBar end diff --git a/rdoc-sources/FXTabBook.rb b/rdoc-sources/FXTabBook.rb index 9343bcba6f2dc06a5077364ef52066726fd468f9..21480d325a6c3334b2122cc06b600327787266b8 100755 --- a/rdoc-sources/FXTabBook.rb +++ b/rdoc-sources/FXTabBook.rb @@ -21,18 +21,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tar book [FXComposite] - # +target+:: the message target, if any, for this tar book [FXObject] - # +selector+:: the message identifier for this tab book [Integer] - # +opts+:: tar book options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this tar book [FXComposite] + # +target+:: the message target, if any, for this tar book [FXObject] + # +selector+:: the message identifier for this tab book [Integer] + # +opts+:: tar book options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=TABBOOK_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING) # :yields: theTabBook end diff --git a/rdoc-sources/FXTabItem.rb b/rdoc-sources/FXTabItem.rb index 959786c220e501cb4b8a08e26ce1d113ec07f8b1..49724f0454a3a06805f20f11224ee60a3a4aed92 100755 --- a/rdoc-sources/FXTabItem.rb +++ b/rdoc-sources/FXTabItem.rb @@ -11,19 +11,19 @@ module Fox # # The following messages are sent by FXTabItem to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. # # === Tab item orientations (which affect border) # - # +TAB_TOP+:: Top side tabs - # +TAB_LEFT+:: Left side tabs - # +TAB_RIGHT+:: Right side tabs - # +TAB_BOTTOM+:: Bottom side tabs - # +TAB_TOP_NORMAL+:: same as <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT|TAB_TOP|FRAME_RAISED|FRAME_THICK</tt> - # +TAB_BOTTOM_NORMAL+:: same as <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT|TAB_BOTTOM|FRAME_RAISED|FRAME_THICK</tt> - # +TAB_LEFT_NORMAL+:: same as <tt>JUSTIFY_LEFT|JUSTIFY_CENTER_Y|ICON_BEFORE_TEXT|TAB_LEFT|FRAME_RAISED|FRAME_THICK</tt> - # +TAB_RIGHT_NORMAL+:: same as <tt>JUSTIFY_LEFT|JUSTIFY_CENTER_Y|ICON_BEFORE_TEXT|TAB_RIGHT|FRAME_RAISED|FRAME_THICK</tt> + # +TAB_TOP+:: Top side tabs + # +TAB_LEFT+:: Left side tabs + # +TAB_RIGHT+:: Right side tabs + # +TAB_BOTTOM+:: Bottom side tabs + # +TAB_TOP_NORMAL+:: same as <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT|TAB_TOP|FRAME_RAISED|FRAME_THICK</tt> + # +TAB_BOTTOM_NORMAL+:: same as <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT|TAB_BOTTOM|FRAME_RAISED|FRAME_THICK</tt> + # +TAB_LEFT_NORMAL+:: same as <tt>JUSTIFY_LEFT|JUSTIFY_CENTER_Y|ICON_BEFORE_TEXT|TAB_LEFT|FRAME_RAISED|FRAME_THICK</tt> + # +TAB_RIGHT_NORMAL+:: same as <tt>JUSTIFY_LEFT|JUSTIFY_CENTER_Y|ICON_BEFORE_TEXT|TAB_RIGHT|FRAME_RAISED|FRAME_THICK</tt> # class FXTabItem < FXLabel @@ -38,18 +38,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent tab book (or tab bar) for this tab item [FXTabBar] - # +text+:: the text for this tab item [String] - # +ic+:: the icon for this tab item, if any [FXIcon] - # +opts+:: tab item options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent tab book (or tab bar) for this tab item [FXTabBar] + # +text+:: the text for this tab item [String] + # +ic+:: the icon for this tab item, if any [FXIcon] + # +opts+:: tab item options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, text, ic=nil, opts=TAB_TOP_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTabItem end diff --git a/rdoc-sources/FXTable.rb b/rdoc-sources/FXTable.rb index d4a0a778ec0fcf485d3bc6e8a259e3cd38e58b3b..c4b956a56dea0dfe5c2137b47d376b8d0b21d00c 100755 --- a/rdoc-sources/FXTable.rb +++ b/rdoc-sources/FXTable.rb @@ -81,9 +81,9 @@ module Fox # # ==== Parameters: # - # +text+:: the text for this table item [String] - # +icon+:: the icon, if any, for this table item [FXIcon] - # +data+:: the user data for this table item [Object] + # +text+:: the text for this table item [String] + # +icon+:: the icon, if any, for this table item [FXIcon] + # +data+:: the user data for this table item [Object] # def initialize(text, icon=nil, data=nil); end @@ -196,68 +196,68 @@ module Fox # # The following messages are sent by FXTable to its target: # - # +SEL_COMMAND+:: sent when a new item is clicked; the message data is an FXTablePos instance indicating the current cell. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_RIGHTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance. - # +SEL_RIGHTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance. - # +SEL_SELECTED+:: sent when a cell is selected; the message data is an FXTablePos instance indicating the position of the selected cell. - # +SEL_DESELECTED+:: sent when a cell is deselected; the message data is an FXTablePos instance indicating the position of the deselected cell. - # +SEL_CHANGED+:: sent when the current cell changes; the message data is an FXTablePos instance indicating the current cell. - # +SEL_CLICKED+:: sent when a cell is single-clicked; the message data is an FXTablePos instance indicating the current cell. - # +SEL_DOUBLECLICKED+:: sent when a cell is double-clicked; the message data is an FXTablePos instance indicating the current cell. - # +SEL_TRIPLECLICKED+:: sent when a cell is triple-clicked; the message data is an FXTablePos instance indicating the current cell. - # +SEL_DELETED+:: sent when a range of cells is about to be removed; the message data is an FXTableRange instance indicating the cells to be removed. - # +SEL_INSERTED+:: sent when a range of cells has been inserted; the message data is an FXTableRange instance indicating the cells inserted. - # +SEL_REPLACED+:: sent when a range of cells has been replaced; the message data is an FXTableRange instance indicating the cells replaced. + # +SEL_COMMAND+:: sent when a new item is clicked; the message data is an FXTablePos instance indicating the current cell. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_RIGHTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance. + # +SEL_RIGHTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance. + # +SEL_SELECTED+:: sent when a cell is selected; the message data is an FXTablePos instance indicating the position of the selected cell. + # +SEL_DESELECTED+:: sent when a cell is deselected; the message data is an FXTablePos instance indicating the position of the deselected cell. + # +SEL_CHANGED+:: sent when the current cell changes; the message data is an FXTablePos instance indicating the current cell. + # +SEL_CLICKED+:: sent when a cell is single-clicked; the message data is an FXTablePos instance indicating the current cell. + # +SEL_DOUBLECLICKED+:: sent when a cell is double-clicked; the message data is an FXTablePos instance indicating the current cell. + # +SEL_TRIPLECLICKED+:: sent when a cell is triple-clicked; the message data is an FXTablePos instance indicating the current cell. + # +SEL_DELETED+:: sent when a range of cells is about to be removed; the message data is an FXTableRange instance indicating the cells to be removed. + # +SEL_INSERTED+:: sent when a range of cells has been inserted; the message data is an FXTableRange instance indicating the cells inserted. + # +SEL_REPLACED+:: sent when a range of cells has been replaced; the message data is an FXTableRange instance indicating the cells replaced. # # === Table options # - # +TABLE_COL_SIZABLE+:: Columns are resizable - # +TABLE_ROW_SIZABLE+:: Rows are resizable - # +TABLE_NO_COLSELECT+:: Disallow column selections - # +TABLE_NO_ROWSELECT+:: Disallow row selections - # +TABLE_READONLY+:: Table is not editable - # +TABLE_COL_RENUMBER+:: Renumber columns - # +TABLE_ROW_RENUMBER+:: Renumber rows + # +TABLE_COL_SIZABLE+:: Columns are resizable + # +TABLE_ROW_SIZABLE+:: Rows are resizable + # +TABLE_NO_COLSELECT+:: Disallow column selections + # +TABLE_NO_ROWSELECT+:: Disallow row selections + # +TABLE_READONLY+:: Table is not editable + # +TABLE_COL_RENUMBER+:: Renumber columns + # +TABLE_ROW_RENUMBER+:: Renumber rows # # === Message identifiers # - # +ID_HORZ_GRID+:: x - # +ID_VERT_GRID+:: x - # +ID_TOGGLE_EDITABLE+:: x - # +ID_DELETE_COLUMN+:: x - # +ID_DELETE_ROW+:: x - # +ID_INSERT_COLUMN+:: x - # +ID_INSERT_ROW+:: x - # +ID_SELECT_COLUMN_INDEX+:: x - # +ID_SELECT_ROW_INDEX+:: x - # +ID_SELECT_COLUMN+:: x - # +ID_SELECT_ROW+:: x - # +ID_SELECT_CELL+:: x - # +ID_SELECT_ALL+:: x - # +ID_DESELECT_ALL+:: x - # +ID_MOVE_LEFT+:: x - # +ID_MOVE_RIGHT+:: x - # +ID_MOVE_UP+:: x - # +ID_MOVE_DOWN+:: x - # +ID_MOVE_HOME+:: x - # +ID_MOVE_END+:: x - # +ID_MOVE_TOP+:: x - # +ID_MOVE_BOTTOM+:: x - # +ID_MOVE_PAGEDOWN+:: x - # +ID_MOVE_PAGEUP+:: x - # +ID_START_INPUT+:: x - # +ID_CANCEL_INPUT+:: x - # +ID_ACCEPT_INPUT+:: x - # +ID_MARK+:: x - # +ID_EXTEND+:: x - # +ID_CUT_SEL+:: x - # +ID_COPY_SEL+:: x - # +ID_PASTE_SEL+:: x - # +ID_DELETE_SEL+:: x + # +ID_HORZ_GRID+:: x + # +ID_VERT_GRID+:: x + # +ID_TOGGLE_EDITABLE+:: x + # +ID_DELETE_COLUMN+:: x + # +ID_DELETE_ROW+:: x + # +ID_INSERT_COLUMN+:: x + # +ID_INSERT_ROW+:: x + # +ID_SELECT_COLUMN_INDEX+:: x + # +ID_SELECT_ROW_INDEX+:: x + # +ID_SELECT_COLUMN+:: x + # +ID_SELECT_ROW+:: x + # +ID_SELECT_CELL+:: x + # +ID_SELECT_ALL+:: x + # +ID_DESELECT_ALL+:: x + # +ID_MOVE_LEFT+:: x + # +ID_MOVE_RIGHT+:: x + # +ID_MOVE_UP+:: x + # +ID_MOVE_DOWN+:: x + # +ID_MOVE_HOME+:: x + # +ID_MOVE_END+:: x + # +ID_MOVE_TOP+:: x + # +ID_MOVE_BOTTOM+:: x + # +ID_MOVE_PAGEDOWN+:: x + # +ID_MOVE_PAGEUP+:: x + # +ID_START_INPUT+:: x + # +ID_CANCEL_INPUT+:: x + # +ID_ACCEPT_INPUT+:: x + # +ID_MARK+:: x + # +ID_EXTEND+:: x + # +ID_CUT_SEL+:: x + # +ID_COPY_SEL+:: x + # +ID_PASTE_SEL+:: x + # +ID_DELETE_SEL+:: x class FXTable < FXScrollArea @@ -271,124 +271,124 @@ module Fox attr_reader :rowHeader # Number of visible rows [Integer] - attr_accessor :visibleRows + attr_accessor :visibleRows # Number of visible columns [Integer] - attr_accessor :visibleColumns + attr_accessor :visibleColumns # Number of rows [Integer] - attr_reader :numRows + attr_reader :numRows # Number of columns [Integer] - attr_reader :numColumns + attr_reader :numColumns # Top cell margin, in pixels [Integer] - attr_accessor :marginTop + attr_accessor :marginTop # Bottom cell margin, in pixels [Integer] - attr_accessor :marginBottom + attr_accessor :marginBottom # Left cell margin, in pixels [Integer] - attr_accessor :marginLeft + attr_accessor :marginLeft # Right cell margin, in pixels [Integer] - attr_accessor :marginRight + attr_accessor :marginRight # Table style [Integer] - attr_accessor :tableStyle + attr_accessor :tableStyle # The column header height mode is either fixed (LAYOUT_FIX_HEIGHT) or variable. # In variable height mode, the column header will size to fit the contents in it. # In fixed height mode, the size is explicitly set via the _columnHeaderHeight_ # attribute. - attr_accessor :columnHeaderMode + attr_accessor :columnHeaderMode # The row header width mode is either fixed (LAYOUT_FIX_WIDTH) or variable. # In variable width mode, the row header will size to fit the contents in it. # In fixed width mode, the size is explicitly set via the _rowHeaderWidth_ # attribute. - attr_accessor :rowHeaderMode + attr_accessor :rowHeaderMode # Row header font [FXFont] - attr_accessor :rowHeaderFont + attr_accessor :rowHeaderFont # Column header font [FXFont] - attr_accessor :columnHeaderFont + attr_accessor :columnHeaderFont # The fixed column header height, if _columnHeaderMode_ is +LAYOUT_FIX_HEIGHT+. - attr_accessor :columnHeaderHeight + attr_accessor :columnHeaderHeight # The fixed row header width, if _rowHeaderMode_ is +LAYOUT_FIX_WIDTH+. - attr_accessor :rowHeaderWidth + attr_accessor :rowHeaderWidth # Default column width, in pixels [Integer] - attr_accessor :defColumnWidth + attr_accessor :defColumnWidth # Default row height, in pixels [Integer] - attr_accessor :defRowHeight + attr_accessor :defRowHeight # Row number for current cell [Integer] - attr_reader :currentRow + attr_reader :currentRow # Column number for current cell [Integer] - attr_reader :currentColumn + attr_reader :currentColumn # Row number for anchor cell [Integer] - attr_reader :anchorRow + attr_reader :anchorRow # Column number for anchor cell [Integer] - attr_reader :anchorColumn + attr_reader :anchorColumn # Starting row number for selection, or -1 if there is no selection [Integer] - attr_reader :selStartRow + attr_reader :selStartRow # Starting column number for selection, or -1 if there is no selection [Integer] - attr_reader :selStartColumn + attr_reader :selStartColumn # Ending row number for selection, or -1 if there is no selection [Integer] - attr_reader :selEndRow + attr_reader :selEndRow # Ending column number for selection, or -1 if there is no selection [Integer] - attr_reader :selEndColumn + attr_reader :selEndColumn # Text font [FXFont] - attr_accessor :font + attr_accessor :font # Text color [FXColor] - attr_accessor :textColor + attr_accessor :textColor # Base GUI color [FXColor] - attr_accessor :baseColor + attr_accessor :baseColor # Highlight color [FXColor] - attr_accessor :hiliteColor + attr_accessor :hiliteColor # Shadow color [FXColor] - attr_accessor :shadowColor + attr_accessor :shadowColor # Border color [FXColor] - attr_accessor :borderColor + attr_accessor :borderColor # Background color for selected cell(s) [FXColor] - attr_accessor :selBackColor + attr_accessor :selBackColor # Text color for selected cell(s) [FXColor] - attr_accessor :selTextColor + attr_accessor :selTextColor # Grid color [FXColor] - attr_accessor :gridColor + attr_accessor :gridColor # Stipple color [FXColor] - attr_accessor :stippleColor + attr_accessor :stippleColor # Cell border color [FXColor] - attr_accessor :cellBorderColor + attr_accessor :cellBorderColor # Cell border width, in pixels [Integer] - attr_accessor :cellBorderWidth + attr_accessor :cellBorderWidth # Status line help text [String] - attr_accessor :helpText + attr_accessor :helpText # Returns the drag type for CSV data def FXTable.csvType; end @@ -403,18 +403,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this table [FXComposite] - # +target+:: the message target (if any) for this table [FXObject] - # +selector+:: the message identifier for this table [Integer] - # +opts+:: table options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this table [FXComposite] + # +target+:: the message target (if any) for this table [FXObject] + # +selector+:: the message identifier for this table [Integer] + # +opts+:: table options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_MARGIN, padRight=DEFAULT_MARGIN, padTop=DEFAULT_MARGIN, padBottom=DEFAULT_MARGIN) # :yields: theTable end @@ -654,7 +654,7 @@ module Fox # Change column header icon. # Raises IndexError if _index_ is out of bounds. - def setColumnIcon(FXint index,FXIcon* icon); + def setColumnIcon(index, icon); end # Return icon of column header at _index_. # Raises IndexError if _index_ is out of bounds. @@ -745,12 +745,12 @@ module Fox # # ==== Parameters: # - # +startrow+:: the starting row for the range [Integer] - # +endrow+:: the ending row for the range [Integer] - # +startcol+:: the starting column for the range [Integer] - # +endcol+:: the ending column for the range [Integer] - # +cs+:: the string to insert at each column break [String] - # +rs+:: the string to insert at each row break [String] + # +startrow+:: the starting row for the range [Integer] + # +endrow+:: the ending row for the range [Integer] + # +startcol+:: the starting column for the range [Integer] + # +endcol+:: the ending column for the range [Integer] + # +cs+:: the string to insert at each column break [String] + # +rs+:: the string to insert at each row break [String] # def extractText(startrow, endrow, startcol, endcol, cs="\t", rs="\n"); end @@ -767,13 +767,13 @@ module Fox # # ==== Parameters: # - # +startrow+:: the starting row for the range [Integer] - # +endrow+:: the ending row for the range [Integer] - # +startcol+:: the starting column for the range [Integer] - # +endcol+:: the ending column for the range [Integer] - # +text+:: the text containing the new cell text [String] - # +cs+:: the character to insert at each column break [String] - # +rs+:: the character to insert at each row break [String] + # +startrow+:: the starting row for the range [Integer] + # +endrow+:: the ending row for the range [Integer] + # +startcol+:: the starting column for the range [Integer] + # +endcol+:: the ending column for the range [Integer] + # +text+:: the text containing the new cell text [String] + # +cs+:: the character to insert at each column break [String] + # +rs+:: the character to insert at each row break [String] # def overlayText(startrow, endrow, startcol, endcol, text, cs="\t", rs="\n", notify=false); end diff --git a/rdoc-sources/FXText.rb b/rdoc-sources/FXText.rb index 74bbd2e51ade88c4fe9fc8ec6f418c82c4bf61b2..5c6f2f45fdbce9f6b397d42f22d271179eb4dc31 100755 --- a/rdoc-sources/FXText.rb +++ b/rdoc-sources/FXText.rb @@ -4,28 +4,28 @@ module Fox # class FXHiliteStyle # Normal text foreground color [FXColor] - attr_accessor :normalForeColor + attr_accessor :normalForeColor # Normal text background color [FXColor] - attr_accessor :normalBackColor + attr_accessor :normalBackColor # Selected text foreground color [FXColor] - attr_accessor :selectForeColor + attr_accessor :selectForeColor # Selected text background color [FXColor] - attr_accessor :selectBackColor + attr_accessor :selectBackColor # Highlight text foreground color [FXColor] - attr_accessor :hiliteForeColor + attr_accessor :hiliteForeColor # Highlight text background color [FXColor] - attr_accessor :hiliteBackColor + attr_accessor :hiliteBackColor # Active text background color [FXColor] - attr_accessor :activeBackColor + attr_accessor :activeBackColor # Highlight text style [Integer] - attr_accessor :style + attr_accessor :style end # @@ -65,14 +65,14 @@ module Fox # # The following messages are sent by FXText to its target: # - # +SEL_KEYPRESS+:: sent when a key is pressed; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key is released; the message data is an FXEvent instance. - # +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_KEYPRESS+:: sent when a key is pressed; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key is released; the message data is an FXEvent instance. + # +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_INSERTED+:: # sent after text is inserted into the text buffer; the message data # is a reference to an FXTextChange instance. @@ -96,14 +96,14 @@ module Fox # # === Text widget options # - # +TEXT_READONLY+:: Text is _not_ editable - # +TEXT_WORDWRAP+:: Wrap at word breaks - # +TEXT_OVERSTRIKE+:: Overstrike mode - # +TEXT_FIXEDWRAP+:: Fixed wrap columns - # +TEXT_NO_TABS+:: Insert spaces for tabs - # +TEXT_AUTOINDENT+:: Autoindent - # +TEXT_SHOWACTIVE+:: Show active line - # +TEXT_AUTOSCROLL+:: Logging mode, keeping last line visible + # +TEXT_READONLY+:: Text is _not_ editable + # +TEXT_WORDWRAP+:: Wrap at word breaks + # +TEXT_OVERSTRIKE+:: Overstrike mode + # +TEXT_FIXEDWRAP+:: Fixed wrap columns + # +TEXT_NO_TABS+:: Insert spaces for tabs + # +TEXT_AUTOINDENT+:: Autoindent + # +TEXT_SHOWACTIVE+:: Show active line + # +TEXT_AUTOSCROLL+:: Logging mode, keeping last line visible # # === Selection modes # @@ -113,9 +113,9 @@ module Fox # # === Text styles # - # +STYLE_UNDERLINE+:: underline text - # +STYLE_STRIKEOUT+:: strike out text - # +STYLE_BOLD_+:: bold text + # +STYLE_UNDERLINE+:: underline text + # +STYLE_STRIKEOUT+:: strike out text + # +STYLE_BOLD_+:: bold text # # === Message identifiers # @@ -197,129 +197,129 @@ module Fox class FXText < FXScrollArea # Top margin [Integer] - attr_accessor :marginTop + attr_accessor :marginTop # Bottom margin [Integer] - attr_accessor :marginBottom + attr_accessor :marginBottom # Left margin [Integer] - attr_accessor :marginLeft + attr_accessor :marginLeft # Right margin [Integer] - attr_accessor :marginRight + attr_accessor :marginRight # Wrap columns [Integer] - attr_accessor :wrapColumns + attr_accessor :wrapColumns # Tab columns [Integer] - attr_accessor :tabColumns + attr_accessor :tabColumns # Number of columns used for line numbers [Integer] - attr_accessor :barColumns + attr_accessor :barColumns # Indicates whether text is modified [Boolean] - attr_writer :modified + attr_writer :modified # Indicates whether text is editable [Boolean] - attr_writer :editable + attr_writer :editable # Indicates whether text is styled [Boolean] - attr_writer :styled + attr_writer :styled # Word delimiters [String] - attr_accessor :delimiters + attr_accessor :delimiters # Text font [FXFont] - attr_accessor :font + attr_accessor :font # Text color [FXColor] - attr_accessor :textColor + attr_accessor :textColor # Selected text background color [FXColor] - attr_accessor :selBackColor + attr_accessor :selBackColor # Selected text color [FXColor] - attr_accessor :selTextColor + attr_accessor :selTextColor # Highlight text color [FXColor] - attr_accessor :hiliteTextColor + attr_accessor :hiliteTextColor # Highlight text background color [FXColor] - attr_accessor :hiliteBackColor + attr_accessor :hiliteBackColor # Active background color [FXColor] - attr_accessor :activeBackColor + attr_accessor :activeBackColor # Cursor color [FXColor] - attr_accessor :cursorColor + attr_accessor :cursorColor # Line number color [FXColor] - attr_accessor :numberColor + attr_accessor :numberColor # Bar color [FXColor] - attr_accessor :barColor + attr_accessor :barColor # Status line help text [String] - attr_accessor :helpText + attr_accessor :helpText # Tool tip message [String] - attr_accessor :tipText + attr_accessor :tipText # The text buffer [String] - attr_accessor :text + attr_accessor :text # The length of the text buffer [Integer] - attr_reader :length + attr_reader :length # Anchor position [Integer] - attr_accessor :anchorPos + attr_accessor :anchorPos # Cursor row [Integer] - attr_accessor :cursorRow + attr_accessor :cursorRow # Cursor column [Integer] - attr_accessor :cursorCol + attr_accessor :cursorCol # Cursor position [Integer] - attr_reader :cursorPos + attr_reader :cursorPos # Selection start position [Integer] - attr_reader :selStartPos + attr_reader :selStartPos # Selection end position [Integer] - attr_reader :selEndPos + attr_reader :selEndPos # Text widget style [Integer] - attr_accessor :textStyle + attr_accessor :textStyle # Number of visible rows [Integer] - attr_accessor :visibleRows + attr_accessor :visibleRows # Number of visible columns [Integer] - attr_accessor :visibleColumns + attr_accessor :visibleColumns # # Brace and parenthesis match highlighting time, in milliseconds [Integer]. # A _hiliteMatchTime_ of 0 disables brace matching. # - attr_accessor :hiliteMatchTime + attr_accessor :hiliteMatchTime # Array of hilite styles [an Array of FXHiliteStyle instances] - attr_accessor :hiliteStyles + attr_accessor :hiliteStyles # # Return an initialized FXText instance. # # ==== Parameters: # - # +p+:: the parent window for this text widget [FXComposite] - # +target+:: the message target, if any, for this text widget [FXObject] - # +selector+:: the message identifier for this text widget [Integer] - # +opts+:: text options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent window for this text widget [FXComposite] + # +target+:: the message target, if any, for this text widget [FXObject] + # +selector+:: the message identifier for this text widget [Integer] + # +opts+:: text options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2) # :yields: theText end @@ -457,13 +457,13 @@ module Fox def getPosAt(x, y); end # Count number of rows; _start_ should be on a row start - def countRows(start, end); end + def countRows(start, end_); end # Count number of columns; _start_ should be on a row start - def countCols(start, end); end + def countCols(start, end_); end # Count number of newlines - def countLines(start, end); end + def countLines(start, end_); end # Return position of beginning of line containing position _pos_ def lineStart(pos); end diff --git a/rdoc-sources/FXTextField.rb b/rdoc-sources/FXTextField.rb index 92b23d9a5d2b95e0939dae7d09771c0be5a0f53c..c1d25cbbbb747fe0ef18865a20ee261dceb35905 100755 --- a/rdoc-sources/FXTextField.rb +++ b/rdoc-sources/FXTextField.rb @@ -11,15 +11,15 @@ module Fox # # The following messages are sent from FXTextField to its target: # - # +SEL_COMMAND+:: sent when the user presses the *Enter* key or tabs out of the text field; the message data is a String containing the text. - # +SEL_CHANGED+:: sent when the text changes; the message data is a String containing the text. - # +SEL_VERIFY+:: sent when the user attempts to enter new text in the text field; the message data is a String containing the proposed new text. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when the user presses the *Enter* key or tabs out of the text field; the message data is a String containing the text. + # +SEL_CHANGED+:: sent when the text changes; the message data is a String containing the text. + # +SEL_VERIFY+:: sent when the user attempts to enter new text in the text field; the message data is a String containing the proposed new text. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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. # # === Textfield styles # @@ -57,43 +57,43 @@ module Fox class FXTextField < FXFrame # Text field editability [Boolean] - attr_writer :editable + attr_writer :editable # Cursor position [Integer] - attr_accessor :cursorPos + attr_accessor :cursorPos # Anchor position [Integer] - attr_accessor :anchorPos + attr_accessor :anchorPos # Text [String] - attr_accessor :text + attr_accessor :text # Text font [FXFont] - attr_accessor :font + attr_accessor :font # Text color [FXColor] - attr_accessor :textColor + attr_accessor :textColor # Background color for selected text [FXColor] - attr_accessor :selBackColor + attr_accessor :selBackColor # Foreground color for selected text [FXColor] - attr_accessor :selTextColor + attr_accessor :selTextColor # Default width of this text field, in terms of a number of columns times the width of the numeral '8' [Integer] - attr_accessor :numColumns + attr_accessor :numColumns # Text justification mode, a combination of horizontal justification (JUSTIFY_LEFT, JUSTIFY_RIGHT, or JUSTIFY_CENTER_X), and vertical justification (JUSTIFY_TOP, JUSTIFY_BOTTOM, JUSTIFY_CENTER_Y) [Integer] - attr_accessor :justify + attr_accessor :justify # Status line help text [String] - attr_accessor :helpText + attr_accessor :helpText # Tool tip message [String] - attr_accessor :tipText + attr_accessor :tipText # Text style [Integer] - attr_accessor :textStyle + attr_accessor :textStyle # # Return an initialized FXTextField instance. @@ -101,19 +101,19 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this text field [FXComposite] - # +ncols+:: number of visible items [Integer] - # +target+:: the message target, if any, for this text field [FXObject] - # +selector+:: the message identifier for this text field [Integer] - # +opts+:: text field options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this text field [FXComposite] + # +ncols+:: number of visible items [Integer] + # +target+:: the message target, if any, for this text field [FXObject] + # +selector+:: the message identifier for this text field [Integer] + # +opts+:: text field options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, ncols, target=nil, selector=0, opts=TEXTFIELD_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTextField end diff --git a/rdoc-sources/FXToggleButton.rb b/rdoc-sources/FXToggleButton.rb index 95bd9dac32d96e9ef0447e71d01650cf411c1142..2b05b30fff93dac0b668a845ec720184bf0c9691 100755 --- a/rdoc-sources/FXToggleButton.rb +++ b/rdoc-sources/FXToggleButton.rb @@ -8,61 +8,61 @@ module Fox # # The following messages are sent by FXToggleButton to its target: # - # +SEL_COMMAND+:: sent when the toggle button is pressed. - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_COMMAND+:: sent when the toggle button is pressed. + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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. # # === Toggle button flags # - # +TOGGLEBUTTON_AUTOGRAY+:: Automatically gray out when not updated - # +TOGGLEBUTTON_AUTOHIDE+:: Automatically hide toggle button when not updated - # +TOGGLEBUTTON_TOOLBAR+:: Toolbar style toggle button [flat look] + # +TOGGLEBUTTON_AUTOGRAY+:: Automatically gray out when not updated + # +TOGGLEBUTTON_AUTOHIDE+:: Automatically hide toggle button when not updated + # +TOGGLEBUTTON_TOOLBAR+:: Toolbar style toggle button [flat look] # +TOGGLEBUTTON_KEEPSTATE+:: Draw button according to state - # +TOGGLEBUTTON_NORMAL+:: <tt>FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt> + # +TOGGLEBUTTON_NORMAL+:: <tt>FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt> # class FXToggleButton < FXLabel # Alternate text, shown when toggled [String] - attr_accessor :altText + attr_accessor :altText # Alternate icon, shown when toggled [FXIcon] - attr_accessor :altIcon + attr_accessor :altIcon # Toggled state [+true+ or +false+] - attr_accessor :state + attr_accessor :state # Alternate status line help text, shown when toggled [String] - attr_accessor :altHelpText + attr_accessor :altHelpText # Alternate tool tip message, shown when toggled [String] - attr_accessor :altTipText + attr_accessor :altTipText # Toggle button style [Integer] - attr_accessor :toggleStyle + attr_accessor :toggleStyle # # Return an initialized FXToggleButton instance. # # ==== Parameters: # - # +p+:: the parent window for this toggle button [FXComposite] - # <tt>text1</tt>:: the text for this toggle button's first state [String] - # <tt>text2</tt>:: the text for this toggle button's second state [String] - # <tt>icon1</tt>:: the icon, if any, for this toggle button's first state [FXIcon] - # <tt>icon2</tt>:: the icon, if any, for this toggle button's second state [FXIcon] - # +target+:: the message target, if any, for this toggle button [FXObject] - # +selector+:: the message identifier for this toggle button [Integer] - # +opts+:: toggle button options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this toggle button [FXComposite] + # <tt>text1</tt>:: the text for this toggle button's first state [String] + # <tt>text2</tt>:: the text for this toggle button's second state [String] + # <tt>icon1</tt>:: the icon, if any, for this toggle button's first state [FXIcon] + # <tt>icon2</tt>:: the icon, if any, for this toggle button's second state [FXIcon] + # +target+:: the message target, if any, for this toggle button [FXObject] + # +selector+:: the message identifier for this toggle button [Integer] + # +opts+:: toggle button options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, text1, text2, icon1=nil, icon2=nil, target=nil, selector=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theToggleButton end diff --git a/rdoc-sources/FXToolBar.rb b/rdoc-sources/FXToolBar.rb index 533b338a71534bcf30f0a63277c3da0a51cb5b6d..09429720f33a2c24e1c22fcd60ef65aef3173ac7 100755 --- a/rdoc-sources/FXToolBar.rb +++ b/rdoc-sources/FXToolBar.rb @@ -18,19 +18,19 @@ module Fox # # ==== Parameters: # - # +p+:: the "dry dock" window for this tool bar [FXComposite] - # +q+:: the "wet dock" window for this tool bar [FXComposite] - # +opts+:: tool bar options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the "dry dock" window for this tool bar [FXComposite] + # +q+:: the "wet dock" window for this tool bar [FXComposite] + # +opts+:: tool bar options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theToolBar end @@ -41,18 +41,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tool bar [FXComposite] - # +opts+:: tool bar options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this tool bar [FXComposite] + # +opts+:: tool bar options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theToolBar end diff --git a/rdoc-sources/FXToolBarGrip.rb b/rdoc-sources/FXToolBarGrip.rb index 8dbac47e6f5ff4cbffe8e79c65e350d2730f62a2..3171dabff0f2e4c4b676fc20f47f084ce9b931cd 100755 --- a/rdoc-sources/FXToolBarGrip.rb +++ b/rdoc-sources/FXToolBarGrip.rb @@ -12,13 +12,13 @@ module Fox # # === Toolbar Grip styles # - # +TOOLBARGRIP_SINGLE+:: Single bar mode for movable tool bars - # +TOOLBARGRIP_DOUBLE+:: Double bar mode for dockable tool bars + # +TOOLBARGRIP_SINGLE+:: Single bar mode for movable tool bars + # +TOOLBARGRIP_DOUBLE+:: Double bar mode for dockable tool bars # class FXToolBarGrip < FXDockHandler # Indicates whether the grip is displayed as a double-bar [Boolean] - attr_writer :doubleBar + attr_writer :doubleBar # Active color [FXColor] attr_accessor :activeColor @@ -28,14 +28,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tool bar grip [FXComposite] - # +target+:: the message target, if any, for this tool bar grip [FXObject] - # +selector+:: the message identifier for this tool bar grip [Integer] - # +opts+:: tool bar grip options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent window for this tool bar grip [FXComposite] + # +target+:: the message target, if any, for this tool bar grip [FXObject] + # +selector+:: the message identifier for this tool bar grip [Integer] + # +opts+:: tool bar grip options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, target=nil, selector=0, opts=TOOLBARGRIP_SINGLE, x=0, y=0, width=0, height=0) # :yields: theToolBarGrip end diff --git a/rdoc-sources/FXToolBarShell.rb b/rdoc-sources/FXToolBarShell.rb index e2ad4e0087762414dd8e18abdf97073c4dc5dfa6..a612f67b520e1b7b197ebe4fb320b79f338c3d6d 100755 --- a/rdoc-sources/FXToolBarShell.rb +++ b/rdoc-sources/FXToolBarShell.rb @@ -9,7 +9,7 @@ module Fox attr_accessor :frameStyle # Border width [Integer] - attr_reader :borderWidth + attr_reader :borderWidth # Highlight color [FXColor] attr_accessor :hiliteColor @@ -28,14 +28,14 @@ module Fox # # ==== Parameters: # - # +owner+:: the owner window for this tool bar shell [FXWindow] - # +opts+:: tool bar shell options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +owner+:: the owner window for this tool bar shell [FXWindow] + # +opts+:: tool bar shell options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(owner, opts=FRAME_RAISED|FRAME_THICK, x=0, y=0, width=0, height=0, hSpacing=4, vSpacing=4) # :yields: theToolBarShell end diff --git a/rdoc-sources/FXToolBarTab.rb b/rdoc-sources/FXToolBarTab.rb index b520c5d9e4604252acf6b2a63e5cc98681ddadae..55e2e6dae905b83da0a2024f1bd56793f5853a3b 100755 --- a/rdoc-sources/FXToolBarTab.rb +++ b/rdoc-sources/FXToolBarTab.rb @@ -16,19 +16,19 @@ module Fox # # The following messages are sent by FXToolBarTab to its target: # - # +SEL_KEYPRESS+:: Sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: Sent when a key goes up; the message data is an FXEvent instance. - # +SEL_COMMAND+:: Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it's +true+ if the toolbar tab is now collapsed, +false+ if it is now uncollapsed). + # +SEL_KEYPRESS+:: Sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: Sent when a key goes up; the message data is an FXEvent instance. + # +SEL_COMMAND+:: Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it's +true+ if the toolbar tab is now collapsed, +false+ if it is now uncollapsed). # # === Toolbar tab styles # - # +TOOLBARTAB_HORIZONTAL+:: Default is for horizontal toolbar - # +TOOLBARTAB_VERTICAL+:: For vertical toolbar + # +TOOLBARTAB_HORIZONTAL+:: Default is for horizontal toolbar + # +TOOLBARTAB_VERTICAL+:: For vertical toolbar # # === Message identifiers # - # +ID_COLLAPSE+:: Collapse the toolbar tab - # +ID_UNCOLLAPSE+:: Uncollapse the toolbar tab + # +ID_COLLAPSE+:: Collapse the toolbar tab + # +ID_UNCOLLAPSE+:: Uncollapse the toolbar tab # class FXToolBarTab < FXFrame @@ -46,14 +46,14 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this toolbar tab [FXWindow] - # +target+:: the message target [FXObject] - # +selector+:: the message identifier [Integer] - # +opts+:: the options [Integer] - # +x+:: x-coordinate of window upper left corner [Integer] - # +y+:: y-coordinate of window upper left corner [Integer] - # +width+:: window width [Integer] - # +height+:: window height [Integer] + # +p+:: the parent window for this toolbar tab [FXWindow] + # +target+:: the message target [FXObject] + # +selector+:: the message identifier [Integer] + # +opts+:: the options [Integer] + # +x+:: x-coordinate of window upper left corner [Integer] + # +y+:: y-coordinate of window upper left corner [Integer] + # +width+:: window width [Integer] + # +height+:: window height [Integer] # def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yield: theToolBarTab end diff --git a/rdoc-sources/FXTopWindow.rb b/rdoc-sources/FXTopWindow.rb index 09523e2730409b9ce0ead1faa89deeaf3404b60b..c8d46b7c9da1dc77ac05b5b69485f76e66367735 100755 --- a/rdoc-sources/FXTopWindow.rb +++ b/rdoc-sources/FXTopWindow.rb @@ -73,47 +73,47 @@ module Fox # # === Message identifiers # - # +ID_MAXIMIZE+:: Maximize the window - # +ID_MINIMIZE+:: Minimize the window - # +ID_RESTORE+:: Restore the window - # +ID_CLOSE+:: Close the window - # +ID_QUERY_DOCK+:: Toolbar asks to dock + # +ID_MAXIMIZE+:: Maximize the window + # +ID_MINIMIZE+:: Minimize the window + # +ID_RESTORE+:: Restore the window + # +ID_CLOSE+:: Close the window + # +ID_QUERY_DOCK+:: Toolbar asks to dock # class FXTopWindow < FXShell # Window title [String] - attr_accessor :title + attr_accessor :title # Top padding, in pixels [Integer] - attr_accessor :padTop + attr_accessor :padTop # Bottom padding, in pixels [Integer] - attr_accessor :padBottom + attr_accessor :padBottom # Left padding, in pixels [Integer] - attr_accessor :padLeft + attr_accessor :padLeft # Right padding, in pixels [Integer] - attr_accessor :padRight + attr_accessor :padRight # Horizontal spacing between child widgets, in pixels [Integer] - attr_accessor :hSpacing + attr_accessor :hSpacing # Vertical spacing between child widgets, in pixels [Integer] - attr_accessor :vSpacing + attr_accessor :vSpacing # Packing hints for child widgets [Integer] - attr_accessor :packingHints + attr_accessor :packingHints # Title and border decorations (see above) [Integer] - attr_accessor :decorations + attr_accessor :decorations # Window icon [FXIcon] - attr_accessor :icon + attr_accessor :icon # Window mini (title) icon [FXIcon] - attr_accessor :miniIcon + attr_accessor :miniIcon # Show this window with given _placement_ # (one of +PLACEMENT_DEFAULT+, +PLACEMENT_VISIBLE+, +PLACEMENT_CURSOR+, +PLACEMENT_OWNER+, +PLACEMENT_SCREEN+ or +PLACEMENT_MAXIMIZED+). diff --git a/rdoc-sources/FXTreeList.rb b/rdoc-sources/FXTreeList.rb index e73578663c96969c93002a14cd251255aee1d7a0..2cb6a9adf3beca8732c386d0bda27cb9089db4d4 100755 --- a/rdoc-sources/FXTreeList.rb +++ b/rdoc-sources/FXTreeList.rb @@ -174,98 +174,98 @@ module Fox # # The following messages are sent by FXTreeList to its target: # - # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. - # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. - # +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_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_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. - # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. - # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. - # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance). - # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance). - # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXTreeItem instance). - # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXTreeItem instance). - # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance. + # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance. + # +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_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_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. + # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. + # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked. + # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance). + # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance). + # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXTreeItem instance). + # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXTreeItem instance). + # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXTreeItem instance). # # === Tree list styles # - # +TREELIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items - # +TREELIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected - # +TREELIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times - # +TREELIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items - # +TREELIST_AUTOSELECT+:: Automatically select under cursor - # +TREELIST_SHOWS_LINES+:: Lines shown - # +TREELIST_SHOWS_BOXES+:: Boxes to expand shown - # +TREELIST_ROOT_BOXES+:: Display root boxes also - # +TREELIST_NORMAL+:: same as +TREELIST_EXTENDEDLIST+ + # +TREELIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items + # +TREELIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected + # +TREELIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times + # +TREELIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items + # +TREELIST_AUTOSELECT+:: Automatically select under cursor + # +TREELIST_SHOWS_LINES+:: Lines shown + # +TREELIST_SHOWS_BOXES+:: Boxes to expand shown + # +TREELIST_ROOT_BOXES+:: Display root boxes also + # +TREELIST_NORMAL+:: same as +TREELIST_EXTENDEDLIST+ class FXTreeList < FXScrollArea # Number of items [Integer] - attr_reader :numItems + attr_reader :numItems # Number of visible items [Integer] - attr_accessor :numVisible + attr_accessor :numVisible # First root-level item [FXTreeItem] - attr_reader :firstItem + attr_reader :firstItem # Last root-level item [FXTreeItem] - attr_reader :lastItem + attr_reader :lastItem # Current item, if any [FXTreeItem] - attr_accessor :currentItem + attr_accessor :currentItem # Anchor item, if any [FXTreeItem] - attr_accessor :anchorItem + attr_accessor :anchorItem # Item under the cursor, if any [FXTreeItem] - attr_reader :cursorItem + attr_reader :cursorItem # Text font [FXFont] - attr_accessor :font + attr_accessor :font # Parent-child indent amount, in pixels [Integer] - attr_accessor :indent + attr_accessor :indent # Normal text color [FXColor] - attr_accessor :textColor + attr_accessor :textColor # Selected text background color [FXColor] - attr_accessor :selBackColor + attr_accessor :selBackColor # Selected text color [FXColor] - attr_accessor :selTextColor + attr_accessor :selTextColor # Line color [FXColor] - attr_accessor :lineColor + attr_accessor :lineColor # List style [Integer] - attr_accessor :listStyle + attr_accessor :listStyle # Status line help text for this list [String] - attr_accessor :helpText + attr_accessor :helpText # # Construct a new, initially empty tree list. # # ==== Parameters: # - # +p+:: the parent window for this tree list [FXComposite] - # +target+:: the message target, if any, for this tree list [FXObject] - # +selector+:: the message identifier for this tree list [Integer] - # +opts+:: tree list options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent window for this tree list [FXComposite] + # +target+:: the message target, if any, for this tree list [FXObject] + # +selector+:: the message identifier for this tree list [Integer] + # +opts+:: tree list options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, target=nil, selector=0, opts=TREELIST_NORMAL, x=0, y=0, width=0, height=0) # :yields: theTreeList end @@ -331,7 +331,7 @@ module Fox # Remove item. # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message # target before the item is removed. - def removeItem(item, notify=false); + def removeItem(item, notify=false); end # Remove items in range [_fromItem_, _toItem_] inclusively. # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message diff --git a/rdoc-sources/FXTreeListBox.rb b/rdoc-sources/FXTreeListBox.rb index 3aa18b001e6bcb593e5a35ee819d157ba26a93cb..8798898a847e47ed28ef8d3bc9c3dc48a568d565 100755 --- a/rdoc-sources/FXTreeListBox.rb +++ b/rdoc-sources/FXTreeListBox.rb @@ -17,12 +17,12 @@ module Fox # # === Tree list box styles # - # +TREELISTBOX_NORMAL+:: Normal style + # +TREELISTBOX_NORMAL+:: Normal style # # === Message identifiers # - # +ID_TREE+:: x - # +ID_FIELD+:: x + # +ID_TREE+:: x + # +ID_FIELD+:: x # class FXTreeListBox < FXPacker @@ -58,18 +58,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this tree list box [FXComposite] - # +target+:: the message target, if any, for this tree list box [FXObject] - # +selector+:: the message identifier for this tree list box [Integer] - # +opts+:: tree list options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this tree list box [FXComposite] + # +target+:: the message target, if any, for this tree list box [FXObject] + # +selector+:: the message identifier for this tree list box [Integer] + # +opts+:: tree list options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, target=nil, selector=0, opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTreeListBox end @@ -121,7 +121,7 @@ module Fox # Remove item. # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message # target before the item is removed. - def removeItem(item, notify=false); + def removeItem(item, notify=false); end # Remove items in range [_fromItem_, _toItem_] inclusively. # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message diff --git a/rdoc-sources/FXTriStateButton.rb b/rdoc-sources/FXTriStateButton.rb index 541f20c3d452b7f27221eb42ec94abdcea898aef..ab5b987ca4b59d797b6808ac558abbf645763062 100755 --- a/rdoc-sources/FXTriStateButton.rb +++ b/rdoc-sources/FXTriStateButton.rb @@ -8,40 +8,40 @@ module Fox class FXTriStateButton < FXToggleButton # Maybe text, shown when toggled [String] - attr_accessor :maybeText + attr_accessor :maybeText # Maybe icon, shown when toggled [FXIcon] - attr_accessor :maybeIcon + attr_accessor :maybeIcon # Maybe status line help text, shown when toggled [String] - attr_accessor :maybeHelpText + attr_accessor :maybeHelpText # Maybe tool tip message, shown when toggled [String] - attr_accessor :maybeTipText + attr_accessor :maybeTipText # # Return an initialized FXTriStateButton instance. # # ==== Parameters: # - # +p+:: the parent window for this tri-state button [FXComposite] - # <tt>text1</tt>:: the text for this tri-state button's first state [String] - # <tt>text2</tt>:: the text for this tri-state button's second state [String] - # <tt>text3</tt>:: the text for this tri-state button's third state [String] - # <tt>icon1</tt>:: the icon, if any, for this tri-state button's first state [FXIcon] - # <tt>icon2</tt>:: the icon, if any, for this tri-state button's second state [FXIcon] - # <tt>icon3</tt>:: the icon, if any, for this tri-state button's third state [FXIcon] - # +target+:: the message target, if any, for this tri-state button [FXObject] - # +selector+:: the message identifier for this tri-state button [Integer] - # +opts+:: tri-state button options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +p+:: the parent window for this tri-state button [FXComposite] + # <tt>text1</tt>:: the text for this tri-state button's first state [String] + # <tt>text2</tt>:: the text for this tri-state button's second state [String] + # <tt>text3</tt>:: the text for this tri-state button's third state [String] + # <tt>icon1</tt>:: the icon, if any, for this tri-state button's first state [FXIcon] + # <tt>icon2</tt>:: the icon, if any, for this tri-state button's second state [FXIcon] + # <tt>icon3</tt>:: the icon, if any, for this tri-state button's third state [FXIcon] + # +target+:: the message target, if any, for this tri-state button [FXObject] + # +selector+:: the message identifier for this tri-state button [Integer] + # +opts+:: tri-state button options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] # def initialize(p, text1, text2, text3, icon1=nil, icon2=nil, icon3=nil, target=nil, selector=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTriStateButton end diff --git a/rdoc-sources/FXVec2d.rb b/rdoc-sources/FXVec2d.rb index 2ec71c24bb0d8187bb598b5b0b10acf52d887625..356eb3d0ee5adc21e3d7d778b067774c19bd6dc9 100755 --- a/rdoc-sources/FXVec2d.rb +++ b/rdoc-sources/FXVec2d.rb @@ -22,7 +22,7 @@ module Fox def []=(index, value); end # Returns a new FXVec2d instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec2d instance obtained by memberwise diff --git a/rdoc-sources/FXVec2f.rb b/rdoc-sources/FXVec2f.rb index 005db324cd71d58631190e8e8a87279936d7cb42..e93028d93cc690693f680045818ede46e9c66ccb 100755 --- a/rdoc-sources/FXVec2f.rb +++ b/rdoc-sources/FXVec2f.rb @@ -22,7 +22,7 @@ module Fox def []=(index, value); end # Returns a new FXVec2f instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec2f instance obtained by memberwise diff --git a/rdoc-sources/FXVec3d.rb b/rdoc-sources/FXVec3d.rb index 2c8ed47b4d8330218c413bda976ebf6cd94cefdc..10e9d6a10398565815ce5187b0368b1636c88a83 100755 --- a/rdoc-sources/FXVec3d.rb +++ b/rdoc-sources/FXVec3d.rb @@ -28,7 +28,7 @@ module Fox def []=(index, value); end # Returns a new FXVec3d instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec3d instance obtained by memberwise diff --git a/rdoc-sources/FXVec3f.rb b/rdoc-sources/FXVec3f.rb index 879adc71ce140b2684a00948c2082dc67d7dc48f..af240f01df05d1c6a9c636d26fcbdb21ddb3ac63 100755 --- a/rdoc-sources/FXVec3f.rb +++ b/rdoc-sources/FXVec3f.rb @@ -28,7 +28,7 @@ module Fox def []=(index, value); end # Returns a new FXVec3f instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec3f instance obtained by memberwise diff --git a/rdoc-sources/FXVec4d.rb b/rdoc-sources/FXVec4d.rb index 0d996420f857e7226c3542ec875abdb33bc88c73..8f1e25f6b939c68ff30ff06d0346ed9ead12e161 100755 --- a/rdoc-sources/FXVec4d.rb +++ b/rdoc-sources/FXVec4d.rb @@ -34,7 +34,7 @@ module Fox def []=(index, value); end # Returns a new FXVec4d instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec4d instance obtained by memberwise diff --git a/rdoc-sources/FXVec4f.rb b/rdoc-sources/FXVec4f.rb index c22e3c9c647eaa6e3ada359ddd1a29cacea31f71..975949a797e662016a2b323588ec17d9e844cf72 100755 --- a/rdoc-sources/FXVec4f.rb +++ b/rdoc-sources/FXVec4f.rb @@ -34,7 +34,7 @@ module Fox def []=(index, value); end # Returns a new FXVec4f instance which is the negation of this one. - def @-(); end + def -@(); end # # Returns a new FXVec4f instance obtained by memberwise diff --git a/rdoc-sources/FXVerticalFrame.rb b/rdoc-sources/FXVerticalFrame.rb index d22ec2e08fa6412e4c72f217080be661562b4ceb..a1c89fca2eac76ec0fcea15b9dec1ac7a17e5e41 100755 --- a/rdoc-sources/FXVerticalFrame.rb +++ b/rdoc-sources/FXVerticalFrame.rb @@ -10,18 +10,18 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this vertical frame [FXComposite] - # +opts+:: frame options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] - # +padLeft+:: internal padding on the left side, in pixels [Integer] - # +padRight+:: internal padding on the right side, in pixels [Integer] - # +padTop+:: internal padding on the top side, in pixels [Integer] - # +padBottom+:: internal padding on the bottom side, in pixels [Integer] - # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] - # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] + # +p+:: the parent window for this vertical frame [FXComposite] + # +opts+:: frame options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] + # +padLeft+:: internal padding on the left side, in pixels [Integer] + # +padRight+:: internal padding on the right side, in pixels [Integer] + # +padTop+:: internal padding on the top side, in pixels [Integer] + # +padBottom+:: internal padding on the bottom side, in pixels [Integer] + # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer] + # +vSpacing+:: vertical spacing between widgets, in pixels [Integer] # def initialize(p, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theVerticalFrame end diff --git a/rdoc-sources/FXVisual.rb b/rdoc-sources/FXVisual.rb index afd60839753234af4fe19fdc51da8ad4489f66d1..7b7ab408b9297d8f7a44f64db2262ca2daeeecf0 100755 --- a/rdoc-sources/FXVisual.rb +++ b/rdoc-sources/FXVisual.rb @@ -4,25 +4,25 @@ module Fox # # === Construction options for FXVisual # - # +VISUAL_DEFAULT+:: Default visual - # +VISUAL_MONOCHROME+:: Must be monochrome visual - # +VISUAL_BEST+:: Best (deepest) visual - # +VISUAL_INDEXCOLOR+:: Palette visual - # +VISUAL_GRAYSCALE+:: Gray scale visual - # +VISUAL_TRUECOLOR+:: Must be true color visual - # +VISUAL_OWNCOLORMAP+:: Allocate private colormap - # +VISUAL_DOUBLEBUFFER+:: Double-buffered [FXGLVisual] - # +VISUAL_STEREO+:: Stereo [FXGLVisual] - # +VISUAL_NOACCEL+:: No hardware acceleration [for broken h/w] - # +VISUAL_SWAP_COPY+:: Buffer swap by copying (for FXGLVisual) + # +VISUAL_DEFAULT+:: Default visual + # +VISUAL_MONOCHROME+:: Must be monochrome visual + # +VISUAL_BEST+:: Best (deepest) visual + # +VISUAL_INDEXCOLOR+:: Palette visual + # +VISUAL_GRAYSCALE+:: Gray scale visual + # +VISUAL_TRUECOLOR+:: Must be true color visual + # +VISUAL_OWNCOLORMAP+:: Allocate private colormap + # +VISUAL_DOUBLEBUFFER+:: Double-buffered [FXGLVisual] + # +VISUAL_STEREO+:: Stereo [FXGLVisual] + # +VISUAL_NOACCEL+:: No hardware acceleration [for broken h/w] + # +VISUAL_SWAP_COPY+:: Buffer swap by copying (for FXGLVisual) # # === Visual type # - # +VISUALTYPE_UNKNOWN+:: Undetermined visual type - # +VISUALTYPE_MONO+:: Visual for drawing into 1-bpp surfaces - # +VISUALTYPE_TRUE+:: True color - # +VISUALTYPE_INDEX+:: Index [palette] color - # +VISUALTYPE_GRAY+:: Gray scale + # +VISUALTYPE_UNKNOWN+:: Undetermined visual type + # +VISUALTYPE_MONO+:: Visual for drawing into 1-bpp surfaces + # +VISUALTYPE_TRUE+:: True color + # +VISUALTYPE_INDEX+:: Index [palette] color + # +VISUALTYPE_GRAY+:: Gray scale # class FXVisual < FXId # Visual construction flags [Integer] @@ -59,9 +59,9 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +flgs+:: visual construction flags [Integer] - # +d+:: requested visual depth, in bits [Integer] + # +a+:: an application instance [FXApp] + # +flgs+:: visual construction flags [Integer] + # +d+:: requested visual depth, in bits [Integer] # def initialize(a, flgs, d=32); end diff --git a/rdoc-sources/FXWindow.rb b/rdoc-sources/FXWindow.rb index 66c47eb81c8b2096483ca98479f18f582d98dd84..dba6c3db95a0c14cb15d151c4a473f2932477055 100755 --- a/rdoc-sources/FXWindow.rb +++ b/rdoc-sources/FXWindow.rb @@ -6,54 +6,54 @@ module Fox # # The following messages are sent by FXWindow to its target: # - # +SEL_MAP+:: sent when the window is mapped to the screen; the message data is an FXEvent instance. - # +SEL_UNMAP+:: sent when the window is unmapped; the message data is an FXEvent instance. - # +SEL_CONFIGURE+:: sent when the window's size changes; the message data is an FXEvent instance. - # +SEL_ENTER+:: sent when the mouse cursor enters this window - # +SEL_LEAVE+:: sent when the mouse cursor leaves this window - # +SEL_FOCUSIN+:: sent when this window gains the focus - # +SEL_FOCUSOUT+:: sent when this window loses the focus - # +SEL_UPDATE+:: sent when this window needs an update - # +SEL_UNGRABBED+:: sent when this window loses the mouse grab (or capture) + # +SEL_MAP+:: sent when the window is mapped to the screen; the message data is an FXEvent instance. + # +SEL_UNMAP+:: sent when the window is unmapped; the message data is an FXEvent instance. + # +SEL_CONFIGURE+:: sent when the window's size changes; the message data is an FXEvent instance. + # +SEL_ENTER+:: sent when the mouse cursor enters this window + # +SEL_LEAVE+:: sent when the mouse cursor leaves this window + # +SEL_FOCUSIN+:: sent when this window gains the focus + # +SEL_FOCUSOUT+:: sent when this window loses the focus + # +SEL_UPDATE+:: sent when this window needs an update + # +SEL_UNGRABBED+:: sent when this window loses the mouse grab (or capture) # # For each of the following keyboard-related events, the message data is an FXEvent instance: # - # +SEL_KEYPRESS+:: sent when a key is pressed - # +SEL_KEYRELEASE+:: sent when a key is released + # +SEL_KEYPRESS+:: sent when a key is pressed + # +SEL_KEYRELEASE+:: sent when a key is released # # For each of the following mouse-related events, the message data is an FXEvent instance: # - # +SEL_MOTION+:: sent when the mouse moves - # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down - # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up - # +SEL_MIDDLEBUTTONPRESS+:: sent when the middle mouse button goes down - # +SEL_MIDDLEBUTTONRELEASE+:: sent when the middle mouse button goes up - # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down - # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up - # +SEL_MOUSEWHEEL+:: sent when the mouse wheel is scrolled + # +SEL_MOTION+:: sent when the mouse moves + # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down + # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up + # +SEL_MIDDLEBUTTONPRESS+:: sent when the middle mouse button goes down + # +SEL_MIDDLEBUTTONRELEASE+:: sent when the middle mouse button goes up + # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down + # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up + # +SEL_MOUSEWHEEL+:: sent when the mouse wheel is scrolled # # For each of the following selection-related events, the message data is an FXEvent instance: # - # +SEL_SELECTION_GAINED+:: sent when this window acquires the selection - # +SEL_SELECTION_LOST+:: sent when this window loses the selection - # +SEL_SELECTION_REQUEST+:: sent when this window's selection is requested + # +SEL_SELECTION_GAINED+:: sent when this window acquires the selection + # +SEL_SELECTION_LOST+:: sent when this window loses the selection + # +SEL_SELECTION_REQUEST+:: sent when this window's selection is requested # # For each of the following clipboard-related events, the message data is an FXEvent instance: # - # +SEL_CLIPBOARD_GAINED+:: sent when this window acquires the clipboard - # +SEL_CLIPBOARD_LOST+:: sent when this window loses the clipboard - # +SEL_CLIPBOARD_REQUEST+:: sent when this window's clipboard data is requested + # +SEL_CLIPBOARD_GAINED+:: sent when this window acquires the clipboard + # +SEL_CLIPBOARD_LOST+:: sent when this window loses the clipboard + # +SEL_CLIPBOARD_REQUEST+:: sent when this window's clipboard data is requested # # For each of the following drag-and-drop events, the message data is an FXEvent instance: # - # +SEL_BEGINDRAG+:: sent at the beginning of a drag operation - # +SEL_DRAGGED+:: sent while stuff is being dragged around - # +SEL_ENDDRAG+:: sent at the end of a drag operation - # +SEL_DND_ENTER+:: drag-and-drop enter - # +SEL_DND_LEAVE+:: drag-and-drop leave - # +SEL_DND_MOTION+:: drag-and-drop motion - # +SEL_DND_DROP+:: drag-and-drop motion - # +SEL_DND_REQUEST+:: drag-and-drop request + # +SEL_BEGINDRAG+:: sent at the beginning of a drag operation + # +SEL_DRAGGED+:: sent while stuff is being dragged around + # +SEL_ENDDRAG+:: sent at the end of a drag operation + # +SEL_DND_ENTER+:: drag-and-drop enter + # +SEL_DND_LEAVE+:: drag-and-drop leave + # +SEL_DND_MOTION+:: drag-and-drop motion + # +SEL_DND_DROP+:: drag-and-drop motion + # +SEL_DND_REQUEST+:: drag-and-drop request # # === Layout hints for child widgets # @@ -153,64 +153,64 @@ module Fox class FXWindow < FXDrawable # This window's parent window [FXWindow] - attr_reader :parent + attr_reader :parent # This window's owner window [FXWindow] - attr_reader :owner + attr_reader :owner # The shell window for this window [FXWindow] - attr_reader :shell + attr_reader :shell # Root window [FXWindow] - attr_reader :root + attr_reader :root # Next (sibling) window, if any [FXWindow] - attr_reader :next + attr_reader :next # Previous (sibling) window, if any [FXWindow] - attr_reader :prev + attr_reader :prev # This window's first child window, if any [FXWindow] - attr_reader :first + attr_reader :first # This window's last child window, if any [FXWindow] - attr_reader :last + attr_reader :last # Currently focused child window, if any [FXWindow] - attr_reader :focus + attr_reader :focus # Window key [Integer] - attr_accessor :key + attr_accessor :key # Message target object for this window [FXObject] - attr_accessor :target + attr_accessor :target # Message identifier for this window [Integer] - attr_accessor :selector + attr_accessor :selector # This window's x-coordinate, in the parent's coordinate system [Integer] - attr_accessor :x + attr_accessor :x # This window's y-coordinate, in the parent's coordinate system [Integer] - attr_accessor :y + attr_accessor :y # The accelerator table for this window [FXAccelTable] - attr_accessor :accelTable + attr_accessor :accelTable # Layout hints for this window [Integer] - attr_accessor :layoutHints + attr_accessor :layoutHints # Number of child windows for this window [Integer] - attr_reader :numChildren + attr_reader :numChildren # Default cursor for this window [FXCursor] - attr_accessor :defaultCursor + attr_accessor :defaultCursor # Drag cursor for this window [FXCursor] - attr_accessor :dragCursor + attr_accessor :dragCursor # Window background color [FXColor] - attr_accessor :backColor + attr_accessor :backColor # Common DND type: Raw octet stream def FXWindow.octetType; end @@ -265,12 +265,12 @@ module Fox # # ==== Parameters: # - # +p+:: the parent window for this window [FXComposite] - # +opts+:: window options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +p+:: the parent window for this window [FXComposite] + # +opts+:: window options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(p, opts=0, x=0, y=0, width=0, height=0) # :yields: theWindow end @@ -280,8 +280,8 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +vis+:: the visual to use for this window [FXVisual] + # +a+:: an application instance [FXApp] + # +vis+:: the visual to use for this window [FXVisual] # def initialize(a, vis) # :yields: theWindow end @@ -291,13 +291,13 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +own+:: the owner window for this window [FXWindow] - # +opts+:: window options [Integer] - # +x+:: initial x-position [Integer] - # +y+:: initial y-position [Integer] - # +width+:: initial width [Integer] - # +height+:: initial height [Integer] + # +a+:: an application instance [FXApp] + # +own+:: the owner window for this window [FXWindow] + # +opts+:: window options [Integer] + # +x+:: initial x-position [Integer] + # +y+:: initial y-position [Integer] + # +width+:: initial width [Integer] + # +height+:: initial height [Integer] # def initialize(a, own, opts, x, y, w, h) # :yields: theWindow end @@ -613,12 +613,12 @@ module Fox # When dragging, inform the drop target of the new position and # the drag action. The _action_ is a constant, one of: # - # +DRAG_REJECT+:: reject all drop actions - # +DRAG_ACCEPT+:: accept any drop action - # +DRAG_COPY+:: accept this drop as a copy - # +DRAG_MOVE+:: accept this drop as a move - # +DRAG_LINK+:: accept this drop as a link - # +DRAG_PRIVATE+:: private + # +DRAG_REJECT+:: reject all drop actions + # +DRAG_ACCEPT+:: accept any drop action + # +DRAG_COPY+:: accept this drop as a copy + # +DRAG_MOVE+:: accept this drop as a move + # +DRAG_LINK+:: accept this drop as a link + # +DRAG_PRIVATE+:: private def handleDrag(x, y, action=DRAG_COPY) ; end @@ -637,17 +637,17 @@ module Fox # When being dragged over, indicate we want to receive +SEL_DND_MOTION+ messages # every time the cursor moves - def clearDragRectangle(); + def clearDragRectangle(); end # When being dragged over, indicate acceptance or rejection of the dragged data. # The _action_ is a constant indicating the suggested drag action, one of: # - # +DRAG_REJECT+:: reject all drop actions - # +DRAG_ACCEPT+:: accept any drop action - # +DRAG_COPY+:: accept this drop as a copy - # +DRAG_MOVE+:: accept this drop as a move - # +DRAG_LINK+:: accept this drop as a link - # +DRAG_PRIVATE+:: private + # +DRAG_REJECT+:: reject all drop actions + # +DRAG_ACCEPT+:: accept any drop action + # +DRAG_COPY+:: accept this drop as a copy + # +DRAG_MOVE+:: accept this drop as a move + # +DRAG_LINK+:: accept this drop as a link + # +DRAG_PRIVATE+:: private def acceptDrop(action=DRAG_ACCEPT); end diff --git a/rdoc-sources/FXWizard.rb b/rdoc-sources/FXWizard.rb index e36cc4dc1a8c664f5ff90363767dee47d4208b45..4d8c6caf536dbd0a1d0f20b8160531cf73080d92 100755 --- a/rdoc-sources/FXWizard.rb +++ b/rdoc-sources/FXWizard.rb @@ -8,8 +8,8 @@ module Fox # # === Message identifiers # - # +ID_NEXT+:: Move to the next panel in the wizard - # +ID_BACK+:: Move to the previous panel in the wizard + # +ID_NEXT+:: Move to the next panel in the wizard + # +ID_BACK+:: Move to the previous panel in the wizard # class FXWizard < FXDialogBox diff --git a/rdoc-sources/FXXBMIcon.rb b/rdoc-sources/FXXBMIcon.rb index 0a6ecb5c894357c7afb98f18667f4d6a9720694a..d6c404065de2842c4a290ac1a91982e9eb34c433 100755 --- a/rdoc-sources/FXXBMIcon.rb +++ b/rdoc-sources/FXXBMIcon.rb @@ -18,13 +18,13 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pixels+:: a memory buffer formatted in XBM file format [String] - # +mask+:: a memory buffer formatted in XBM file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pixels+:: a memory buffer formatted in XBM file format [String] + # +mask+:: a memory buffer formatted in XBM file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pixels=nil, mask=nil, clr=0, opts=0, width=1, height=1) # :yields: theXBMIcon end diff --git a/rdoc-sources/FXXBMImage.rb b/rdoc-sources/FXXBMImage.rb index f71317092628a6a1e7ecfa4bb0f0963896bacef2..100ba8eb3e80cde87a08e1d2d9438609dbdb6d0e 100755 --- a/rdoc-sources/FXXBMImage.rb +++ b/rdoc-sources/FXXBMImage.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pixels+:: a memory buffer formatted in XBM file format [String] - # +mask+:: a memory buffer formatted in XBM file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pixels+:: a memory buffer formatted in XBM file format [String] + # +mask+:: a memory buffer formatted in XBM file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pixels=nil, mask=nil, opts=0, width=1, height=1) # :yields: theXBMImage end diff --git a/rdoc-sources/FXXPMIcon.rb b/rdoc-sources/FXXPMIcon.rb index 079340b9f26317eb1ffc201246991e8ba4281ca0..6079c3881d09384ac6d64bc19ddf88eb8dc564bf 100755 --- a/rdoc-sources/FXXPMIcon.rb +++ b/rdoc-sources/FXXPMIcon.rb @@ -18,12 +18,12 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in XPM file format [String] - # +clr+:: transparency color [FXColor] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in XPM file format [String] + # +clr+:: transparency color [FXColor] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theXPMIcon end @@ -38,7 +38,7 @@ module Fox # # ==== Parameters: # - # +store+:: stream from which to read the file data [FXStream] + # +store+:: stream from which to read the file data [FXStream] # def Fox.fxloadXPM(store); end @@ -48,12 +48,12 @@ module Fox # # ==== Parameters: # - # +store+:: stream to which to write the file data [FXStream] - # +data+:: the image pixel data, an array of FXColor values - # +transp+:: transparency color [FXColor] - # +width+:: width [Integer] - # +height+:: height [Integer] - # +fast+:: if +true+, use fast something + # +store+:: stream to which to write the file data [FXStream] + # +data+:: the image pixel data, an array of FXColor values + # +transp+:: transparency color [FXColor] + # +width+:: width [Integer] + # +height+:: height [Integer] + # +fast+:: if +true+, use fast something # def fxsaveXPM(store, data, transp, width, height, fast=true); end diff --git a/rdoc-sources/FXXPMImage.rb b/rdoc-sources/FXXPMImage.rb index 532c5e0815a6d49428c93dd963fc507384c7c88f..40fab42387560eeb439138acddf8de687805a104 100755 --- a/rdoc-sources/FXXPMImage.rb +++ b/rdoc-sources/FXXPMImage.rb @@ -18,11 +18,11 @@ module Fox # # ==== Parameters: # - # +a+:: an application instance [FXApp] - # +pix+:: a memory buffer formatted in XPM file format [String] - # +opts+:: options [Integer] - # +width+:: width [Integer] - # +height+:: height [Integer] + # +a+:: an application instance [FXApp] + # +pix+:: a memory buffer formatted in XPM file format [String] + # +opts+:: options [Integer] + # +width+:: width [Integer] + # +height+:: height [Integer] # def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theXPMImage end diff --git a/rdoc-sources/Makefile b/rdoc-sources/Makefile index 23b3478134fd3232c06a82396d21403db001cc95..c265424df92efccdd767165be3d886889eddcf06 100755 --- a/rdoc-sources/Makefile +++ b/rdoc-sources/Makefile @@ -14,10 +14,10 @@ SOURCES = *.rb \ ../lib/fox/version.rb rdoc: - @rdoc --op ../doc/api --main README.rdoc $(SOURCES) README.rdoc + @rdoc --op ../doc/api --main README.rdoc $(SOURCES) README.rdoc ri: - @rdoc --ri $(SOURCES) + @rdoc --ri $(SOURCES) clean: - @rm -rf ../doc/api + @rm -rf ../doc/api