Sun, 22 Nov 2020 14:12:44 +0100
Added source code documentation.
--- a/PluginFlask.e4p Sun Nov 22 14:06:00 2020 +0100 +++ b/PluginFlask.e4p Sun Nov 22 14:12:44 2020 +0100 @@ -45,6 +45,8 @@ <Other>.hgignore</Other> <Other>PluginFlask.e4p</Other> <Other>ProjectFlask/APIs</Other> + <Other>ProjectFlask/Documentation/LICENSE.GPL3</Other> + <Other>ProjectFlask/Documentation/source</Other> <Other>ProjectFlask/icons/flask-dark.svg</Other> <Other>ProjectFlask/icons/flask-light.svg</Other> <Other>ProjectFlask/icons/flask64-dark.svg</Other> @@ -176,6 +178,61 @@ <FiletypeAssociation pattern="Ui_*.py" type="__IGNORE__"/> <FiletypeAssociation pattern="makefile" type="OTHERS"/> </FiletypeAssociations> + <Documentation> + <DocumentationParams> + <dict> + <key> + <string>ERIC4DOC</string> + </key> + <value> + <dict> + <key> + <string>cssFile</string> + </key> + <value> + <string>%PYTHON%/eric6/CSSs/default.css</string> + </value> + <key> + <string>ignoreDirectories</string> + </key> + <value> + <list> + <string>.eric6project</string> + <string>.ropeproject</string> + <string>.hg</string> + </list> + </value> + <key> + <string>ignoreFilePatterns</string> + </key> + <value> + <list> + <string>Ui_*</string> + </list> + </value> + <key> + <string>outputDirectory</string> + </key> + <value> + <string>ProjectFlask/Documentation/source</string> + </value> + <key> + <string>qtHelpEnabled</string> + </key> + <value> + <bool>False</bool> + </value> + <key> + <string>useRecursion</string> + </key> + <value> + <bool>True</bool> + </value> + </dict> + </value> + </dict> + </DocumentationParams> + </Documentation> <Checkers> <CheckersParams> <dict>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/LICENSE.GPL3 Sun Nov 22 14:12:44 2020 +0100 @@ -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/ProjectFlask/Documentation/source/Plugin_Project_Flask.PluginProjectFlask.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,503 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.PluginProjectFlask</title> +<meta charset="UTF-8"> +<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_Flask.PluginProjectFlask</h1> + +<p> +Module implementing the Flask 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>flaskPluginObject</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>shortDescription</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ProjectFlaskPlugin">ProjectFlaskPlugin</a></td> +<td>Class implementing the Flask 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="#createFlaskPage">createFlaskPage</a></td> +<td>Module function to create the Flask 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="ProjectFlaskPlugin" ID="ProjectFlaskPlugin"></a> +<h2>ProjectFlaskPlugin</h2> + +<p> + Class implementing the Flask project plugin. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> + +<table> +<tr><td>PreferencesKey</td></tr><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="#ProjectFlaskPlugin.__init__">ProjectFlaskPlugin</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.__projectClosed">__projectClosed</a></td> +<td>Private slot to handle the projectClosed signal.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.__projectOpened">__projectOpened</a></td> +<td>Private slot to handle the projectOpened signal.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.__reregisterProjectType">__reregisterProjectType</a></td> +<td>Private method to re-register the project type.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.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="#ProjectFlaskPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.fileTypesCallback">fileTypesCallback</a></td> +<td>Public method get the filetype associations of the Django project type.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.getDefaultPreference">getDefaultPreference</a></td> +<td>Public method to get the default value for a setting.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.getMenu">getMenu</a></td> +<td>Public method to get a reference to the requested menu.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.getMenuNames">getMenuNames</a></td> +<td>Public method to get the names of all menus.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> +<td>Public method to get the lexer association of the Django project type for a file.</td> +</tr> +<tr> +<td><a href="#ProjectFlaskPlugin.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="ProjectFlaskPlugin.__init__" ID="ProjectFlaskPlugin.__init__"></a> +<h4>ProjectFlaskPlugin (Constructor)</h4> +<b>ProjectFlaskPlugin</b>(<i>ui</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>ui</i> (UI.UserInterface)</dt> +<dd> +reference to the user interface object +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.__initialize" ID="ProjectFlaskPlugin.__initialize"></a> +<h4>ProjectFlaskPlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) + +<p> + Private slot to (re)initialize the plugin. +</p> +<a NAME="ProjectFlaskPlugin.__loadTranslator" ID="ProjectFlaskPlugin.__loadTranslator"></a> +<h4>ProjectFlaskPlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) + +<p> + Private method to load the translation file. +</p> +<a NAME="ProjectFlaskPlugin.__projectClosed" ID="ProjectFlaskPlugin.__projectClosed"></a> +<h4>ProjectFlaskPlugin.__projectClosed</h4> +<b>__projectClosed</b>(<i></i>) + +<p> + Private slot to handle the projectClosed signal. +</p> +<a NAME="ProjectFlaskPlugin.__projectOpened" ID="ProjectFlaskPlugin.__projectOpened"></a> +<h4>ProjectFlaskPlugin.__projectOpened</h4> +<b>__projectOpened</b>(<i></i>) + +<p> + Private slot to handle the projectOpened signal. +</p> +<a NAME="ProjectFlaskPlugin.__reregisterProjectType" ID="ProjectFlaskPlugin.__reregisterProjectType"></a> +<h4>ProjectFlaskPlugin.__reregisterProjectType</h4> +<b>__reregisterProjectType</b>(<i></i>) + +<p> + Private method to re-register the project type. +</p> +<a NAME="ProjectFlaskPlugin.activate" ID="ProjectFlaskPlugin.activate"></a> +<h4>ProjectFlaskPlugin.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 +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.binaryTranslationsCallback" ID="ProjectFlaskPlugin.binaryTranslationsCallback"></a> +<h4>ProjectFlaskPlugin.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> (str)</dt> +<dd> +name of the translation source file +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +name of the binary translation file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.deactivate" ID="ProjectFlaskPlugin.deactivate"></a> +<h4>ProjectFlaskPlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) + +<p> + Public method to deactivate this plugin. +</p> +<a NAME="ProjectFlaskPlugin.fileTypesCallback" ID="ProjectFlaskPlugin.fileTypesCallback"></a> +<h4>ProjectFlaskPlugin.fileTypesCallback</h4> +<b>fileTypesCallback</b>(<i></i>) + +<p> + Public method get the filetype associations of the Django project type. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary with file type associations +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.getDefaultPreference" ID="ProjectFlaskPlugin.getDefaultPreference"></a> +<h4>ProjectFlaskPlugin.getDefaultPreference</h4> +<b>getDefaultPreference</b>(<i>key</i>) + +<p> + Public method to get the default value for a setting. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the value to get +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +the requested setting +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.getMenu" ID="ProjectFlaskPlugin.getMenu"></a> +<h4>ProjectFlaskPlugin.getMenu</h4> +<b>getMenu</b>(<i>name</i>) + +<p> + Public method to get a reference to the requested menu. +</p> +<dl> + +<dt><i>name</i> (str)</dt> +<dd> +name of the menu +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +reference to the menu or None, if no + menu with the given name exists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu or None +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.getMenuNames" ID="ProjectFlaskPlugin.getMenuNames"></a> +<h4>ProjectFlaskPlugin.getMenuNames</h4> +<b>getMenuNames</b>(<i></i>) + +<p> + Public method to get the names of all menus. +</p> +<dl> +<dt>Returns:</dt> +<dd> +menu names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.getPreferences" ID="ProjectFlaskPlugin.getPreferences"></a> +<h4>ProjectFlaskPlugin.getPreferences</h4> +<b>getPreferences</b>(<i>key</i>) + +<p> + Public method to retrieve the various settings. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the value to get +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +the requested setting +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.lexerAssociationCallback" ID="ProjectFlaskPlugin.lexerAssociationCallback"></a> +<h4>ProjectFlaskPlugin.lexerAssociationCallback</h4> +<b>lexerAssociationCallback</b>(<i>filename</i>) + +<p> + Public method to get the lexer association of the Django project type + for a file. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +name of the file +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +name of the lexer (Pygments lexers are prefixed with + 'Pygments|') +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="ProjectFlaskPlugin.setPreferences" ID="ProjectFlaskPlugin.setPreferences"></a> +<h4>ProjectFlaskPlugin.setPreferences</h4> +<b>setPreferences</b>(<i>key, value</i>) + +<p> + Public method to store the various settings. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the setting to be set +</dd> +<dt><i>value</i> (any)</dt> +<dd> +the value to be set +</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><i>language</i></dt> +<dd> +language to get APIs for (string) +</dd> +</dl> +<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="createFlaskPage" ID="createFlaskPage"></a> +<h2>createFlaskPage</h2> +<b>createFlaskPage</b>(<i>configDlg</i>) + +<p> + Module function to create the Flask configuration page. +</p> +<dl> + +<dt><i>configDlg</i></dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<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> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.AnsiTools.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,107 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.AnsiTools</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.AnsiTools</h1> + +<p> +Module implementing functions to work with ANSI escape sequences for colors. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_AnsiColorSchemes</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#getAvailableColorSchemes">getAvailableColorSchemes</a></td> +<td>Function to get a list of available color schemes.</td> +</tr> +<tr> +<td><a href="#getColor">getColor</a></td> +<td>Function to get the brush for a given scheme and color.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="getAvailableColorSchemes" ID="getAvailableColorSchemes"></a> +<h2>getAvailableColorSchemes</h2> +<b>getAvailableColorSchemes</b>(<i></i>) + +<p> + Function to get a list of available color schemes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +list containing the names of the supported color schemes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getColor" ID="getColor"></a> +<h2>getColor</h2> +<b>getColor</b>(<i>scheme, color</i>) + +<p> + Function to get the brush for a given scheme and color. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +name of the color scheme +</dd> +<dt><i>color</i> (int)</dt> +<dd> +ANSI color code +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +brush for the given parameters or None in case of error +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QBrush or None +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.ConfigurationPage.FlaskPage.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,131 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.ConfigurationPage.FlaskPage</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.ConfigurationPage.FlaskPage</h1> + +<p> +Module implementing the Flask configuration page. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#FlaskPage">FlaskPage</a></td> +<td>Class implementing the Flask configuration page.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="FlaskPage" ID="FlaskPage"></a> +<h2>FlaskPage</h2> + +<p> + Class implementing the Flask configuration page. +</p> +<h3>Derived from</h3> +ConfigurationPageBase, Ui_FlaskPage +<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="#FlaskPage.__init__">FlaskPage</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#FlaskPage.on_py3VenvNamesReloadButton_clicked">on_py3VenvNamesReloadButton_clicked</a></td> +<td>Private slot to reload the virtual environment names.</td> +</tr> +<tr> +<td><a href="#FlaskPage.on_urlResetButton_clicked">on_urlResetButton_clicked</a></td> +<td>Private slot to reset the Flask documentation URL.</td> +</tr> +<tr> +<td><a href="#FlaskPage.save">save</a></td> +<td>Public slot to save the Flask configuration.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="FlaskPage.__init__" ID="FlaskPage.__init__"></a> +<h4>FlaskPage (Constructor)</h4> +<b>FlaskPage</b>(<i>plugin</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd> +</dl> +<a NAME="FlaskPage.on_py3VenvNamesReloadButton_clicked" ID="FlaskPage.on_py3VenvNamesReloadButton_clicked"></a> +<h4>FlaskPage.on_py3VenvNamesReloadButton_clicked</h4> +<b>on_py3VenvNamesReloadButton_clicked</b>(<i></i>) + +<p> + Private slot to reload the virtual environment names. +</p> +<a NAME="FlaskPage.on_urlResetButton_clicked" ID="FlaskPage.on_urlResetButton_clicked"></a> +<h4>FlaskPage.on_urlResetButton_clicked</h4> +<b>on_urlResetButton_clicked</b>(<i></i>) + +<p> + Private slot to reset the Flask documentation URL. +</p> +<a NAME="FlaskPage.save" ID="FlaskPage.save"></a> +<h4>FlaskPage.save</h4> +<b>save</b>(<i></i>) + +<p> + Public slot to save the Flask 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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.FlaskBabelDetector.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,44 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.FlaskBabelDetector</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskBabelExtension.FlaskBabelDetector</h1> + +<p> +Module to check for the presence of 'flask-babel' by importing it. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,271 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog</h1> + +<p> +Module implementing a dialog to run a flask command and show its output. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyBabelCommandDialog">PyBabelCommandDialog</a></td> +<td>Class implementing a dialog to run a flask command and show its output.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyBabelCommandDialog" ID="PyBabelCommandDialog"></a> +<h2>PyBabelCommandDialog</h2> + +<p> + Class implementing a dialog to run a flask command and show its output. +</p> +<h3>Derived from</h3> +QDialog, Ui_FlaskCommandDialog +<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="#PyBabelCommandDialog.__init__">PyBabelCommandDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.__cancelProcess">__cancelProcess</a></td> +<td>Private slot to terminate the current process.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.__processFinished">__processFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.__readStdOut">__readStdOut</a></td> +<td>Private slot to add the server process output to the output pane.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.closeEvent">closeEvent</a></td> +<td>Protected method handling the close event of the dialog.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot handling presses of the button box buttons.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.startBatchCommand">startBatchCommand</a></td> +<td>Public method to start a pybabel command repeatedly with a list of arguments and show the output.</td> +</tr> +<tr> +<td><a href="#PyBabelCommandDialog.startCommand">startCommand</a></td> +<td>Public method to start a pybabel command and show its output.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyBabelCommandDialog.__init__" ID="PyBabelCommandDialog.__init__"></a> +<h4>PyBabelCommandDialog (Constructor)</h4> +<b>PyBabelCommandDialog</b>(<i>project, title="", msgSuccess="", msgError="", parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>title</i> (str)</dt> +<dd> +window title of the dialog +</dd> +<dt><i>msgSuccess</i> (str)</dt> +<dd> +success message to be shown +</dd> +<dt><i>msgError</i> (str)</dt> +<dd> +message to be shown on error +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="PyBabelCommandDialog.__cancelProcess" ID="PyBabelCommandDialog.__cancelProcess"></a> +<h4>PyBabelCommandDialog.__cancelProcess</h4> +<b>__cancelProcess</b>(<i></i>) + +<p> + Private slot to terminate the current process. +</p> +<a NAME="PyBabelCommandDialog.__processFinished" ID="PyBabelCommandDialog.__processFinished"></a> +<h4>PyBabelCommandDialog.__processFinished</h4> +<b>__processFinished</b>(<i>exitCode, exitStatus</i>) + +<p> + Private slot connected to the finished signal. +</p> +<dl> + +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> +<dd> +exit status of the process +</dd> +</dl> +<a NAME="PyBabelCommandDialog.__readStdOut" ID="PyBabelCommandDialog.__readStdOut"></a> +<h4>PyBabelCommandDialog.__readStdOut</h4> +<b>__readStdOut</b>(<i></i>) + +<p> + Private slot to add the server process output to the output pane. +</p> +<a NAME="PyBabelCommandDialog.closeEvent" ID="PyBabelCommandDialog.closeEvent"></a> +<h4>PyBabelCommandDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method handling the close event of the dialog. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event object +</dd> +</dl> +<a NAME="PyBabelCommandDialog.on_buttonBox_clicked" ID="PyBabelCommandDialog.on_buttonBox_clicked"></a> +<h4>PyBabelCommandDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot handling presses of the button box buttons. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the button been clicked +</dd> +</dl> +<a NAME="PyBabelCommandDialog.startBatchCommand" ID="PyBabelCommandDialog.startBatchCommand"></a> +<h4>PyBabelCommandDialog.startBatchCommand</h4> +<b>startBatchCommand</b>(<i>argsLists, workdir</i>) + +<p> + Public method to start a pybabel command repeatedly with a list of + arguments and show the output. +</p> +<dl> + +<dt><i>argsLists</i> (list of lists of str)</dt> +<dd> +list of command line arguments for the batch commands +</dd> +<dt><i>workdir</i> (str)</dt> +<dd> +working directory for the command +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start of the first process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="PyBabelCommandDialog.startCommand" ID="PyBabelCommandDialog.startCommand"></a> +<h4>PyBabelCommandDialog.startCommand</h4> +<b>startCommand</b>(<i>command, args, workdir, clearOutput=True</i>) + +<p> + Public method to start a pybabel command and show its output. +</p> +<dl> + +<dt><i>command</i> (str)</dt> +<dd> +pybabel command to be run +</dd> +<dt><i>args</i> (list of str)</dt> +<dd> +list of command line arguments for the command +</dd> +<dt><i>workdir</i> (str)</dt> +<dd> +working directory for the command +</dd> +<dt><i>clearOutput</i> (bool)</dt> +<dd> +flag indicating to clear the output +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,201 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog</h1> + +<p> +Module implementing a dialog to edit the PyBabel configuration. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyBabelConfigDialog">PyBabelConfigDialog</a></td> +<td>Class implementing a dialog to edit the PyBabel configuration.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyBabelConfigDialog" ID="PyBabelConfigDialog"></a> +<h2>PyBabelConfigDialog</h2> + +<p> + Class implementing a dialog to edit the PyBabel configuration. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyBabelConfigDialog +<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="#PyBabelConfigDialog.__init__">PyBabelConfigDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.__updateCatalogPicker">__updateCatalogPicker</a></td> +<td>Private method to update the contents of the catalog picker.</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.__updateOK">__updateOK</a></td> +<td>Private method to update the status of the OK button.</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.getConfiguration">getConfiguration</a></td> +<td>Public method to get the entered configuration data.</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.on_configFilePicker_textChanged">on_configFilePicker_textChanged</a></td> +<td>Private slot to handle a change of the configuration file name.</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.on_domainEdit_textChanged">on_domainEdit_textChanged</a></td> +<td>Private slot to handle a change of the translations domain.</td> +</tr> +<tr> +<td><a href="#PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged">on_translationsDirectoryPicker_textChanged</a></td> +<td>Private slot to handle a change of the catalog file name.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyBabelConfigDialog.__init__" ID="PyBabelConfigDialog.__init__"></a> +<h4>PyBabelConfigDialog (Constructor)</h4> +<b>PyBabelConfigDialog</b>(<i>configuration, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>configuration</i> (dict)</dt> +<dd> +current pybabel configuration +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="PyBabelConfigDialog.__updateCatalogPicker" ID="PyBabelConfigDialog.__updateCatalogPicker"></a> +<h4>PyBabelConfigDialog.__updateCatalogPicker</h4> +<b>__updateCatalogPicker</b>(<i></i>) + +<p> + Private method to update the contents of the catalog picker. +</p> +<a NAME="PyBabelConfigDialog.__updateOK" ID="PyBabelConfigDialog.__updateOK"></a> +<h4>PyBabelConfigDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private method to update the status of the OK button. +</p> +<a NAME="PyBabelConfigDialog.getConfiguration" ID="PyBabelConfigDialog.getConfiguration"></a> +<h4>PyBabelConfigDialog.getConfiguration</h4> +<b>getConfiguration</b>(<i></i>) + +<p> + Public method to get the entered configuration data. +</p> +<dl> +<dt>Returns:</dt> +<dd> +pybabel configuration +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="PyBabelConfigDialog.on_configFilePicker_textChanged" ID="PyBabelConfigDialog.on_configFilePicker_textChanged"></a> +<h4>PyBabelConfigDialog.on_configFilePicker_textChanged</h4> +<b>on_configFilePicker_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the configuration file name. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +configuration file name +</dd> +</dl> +<a NAME="PyBabelConfigDialog.on_domainEdit_textChanged" ID="PyBabelConfigDialog.on_domainEdit_textChanged"></a> +<h4>PyBabelConfigDialog.on_domainEdit_textChanged</h4> +<b>on_domainEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the translations domain. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +entered translations domain +</dd> +</dl> +<a NAME="PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged" ID="PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged"></a> +<h4>PyBabelConfigDialog.on_translationsDirectoryPicker_textChanged</h4> +<b>on_translationsDirectoryPicker_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the catalog file name. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +configuration file name +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,456 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension</h1> + +<p> +Module implementing the project support for flask-babel. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PyBabelProject">PyBabelProject</a></td> +<td>Class implementing the Flask project support.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PyBabelProject" ID="PyBabelProject"></a> +<h2>PyBabelProject</h2> + +<p> + Class implementing the Flask 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="#PyBabelProject.__init__">PyBabelProject</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__createBabelCfg">__createBabelCfg</a></td> +<td>Private method to create a template pybabel configuration file.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__ensurePybabelConfigured">__ensurePybabelConfigured</a></td> +<td>Private method to ensure, that PyBabel has been configured.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__getLocale">__getLocale</a></td> +<td>Private method to extract the locale out of a file name.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.__projectLanguageAdded">__projectLanguageAdded</a></td> +<td>Private slot handling the addition of a new language.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.compileCatalogs">compileCatalogs</a></td> +<td>Public method to compile the message catalogs.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.compileSelectedCatalogs">compileSelectedCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.configurePyBabel">configurePyBabel</a></td> +<td>Public slot to show a dialog to edit the pybabel configuration.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.determineCapability">determineCapability</a></td> +<td>Public method to determine the availability of flask-babel.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.extractMessages">extractMessages</a></td> +<td>Public method to extract the messages catalog template file.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.flaskBabelAvailable">flaskBabelAvailable</a></td> +<td>Public method to check, if the 'flask-babel' package is available.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.getBabelCommand">getBabelCommand</a></td> +<td>Public method to build the Babel command.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.openPOEditor">openPOEditor</a></td> +<td>Public method to edit the given file in an external .po editor.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.projectClosedHooks">projectClosedHooks</a></td> +<td>Public method to remove our hook methods.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.projectOpenedHooks">projectOpenedHooks</a></td> +<td>Public method to add our hook methods.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.registerOpenHook">registerOpenHook</a></td> +<td>Public method to register the open hook to open a translations file in a translations editor.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.updateCatalogs">updateCatalogs</a></td> +<td>Public method to update the message catalogs.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.updateCatalogsObsolete">updateCatalogsObsolete</a></td> +<td>Public method to update the message catalogs keeping obsolete translations.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.updateSelectedCatalogs">updateSelectedCatalogs</a></td> +<td>Public method to update the selected message catalogs.</td> +</tr> +<tr> +<td><a href="#PyBabelProject.updateSelectedCatalogsObsolete">updateSelectedCatalogsObsolete</a></td> +<td>Public method to update the message catalogs keeping obsolete translations.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PyBabelProject.__init__" ID="PyBabelProject.__init__"></a> +<h4>PyBabelProject (Constructor)</h4> +<b>PyBabelProject</b>(<i>plugin, project, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i> (ProjectFlaskPlugin)</dt> +<dd> +reference to the plugin object +</dd> +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent +</dd> +</dl> +<a NAME="PyBabelProject.__createBabelCfg" ID="PyBabelProject.__createBabelCfg"></a> +<h4>PyBabelProject.__createBabelCfg</h4> +<b>__createBabelCfg</b>(<i>configFile</i>) + +<p> + Private method to create a template pybabel configuration file. +</p> +<dl> + +<dt><i>configFile</i> (str)</dt> +<dd> +name of the configuration file to be created +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating successful configuration file creation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="PyBabelProject.__ensurePybabelConfigured" ID="PyBabelProject.__ensurePybabelConfigured"></a> +<h4>PyBabelProject.__ensurePybabelConfigured</h4> +<b>__ensurePybabelConfigured</b>(<i></i>) + +<p> + Private method to ensure, that PyBabel has been configured. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating successful configuration +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="PyBabelProject.__getLocale" ID="PyBabelProject.__getLocale"></a> +<h4>PyBabelProject.__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> (str)</dt> +<dd> +name of the file used for extraction +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +extracted locale +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str or None +</dd> +</dl> +<a NAME="PyBabelProject.__projectLanguageAdded" ID="PyBabelProject.__projectLanguageAdded"></a> +<h4>PyBabelProject.__projectLanguageAdded</h4> +<b>__projectLanguageAdded</b>(<i>code</i>) + +<p> + Private slot handling the addition of a new language. +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +language code of the new language +</dd> +</dl> +<a NAME="PyBabelProject.compileCatalogs" ID="PyBabelProject.compileCatalogs"></a> +<h4>PyBabelProject.compileCatalogs</h4> +<b>compileCatalogs</b>(<i>filenames</i>) + +<p> + Public method to compile the message catalogs. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of filenames (not used) +</dd> +</dl> +<a NAME="PyBabelProject.compileSelectedCatalogs" ID="PyBabelProject.compileSelectedCatalogs"></a> +<h4>PyBabelProject.compileSelectedCatalogs</h4> +<b>compileSelectedCatalogs</b>(<i>filenames</i>) + +<p> + Public method to update the message catalogs. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of file names +</dd> +</dl> +<a NAME="PyBabelProject.configurePyBabel" ID="PyBabelProject.configurePyBabel"></a> +<h4>PyBabelProject.configurePyBabel</h4> +<b>configurePyBabel</b>(<i></i>) + +<p> + Public slot to show a dialog to edit the pybabel configuration. +</p> +<a NAME="PyBabelProject.determineCapability" ID="PyBabelProject.determineCapability"></a> +<h4>PyBabelProject.determineCapability</h4> +<b>determineCapability</b>(<i></i>) + +<p> + Public method to determine the availability of flask-babel. +</p> +<a NAME="PyBabelProject.extractMessages" ID="PyBabelProject.extractMessages"></a> +<h4>PyBabelProject.extractMessages</h4> +<b>extractMessages</b>(<i></i>) + +<p> + Public method to extract the messages catalog template file. +</p> +<a NAME="PyBabelProject.flaskBabelAvailable" ID="PyBabelProject.flaskBabelAvailable"></a> +<h4>PyBabelProject.flaskBabelAvailable</h4> +<b>flaskBabelAvailable</b>(<i></i>) + +<p> + Public method to check, if the 'flask-babel' package is available. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the availability of 'flask-babel' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="PyBabelProject.getBabelCommand" ID="PyBabelProject.getBabelCommand"></a> +<h4>PyBabelProject.getBabelCommand</h4> +<b>getBabelCommand</b>(<i></i>) + +<p> + Public method to build the Babel command. +</p> +<dl> +<dt>Returns:</dt> +<dd> +full pybabel command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="PyBabelProject.openPOEditor" ID="PyBabelProject.openPOEditor"></a> +<h4>PyBabelProject.openPOEditor</h4> +<b>openPOEditor</b>(<i>poFile</i>) + +<p> + Public method to edit the given file in an external .po editor. +</p> +<dl> + +<dt><i>poFile</i> (str)</dt> +<dd> +name of the .po file +</dd> +</dl> +<a NAME="PyBabelProject.projectClosedHooks" ID="PyBabelProject.projectClosedHooks"></a> +<h4>PyBabelProject.projectClosedHooks</h4> +<b>projectClosedHooks</b>(<i></i>) + +<p> + Public method to remove our hook methods. +</p> +<a NAME="PyBabelProject.projectOpenedHooks" ID="PyBabelProject.projectOpenedHooks"></a> +<h4>PyBabelProject.projectOpenedHooks</h4> +<b>projectOpenedHooks</b>(<i></i>) + +<p> + Public method to add our hook methods. +</p> +<a NAME="PyBabelProject.registerOpenHook" ID="PyBabelProject.registerOpenHook"></a> +<h4>PyBabelProject.registerOpenHook</h4> +<b>registerOpenHook</b>(<i></i>) + +<p> + Public method to register the open hook to open a translations file + in a translations editor. +</p> +<a NAME="PyBabelProject.updateCatalogs" ID="PyBabelProject.updateCatalogs"></a> +<h4>PyBabelProject.updateCatalogs</h4> +<b>updateCatalogs</b>(<i>filenames, withObsolete=False</i>) + +<p> + Public method to update the message catalogs. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of filenames (not used) +</dd> +<dt><i>withObsolete</i> (bool)</dt> +<dd> +flag indicating to keep obsolete translations +</dd> +</dl> +<a NAME="PyBabelProject.updateCatalogsObsolete" ID="PyBabelProject.updateCatalogsObsolete"></a> +<h4>PyBabelProject.updateCatalogsObsolete</h4> +<b>updateCatalogsObsolete</b>(<i>filenames</i>) + +<p> + Public method to update the message catalogs keeping obsolete + translations. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of filenames (not used) +</dd> +</dl> +<a NAME="PyBabelProject.updateSelectedCatalogs" ID="PyBabelProject.updateSelectedCatalogs"></a> +<h4>PyBabelProject.updateSelectedCatalogs</h4> +<b>updateSelectedCatalogs</b>(<i>filenames, withObsolete=False</i>) + +<p> + Public method to update the selected message catalogs. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of filenames +</dd> +<dt><i>withObsolete</i> (bool)</dt> +<dd> +flag indicating to keep obsolete translations +</dd> +</dl> +<a NAME="PyBabelProject.updateSelectedCatalogsObsolete" ID="PyBabelProject.updateSelectedCatalogsObsolete"></a> +<h4>PyBabelProject.updateSelectedCatalogsObsolete</h4> +<b>updateSelectedCatalogsObsolete</b>(<i>filenames</i>) + +<p> + Public method to update the message catalogs keeping obsolete + translations. +</p> +<dl> + +<dt><i>filenames</i> (list of str)</dt> +<dd> +list of filenames (not used) +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,228 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskCommandDialog</h1> + +<p> +Module implementing a dialog to run a flask command and show its output. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#FlaskCommandDialog">FlaskCommandDialog</a></td> +<td>Class implementing a dialog to run a flask command and show its output.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="FlaskCommandDialog" ID="FlaskCommandDialog"></a> +<h2>FlaskCommandDialog</h2> + +<p> + Class implementing a dialog to run a flask command and show its output. +</p> +<h3>Derived from</h3> +QDialog, Ui_FlaskCommandDialog +<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="#FlaskCommandDialog.__init__">FlaskCommandDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.__cancelProcess">__cancelProcess</a></td> +<td>Private slot to terminate the current process.</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.__processFinished">__processFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.__readStdOut">__readStdOut</a></td> +<td>Private slot to add the server process output to the output pane.</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.closeEvent">closeEvent</a></td> +<td>Protected method handling the close event of the dialog.</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot handling presses of the button box buttons.</td> +</tr> +<tr> +<td><a href="#FlaskCommandDialog.startCommand">startCommand</a></td> +<td>Public method to start a flask command and show its output.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="FlaskCommandDialog.__init__" ID="FlaskCommandDialog.__init__"></a> +<h4>FlaskCommandDialog (Constructor)</h4> +<b>FlaskCommandDialog</b>(<i>project, title="", msgSuccess="", msgError="", parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>title</i> (str)</dt> +<dd> +window title of the dialog +</dd> +<dt><i>msgSuccess</i> (str)</dt> +<dd> +success message to be shown +</dd> +<dt><i>msgError</i> (str)</dt> +<dd> +message to be shown on error +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="FlaskCommandDialog.__cancelProcess" ID="FlaskCommandDialog.__cancelProcess"></a> +<h4>FlaskCommandDialog.__cancelProcess</h4> +<b>__cancelProcess</b>(<i></i>) + +<p> + Private slot to terminate the current process. +</p> +<a NAME="FlaskCommandDialog.__processFinished" ID="FlaskCommandDialog.__processFinished"></a> +<h4>FlaskCommandDialog.__processFinished</h4> +<b>__processFinished</b>(<i>exitCode, exitStatus</i>) + +<p> + Private slot connected to the finished signal. +</p> +<dl> + +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> +<dd> +exit status of the process +</dd> +</dl> +<a NAME="FlaskCommandDialog.__readStdOut" ID="FlaskCommandDialog.__readStdOut"></a> +<h4>FlaskCommandDialog.__readStdOut</h4> +<b>__readStdOut</b>(<i></i>) + +<p> + Private slot to add the server process output to the output pane. +</p> +<a NAME="FlaskCommandDialog.closeEvent" ID="FlaskCommandDialog.closeEvent"></a> +<h4>FlaskCommandDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method handling the close event of the dialog. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event object +</dd> +</dl> +<a NAME="FlaskCommandDialog.on_buttonBox_clicked" ID="FlaskCommandDialog.on_buttonBox_clicked"></a> +<h4>FlaskCommandDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot handling presses of the button box buttons. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the button been clicked +</dd> +</dl> +<a NAME="FlaskCommandDialog.startCommand" ID="FlaskCommandDialog.startCommand"></a> +<h4>FlaskCommandDialog.startCommand</h4> +<b>startCommand</b>(<i>command, args=None</i>) + +<p> + Public method to start a flask command and show its output. +</p> +<dl> + +<dt><i>command</i> (str)</dt> +<dd> +flask command to be run +</dd> +<dt><i>args</i> (list of str)</dt> +<dd> +list of command line arguments for the command +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful start +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FormSelectionDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,139 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FormSelectionDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.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>{% extends "base.html" %}\n</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> +{% extends "base.html" %}\n +</p> +<h3>Derived from</h3> +QDialog, Ui_FormSelectionDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>Templates</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> (QWidget)</dt> +<dd> +reference to the parent widget +</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 +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</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> (int)</dt> +<dd> +selected index +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.Project.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,700 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.Project</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.Project</h1> + +<p> +Module implementing the Flask 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 Flask project support.</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 Flask 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.__configureFlaskForProject">__configureFlaskForProject</a></td> +<td>Private slot to configure the project specific flask parameters.</td> +</tr> +<tr> +<td><a href="#Project.__determineCapabilities">__determineCapabilities</a></td> +<td>Private method to determine capabilities provided by supported extensions.</td> +</tr> +<tr> +<td><a href="#Project.__flaskInfo">__flaskInfo</a></td> +<td>Private slot to show some info about Flask.</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.__initDatabase">__initDatabase</a></td> +<td>Private slot showing the result of the database creation.</td> +</tr> +<tr> +<td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td> +<td>Private method to test, if a detected command file is suitable for the given Python variant.</td> +</tr> +<tr> +<td><a href="#Project.__runDevelopmentServer">__runDevelopmentServer</a></td> +<td>Private slot to start the Flask Web server in development mode.</td> +</tr> +<tr> +<td><a href="#Project.__runPythonShell">__runPythonShell</a></td> +<td>Private slot to start a Python console in the app context.</td> +</tr> +<tr> +<td><a href="#Project.__runServer">__runServer</a></td> +<td>Private slot to start the Flask Web server.</td> +</tr> +<tr> +<td><a href="#Project.__shellProcessFinished">__shellProcessFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr> +<tr> +<td><a href="#Project.__showDocumentation">__showDocumentation</a></td> +<td>Private slot to show the helpviewer with the Flask documentation.</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.__terminatePythonShell">__terminatePythonShell</a></td> +<td>Private method to terminate the current Python console.</td> +</tr> +<tr> +<td><a href="#Project.getApplication">getApplication</a></td> +<td>Public method to determine the application name and the respective working directory.</td> +</tr> +<tr> +<td><a href="#Project.getData">getData</a></td> +<td>Public method to get data stored in the project store.</td> +</tr> +<tr> +<td><a href="#Project.getFlaskCommand">getFlaskCommand</a></td> +<td>Public method to build the Flask command.</td> +</tr> +<tr> +<td><a href="#Project.getFlaskVersionStrings">getFlaskVersionStrings</a></td> +<td>Public method to get the Flask, Werkzeug and Python versions as a string.</td> +</tr> +<tr> +<td><a href="#Project.getFullCommand">getFullCommand</a></td> +<td>Public method to get the full command for a given command name.</td> +</tr> +<tr> +<td><a href="#Project.getMenu">getMenu</a></td> +<td>Public method to get a reference to the requested menu.</td> +</tr> +<tr> +<td><a href="#Project.getMenuNames">getMenuNames</a></td> +<td>Public method to get the names of all menus.</td> +</tr> +<tr> +<td><a href="#Project.hasCapability">hasCapability</a></td> +<td>Public method to check, if a capability is available.</td> +</tr> +<tr> +<td><a href="#Project.initActions">initActions</a></td> +<td>Public method to define the Flask actions.</td> +</tr> +<tr> +<td><a href="#Project.initMenu">initMenu</a></td> +<td>Public method to initialize the Flask menu.</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.prepareRuntimeEnvironment">prepareRuntimeEnvironment</a></td> +<td>Public method to prepare a QProcessEnvironment object and determine the appropriate working directory.</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.setCapability">setCapability</a></td> +<td>Public method to set the availability status of a capability.</td> +</tr> +<tr> +<td><a href="#Project.setData">setData</a></td> +<td>Public method to store data in the project store.</td> +</tr> +<tr> +<td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td> +<td>Public method to get the supported Python variants.</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, iconSuffix, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i> (ProjectFlaskPlugin)</dt> +<dd> +reference to the plugin object +</dd> +<dt><i>iconSuffix</i> (str)</dt> +<dd> +suffix for the icons +</dd> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent +</dd> +</dl> +<a NAME="Project.__configureFlaskForProject" ID="Project.__configureFlaskForProject"></a> +<h4>Project.__configureFlaskForProject</h4> +<b>__configureFlaskForProject</b>(<i></i>) + +<p> + Private slot to configure the project specific flask parameters. +</p> +<a NAME="Project.__determineCapabilities" ID="Project.__determineCapabilities"></a> +<h4>Project.__determineCapabilities</h4> +<b>__determineCapabilities</b>(<i></i>) + +<p> + Private method to determine capabilities provided by supported + extensions. +</p> +<a NAME="Project.__flaskInfo" ID="Project.__flaskInfo"></a> +<h4>Project.__flaskInfo</h4> +<b>__flaskInfo</b>(<i></i>) + +<p> + Private slot to show some info about Flask. +</p> +<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 +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="Project.__initDatabase" ID="Project.__initDatabase"></a> +<h4>Project.__initDatabase</h4> +<b>__initDatabase</b>(<i></i>) + +<p> + Private slot showing the result of the database creation. +</p> +<a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a> +<h4>Project.__isSuitableForVariant</h4> +<b>__isSuitableForVariant</b>(<i>variant, line0</i>) + +<p> + Private method to test, if a detected command file is suitable for the + given Python variant. +</p> +<dl> + +<dt><i>variant</i> (str)</dt> +<dd> +Python variant to test for +</dd> +<dt><i>line0</i> (str)</dt> +<dd> +first line of the executable +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a suitable file was found +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="Project.__runDevelopmentServer" ID="Project.__runDevelopmentServer"></a> +<h4>Project.__runDevelopmentServer</h4> +<b>__runDevelopmentServer</b>(<i></i>) + +<p> + Private slot to start the Flask Web server in development mode. +</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 in the app context. +</p> +<a NAME="Project.__runServer" ID="Project.__runServer"></a> +<h4>Project.__runServer</h4> +<b>__runServer</b>(<i>development=False</i>) + +<p> + Private slot to start the Flask Web server. +</p> +<dl> + +<dt><i>development</i> (bool)</dt> +<dd> +flag indicating development mode +</dd> +</dl> +<a NAME="Project.__shellProcessFinished" ID="Project.__shellProcessFinished"></a> +<h4>Project.__shellProcessFinished</h4> +<b>__shellProcessFinished</b>(<i></i>) + +<p> + Private slot connected to the finished signal. +</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 Flask documentation. +</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.__terminatePythonShell" ID="Project.__terminatePythonShell"></a> +<h4>Project.__terminatePythonShell</h4> +<b>__terminatePythonShell</b>(<i></i>) + +<p> + Private method to terminate the current Python console. +</p> +<a NAME="Project.getApplication" ID="Project.getApplication"></a> +<h4>Project.getApplication</h4> +<b>getApplication</b>(<i></i>) + +<p> + Public method to determine the application name and the respective + working directory. +</p> +<dl> +<dt>Returns:</dt> +<dd> +tuple containing the working directory and the application name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) +</dd> +</dl> +<a NAME="Project.getData" ID="Project.getData"></a> +<h4>Project.getData</h4> +<b>getData</b>(<i>category, key</i>) + +<p> + Public method to get data stored in the project store. +</p> +<dl> + +<dt><i>category</i> (str)</dt> +<dd> +data category +</dd> +<dt><i>key</i> (str)</dt> +<dd> +data key +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +referenced data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<a NAME="Project.getFlaskCommand" ID="Project.getFlaskCommand"></a> +<h4>Project.getFlaskCommand</h4> +<b>getFlaskCommand</b>(<i></i>) + +<p> + Public method to build the Flask command. +</p> +<dl> +<dt>Returns:</dt> +<dd> +full flask command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="Project.getFlaskVersionStrings" ID="Project.getFlaskVersionStrings"></a> +<h4>Project.getFlaskVersionStrings</h4> +<b>getFlaskVersionStrings</b>(<i></i>) + +<p> + Public method to get the Flask, Werkzeug and Python versions as a + string. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the Flask, Werkzeug and Python versions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="Project.getFullCommand" ID="Project.getFullCommand"></a> +<h4>Project.getFullCommand</h4> +<b>getFullCommand</b>(<i>command</i>) + +<p> + Public method to get the full command for a given command name. +</p> +<dl> + +<dt><i>command</i> (str)</dt> +<dd> +command name +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +full command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="Project.getMenu" ID="Project.getMenu"></a> +<h4>Project.getMenu</h4> +<b>getMenu</b>(<i>name</i>) + +<p> + Public method to get a reference to the requested menu. +</p> +<dl> + +<dt><i>name</i> (str)</dt> +<dd> +name of the menu +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +reference to the menu or None, if no menu with the given + name exists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu or None +</dd> +</dl> +<a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a> +<h4>Project.getMenuNames</h4> +<b>getMenuNames</b>(<i></i>) + +<p> + Public method to get the names of all menus. +</p> +<dl> +<dt>Returns:</dt> +<dd> +menu names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="Project.hasCapability" ID="Project.hasCapability"></a> +<h4>Project.hasCapability</h4> +<b>hasCapability</b>(<i>key</i>) + +<p> + Public method to check, if a capability is available. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +key of the capability to check +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the availability of the capability +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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 Flask actions. +</p> +<a NAME="Project.initMenu" ID="Project.initMenu"></a> +<h4>Project.initMenu</h4> +<b>initMenu</b>(<i></i>) + +<p> + Public method to initialize the Flask menu. +</p> +<dl> +<dt>Returns:</dt> +<dd> +the menu generated +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> +<a NAME="Project.newForm" ID="Project.newForm"></a> +<h4>Project.newForm</h4> +<b>newForm</b>(<i>dirPath</i>) + +<p> + Public method to create a new form. +</p> +<dl> + +<dt><i>dirPath</i> (str)</dt> +<dd> +full directory path for the new form file +</dd> +</dl> +<a NAME="Project.prepareRuntimeEnvironment" ID="Project.prepareRuntimeEnvironment"></a> +<h4>Project.prepareRuntimeEnvironment</h4> +<b>prepareRuntimeEnvironment</b>(<i>development=False</i>) + +<p> + Public method to prepare a QProcessEnvironment object and determine + the appropriate working directory. +</p> +<dl> + +<dt><i>development</i> (bool)</dt> +<dd> +flag indicating development mode +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +tuple containing the working directory and a prepared + environment object to be used with QProcess +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, QProcessEnvironment) +</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.setCapability" ID="Project.setCapability"></a> +<h4>Project.setCapability</h4> +<b>setCapability</b>(<i>key, available</i>) + +<p> + Public method to set the availability status of a capability. +</p> +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +key of the capability to set +</dd> +<dt><i>available</i> (bool)</dt> +<dd> +flag indicating the availability of the capability +</dd> +</dl> +<a NAME="Project.setData" ID="Project.setData"></a> +<h4>Project.setData</h4> +<b>setData</b>(<i>category, key, value</i>) + +<p> + Public method to store data in the project store. +</p> +<dl> + +<dt><i>category</i> (str)</dt> +<dd> +data category +</dd> +<dt><i>key</i> (str)</dt> +<dd> +data key +</dd> +<dt><i>value</i> (any (serializable type))</dt> +<dd> +data to be stored +</dd> +</dl> +<a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a> +<h4>Project.supportedPythonVariants</h4> +<b>supportedPythonVariants</b>(<i></i>) + +<p> + Public method to get the supported Python variants. +</p> +<dl> +<dt>Returns:</dt> +<dd> +list of supported Python variants +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,234 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.RoutesDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.RoutesDialog</h1> + +<p> +Module implementing a dialog to show the application routes. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#RoutesDialog">RoutesDialog</a></td> +<td>Class implementing a dialog to show the application routes.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="RoutesDialog" ID="RoutesDialog"></a> +<h2>RoutesDialog</h2> + +<p> + Class implementing a dialog to show the application routes. +</p> +<h3>Derived from</h3> +QDialog, Ui_RoutesDialog +<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="#RoutesDialog.__init__">RoutesDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#RoutesDialog.__processOutput">__processOutput</a></td> +<td>Private method to process the flask output and populate the routes list.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.on_allMethodsCheckBox_toggled">on_allMethodsCheckBox_toggled</a></td> +<td>Private slot handling the selection to show all methods.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.on_endpointButton_toggled">on_endpointButton_toggled</a></td> +<td>Private slot handling the selection of the 'endpoint' sort order.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.on_matchButton_toggled">on_matchButton_toggled</a></td> +<td>Private slot handling the selection of the 'match' sort order.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.on_methodsButton_toggled">on_methodsButton_toggled</a></td> +<td>Private slot handling the selection of the 'methods' sort order.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.on_ruleButton_toggled">on_ruleButton_toggled</a></td> +<td>Private slot handling the selection of the 'rule' sort order.</td> +</tr> +<tr> +<td><a href="#RoutesDialog.showRoutes">showRoutes</a></td> +<td>Public method to show the list of routes.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="RoutesDialog.__init__" ID="RoutesDialog.__init__"></a> +<h4>RoutesDialog (Constructor)</h4> +<b>RoutesDialog</b>(<i>project, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="RoutesDialog.__processOutput" ID="RoutesDialog.__processOutput"></a> +<h4>RoutesDialog.__processOutput</h4> +<b>__processOutput</b>(<i>output</i>) + +<p> + Private method to process the flask output and populate the routes + list. +</p> +<dl> + +<dt><i>output</i> (str)</dt> +<dd> +output of the flask process +</dd> +</dl> +<a NAME="RoutesDialog.on_allMethodsCheckBox_toggled" ID="RoutesDialog.on_allMethodsCheckBox_toggled"></a> +<h4>RoutesDialog.on_allMethodsCheckBox_toggled</h4> +<b>on_allMethodsCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection to show all methods. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="RoutesDialog.on_endpointButton_toggled" ID="RoutesDialog.on_endpointButton_toggled"></a> +<h4>RoutesDialog.on_endpointButton_toggled</h4> +<b>on_endpointButton_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection of the 'endpoint' sort order. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="RoutesDialog.on_matchButton_toggled" ID="RoutesDialog.on_matchButton_toggled"></a> +<h4>RoutesDialog.on_matchButton_toggled</h4> +<b>on_matchButton_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection of the 'match' sort order. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="RoutesDialog.on_methodsButton_toggled" ID="RoutesDialog.on_methodsButton_toggled"></a> +<h4>RoutesDialog.on_methodsButton_toggled</h4> +<b>on_methodsButton_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection of the 'methods' sort order. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="RoutesDialog.on_ruleButton_toggled" ID="RoutesDialog.on_ruleButton_toggled"></a> +<h4>RoutesDialog.on_ruleButton_toggled</h4> +<b>on_ruleButton_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection of the 'rule' sort order. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="RoutesDialog.showRoutes" ID="RoutesDialog.showRoutes"></a> +<h4>RoutesDialog.showRoutes</h4> +<b>showRoutes</b>(<i></i>) + +<p> + Public method to show the list of routes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RunServerDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,258 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.RunServerDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.RunServerDialog</h1> + +<p> +Module implementing a dialog to run the Flask server. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#RunServerDialog">RunServerDialog</a></td> +<td>Class implementing a dialog to run the Flask server.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="RunServerDialog" ID="RunServerDialog"></a> +<h2>RunServerDialog</h2> + +<p> + Class implementing a dialog to run the Flask server. +</p> +<h3>Derived from</h3> +QDialog, Ui_RunServerDialog +<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="#RunServerDialog.__init__">RunServerDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__initActionsMenu">__initActionsMenu</a></td> +<td>Private method to populate the actions button menu.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__processFinished">__processFinished</a></td> +<td>Private slot handling the finishing of the server process.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__readStdOut">__readStdOut</a></td> +<td>Private slot to add the server process output to the output pane.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServer">__restartServer</a></td> +<td>Private slot to restart the server process.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServerDifferentMode">__restartServerDifferentMode</a></td> +<td>Private slot to restart the server process with the opposite mode.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServerWithOptions">__restartServerWithOptions</a></td> +<td>Private slot to restart the server asking for start options.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__showActionsMenu">__showActionsMenu</a></td> +<td>Private slot handling the actions menu about to be shown.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.closeEvent">closeEvent</a></td> +<td>Protected method handling a close event.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.on_startBrowserButton_clicked">on_startBrowserButton_clicked</a></td> +<td>Private slot to start a web browser with the server URL.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.on_stopServerButton_clicked">on_stopServerButton_clicked</a></td> +<td>Private slot to stop the running server.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.startServer">startServer</a></td> +<td>Public method to start the Flask server process.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="RunServerDialog.__init__" ID="RunServerDialog.__init__"></a> +<h4>RunServerDialog (Constructor)</h4> +<b>RunServerDialog</b>(<i>plugin, project, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i> (PluginProjectFlask)</dt> +<dd> +reference to the plug-in object +</dd> +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="RunServerDialog.__initActionsMenu" ID="RunServerDialog.__initActionsMenu"></a> +<h4>RunServerDialog.__initActionsMenu</h4> +<b>__initActionsMenu</b>(<i></i>) + +<p> + Private method to populate the actions button menu. +</p> +<a NAME="RunServerDialog.__processFinished" ID="RunServerDialog.__processFinished"></a> +<h4>RunServerDialog.__processFinished</h4> +<b>__processFinished</b>(<i></i>) + +<p> + Private slot handling the finishing of the server process. +</p> +<a NAME="RunServerDialog.__readStdOut" ID="RunServerDialog.__readStdOut"></a> +<h4>RunServerDialog.__readStdOut</h4> +<b>__readStdOut</b>(<i></i>) + +<p> + Private slot to add the server process output to the output pane. +</p> +<a NAME="RunServerDialog.__restartServer" ID="RunServerDialog.__restartServer"></a> +<h4>RunServerDialog.__restartServer</h4> +<b>__restartServer</b>(<i></i>) + +<p> + Private slot to restart the server process. +</p> +<a NAME="RunServerDialog.__restartServerDifferentMode" ID="RunServerDialog.__restartServerDifferentMode"></a> +<h4>RunServerDialog.__restartServerDifferentMode</h4> +<b>__restartServerDifferentMode</b>(<i></i>) + +<p> + Private slot to restart the server process with the opposite mode. +</p> +<a NAME="RunServerDialog.__restartServerWithOptions" ID="RunServerDialog.__restartServerWithOptions"></a> +<h4>RunServerDialog.__restartServerWithOptions</h4> +<b>__restartServerWithOptions</b>(<i></i>) + +<p> + Private slot to restart the server asking for start options. +</p> +<a NAME="RunServerDialog.__showActionsMenu" ID="RunServerDialog.__showActionsMenu"></a> +<h4>RunServerDialog.__showActionsMenu</h4> +<b>__showActionsMenu</b>(<i></i>) + +<p> + Private slot handling the actions menu about to be shown. +</p> +<a NAME="RunServerDialog.closeEvent" ID="RunServerDialog.closeEvent"></a> +<h4>RunServerDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method handling a close event. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="RunServerDialog.on_startBrowserButton_clicked" ID="RunServerDialog.on_startBrowserButton_clicked"></a> +<h4>RunServerDialog.on_startBrowserButton_clicked</h4> +<b>on_startBrowserButton_clicked</b>(<i></i>) + +<p> + Private slot to start a web browser with the server URL. +</p> +<a NAME="RunServerDialog.on_stopServerButton_clicked" ID="RunServerDialog.on_stopServerButton_clicked"></a> +<h4>RunServerDialog.on_stopServerButton_clicked</h4> +<b>on_stopServerButton_clicked</b>(<i></i>) + +<p> + Private slot to stop the running server. +</p> +<a NAME="RunServerDialog.startServer" ID="RunServerDialog.startServer"></a> +<h4>RunServerDialog.startServer</h4> +<b>startServer</b>(<i>development=False, askForOptions=False</i>) + +<p> + Public method to start the Flask server process. +</p> +<dl> + +<dt><i>development</i> (bool)</dt> +<dd> +flag indicating development mode +</dd> +<dt><i>askForOptions</i> (bool)</dt> +<dd> +flag indicating to ask for server start options + first +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.ServerStartOptionsDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.ServerStartOptionsDialog</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.ServerStartOptionsDialog</h1> + +<p> +Module implementing a dialog to enter parameters to start the server. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ServerStartOptionsDialog">ServerStartOptionsDialog</a></td> +<td>Class implementing a dialog to enter parameters to start the server.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ServerStartOptionsDialog" ID="ServerStartOptionsDialog"></a> +<h2>ServerStartOptionsDialog</h2> + +<p> + Class implementing a dialog to enter parameters to start the server. +</p> +<h3>Derived from</h3> +QDialog, Ui_ServerStartOptionsDialog +<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="#ServerStartOptionsDialog.__init__">ServerStartOptionsDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ServerStartOptionsDialog.getDataDict">getDataDict</a></td> +<td>Public method to get a dictionary containing the entered data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ServerStartOptionsDialog.__init__" ID="ServerStartOptionsDialog.__init__"></a> +<h4>ServerStartOptionsDialog (Constructor)</h4> +<b>ServerStartOptionsDialog</b>(<i>options, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>options</i> (dict)</dt> +<dd> +dictionary containing the current server start options +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="ServerStartOptionsDialog.getDataDict" ID="ServerStartOptionsDialog.getDataDict"></a> +<h4>ServerStartOptionsDialog.getDataDict</h4> +<b>getDataDict</b>(<i></i>) + +<p> + Public method to get a dictionary containing the entered data. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the entered data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</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/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.ConfigurationPage.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.ConfigurationPage</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.ConfigurationPage</h1> + +<p> +Package implementing the Flask page of the configuration dialog. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.ConfigurationPage.FlaskPage.html">FlaskPage</a></td> +<td>Module implementing the Flask configuration page.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask.FlaskBabelExtension</h1> + +<p> +Package containing support for the flask-babel extension. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.FlaskBabelDetector.html">FlaskBabelDetector</a></td> +<td>Module to check for the presence of 'flask-babel' by importing it.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog.html">PyBabelCommandDialog</a></td> +<td>Module implementing a dialog to run a flask command and show its output.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelConfigDialog.html">PyBabelConfigDialog</a></td> +<td>Module implementing a dialog to edit the PyBabel configuration.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelProjectExtension.html">PyBabelProjectExtension</a></td> +<td>Module implementing the project support for flask-babel.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.ProjectFlask.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,73 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask</title> +<meta charset="UTF-8"> +<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_Flask.ProjectFlask</h1> + +<p> +Package implementing project support for eric6 Flask projects. +</p> + +<h3>Packages</h3> +<table> + +<tr> +<td><a href="index-Plugin_Project_Flask.ProjectFlask.ConfigurationPage.html">ConfigurationPage</a></td> +<td>Package implementing the Flask page of the configuration dialog.</td> +</tr> +<tr> +<td><a href="index-Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.html">FlaskBabelExtension</a></td> +<td>Package containing support for the flask-babel extension.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.AnsiTools.html">AnsiTools</a></td> +<td>Module implementing functions to work with ANSI escape sequences for colors.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog.html">FlaskCommandDialog</a></td> +<td>Module implementing a dialog to run a flask command and show its output.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.FormSelectionDialog.html">FormSelectionDialog</a></td> +<td>Module implementing a dialog to select the template type.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.Project.html">Project</a></td> +<td>Module implementing the Flask project support.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.RoutesDialog.html">RoutesDialog</a></td> +<td>Module implementing a dialog to show the application routes.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.RunServerDialog.html">RunServerDialog</a></td> +<td>Module implementing a dialog to run the Flask server.</td> +</tr> +<tr> +<td><a href="Plugin_Project_Flask.ProjectFlask.ServerStartOptionsDialog.html">ServerStartOptionsDialog</a></td> +<td>Module implementing a dialog to enter parameters to start the server.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/index-Plugin_Project_Flask.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask</title> +<meta charset="UTF-8"> +<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_Flask</h1> + +<p> +Package implementing the Flask project plugin. +</p> + +<h3>Packages</h3> +<table> + +<tr> +<td><a href="index-Plugin_Project_Flask.ProjectFlask.html">ProjectFlask</a></td> +<td>Package implementing project support for eric6 Flask projects.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_Project_Flask.PluginProjectFlask.html">PluginProjectFlask</a></td> +<td>Module implementing the Flask project plugin.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/index.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,34 @@ +<!DOCTYPE html> +<html><head> +<title>Table of contents</title> +<meta charset="UTF-8"> +<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_Flask.html">Plugin_Project_Flask</a></td> +<td>Package implementing the Flask project plugin.</td> +</tr> +</table> + +</body></html> \ No newline at end of file