Thu, 30 Aug 2012 14:27:35 +0200
Added some documentation files.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ChangeLog Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,4 @@ +ChangeLog +--------- +Version 0.1.0 +- first development release
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/LICENSE.GPL3 Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,621 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,306 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.PluginProjectPyramid</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.PluginProjectPyramid</h1> +<p> +Module implementing the Pyramid project plugin. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>pyramidPluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ProjectPyramidPlugin">ProjectPyramidPlugin</a></td> +<td>Class implementing the Pyramid project plugin.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#apiFiles">apiFiles</a></td> +<td>Module function to return the API files made available by this plugin.</td> +</tr><tr> +<td><a href="#createPyramidPage">createPyramidPage</a></td> +<td>Module function to create the Pyramid configuration page.</td> +</tr><tr> +<td><a href="#getConfigData">getConfigData</a></td> +<td>Module function returning data as required by the configuration dialog.</td> +</tr><tr> +<td><a href="#prepareUninstall">prepareUninstall</a></td> +<td>Module function to prepare for an uninstallation.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="ProjectPyramidPlugin" ID="ProjectPyramidPlugin"></a> +<h2>ProjectPyramidPlugin</h2> +<p> + Class implementing the Pyramid project plugin. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>lexerAssociations</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ProjectPyramidPlugin.__init__">ProjectPyramidPlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.__checkVersions">__checkVersions</a></td> +<td>Private function to check that the eric5 version is ok.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.__projectClosed">__projectClosed</a></td> +<td>Private slot to handle the projectClosed signal.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.__projectOpened">__projectOpened</a></td> +<td>Private slot to handle the projectOpened signal.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td> +<td>Public method to determine the filename of a compiled translation file given the translation source file.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.fileTypesCallback">fileTypesCallback</a></td> +<td>Public method get the filetype associations of the Pyramid project type.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> +<td>Public method to get the lexer association of the Pyramid project type for a file.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.prepareUninstall">prepareUninstall</a></td> +<td>Public method to prepare for an uninstallation.</td> +</tr><tr> +<td><a href="#ProjectPyramidPlugin.setPreferences">setPreferences</a></td> +<td>Public method to store the various settings.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="ProjectPyramidPlugin.__init__" ID="ProjectPyramidPlugin.__init__"></a> +<h4>ProjectPyramidPlugin (Constructor)</h4> +<b>ProjectPyramidPlugin</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the user interface object (UI.UserInterface) +</dd> +</dl><a NAME="ProjectPyramidPlugin.__checkVersions" ID="ProjectPyramidPlugin.__checkVersions"></a> +<h4>ProjectPyramidPlugin.__checkVersions</h4> +<b>__checkVersions</b>(<i></i>) +<p> + Private function to check that the eric5 version is ok. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating version is ok (boolean) +</dd> +</dl><a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a> +<h4>ProjectPyramidPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) +<p> + Private slot to (re)initialize the plugin. +</p><a NAME="ProjectPyramidPlugin.__loadTranslator" ID="ProjectPyramidPlugin.__loadTranslator"></a> +<h4>ProjectPyramidPlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) +<p> + Private method to load the translation file. +</p><a NAME="ProjectPyramidPlugin.__projectClosed" ID="ProjectPyramidPlugin.__projectClosed"></a> +<h4>ProjectPyramidPlugin.__projectClosed</h4> +<b>__projectClosed</b>(<i></i>) +<p> + Private slot to handle the projectClosed signal. +</p><a NAME="ProjectPyramidPlugin.__projectOpened" ID="ProjectPyramidPlugin.__projectOpened"></a> +<h4>ProjectPyramidPlugin.__projectOpened</h4> +<b>__projectOpened</b>(<i></i>) +<p> + Private slot to handle the projectOpened signal. +</p><a NAME="ProjectPyramidPlugin.activate" ID="ProjectPyramidPlugin.activate"></a> +<h4>ProjectPyramidPlugin.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> +<h4>ProjectPyramidPlugin.binaryTranslationsCallback</h4> +<b>binaryTranslationsCallback</b>(<i>filename</i>) +<p> + Public method to determine the filename of a compiled translation file + given the translation source file. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the translation source file (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +name of the binary translation file (string) +</dd> +</dl><a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> +<h4>ProjectPyramidPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plugin. +</p><a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a> +<h4>ProjectPyramidPlugin.fileTypesCallback</h4> +<b>fileTypesCallback</b>(<i></i>) +<p> + Public method get the filetype associations of the Pyramid project type. +</p><dl> +<dt>Returns:</dt> +<dd> +dictionary with file type associations +</dd> +</dl><a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> +<h4>ProjectPyramidPlugin.getPreferences</h4> +<b>getPreferences</b>(<i>key</i>) +<p> + Public method to retrieve the various settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested setting +</dd> +</dl><a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> +<h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> +<b>lexerAssociationCallback</b>(<i>filename</i>) +<p> + Public method to get the lexer association of the Pyramid project type for + a file. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|') +</dd> +</dl><a NAME="ProjectPyramidPlugin.prepareUninstall" ID="ProjectPyramidPlugin.prepareUninstall"></a> +<h4>ProjectPyramidPlugin.prepareUninstall</h4> +<b>prepareUninstall</b>(<i></i>) +<p> + Public method to prepare for an uninstallation. +</p><a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> +<h4>ProjectPyramidPlugin.setPreferences</h4> +<b>setPreferences</b>(<i>key, value</i>) +<p> + Public method to store the various settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set (string) +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="apiFiles" ID="apiFiles"></a> +<h2>apiFiles</h2> +<b>apiFiles</b>(<i>language</i>) +<p> + Module function to return the API files made available by this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +list of API filenames (list of string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="createPyramidPage" ID="createPyramidPage"></a> +<h2>createPyramidPage</h2> +<b>createPyramidPage</b>(<i>configDlg</i>) +<p> + Module function to create the Pyramid configuration page. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the configuration page +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getConfigData" ID="getConfigData"></a> +<h2>getConfigData</h2> +<b>getConfigData</b>(<i></i>) +<p> + Module function returning data as required by the configuration dialog. +</p><dl> +<dt>Returns:</dt> +<dd> +dictionary containing the relevant data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="prepareUninstall" ID="prepareUninstall"></a> +<h2>prepareUninstall</h2> +<b>prepareUninstall</b>(<i></i>) +<p> + Module function to prepare for an uninstallation. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage</h1> +<p> +Module implementing the Pyramid configuration page. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyramidPage">PyramidPage</a></td> +<td>Class implementing the Pyramid configuration page.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyramidPage" ID="PyramidPage"></a> +<h2>PyramidPage</h2> +<p> + Class implementing the Pyramid configuration page. +</p> +<h3>Derived from</h3> +ConfigurationPageBase, Ui_PyramidPage +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PyramidPage.__init__">PyramidPage</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyramidPage.on_virtualEnvPy2Button_clicked">on_virtualEnvPy2Button_clicked</a></td> +<td>Private slot to select the virtual environment for Python 2 via a directory selection dialog.</td> +</tr><tr> +<td><a href="#PyramidPage.on_virtualEnvPy3Button_clicked">on_virtualEnvPy3Button_clicked</a></td> +<td>Private slot to select the virtual environment for Python 3 via a directory selection dialog.</td> +</tr><tr> +<td><a href="#PyramidPage.save">save</a></td> +<td>Public slot to save the Pyramid configuration.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyramidPage.__init__" ID="PyramidPage.__init__"></a> +<h4>PyramidPage (Constructor)</h4> +<b>PyramidPage</b>(<i>plugin</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd> +</dl><a NAME="PyramidPage.on_virtualEnvPy2Button_clicked" ID="PyramidPage.on_virtualEnvPy2Button_clicked"></a> +<h4>PyramidPage.on_virtualEnvPy2Button_clicked</h4> +<b>on_virtualEnvPy2Button_clicked</b>(<i></i>) +<p> + Private slot to select the virtual environment for Python 2 via a + directory selection dialog. +</p><a NAME="PyramidPage.on_virtualEnvPy3Button_clicked" ID="PyramidPage.on_virtualEnvPy3Button_clicked"></a> +<h4>PyramidPage.on_virtualEnvPy3Button_clicked</h4> +<b>on_virtualEnvPy3Button_clicked</b>(<i></i>) +<p> + Private slot to select the virtual environment for Python 3 via a + directory selection dialog. +</p><a NAME="PyramidPage.save" ID="PyramidPage.save"></a> +<h4>PyramidPage.save</h4> +<b>save</b>(<i></i>) +<p> + Public slot to save the Pyramid configuration. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1> +<p> +Module implementing a dialog for entering the create parameters. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#CreateParametersDialog">CreateParametersDialog</a></td> +<td>Class implementing a dialog for entering the create parameters.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a> +<h2>CreateParametersDialog</h2> +<p> + Class implementing a dialog for entering the create parameters. +</p> +<h3>Derived from</h3> +QDialog, Ui_CreateParametersDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> +<td>Private slot to update the dialog.</td> +</tr><tr> +<td><a href="#CreateParametersDialog.getData">getData</a></td> +<td>Public method to get the data.</td> +</tr><tr> +<td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot to handle changes of the site name.</td> +</tr><tr> +<td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td> +<td>Private slot to handle changes of the selected scaffold.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> +<h4>CreateParametersDialog (Constructor)</h4> +<b>CreateParametersDialog</b>(<i>project, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i></dt> +<dd> +reference to the project object (Project) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> +<h4>CreateParametersDialog.__updateUi</h4> +<b>__updateUi</b>(<i></i>) +<p> + Private slot to update the dialog. +</p><a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a> +<h4>CreateParametersDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to get the data. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple giving the scaffold (string), the project name (string), + a flag indicating to overwrite existing files (boolean) and a flag + indicating to simulate the creation (boolean) +</dd> +</dl><a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> +<h4>CreateParametersDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to handle changes of the site name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the site entry (string) +</dd> +</dl><a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a> +<h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4> +<b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>) +<p> + Private slot to handle changes of the selected scaffold. +</p><dl> +<dt><i>text</i></dt> +<dd> +text of the combo box (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog</h1> +<p> +Module implementing a dialog to select the distribution file formats. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#DistributionTypeSelectionDialog">DistributionTypeSelectionDialog</a></td> +<td>Class implementing a dialog to select the distribution file formats.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="DistributionTypeSelectionDialog" ID="DistributionTypeSelectionDialog"></a> +<h2>DistributionTypeSelectionDialog</h2> +<p> + Class implementing a dialog to select the distribution file formats. +</p> +<h3>Derived from</h3> +QDialog, Ui_DistributionTypeSelectionDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#DistributionTypeSelectionDialog.__init__">DistributionTypeSelectionDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#DistributionTypeSelectionDialog.getFormats">getFormats</a></td> +<td>Public method to retrieve the checked formats.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="DistributionTypeSelectionDialog.__init__" ID="DistributionTypeSelectionDialog.__init__"></a> +<h4>DistributionTypeSelectionDialog (Constructor)</h4> +<b>DistributionTypeSelectionDialog</b>(<i>project, projectPath, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i></dt> +<dd> +reference to the project object (ProjectPyramid.Project.Project) +</dd><dt><i>projectPath</i></dt> +<dd> +path of the Pyramid project (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="DistributionTypeSelectionDialog.getFormats" ID="DistributionTypeSelectionDialog.getFormats"></a> +<h4>DistributionTypeSelectionDialog.getFormats</h4> +<b>getFormats</b>(<i></i>) +<p> + Public method to retrieve the checked formats. +</p><dl> +<dt>Returns:</dt> +<dd> +list of selected formats (list of string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog</h1> +<p> +Module implementing a dialog to select the template type. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#FormSelectionDialog">FormSelectionDialog</a></td> +<td>Class implementing a dialog to select the template type.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="FormSelectionDialog" ID="FormSelectionDialog"></a> +<h2>FormSelectionDialog</h2> +<p> + Class implementing a dialog to select the template type. +</p> +<h3>Derived from</h3> +QDialog, Ui_FormSelectionDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#FormSelectionDialog.__init__">FormSelectionDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#FormSelectionDialog.getTemplateText">getTemplateText</a></td> +<td>Public method to get the template text.</td> +</tr><tr> +<td><a href="#FormSelectionDialog.on_typeCombo_currentIndexChanged">on_typeCombo_currentIndexChanged</a></td> +<td>Private slot to act upon a change of the selected template type.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="FormSelectionDialog.__init__" ID="FormSelectionDialog.__init__"></a> +<h4>FormSelectionDialog (Constructor)</h4> +<b>FormSelectionDialog</b>(<i>parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="FormSelectionDialog.getTemplateText" ID="FormSelectionDialog.getTemplateText"></a> +<h4>FormSelectionDialog.getTemplateText</h4> +<b>getTemplateText</b>(<i></i>) +<p> + Public method to get the template text. +</p><dl> +<dt>Returns:</dt> +<dd> +text of the template (string) +</dd> +</dl><a NAME="FormSelectionDialog.on_typeCombo_currentIndexChanged" ID="FormSelectionDialog.on_typeCombo_currentIndexChanged"></a> +<h4>FormSelectionDialog.on_typeCombo_currentIndexChanged</h4> +<b>on_typeCombo_currentIndexChanged</b>(<i>index</i>) +<p> + Private slot to act upon a change of the selected template type. +</p><dl> +<dt><i>index</i></dt> +<dd> +selected index (integer) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,569 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.Project</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.Project</h1> +<p> +Module implementing the Pyramid project support. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Project">Project</a></td> +<td>Class implementing the Pyramid project support.</td> +</tr><tr> +<td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td> +<td>Exception thrown to signal, that there is no current Pyramid project.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Project" ID="Project"></a> +<h2>Project</h2> +<p> + Class implementing the Pyramid project support. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Project.__init__">Project</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Project.__buildDistribution">__buildDistribution</a></td> +<td>Private slot to build a distribution file for the current Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__createProject">__createProject</a></td> +<td>Private slot to create a new Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__findProjects">__findProjects</a></td> +<td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td> +</tr><tr> +<td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td> +<td>Private method to create the path to the initialization script.</td> +</tr><tr> +<td><a href="#Project.__getLocale">__getLocale</a></td> +<td>Private method to extract the locale out of a file name.</td> +</tr><tr> +<td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td> +<td>Private method to get the path of the virtual environment.</td> +</tr><tr> +<td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td> +<td>Private slot to initialize the database of the Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__normalizeList">__normalizeList</a></td> +<td>Private method to normalize a list of file names.</td> +</tr><tr> +<td><a href="#Project.__project">__project</a></td> +<td>Private method to get the name of the current Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td> +<td>Private method to filter a list of file names by Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> +<td>Private slot handling the addition of a new language.</td> +</tr><tr> +<td><a href="#Project.__projectPath">__projectPath</a></td> +<td>Private method to calculate the full path of the Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td> +<td>Private slot to show some info about Pyramid.</td> +</tr><tr> +<td><a href="#Project.__runBrowser">__runBrowser</a></td> +<td>Private slot to start the default web browser with the server URL.</td> +</tr><tr> +<td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td> +<td>Private slot to start the Pyramid Web server with logging.</td> +</tr><tr> +<td><a href="#Project.__runPythonShell">__runPythonShell</a></td> +<td>Private slot to start a Python console for a Pyramid project.</td> +</tr><tr> +<td><a href="#Project.__runServer">__runServer</a></td> +<td>Private slot to start the Pyramid Web server.</td> +</tr><tr> +<td><a href="#Project.__selectProject">__selectProject</a></td> +<td>Private method to select a Pyramid project to work with.</td> +</tr><tr> +<td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td> +<td>Private slot to set the current project.</td> +</tr><tr> +<td><a href="#Project.__setupDevelop">__setupDevelop</a></td> +<td>Private slot to set up the development environment for the current project.</td> +</tr><tr> +<td><a href="#Project.__showDocumentation">__showDocumentation</a></td> +<td>Private slot to show the helpviewer with the Pyramid documentation.</td> +</tr><tr> +<td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td> +<td>Private slot showing all views that would match a given URL.</td> +</tr><tr> +<td><a href="#Project.__showRoutes">__showRoutes</a></td> +<td>Private slot showing all URL dispatch routes.</td> +</tr><tr> +<td><a href="#Project.__showTweens">__showTweens</a></td> +<td>Private slot showing all implicit and explicit tween objects.</td> +</tr><tr> +<td><a href="#Project.compileCatalogs">compileCatalogs</a></td> +<td>Public method to compile the message catalogs.</td> +</tr><tr> +<td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr><tr> +<td><a href="#Project.extractMessages">extractMessages</a></td> +<td>Public method to extract the messages catalog template file.</td> +</tr><tr> +<td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td> +<td>Public method to build a Pyramid command.</td> +</tr><tr> +<td><a href="#Project.getPythonCommand">getPythonCommand</a></td> +<td>Public method to build the Python command.</td> +</tr><tr> +<td><a href="#Project.initActions">initActions</a></td> +<td>Public method to define the Pyramid actions.</td> +</tr><tr> +<td><a href="#Project.initMenu">initMenu</a></td> +<td>Public slot to initialize the Pyramid menu.</td> +</tr><tr> +<td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td> +<td>Public method to check, if the given console is a spawning console.</td> +</tr><tr> +<td><a href="#Project.newForm">newForm</a></td> +<td>Public method to create a new form.</td> +</tr><tr> +<td><a href="#Project.projectClosed">projectClosed</a></td> +<td>Public method to handle the closing of a project.</td> +</tr><tr> +<td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> +<td>Public method to remove our hook methods.</td> +</tr><tr> +<td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> +<td>Public method to add our hook methods.</td> +</tr><tr> +<td><a href="#Project.updateCatalogs">updateCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr><tr> +<td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Project.__init__" ID="Project.__init__"></a> +<h4>Project (Constructor)</h4> +<b>Project</b>(<i>plugin, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd><dt><i>parent</i></dt> +<dd> +parent (QObject) +</dd> +</dl><a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a> +<h4>Project.__buildDistribution</h4> +<b>__buildDistribution</b>(<i></i>) +<p> + Private slot to build a distribution file for the current Pyramid project. +</p><a NAME="Project.__createProject" ID="Project.__createProject"></a> +<h4>Project.__createProject</h4> +<b>__createProject</b>(<i></i>) +<p> + Private slot to create a new Pyramid project. +</p><a NAME="Project.__findProjects" ID="Project.__findProjects"></a> +<h4>Project.__findProjects</h4> +<b>__findProjects</b>(<i></i>) +<p> + Private method to determine the relative path of all Pyramid + projects (= top level dirs). +</p><dl> +<dt>Returns:</dt> +<dd> +list of projects (list of string) +</dd> +</dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> +<h4>Project.__getInitDbCommand</h4> +<b>__getInitDbCommand</b>(<i></i>) +<p> + Private method to create the path to the initialization script. +</p><dl> +<dt>Returns:</dt> +<dd> +path to the initialization script (string) +</dd> +</dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a> +<h4>Project.__getLocale</h4> +<b>__getLocale</b>(<i>filename</i>) +<p> + Private method to extract the locale out of a file name. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file used for extraction (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +extracted locale (string) or None +</dd> +</dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> +<h4>Project.__getVirtualEnvironment</h4> +<b>__getVirtualEnvironment</b>(<i></i>) +<p> + Private method to get the path of the virtual environment. +</p><dl> +<dt>Returns:</dt> +<dd> +path of the virtual environment (string) +</dd> +</dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> +<h4>Project.__initializeDatabase</h4> +<b>__initializeDatabase</b>(<i></i>) +<p> + Private slot to initialize the database of the Pyramid project. +</p><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> +<h4>Project.__normalizeList</h4> +<b>__normalizeList</b>(<i>filenames</i>) +<p> + Private method to normalize a list of file names. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names to normalize (list of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +normalized file names (list of string) +</dd> +</dl><a NAME="Project.__project" ID="Project.__project"></a> +<h4>Project.__project</h4> +<b>__project</b>(<i></i>) +<p> + Private method to get the name of the current Pyramid project. +</p><dl> +<dt>Returns:</dt> +<dd> +name of the project (string) +</dd> +</dl><dl> +<dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> +<dd> +raised, if no project is selected +</dd> +</dl><a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a> +<h4>Project.__projectFilteredList</h4> +<b>__projectFilteredList</b>(<i>filenames</i>) +<p> + Private method to filter a list of file names by Pyramid project. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names to be filtered (list of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +file names belonging to the current site (list of string) +</dd> +</dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> +<h4>Project.__projectLanguageAdded</h4> +<b>__projectLanguageAdded</b>(<i>code</i>) +<p> + Private slot handling the addition of a new language. +</p><dl> +<dt><i>code</i></dt> +<dd> +language code of the new language (string) +</dd> +</dl><a NAME="Project.__projectPath" ID="Project.__projectPath"></a> +<h4>Project.__projectPath</h4> +<b>__projectPath</b>(<i></i>) +<p> + Private method to calculate the full path of the Pyramid project. +</p><dl> +<dt>Returns:</dt> +<dd> +path of the project (string) +</dd> +</dl><dl> +<dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> +<dd> +raised, if no project is selected +</dd> +</dl><a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a> +<h4>Project.__pyramidInfo</h4> +<b>__pyramidInfo</b>(<i></i>) +<p> + Private slot to show some info about Pyramid. +</p><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> +<h4>Project.__runBrowser</h4> +<b>__runBrowser</b>(<i></i>) +<p> + Private slot to start the default web browser with the server URL. +</p><a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a> +<h4>Project.__runLoggingServer</h4> +<b>__runLoggingServer</b>(<i></i>) +<p> + Private slot to start the Pyramid Web server with logging. +</p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> +<h4>Project.__runPythonShell</h4> +<b>__runPythonShell</b>(<i></i>) +<p> + Private slot to start a Python console for a Pyramid project. +</p><a NAME="Project.__runServer" ID="Project.__runServer"></a> +<h4>Project.__runServer</h4> +<b>__runServer</b>(<i>logging = False</i>) +<p> + Private slot to start the Pyramid Web server. +</p><dl> +<dt><i>logging</i></dt> +<dd> +flag indicating to enable logging (boolean) +</dd> +</dl><a NAME="Project.__selectProject" ID="Project.__selectProject"></a> +<h4>Project.__selectProject</h4> +<b>__selectProject</b>(<i></i>) +<p> + Private method to select a Pyramid project to work with. +</p><dl> +<dt>Returns:</dt> +<dd> +selected project (string) +</dd> +</dl><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> +<h4>Project.__serverProcFinished</h4> +<b>__serverProcFinished</b>(<i></i>) +<p> + Private slot connected to the finished signal. +</p><a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a> +<h4>Project.__setCurrentProject</h4> +<b>__setCurrentProject</b>(<i>project</i>) +<p> + Private slot to set the current project. +</p><dl> +<dt><i>project</i></dt> +<dd> +name of the project (string) +</dd> +</dl><a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a> +<h4>Project.__setupDevelop</h4> +<b>__setupDevelop</b>(<i></i>) +<p> + Private slot to set up the development environment for the current project. +</p><a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a> +<h4>Project.__showDocumentation</h4> +<b>__showDocumentation</b>(<i></i>) +<p> + Private slot to show the helpviewer with the Pyramid documentation. +</p><a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a> +<h4>Project.__showMatchingViews</h4> +<b>__showMatchingViews</b>(<i></i>) +<p> + Private slot showing all views that would match a given URL. +</p><a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a> +<h4>Project.__showRoutes</h4> +<b>__showRoutes</b>(<i></i>) +<p> + Private slot showing all URL dispatch routes. +</p><a NAME="Project.__showTweens" ID="Project.__showTweens"></a> +<h4>Project.__showTweens</h4> +<b>__showTweens</b>(<i></i>) +<p> + Private slot showing all implicit and explicit tween objects. +</p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> +<h4>Project.compileCatalogs</h4> +<b>compileCatalogs</b>(<i>filenames</i>) +<p> + Public method to compile the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames (not used) +</dd> +</dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> +<h4>Project.compileSelectedCatalogs</h4> +<b>compileSelectedCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of file names (list of string) +</dd> +</dl><a NAME="Project.extractMessages" ID="Project.extractMessages"></a> +<h4>Project.extractMessages</h4> +<b>extractMessages</b>(<i></i>) +<p> + Public method to extract the messages catalog template file. +</p><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> +<h4>Project.getPyramidCommand</h4> +<b>getPyramidCommand</b>(<i>cmd</i>) +<p> + Public method to build a Pyramid command. +</p><dl> +<dt><i>cmd</i></dt> +<dd> +command (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +full pyramid command (string) +</dd> +</dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a> +<h4>Project.getPythonCommand</h4> +<b>getPythonCommand</b>(<i></i>) +<p> + Public method to build the Python command. +</p><dl> +<dt>Returns:</dt> +<dd> +python command (string) +</dd> +</dl><a NAME="Project.initActions" ID="Project.initActions"></a> +<h4>Project.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to define the Pyramid actions. +</p><a NAME="Project.initMenu" ID="Project.initMenu"></a> +<h4>Project.initMenu</h4> +<b>initMenu</b>(<i></i>) +<p> + Public slot to initialize the Pyramid menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> +<h4>Project.isSpawningConsole</h4> +<b>isSpawningConsole</b>(<i>consoleCmd</i>) +<p> + Public method to check, if the given console is a spawning console. +</p><dl> +<dt><i>consoleCmd</i></dt> +<dd> +console command (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of two entries giving an indication, if the console + is spawning (boolean) and the (possibly) cleaned console command + (string) +</dd> +</dl><a NAME="Project.newForm" ID="Project.newForm"></a> +<h4>Project.newForm</h4> +<b>newForm</b>(<i>path</i>) +<p> + Public method to create a new form. +</p><dl> +<dt><i>path</i></dt> +<dd> +full directory path for the new form file (string) +</dd> +</dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a> +<h4>Project.projectClosed</h4> +<b>projectClosed</b>(<i></i>) +<p> + Public method to handle the closing of a project. +</p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> +<h4>Project.projectClosedHooks</h4> +<b>projectClosedHooks</b>(<i></i>) +<p> + Public method to remove our hook methods. +</p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> +<h4>Project.projectOpenedHooks</h4> +<b>projectOpenedHooks</b>(<i></i>) +<p> + Public method to add our hook methods. +</p><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> +<h4>Project.updateCatalogs</h4> +<b>updateCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames (not used) +</dd> +</dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> +<h4>Project.updateSelectedCatalogs</h4> +<b>updateSelectedCatalogs</b>(<i>filenames</i>) +<p> + Public method to update the message catalogs. +</p><dl> +<dt><i>filenames</i></dt> +<dd> +list of filenames +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a> +<h2>PyramidNoProjectSelectedException</h2> +<p> + Exception thrown to signal, that there is no current Pyramid project. +</p> +<h3>Derived from</h3> +Exception +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,280 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</h1> +<p> +Module implementing a dialog starting a process and showing its output. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyramidDialog">PyramidDialog</a></td> +<td>Class implementing a dialog starting a process and showing its output.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyramidDialog" ID="PyramidDialog"></a> +<h2>PyramidDialog</h2> +<p> + Class implementing a dialog starting a process and showing its output. +</p><p> + It starts a QProcess and displays a dialog that + shows the output of the process. The dialog is modal, + which causes a synchronized execution of the process. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyramidDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PyramidDialog.__init__">PyramidDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyramidDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#PyramidDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#PyramidDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#PyramidDialog.finish">finish</a></td> +<td>Public slot called when the process finished or the user pressed the button.</td> +</tr><tr> +<td><a href="#PyramidDialog.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle a key press event.</td> +</tr><tr> +<td><a href="#PyramidDialog.normalExit">normalExit</a></td> +<td>Public method to check for a normal process termination.</td> +</tr><tr> +<td><a href="#PyramidDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> +<td>Public method to check for a normal process termination without error messages.</td> +</tr><tr> +<td><a href="#PyramidDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#PyramidDialog.on_input_returnPressed">on_input_returnPressed</a></td> +<td>Private slot to handle the press of the return key in the input field.</td> +</tr><tr> +<td><a href="#PyramidDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> +<td>Private slot to handle the password checkbox toggled.</td> +</tr><tr> +<td><a href="#PyramidDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> +<td>Private slot to send the input to the subversion process.</td> +</tr><tr> +<td><a href="#PyramidDialog.startBatchProcesses">startBatchProcesses</a></td> +<td>Public slot used to start a batch of processes.</td> +</tr><tr> +<td><a href="#PyramidDialog.startProcess">startProcess</a></td> +<td>Public slot used to start the process.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyramidDialog.__init__" ID="PyramidDialog.__init__"></a> +<h4>PyramidDialog (Constructor)</h4> +<b>PyramidDialog</b>(<i>text, fixed = False, linewrap = True, msgSuccess = None, msgError = None, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>text</i></dt> +<dd> +text to be shown by the label (string) +</dd><dt><i>fixed=</i></dt> +<dd> +flag indicating a fixed font should be used (boolean) +</dd><dt><i>linewrap=</i></dt> +<dd> +flag indicating to wrap long lines (boolean) +</dd><dt><i>msgSuccess=</i></dt> +<dd> +optional string to show upon successful execution + (string) +</dd><dt><i>msgError=</i></dt> +<dd> +optional string to show upon unsuccessful execution + (string) +</dd><dt><i>parent=</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a> +<h4>PyramidDialog.__procFinished</h4> +<b>__procFinished</b>(<i>exitCode, exitStatus</i>) +<p> + Private slot connected to the finished signal. +</p><dl> +<dt><i>exitCode</i></dt> +<dd> +exit code of the process (integer) +</dd><dt><i>exitStatus</i></dt> +<dd> +exit status of the process (QProcess.ExitStatus) +</dd> +</dl><a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a> +<h4>PyramidDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardError signal. +</p><p> + It reads the error output of the process and inserts it into the + error pane. +</p><a NAME="PyramidDialog.__readStdout" ID="PyramidDialog.__readStdout"></a> +<h4>PyramidDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardOutput signal. +</p><p> + It reads the output of the process, formats it and inserts it into + the contents pane. +</p><a NAME="PyramidDialog.finish" ID="PyramidDialog.finish"></a> +<h4>PyramidDialog.finish</h4> +<b>finish</b>(<i></i>) +<p> + Public slot called when the process finished or the user pressed the button. +</p><a NAME="PyramidDialog.keyPressEvent" ID="PyramidDialog.keyPressEvent"></a> +<h4>PyramidDialog.keyPressEvent</h4> +<b>keyPressEvent</b>(<i>evt</i>) +<p> + Protected slot to handle a key press event. +</p><dl> +<dt><i>evt</i></dt> +<dd> +the key press event (QKeyEvent) +</dd> +</dl><a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a> +<h4>PyramidDialog.normalExit</h4> +<b>normalExit</b>(<i></i>) +<p> + Public method to check for a normal process termination. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating normal process termination (boolean) +</dd> +</dl><a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a> +<h4>PyramidDialog.normalExitWithoutErrors</h4> +<b>normalExitWithoutErrors</b>(<i></i>) +<p> + Public method to check for a normal process termination without + error messages. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating normal process termination (boolean) +</dd> +</dl><a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a> +<h4>PyramidDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a> +<h4>PyramidDialog.on_input_returnPressed</h4> +<b>on_input_returnPressed</b>(<i></i>) +<p> + Private slot to handle the press of the return key in the input field. +</p><a NAME="PyramidDialog.on_passwordCheckBox_toggled" ID="PyramidDialog.on_passwordCheckBox_toggled"></a> +<h4>PyramidDialog.on_passwordCheckBox_toggled</h4> +<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) +<p> + Private slot to handle the password checkbox toggled. +</p><dl> +<dt><i>isOn</i></dt> +<dd> +flag indicating the status of the check box (boolean) +</dd> +</dl><a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a> +<h4>PyramidDialog.on_sendButton_clicked</h4> +<b>on_sendButton_clicked</b>(<i></i>) +<p> + Private slot to send the input to the subversion process. +</p><a NAME="PyramidDialog.startBatchProcesses" ID="PyramidDialog.startBatchProcesses"></a> +<h4>PyramidDialog.startBatchProcesses</h4> +<b>startBatchProcesses</b>(<i>argsLists, workingDir = None</i>) +<p> + Public slot used to start a batch of processes. +</p><dl> +<dt><i>argsLists</i></dt> +<dd> +list of lists of arguments for the processes + (list of list of string) +</dd><dt><i>workingDir</i></dt> +<dd> +working directory for the process (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start of the first process (boolean) +</dd> +</dl><a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a> +<h4>PyramidDialog.startProcess</h4> +<b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>) +<p> + Public slot used to start the process. +</p><dl> +<dt><i>command</i></dt> +<dd> +command to start (string) +</dd><dt><i>args</i></dt> +<dd> +list of arguments for the process (list of strings) +</dd><dt><i>workingDir=</i></dt> +<dd> +working directory for the process (string) +</dd><dt><i>showArgs=</i></dt> +<dd> +flag indicating to show the arguments (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start of the process +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,215 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1> +<p> +Module implementing a dialog showing the available routes. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td> +<td>Class implementing a dialog showing the available routes.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a> +<h2>PyramidRoutesDialog</h2> +<p> + Class implementing a dialog showing the available routes. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyramidRoutesDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td> +<td>Private slot to process the output buffer of the proutes command.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.finish">finish</a></td> +<td>Public slot called when the process finished or the user pressed the button.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle a key press event.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.on_input_returnPressed">on_input_returnPressed</a></td> +<td>Private slot to handle the press of the return key in the input field.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> +<td>Private slot to handle the password checkbox toggled.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> +<td>Private slot to send the input to the subversion process.</td> +</tr><tr> +<td><a href="#PyramidRoutesDialog.start">start</a></td> +<td>Public slot used to start the process.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a> +<h4>PyramidRoutesDialog (Constructor)</h4> +<b>PyramidRoutesDialog</b>(<i>project, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i></dt> +<dd> +reference to the project object (ProjectPyramid.Project.Project) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a> +<h4>PyramidRoutesDialog.__procFinished</h4> +<b>__procFinished</b>(<i>exitCode, exitStatus</i>) +<p> + Private slot connected to the finished signal. +</p><dl> +<dt><i>exitCode</i></dt> +<dd> +exit code of the process (integer) +</dd><dt><i>exitStatus</i></dt> +<dd> +exit status of the process (QProcess.ExitStatus) +</dd> +</dl><a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a> +<h4>PyramidRoutesDialog.__processBuffer</h4> +<b>__processBuffer</b>(<i></i>) +<p> + Private slot to process the output buffer of the proutes command. +</p><a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a> +<h4>PyramidRoutesDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardError signal. +</p><p> + It reads the error output of the process and inserts it into the + error pane. +</p><a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a> +<h4>PyramidRoutesDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardOutput signal. +</p><p> + It reads the output of the process and appends it to a buffer for + delayed processing. +</p><a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a> +<h4>PyramidRoutesDialog.finish</h4> +<b>finish</b>(<i></i>) +<p> + Public slot called when the process finished or the user pressed the button. +</p><a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a> +<h4>PyramidRoutesDialog.keyPressEvent</h4> +<b>keyPressEvent</b>(<i>evt</i>) +<p> + Protected slot to handle a key press event. +</p><dl> +<dt><i>evt</i></dt> +<dd> +the key press event (QKeyEvent) +</dd> +</dl><a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a> +<h4>PyramidRoutesDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a> +<h4>PyramidRoutesDialog.on_input_returnPressed</h4> +<b>on_input_returnPressed</b>(<i></i>) +<p> + Private slot to handle the press of the return key in the input field. +</p><a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a> +<h4>PyramidRoutesDialog.on_passwordCheckBox_toggled</h4> +<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) +<p> + Private slot to handle the password checkbox toggled. +</p><dl> +<dt><i>isOn</i></dt> +<dd> +flag indicating the status of the check box (boolean) +</dd> +</dl><a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a> +<h4>PyramidRoutesDialog.on_sendButton_clicked</h4> +<b>on_sendButton_clicked</b>(<i></i>) +<p> + Private slot to send the input to the subversion process. +</p><a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a> +<h4>PyramidRoutesDialog.start</h4> +<b>start</b>(<i>projectPath</i>) +<p> + Public slot used to start the process. +</p><dl> +<dt><i>command</i></dt> +<dd> +command to start (string) +</dd><dt><i>projectPath</i></dt> +<dd> +path to the Pyramid project (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start of the process +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<h1>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage</h1> +<p> +Package implementing the Pyramid page of the configuration dialog. +</p> + + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage.html">PyramidPage</a></td> +<td>Module implementing the Pyramid configuration page.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid.ProjectPyramid</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<h1>Plugin_Project_Pyramid.ProjectPyramid</h1> +<p> +Package implementing project support for eric5 Pyramid projects. +</p> + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.html">ConfigurationPage</a></td> +<td>Package implementing the Pyramid page of the configuration dialog.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html">CreateParametersDialog</a></td> +<td>Module implementing a dialog for entering the create parameters.</td> +</tr><tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog.html">DistributionTypeSelectionDialog</a></td> +<td>Module implementing a dialog to select the distribution file formats.</td> +</tr><tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog.html">FormSelectionDialog</a></td> +<td>Module implementing a dialog to select the template type.</td> +</tr><tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.Project.html">Project</a></td> +<td>Module implementing the Pyramid project support.</td> +</tr><tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html">PyramidDialog</a></td> +<td>Module implementing a dialog starting a process and showing its output.</td> +</tr><tr> +<td><a href="Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html">PyramidRoutesDialog</a></td> +<td>Module implementing a dialog showing the available routes.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Project_Pyramid</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<h1>Plugin_Project_Pyramid</h1> +<p> +Package implementing the Pyramid project plugin. +</p> + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Project_Pyramid.ProjectPyramid.html">ProjectPyramid</a></td> +<td>Package implementing project support for eric5 Pyramid projects.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Project_Pyramid.PluginProjectPyramid.html">PluginProjectPyramid</a></td> +<td>Module implementing the Pyramid project plugin.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/Documentation/source/index.html Thu Aug 30 14:27:35 2012 +0200 @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Table of contents</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<h1>Table of contents</h1> + + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Project_Pyramid.html">Plugin_Project_Pyramid</a></td> +<td>Package implementing the Pyramid project plugin.</td> +</tr> +</table> + +</body></html> \ No newline at end of file