1
1
Fork 0
mirror of https://github.com/FellippeHeitor/InForm.git synced 2024-05-12 06:50:12 +00:00
InForm/README.md

111 lines
4.4 KiB
Markdown
Raw Permalink Normal View History

2023-06-04 16:35:45 +00:00
# INFORM-PE
2022-10-12 19:54:37 +00:00
2018-03-23 15:43:26 +00:00
![InForm logo](InForm/resources/Application-icon-128.png)
2023-06-24 02:50:13 +00:00
[InForm-PE](https://github.com/a740g/InForm-PE) is a GUI engine and WYSIWYG interface designer for [QB64-PE](https://github.com/QB64-Phoenix-Edition/QB64pe). It is a fork of [InForm](https://github.com/FellippeHeitor/InForm), authored by [Fellippe Heitor](https://github.com/FellippeHeitor).
2023-06-24 02:47:41 +00:00
InForm-PE's main goal is to generate *event-driven* QB64-PE applications. This means that you design a graphical user interface with interactive controls and then write the code to respond to such controls once they are manipulated.
2016-12-18 15:37:50 +00:00
2023-05-09 02:20:08 +00:00
Wiki: <https://github.com/a740g/InForm-PE/wiki>
2018-03-23 15:47:41 +00:00
2023-06-04 16:35:45 +00:00
## FEATURES
2022-10-12 19:54:37 +00:00
2023-06-04 16:35:45 +00:00
- WYSIWYG interface designer
- Event-driven application design
- Works on Windows, Linux & macOS
- Everything is statically linked (no shared library dependencies)
2016-12-18 15:37:50 +00:00
2023-06-04 16:35:45 +00:00
## USAGE
2022-10-12 19:54:37 +00:00
Install InForm-PE and QB64-PE side-by-side in their own directories. There is no need to copy InForm-PE files to the QB64-PE directory.
> The following directory setup is recommended
2023-05-08 23:26:33 +00:00
```text
<some-drive-or-directory>
|
2023-06-29 19:49:08 +00:00
|-------<InForm-PE>
2023-05-09 02:34:28 +00:00
| |
2023-06-04 16:35:45 +00:00
| |-------<UiEditor[.exe]>
2023-05-08 23:26:33 +00:00
|
|-------<QB64pe>
2023-05-09 02:34:28 +00:00
|
2023-06-04 16:35:45 +00:00
|-------<qb64pe[.exe]>
2023-05-08 23:26:33 +00:00
```
2023-06-04 16:35:45 +00:00
Assuming your setup is like the above, do the following:
- Open Terminal and change to the InForm-PE directory using an appropriate OS command
- Run `setup_inform_lnx.sh`, `setup_inform_osx.command` or `setup_inform_win.cmd` depending on the OS you are on. This will run make with the correct parameters. If the build fails, ensure QB64-PE is installed in the **QB64pe** directory (next to the InForm-PE directory). If QB64-PE is installed elsewhere, then edit the setup scripts to change the location
- Once InForm-PE is compiled, you will find the UiEditor[.exe] executable in the InForm-PE directory
2023-06-04 16:35:45 +00:00
- Run UiEditor[.exe] to start designing your forms
- After your form looks the way you want it to, click **File > Save** to export its contents and generate a **.bas** source file. Two files are exported:
- **.frm** - the generated form in QB64-PE code. This can be loaded back into InForm-PE's designer or manually edited in QB64-PE or any text editor later, if you want to adjust fine details
- **.bas** - the actual program you will add your code to
***You add code to respond to events.***
- *Click*
- *MouseEnter/MouseLeave* (hover)
- *FocusIn/FocusOut*
- *MouseDown/MouseUp* (events preceding a Click)
- *KeyPress*
- *TextChanged* (for text box controls)
- *ValueChanged* (for track bars, lists and dropdown lists)
***There are also events that occur in specific moments, to which you can respond/add code.***
- *BeforeInit*, triggered just before the form is shown.
- *OnLoad*, triggered right after the form is first shown.
- *BeforeUpdateDisplay*, triggered every time the form is about to be repainted.
2023-06-04 16:35:45 +00:00
- *BeforeUnload*, triggered when the user tries to close the program, either via clicking the window's X button, right click in the task bar -> Close or with Alt+F4 (Windows only).
- *FormResized*, triggered when a form with the CanResize property is resized at runtime.
***IMPORTANT: The following files must be copied to your project directory for it to compile.***
```text
InForm/InForm.bi
InForm/InForm.ui
InForm/InFormCommon.bi
InForm/InFormVersion.bi
InForm/xp.uitheme
InForm/extensions/*.*
```
2023-06-15 21:58:12 +00:00
## EXAMPLES
| Name | Author |
|------|-------------|
2023-06-29 19:49:08 +00:00
| Bin2Include | Zachary Spriggs |
| Calculator | Terry Ritchie |
| ClickTheVoid | Fellippe Heitor |
| ClockPatience | Richard Notley |
| DuckShoot | Richard Notley |
| ebacCalculator | George McGinn |
| Fahrenheit-Celsius | Richard Notley |
| Fireworks2 | Fellippe Heitor |
| GIFPlaySample | Fellippe Heitor |
| GravitationSimulation | Richard Notley |
| InFormPaint | Fellippe Heitor |
| InsideOutsideTriangle | Richard Notley |
| Lander1 | B+ |
| Lander2 | B+ |
| Mahjong | Richard Notley |
| MasterMindGuessTheSequence | TempodiBasic |
| Pelmanism | Richard Notley |
| PictureGrid | Richard Notley |
| PlayFX | Samuel Gomes |
| RockPaperScissorsSpockLizard | TempodiBasic |
| Stopwatch | Fellippe Heitor |
| TextFetch | B+ |
| ThemePreview | Fellippe Heitor |
| TicTacToe | Fellippe Heitor |
| TicTacToe2 | Fellippe Heitor |
| Trackword | Richard Notley |
| WordClock | Fellippe Heitor |
| wordSearch | George McGinn |
2023-06-15 21:58:12 +00:00
2023-06-04 16:35:45 +00:00
## NOTES
- This requires the latest version of [QB64-PE](https://github.com/QB64-Phoenix-Edition/QB64pe/releases/latest). QB64, or other forks of QB64 will not work!