wiki.visual-prolog.com - User contributions [en]

A Beginners Guide to Visual Prolog

2019-09-06T08:59:45Z

GalinaTchekmareva: /* Examples */

__NOTOC__

{{ambox|text= This book is about an '''old''' version of Visual Prolog, but it may still be useful.}}

''A Beginners' Guide to Visual Prolog'' is a comprehensive book for absolute beginners written by ''Thomas W. de Boer''.

The book contains already published material, which is used with permision of the authors.

The latest version of the book is devoted to Visual Prolog 7.2, but the principles are still more or less the same.

This book is an introduction. It is meant it is for people, who know little about programming. You should know the basics about computers and that it is possible to program them and that for a program you use a programming language.

What when you know more? Then you should look for other sources.

* When you are programmer and know about other languages like Visual Basic or C##, read the book [[Visual Prolog for Tyros]] by Eduardo Costa.

* When you know about other languages and are curious about Prolog, read the basic the [[:Category:Tutorials|Tutorials]].

* When you have experience in Prolog programming, look for details about Visual Prolog, object orientation in the [[:Category:Tutorials|Tutorials]] section of this site and Visual Prolog [[Language Reference]].

=== Contents ===

# The Integrated Development Environment
# Forms
# Simple user interfacing
# A closer look at the IDE
# Fundamental Prolog
# Data modeling in Prolog
# Using Forms or Dialogs and Controls: a minimal database
# Object oriented programming - classes and objects
# Declarations in Visual Prolog
# Recursion, lists and sorting
# Reading, writing, streams and files
# More data structures: Stacks, Queues and Trees

'''Appendices'''

# Everything about Dialogs and Forms
# List manipulating predicates

=== Download ===
* [https://www.visual-prolog.com/download/72/books/deBoer/VisualPrologBeginners.pdf A Beginners' Guide to Visual Prolog 7.2] (PDF format, English 279 pages).

==== Examples ====
* [https://www.visual-prolog.com/download/92/books/deBoer/deBoer-BeginnersGuide-examples.zip Examples from A Beginners' Guide to Visual Prolog 9.2] (ZIP format, 270 KB).
* [https://www.visual-prolog.com/download/73/books/deBoer/deBoer-BeginnersGuide-examples.zip Examples from A Beginners' Guide to Visual Prolog 7.3] (ZIP format, 440 KB).
* [https://www.visual-prolog.com/download/72/books/deBoer/deBoer-BeginnersGuide-examples.zip Examples from A Beginners' Guide to Visual Prolog 7.2] (ZIP format, 437 KB).

=== See also ===
[[A Beginners Guide to Visual Prolog in Chinese]]

[[Category:Books]]

Ide/Key Bindings

2013-12-12T06:37:56Z

GalinaTchekmareva:

{{ideNavbar|Key Bindings}}

A number of Visual Prolog menu entries have accelerator keys (hot keys) associated with them.

Beginning with Visual Prolog 7.0 some key binding have been changed to comply with Microsoft de facto standards.
The table below shows Visual Prolog 7.2 accelerator keys by functions.

:{| {{prettytable}}
|- class="header2"
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Function
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Key
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Edit
|-
| Copy
| Ctrl-C or Ctrl-Ins
|-
| Copy Position
| Ctrl-Alt-Shift-C
|-
| Cut
| Ctrl-X or Shift-Del
|-
| Paste
| Ctrl-V or Shift-Ins
|-
| Undo
| Ctrl-Z
|-
| Redo
| Ctrl-Y or Ctrl-Shift-Z
|-
| Select All
| Ctrl-A
|-
| Select Current Word
| Ctrl-W
|-
| Code Expert
| Ctrl-Shift-W
|-
| Delete
| Del
|-
| Delete Line
| Ctrl-Shift-L
|-
| Delete to End of Line
| Ctrl-Shift-E
|-
| Delete to Start of Line
| Ctrl-Shift-H
|-
| Word Delete To End
| Ctrl-Del
|-
| Insert Predicate
| Ctrl-Shift-I
|-
| Replace
| Ctrl-H
|-
| Lower Case
| Ctrl-U
|-
| Upper Case
| Ctrl-Shift-U
|-
| Toggle Case
| Ctrl-Alt-U
|-
| Zoom In
| Ctrl-[+] or Ctrl-Scroll mouse wheel up
|-
| Zoom Out
| Ctrl-[-] or Ctrl-Scroll mouse wheel down
|-
| Zoom to Normal
| Ctrl-0
|-
| Comment Line(s)
| Ctrl-Alt-5
|-
| Uncomment Line(s)
| Ctrl-Alt-Shift-5
|-
| Duplcate Line
| Ctrl-Alt-R
|-
| Insert Date Stamp
| Ctrl-Shift-Y
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Navigation
|-
| Find
| Ctrl-F
|-
| Find in Files
| Ctrl-Shift-F
|-
| Find Next
| F3
|-
| Find Previous
| Shift-F3
|-
| Last Searchs Result Window
| Ctrl-Alt-S
|-
| Locate in Project Tree
| Ctrl-T
|-
| Go Back
| Ctrl-Shift-F8
|-
| Go to Address
| Ctrl-G
|-
| Go to Definition
| F12
Ctrl-Shift-C
|-
| Go To Declaration
| Ctrl-F12
Ctrl-Shift-D
|-
| Go to Related Files
| Ctrl-R
|-
| Go to Executing Predicate Source
| Ctrl-E
|-
| Go To Line
| Ctrl-F2
|-
| Go To Position on Clipboard
| Shift-F2
|-
| Go To Next Error
| F8
|-
| Go To Previous Error
| Shift-F8
|-
| Go To Next Bookmark
| F6
|-
| Go To Previous Bookmark
| Shift-F6
|-
| Window Navigation Dialog
| Ctrl-Tab or Ctrl-F6
|-
| Set/Remove bookmark
| Ctrl-K
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Compile
|-
| Build
| Ctrl-Shift-B
|-
| Stop Build
| Ctrl-Break
|-
| Build Resource Only
| Alt-F8
|-
| Compile
| Ctrl-F7
|-
| Rebuild Project
| Ctrl-Shift-Alt-B
|-
| Run
| Ctrl-F5
|-
| Run in Window
| Alt-F5
|-
| 32 bit Platform
| Ctrl-Alt-3
|-
| 64 bit Platform
| Ctrl-Alt-6
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Debug
|-
| Start Debugging
| F5
|-
| Run Debugging Skipping Soft Breakpoints
| Ctrl-Shift-F10
|-
| Stop Debugging
| Shift-F5
|-
| Restart Debugging
| Ctrl-Shift-F5
|-
| Refresh Debug Window
| Ctrl-R
|-
| CallStack Window
| Ctrl-Alt-C
|-
| Variable Window
| Ctrl-Alt-V
|-
| Watch Window
| Ctrl-Alt-W
|-
| Facts Window
| Ctrl-Alt-F
|-
| Delete Object from Facts Tree
Retract Fact(s)
| Ctrl-Del
|-
| Threads Window
| Ctrl-Alt-H
|-
| Modules Window
| Ctrl-Alt-L
|-
| Exceptions Window
| Ctrl-Alt-X
|-
| Breakpoints Window
| Ctrl-Alt-B
|-
| Bookmarks Window
| Ctrl-Alt-K
|-
| Disassembly Window
| Ctrl-Alt-D
|-
| Disassembly Window from Current Line
| Ctrl-D
|-
| Registers window
| Ctrl-Alt-G
|-
| Memory Dump 1 Window
| Ctrl-Alt-M
|-
| Toggle Breakpoint
| F9
|-
| Toggle Hard/Soft Breakpoint
| Ctrl-F9
|-
| Breakpoint Properties
| Alt-F9
|-
| Breakpoint -> Bookmark
| Ctrl-Alt-F9
|-
| Bookmark -> Breakpoint
| Ctrl-Alt-F9
|-
| Step Into
| F11
|-
| Step out of
| Shift-F11
|-
| Step Over
| F10
|-
| Run To Cursor
| Ctrl-F10
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Project
|-
| New Project
| Ctrl-Shift-N
|-
| Open Project
| Ctrl-Shift-O
|-
| Add Module to Project
| Ctrl-Shift-A
|-
| Create Project Item
| Ctrl-N
|-
| Create Project Item in Existing Package
| Ctrl-Alt-N
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
IDE
|-
| Add qualification
| Ctrl-Shift-S
|-
| Close all other editors
| Ctrl-Q
|-
| Prune open editors
| Ctrl-Shift-Q
|-
| Close the active window
| Ctrl-F4
|-
| Project window
| Ctrl-Alt-P
|-
| Project Settings
| Alt-F7
|-
| Open File
| Ctrl-O
|-
| Save File
| F2
|-
| Save Project
| Ctrl-S
|-
| Source Browser
| Ctrl-B
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Other
|-
| Help
| F1
|-
| Messages Window
| Ctrl-Alt-O
|-
| Error/Warnings Window
| Ctrl-Alt-E
|-
| Print
| Ctrl-P
|-
| Exit IDE
| Alt-F4
|}

[[ru:IDE:Горячие Клавиши]]

Ide/Key Bindings

2013-12-11T09:35:38Z

GalinaTchekmareva:

{{ideNavbar|Key Bindings}}

A number of Visual Prolog menu entries have accelerator keys (hot keys) associated with them.

Beginning with Visual Prolog 7.0 some key binding have been changed to comply with Microsoft de facto standards.
The table below shows Visual Prolog 7.2 accelerator keys by functions.

:{| {{prettytable}}
|- class="header2"
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Function
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Key
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Edit
|-
| Copy
| Ctrl-C or Ctrl-Ins
|-
| Copy Position
| Ctrl-Alt-Shift-C
|-
| Cut
| Ctrl-X or Shift-Del
|-
| Paste
| Ctrl-V or Shift-Ins
|-
| Undo
| Ctrl-Z
|-
| Redo
| Ctrl-Y or Ctrl-Shift-Z
|-
| Select All
| Ctrl-A
|-
| Select Current Word
| Ctrl-W
|-
| Code Expert
| Ctrl-Shift-W
|-
| Delete
| Del
|-
| Delete Line
| Ctrl-Shift-L
|-
| Delete to End of Line
| Ctrl-Shift-E
|-
| Delete to Start of Line
| Ctrl-Shift-H
|-
| Word Delete To End
| Ctrl-Del
|-
| Insert Predicate
| Ctrl-Shift-I
|-
| Replace
| Ctrl-H
|-
| Lower Case
| Ctrl-U
|-
| Upper Case
| Ctrl-Shift-U
|-
| Toggle Case
| Ctrl-Alt-U
|-
| Zoom In
| Ctrl-[+] or Ctrl-Scroll mouse wheel up
|-
| Zoom Out
| Ctrl-[-] or Ctrl-Scroll mouse wheel down
|-
| Zoom to Normal
| Ctrl-0
|-
| Comment Line(s)
| Ctrl-Alt-5
|-
| Uncomment Line(s)
| Ctrl-Alt-Shift-5
|-
| Duplcate Line
| Ctrl-Alt-R
|-
| Insert Date Stamp
| Ctrl-Shift-Y
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Navigation
|-
| Find
| Ctrl-F
|-
| Find in Files
| Ctrl-Shift-F
|-
| Find Next
| F3
|-
| Find Previous
| Shift-F3
|-
| Last Searchs Result Window
| Ctrl-Alt-S
|-
| Locate in Project Tree
| Ctrl-T
|-
| Go Back
| Ctrl-Shift-F8
|-
| Go to Address
| Ctrl-G
|-
| Go to Definition
| F12
Ctrl-Shift-C
|-
| Go To Declaration
| Ctrl-F12
Ctrl-Shift-D
|-
| Go to Related Files
| Ctrl-R
|-
| Go to Executing Predicate Source
| Ctrl-E
|-
| Go To Line
| Ctrl-F2
|-
| Go To Position on Clipboard
| Shift-F2
|-
| Go To Next Error
| F8
|-
| Go To Previous Error
| Shift-F8
|-
| Go To Next Bookmark
| F6
|-
| Go To Previous Bookmark
| Shift-F6
|-
| Window Navigation Dialog
| Ctrl-Tab or Ctrl-F6
|-
| Set/Remove bookmark
| Ctrl-K
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Compile
|-
| Build
| Ctrl-Shift-B
|-
| Stop Build
| Ctrl-Break
|-
| Build Resource Only
| Alt-F8
|-
| Compile
| Ctrl-F7
|-
| Rebuild Project
| Ctrl-Shift-Alt-B
|-
| Run
| Ctrl-F5
|-
| Run in Window
| Alt-F5
|-
| 32 bit Platform
| Ctrl-Alt-3
|-
| 64 bit Platform
| Ctrl-Alt-6
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Debug
|-
| Start Debugging
| F5
|-
| Run Debugging Skipping Soft Breakpoints
| Ctrl-Shift-F10
|-
| Stop Debugging
| Shift-F5
|-
| Restart Debugging
| Ctrl-Shift-F5
|-
| Refresh Debug Window
| Ctrl-R
|-
| CallStack Window
| Ctrl-Alt-C
|-
| Variable Window
| Ctrl-Alt-V
|-
| Watch Window
| Ctrl-Alt-W
|-
| Facts Window
| Ctrl-Alt-F
|-
| Delete Object from Facts Tree
Retract Fact(s)
| Ctrl-Del
|-
| Threads Window
| Ctrl-Alt-H
|-
| Modules Window
| Ctrl-Alt-L
|-
| Breakpoints Window
| Ctrl-Alt-B
|-
| Bookmarks Window
| Ctrl-Alt-K
|-
| Disassembly Window
| Ctrl-Alt-D
|-
| Disassembly Window from Current Line
| Ctrl-D
|-
| Registers window
| Ctrl-Alt-G
|-
| Memory Dump 1 Window
| Ctrl-Alt-M
|-
| Toggle Breakpoint
| F9
|-
| Toggle Hard/Soft Breakpoint
| Ctrl-F9
|-
| Breakpoint Properties
| Alt-F9
|-
| Breakpoint -> Bookmark
| Ctrl-Alt-F9
|-
| Bookmark -> Breakpoint
| Ctrl-Alt-F9
|-
| Step Into
| F11
|-
| Step out of
| Shift-F11
|-
| Step Over
| F10
|-
| Run To Cursor
| Ctrl-F10
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Project
|-
| New Project
| Ctrl-Shift-N
|-
| Open Project
| Ctrl-Shift-O
|-
| Add Module to Project
| Ctrl-Shift-A
|-
| Create Project Item
| Ctrl-N
|-
| Create Project Item in Existing Package
| Ctrl-Alt-N
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
IDE
|-
| Add qualification
| Ctrl-Shift-S
|-
| Close all other editors
| Ctrl-Q
|-
| Prune open editors
| Ctrl-Shift-Q
|-
| Close the active window
| Ctrl-F4
|-
| Project window
| Ctrl-Alt-P
|-
| Project Settings
| Alt-F7
|-
| Open File
| Ctrl-O
|-
| Save File
| F2
|-
| Save Project
| Ctrl-S
|-
| Source Browser
| Ctrl-B
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Other
|-
| Help
| F1
|-
| Messages Window
| Ctrl-Alt-O
|-
| Error/Warnings Window
| Ctrl-Alt-E
|-
| Print
| Ctrl-P
|-
| Exit IDE
| Alt-F4
|}

[[ru:IDE:Горячие Клавиши]]

Error c025: Error during the file operation.

2013-05-31T10:17:09Z

GalinaTchekmareva: New page: Error during the file operation. File name: '<vp>FileName</vp>'. Operation: '<vp>Operation</vp>'. System message: <vp>SystemMessage</vp> The specified error message is generated, when ...

Error during the file operation. File name: '<vp>FileName</vp>'.
Operation: '<vp>Operation</vp>'.
System message: <vp>SystemMessage</vp>

The specified error message is generated, when the operation with the file failed.

[[ru:Error c025: Error during the file operation.]]

[[Category:Compiler Errors and Warnings|025]]

How to Distribute Applications

2013-05-29T13:15:41Z

GalinaTchekmareva:

= How to Distribute Visual Prolog Applications =

Running of target modules created by Visual Prolog IDE requires existence of some Visual Prolog runtime DLLs on the computer at which these modules will be used. Therefore, these Visual Prolog runtime DLLs should be supplied together with the distributed modules. (Visual Prolog target modules can be applications, DLLs, and COM objects.)

The IDE provides you assistance in preparing the set of files, which should be distributed together with your target modules generated by Visual Prolog. At any moment you can use the '''Project Settings''' dialog to copy all Visual Prolog runtime DLLs, which are required to be distributed together with the generated target module, to the final directory of the project.

Here we describe how to do this. When you activate the '''Project Settings''' dialog, you will see the picture like this:

[[Image:Ide_ApplicationExpert_General.png]]

Notice that when the '''Project Settings''' dialog is opened to create a new project, then it has the edit fields instead of the table you see on the picture.

By the default the project '''Final''' directory is '''EXE''' (or '''EXE64''' for 64bit targets) subdirectory of the project. It can be seen and changed if needed in the '''Directories''' tab of the '''Project Settings''' dialog:

[[Image:Ide_ApplicationExpert_Directories.png]]

IDE automatically copies Visual Prolog runtime DLLs to the project final directory. When it reports, that the target project module is successfully built, go into the project final directory. In this directory you will see the project target module like <vp>ProjectName.exe</vp> or <vp>ProjectName.dll</vp> and the set of required Visual Prolog runtime DLLs.

If you will distribute the project target module to the customers, who can do not have the same version of Visual Prolog installed on computers at which they will execute this target module, then you NEED to SUPPLY to them all DLLs, which are copied by the IDE into the project '''Final''' directory.

'''Prolog Development Center A/S grants you permission to supply Visual Prolog runtime DLLs, which was copied by the IDE to your project final directory, to your customers.'''

[[How to Distribute Applications]]

How to Distribute Applications

2013-05-29T13:04:50Z

GalinaTchekmareva:

= How to Distribute Visual Prolog Applications =

Running of target modules created by Visual Prolog IDE requires existence of some Visual Prolog runtime DLLs on the computer at which these modules will be used. Therefore, these Visual Prolog runtime DLLs should be supplied together with the distributed modules. (Visual Prolog target modules can be applications, DLLs, and COM objects.)

The IDE provides you assistance in preparing the set of files, which should be distributed together with your target modules generated by Visual Prolog. At any moment you can use the '''Project Settings''' dialog to copy all Visual Prolog runtime DLLs, which are required to be distributed together with the generated target module, to the final directory of the project.

Here we describe how to do this. When you activate the '''Project Settings''' dialog, you will see the picture like this:

[[Image:Ide_ApplicationExpert_General.png]]

Notice that when the '''Project Settings''' dialog is opened to create a new project, then it has the edit fields instead of the table you see on the picture.

By the default the project '''Final''' directory is '''EXE''' (or '''EXE64''' for 64bit targets) subdirectory of the project. It can be seen and changed if needed in the '''Directories''' tab of the '''Project Settings''' dialog:

[[Image:Ide_ApplicationExpert_Directories.png]]

IDE automatically copies Visual Prolog runtime DLLs to the project final directory. When it reports, that the target project module is successfully built, go into the project final directory. In this directory you will see the project target module like <vp>ProjectName.exe</vp> or <vp>ProjectName.dll</vp> and the set of required Visual Prolog runtime DLLs.

If you will distribute the project target module to the customers, who can do not have the same version of Visual Prolog installed on computers at which they will execute this target module, then you NEED to SUPPLY to them all DLLs, which are copied by the IDE into the project '''Final''' directory.

'''Prolog Development Center A/S grants you permission to supply Visual Prolog runtime DLLs, which was copied by the IDE to your project final directory, to your customers.'''

[[How to Distribute Applications]]

Ide/Key Bindings

2013-05-27T12:00:24Z

GalinaTchekmareva:

{{ideNavbar|Key Bindings}}

A number of Visual Prolog menu entries have accelerator keys (hot keys) associated with them.

Beginning with Visual Prolog 7.0 some key binding have been changed to comply with Microsoft de facto standards.
The table below shows Visual Prolog 7.2 accelerator keys by functions.

:{| {{prettytable}}
|- class="header2"
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Function
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Key
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Edit
|-
| Copy
| Ctrl-C or Ctrl-Ins
|-
| Copy Position
| Ctrl-Alt-Shift-C
|-
| Cut
| Ctrl-X or Shift-Del
|-
| Paste
| Ctrl-V or Shift-Ins
|-
| Undo
| Ctrl-Z
|-
| Redo
| Ctrl-Y or Ctrl-Shift-Z
|-
| Select All
| Ctrl-A
|-
| Select Current Word
| Ctrl-W
|-
| Box Editor: Size To Content
| Shift-F6
|-
| Code Expert
| Ctrl-Shift-W
|-
| Delete
| Del
|-
| Delete Line
| Ctrl-Shift-L
|-
| Delete to End of Line
| Ctrl-Shift-E
|-
| Delete to Start of Line
| Ctrl-Shift-H
|-
| Word Delete To End
| Ctrl-Del
|-
| Insert Predicate
| Ctrl-Shift-I
|-
| Replace
| Ctrl-H
|-
| Lower Case
| Ctrl-U
|-
| Upper Case
| Ctrl-Shift-U
|-
| Toggle Case
| Ctrl-Alt-U
|-
| Zoom In
| Ctrl-[+] or Ctrl-Scroll mouse wheel up
|-
| Zoom Out
| Ctrl-[-] or Ctrl-Scroll mouse wheel down
|-
| Zoom to Normal
| Ctrl-0
|-
| Comment Line(s)
| Ctrl-Alt-5
|-
| Uncomment Line(s)
| Ctrl-Alt-Shift-5
|-
| Duplcate Line
| Ctrl-Alt-R
|-
| Insert Date Stamp
| Ctrl-Shift-Y
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Navigation
|-
| Find
| Ctrl-F
|-
| Find in Files
| Ctrl-Shift-F
|-
| Find Next
| F3
|-
| Find Previous
| Shift-F3
|-
| Last Searchs Result Window
| Ctrl-Alt-S
|-
| Locate in Project Tree
| Ctrl-T
|-
| Go Back
| Ctrl-Shift-F8
|-
| Go to Address
| Ctrl-G
|-
| Go to Definition
| F12
Ctrl-Shift-C
|-
| Go To Declaration
| Ctrl-F12
Ctrl-Shift-D
|-
| Go to Related Files
| Ctrl-R
|-
| Go to Executing Predicate Source
| Ctrl-E
|-
| Go To Line
| Ctrl-F2
|-
| Go To Position on Clipboard
| Shift-F2
|-
| Go To Next Error
| F8
|-
| Go To Previous Error
| Shift-F8
|-
| Go To Next Bookmark
| F6
|-
| Go To Previous Bookmark
| Shift-F6
|-
| Window Navigation Dialog
| Ctrl-Tab or Ctrl-F6
|-
| Set/Remove bookmark
| Ctrl-K
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Compile
|-
| Build
| Ctrl-Shift-B
|-
| Stop Build
| Ctrl-Break
|-
| Build Resource Only
| Alt-F8
|-
| Compile
| Ctrl-F7
|-
| Rebuild Project
| Ctrl-Shift-Alt-B
|-
| Run
| Ctrl-F5
|-
| Run in Window
| Alt-F5
|-
| 32 bit Platform
| Ctrl-Alt-3
|-
| 64 bit Platform
| Ctrl-Alt-6
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Debug
|-
| Start Debugging
| F5
|-
| Run Debugging Skipping Soft Breakpoints
| Ctrl-Shift-F10
|-
| Stop Debugging
| Shift-F5
|-
| Restart Debugging
| Ctrl-Shift-F5
|-
| Refresh Debug Window
| Ctrl-R
|-
| CallStack Window
| Ctrl-Alt-C
|-
| Variable Window
| Ctrl-Alt-V
|-
| Watch Window
| Ctrl-Alt-W
|-
| Facts Window
| Ctrl-Alt-F
|-
| Delete Object from Facts Tree
Retract Fact(s)
| Ctrl-Del
|-
| Threads Window
| Ctrl-Alt-H
|-
| Modules Window
| Ctrl-Alt-L
|-
| Breakpoints Window
| Ctrl-Alt-B
|-
| Bookmarks Window
| Ctrl-Alt-K
|-
| Disassembly Window
| Ctrl-Alt-D
|-
| Disassembly Window from Current Line
| Ctrl-D
|-
| Registers window
| Ctrl-Alt-G
|-
| Memory Dump 1 Window
| Ctrl-Alt-M
|-
| Toggle Breakpoint
| F9
|-
| Toggle Hard/Soft Breakpoint
| Ctrl-F9
|-
| Breakpoint Properties
| Alt-F9
|-
| Breakpoint -> Bookmark
| Ctrl-Alt-F9
|-
| Bookmark -> Breakpoint
| Ctrl-Alt-F9
|-
| Step Into
| F11
|-
| Step out of
| Shift-F11
|-
| Step Over
| F10
|-
| Run To Cursor
| Ctrl-F10
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Project
|-
| New Project
| Ctrl-Shift-N
|-
| Open Project
| Ctrl-Shift-O
|-
| Add Module to Project
| Ctrl-Shift-A
|-
| Create Project Item
| Ctrl-N
|-
| Create Project Item in Existing Package
| Ctrl-Alt-N
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
IDE
|-
| Add qualification
| Ctrl-Shift-S
|-
| Close all other editors
| Ctrl-Q
|-
| Prune open editors
| Ctrl-Shift-Q
|-
| Close the active window
| Ctrl-F4
|-
| Project window
| Ctrl-Alt-P
|-
| Project Settings
| Alt-F7
|-
| Open File
| Ctrl-O
|-
| Save File
| F2
|-
| Save Project
| Ctrl-S
|-
| Source Browser
| Ctrl-B
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Other
|-
| Help
| F1
|-
| Messages Window
| Ctrl-Alt-O
|-
| Error/Warnings Window
| Ctrl-Alt-E
|-
| Print
| Ctrl-P
|-
| Exit IDE
| Alt-F4
|}

[[ru:IDE:Горячие Клавиши]]

How to Distribute Applications

2013-05-24T09:57:53Z

GalinaTchekmareva: New page: = How to Distribute Visual Prolog Applications = Running of target modules created by Visual Prolog IDE requires existence of some Visual Prolog runtime DLLs on the computer at which thes...

= How to Distribute Visual Prolog Applications =

Running of target modules created by Visual Prolog IDE requires existence of some Visual Prolog runtime DLLs on the computer at which these modules will be used. Therefore, these Visual Prolog runtime DLLs should be supplied together with the distributed modules. (Visual Prolog target modules can be applications, DLLs, and COM objects.)

The IDE provides you assistance in preparing the set of files, which should be distributed together with your target modules generated by Visual Prolog. At any moment you can use the '''Project Settings''' dialog to copy all Visual Prolog runtime DLLs, which are required to be distributed together with the generated target module, to the final directory of the project.

Here we describe how to do this. When you activate the '''Project Settings''' dialog, you will see the picture like this:

[[Image:Ide_ApplicationExpert_General.png]]

Notice that when the '''Project Settings''' dialog is opened to create a new project, then it has the edit fields instead of the table you see on the picture.

By the default the project '''Final''' directory is '''EXE''' (or '''EXE64''' for 64bit targets) subdirectory of the project. It can be seen and changed if needed in the '''Directories''' tab of the '''Project Settings''' dialog:

[[Image:Ide_ApplicationExpert_Directories.png]]

IDE automatically copies Visual Prolog runtime DLLs to the project final directory. When it reports, that the target project module is successfully built, go into the project final directory. In this directory you will see the project target module like <vp>ProjectName.exe</vp> or <vp>ProjectName.dll</vp> and the set of required Visual Prolog runtime DLLs.

If you will distribute the project target module to the customers, who can do not have the same version of Visual Prolog installed on computers at which they will execute this target module, then you NEED to SUPPLY to them all DLLs, which are copied by the IDE into the project '''Final''' directory.

'''Prolog Development Center A/S grants you permission to supply Visual Prolog runtime DLLs, which was copied by the IDE to your project final directory, to your customers.'''

File:Ide ApplicationExpert Directories.png

2013-05-24T09:56:27Z

GalinaTchekmareva:

Ide/IDE Dialogs

2013-05-24T08:52:19Z

GalinaTchekmareva:

{{ideNavbar|IDE Dialogs}}

=== Warning: These files will be overwritten ===

When you create a new project with the IDE {{ide|Project Settings#General Tab|Project Settings}} facility, you can specify the '''Subdirectory''' in which the project will be placed (notice that usually this name is generated automatically from the specified project name). Notice that each project contains several standard files (always automatically generated by the IDE) with standard names. Therefore, if the specified subdirectory name coincides with one in which a previously created project already exists, then these 2 projects should have several standard files with the same names. Because the old versions of these files can be incompatible with the new project, the {{ide|Project Settings#General Tab|Project Settings}} generates the warning dialog with the title:

'''These files will be overwritten:'''

In the central pane of this dialog you see a list of files which should be overwritten.

You can select the following actions:

'''Continue'''

If you select this button, then the old versions of files specified in the list will be overwritten with the new versions.

'''Cancel'''

If you select this button, then no files will be overwritten, the IDE returns into the {{ide|Project Settings#General Tab|Project Settings}} dialog where you can the specify other name in the '''Subdirectory''' control.

=== Resolve Ambiguity ===

This dialog appears when you execute the:

* '''Go to Declaration''' ('''Ctrl+Shift+D'''),
* '''Go to Definition''' ('''Ctrl+Shift+C'''), or
* '''Show Visual Prolog Help''' ('''F1''')

commands and the cursor points onto a "'''''name'''''", which has several versions of the "'''''name'''''" references in the generated {{ide|Code Experts#Source Browser|browse information}} and cannot resolve this ambiguity using all additional information about the "'''''name'''''", which The IDE can gather in the edited file.

Correspondently it have titles:

* '''Resolve Ambiguity of "''name''" Declaration'''
* '''Resolve Ambiguity of "''name''" Definition'''
* '''Choose "''name''" to Show Help Topic'''

These dialogs display lists of references to the "'''''name'''''" with additional information (gathered in the generated by the compiler {{ide|Code Experts#Source Browser|browse information}}, which helps you to resolve ambiguity of the "'''''name'''''".

Names are prefixed with the same {{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window.

To continue an initiated command execution you need to select (click) one of displayed lines containing unique references to the "'''''name'''''".

=== Send Bug Report to Support ===

Normally you should use '''Help | Send Bug Report...''' IDE command to send a bug report or feedback. You can also send a mail directly to the '''Visual Prolog Support Service'''.

'''About Visual Prolog Support Service'''

'''Visual Prolog Support''' is responsible for answering questions only about bugs and problems with using of Visual Prolog language, the IDE, and other tools and packages supplied in '''Commercial''' editions of Visual Prolog.

'''Guidelines for preparing Bug Reports to Visual Prolog Support'''
----

'''1. Please check the following information sources before submitting your E-mail:'''

* [http://www.visual-prolog.com/vip6/support/faq.htm Frequently Asked Questions]
* [http://kb.visual-prolog.com Visual Prolog Knowledge Base]

'''2. Please do not ask Visual Prolog Support about general problems like: "Visual Prolog and Fuzzy Logic?"'''

For things please use [http://discuss.visual-prolog.com/ Visual Prolog Discussion Forum], where you are free to discuss any question deals with Visual Prolog. Anybody can read the debate, but you need to register if you want to make postings.

Prolog Development Center will follow and participate as much as possible in the debates. But we cannot make any "answer guarantee"; this is mainly your forum.

This forum will receive all major announcements from Prolog Development Center.

'''3. Your message MUST contain information generated by "Help | Send Bug Report | Show Details" IDE command.'''

This information contains some parameters about your computer and your project that are useful for correct understanding of the problem. It should be copied to the mail.

'''4. How to write a message:'''

*'''To:'''
*:The address of Visual Prolog International Support Group is: '''support@visual-prolog.com'''
*'''Subject:'''
*:Use a short, precise, and relevant Subject (title line). Please, do not use subjects like: '''My 1st problem with Prolog'''
*'''Message Text:'''
*:One problem per message, please.
*:Here you should describe your problem as detailed and precise, as it is possible.
*:Please supply examples of code illustrating your problem.
*:The information supplied in your message should be sufficient to reproduce your problem on our computers.

Please follow the above guidelines when you E-mail Bug Reports to Visual Prolog Support.

Regards

The Visual Prolog International Support Group

support@visual-prolog.com

=== Replace Text ===

Using this dialog you can find and replace each or every occurrence of a text pattern (a string or a regular expression) in the edited file.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''New Text'''
:Type the replacement string, or ''regular replacement expression'' in the '''New Text''' box, or choose a previous string from the drop-down list. Notice that ''regular replacement expressions'' have limited syntax regarding to ''regular expressions'' used in the '''Text to Find''' patterns.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:*'''Entire Scope'''
:*:Defines that the string should be searched in all file.
:*'''From Cursor'''
:*:Defines that the string should be searched beginning from the current cursor position.
:*'''Selected Text'''
:*:Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:*'''Forward'''
:*:Search the document below the insertion point.
:*'''Backward'''
:*:Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:*'''Case Sensitive'''
:*:Find strings having the given pattern of uppercase and lowercase letters.
:*'''Whole Words Only'''
:*:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
:*'''Use Regular Expressions'''
:*:See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.
'''Replace'''
:Press the '''Replace''' button to replace the current selection or to invoke searching of the specified string (regular expression) with the specified options if there are no selection.
'''Find Next'''
:Press the '''Find''' button to invoke searching of the next occurrence of the specified string (regular expression) with the specified options.
'''Change All'''
:Press the '''Change All''' button to replace all occurrences of the search text, in the specified scope.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Find Text in Files ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions in the specified group of files.

[[Image:Ide_FindInFiles.png]]

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''Find in All Opened Editors'''
:Check this option if you wish that the IDE search the specified string only in that text files, which are currently opened in the IDE text editors.
'''Find in Project Files Only'''
:Check this option if you wish that the IDE search the specified string only in text files, which are parts of the project currently loaded into the IDE.
:This button is disabled when the project is not loaded.
'''Show Search Results in New Window'''
:If this option is checked ON, then the IDE will open new '''Search results''' window each time the search is completed, otherwise it will display search results in the same window.
'''In Files:'''
:In this list editor you can specify (or select from the list of previously used) the file mask which will be used to restrict files in which the IDE will search for the string. For example, you can use <vp>*</vp> operator to specify that any sub-string can be used instead of this operator.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''In Folder:'''
:In this list editor you can specify (or select from the list of previously used) the folder, which will be used to restrict files in which the IDE will search for the string.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Browse'''
:Press this button to open the '''Set New Directory''' dialog in which you can select the folder, which name will be inserted into the '''In Folder''' field.
: Notice that when '''Find in Project Files Only''' is checked ON, then this dialog will gives you access only to the folders known to the project.
:This button is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Search Subfolders'''
:When this option is checked ON (the default), then the IDE will search in all subfolders of the folder specified in the '''In Folder''' field.
:Otherwise, search will be only in the files directly in the folder specified in the '''In Folder''' field.
'''Whole Words Only'''
:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
'''Case Sensitive'''
:The selected item specifies whether the search should match case of the whole search string ('''Case Sensitive'''), ignore the case ('''Case Insensitive''') or match the case of the first character of the search string ('''Prolog Sensitive'''). The last option is unavailable, when '''Regular Expressions''' option is checked ON.

==== Regular Expressions ====

Provides possibility to perform advanced string searching operations (searching, matching and replacing) using regular expressions.

'''Regular Expressions '''
:A ''regular expression'' (or pattern) is a text string that describes some (mathematical) group of strings. A string <vp>S</vp> "matches" a regular expression <vp>R</vp> if <vp>S</vp> belongs to the set of strings described by <vp>R</vp>. Using regular expression, you can:
:* check whether the specified string matches the specified pattern;
:* search within a string for a substring matching the specified pattern;
:* perform replacing within matched substrings.
:Some regular expressions can match only one substring. That is, a set of strings such regular expression describes has only one member. For example, the regular expression '''foo''' matches only the substring '''foo''' and no others. Other regular expressions can match more than one substring. That is, a set of strings such regular expression describes has more than one member. For example, the regular expression <vp>f*</vp> matches the set of strings made up of any number (including zero) of '''f''' characters. Some characters in regular expressions match themselves (such as '''f''') and some do not match to any concrete character (such as <vp>*</vp>). Characters that do not match themselves are used to specify patterns, which describe sets of different strings.
'''Regular Expression Syntax'''
:See the pfc\regEx\packRegEx package for more details of regular expression syntax.
'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Stop'''
:Press the '''Stop''' button to stop searching.
'''Help'''
:Displays this help topic.

==== Search results ====

[[Image:Ide_FindInFilesResults.png]]

This window displays the table which contains the names of files in which the specified string is found, the line number and the position, where the specified text is located and the content of the whole line.

If you double-click any filename, then this file will be opened in the text editor.

=== Find Text ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or regular expression, or choose a previous string from the drop-down list.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:'''Entire Scope'''
::Defines that the string should be searched in all file.
:'''From Cursor'''
::Defines that the string should be searched beginning from the current cursor position.
:'''Selected Text'''
::Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:'''Forward'''
::Search the document below the insertion point.
:'''Backward'''
::Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:'''Case Sensitive'''
::Find strings having the given pattern of uppercase and lowercase letters.
:'''Whole Words Only'''
::Find occurrences of the string as whole words.
:'''Use Regular Expressions'''
::See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.
'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Window Navigation Dialog ===

The order, in which '''Ctrl-TAB''' shifts between IDE windows, has been changed to visit most-recently-visited windows first.

Furthermore, '''Ctrl-TAB''' also brings up a navigation dialog listing all the open windows. The dialog stays up as long as Ctrl-key is pressed. In this dialog you can see the windows in the order they will be shifted to, but you can also choose a window directly using the mouse or the arrow keys. If you press letters the list will be filtered to windows starting with the letters you have pressed.

'''Ctrl-F1''' Help,

'''Ctrl-Del''' will close the selected window,

'''Ctrl-BackSpace''' removes the last letter,

'''Ctrl-Alt''' switches on/off showing only read-write files.

'''Ctrl-*''' switches on/off alternate filter by letter.

Ide/Key Bindings

2013-05-23T13:19:21Z

GalinaTchekmareva:

{{ideNavbar|Key Bindings}}

A number of Visual Prolog menu entries have accelerator keys (hot keys) associated with them.

Beginning with Visual Prolog 7.0 some key binding have been changed to comply with Microsoft de facto standards.
The table below shows Visual Prolog 7.2 accelerator keys by functions.

:{| {{prettytable}}
|- class="header2"
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Function
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Key
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Edit
|-
| Copy
| Ctrl-C
|-
| Cut
| Ctrl-X or Shift-Del
|-
| Paste
| Ctrl-V or Shift-Ins
|-
| Paste
| Ctrl-Ins
|-
| Undo
| Ctrl-Z
|-
| Redo
| Ctrl-Y or Ctrl-Shift-Z
|-
| Select All
| Ctrl-A
|-
| Select Current Word
| Ctrl-W
|-
| Box Editor: Size To Content
| Shift-F6
|-
| Code Expert
| Ctrl-Shift-W
|-
| Delete
| Del
|-
| Delete Line
| Ctrl-Shift-L
|-
| Delete to End of Line
| Ctrl-Shift-E
|-
| Word Delete To End
Delete Object from Facts Tree
Retract Fact(s)
| Ctrl-Del
|-
| Insert Predicate
| Ctrl-Shift-I
|-
| Replace
| Ctrl-H
|-
| Lower Case
| Ctrl-U
|-
| Upper Case
| Ctrl-Shift-U
|-
| Toggle Case
| Ctrl-Alt-U
|-
| Zoom In
| Ctrl-[+] or Ctrl-Scroll mouse wheel up
|-
| Zoom Out
| Ctrl-[-] or Ctrl-Scroll mouse wheel down
|-
| Zoom to Normal
| Ctrl-0
|-
| Comment Line(s)
| Ctrl-Alt-5
|-
| Uncomment Line(s)
| Ctrl-Alt-Shift-5
|-
| Duplcate Line
| Ctrl-Alt-R
|-
| Insert Date Stamp
| Ctrl-Shift-Y
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Navigation
|-
| Find
| Ctrl-F
|-
| Find in Files
| Ctrl-Shift-F
|-
| Find Next
| F3
|-
| Find Previous
| Shift-F3
|-
| Last Searchs Result Window
| Ctrl-Alt-S
|-
| Locate in Project Tree
| Ctrl-T
|-
| Go Back
| Ctrl-Shift-F8
|-
| Go to Address
| Ctrl-G
|-
| Go to Definition
| F12
Ctrl-Shift-C
|-
| Go To Declaration
| Ctrl-F12
Ctrl-Shift-D
|-
| Go to Related Files
| Ctrl-R
|-
| Go to Executing Predicate Source
| Ctrl-E
|-
| Go To Line
| Ctrl-F2
|-
| Go To Position on Clipboard
| Shift-F2
|-
| Go To Next Error
| F8
|-
| Go To Previous Error
| Shift-F8
|-
| Go To Next Bookmark
| F6
|-
| Go To Previous Bookmark
| Shift-F6
|-
| Window Navigation Dialog
| Ctrl-Tab or Ctrl-F6
|-
| Set/Remove bookmark
| Ctrl-K
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Compile
|-
| Build
| Ctrl-Shift-B
|-
| Stop Build
| Ctrl-Break
|-
| Build Resource Only
| Alt-F8
|-
| Compile
| Ctrl-F7
|-
| Rebuild Project
| Ctrl-Shift-Alt-B
|-
| Run
| Ctrl-F5
|-
| Run in Window
| Alt-F5
|-
| 32 bit Platform
| Ctrl-Alt-3
|-
| 64 bit Platform
| Ctrl-Alt-6
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Debug
|-
| Start Debugging
| F5
|-
| Run Debugging Skipping Soft Breakpoints
| Ctrl-Shft-F10
|-
| Stop Debugging
| Shift-F5
|-
| Restart Debugging
| Ctrl-Shift-F5
|-
| Breakpoint Properties
| Alt-F9
|-
| Refresh Debug Window
| Ctrl-R
|-
| CallStack Window
| Ctrl-Alt-C
|-
| Variable Window
| Ctrl-Alt-V
|-
| Watch Window
| Ctrl-Alt-W
|-
| Facts Window
| Ctrl-Alt-F
|-
| Threads Window
| Ctrl-Alt-H
|-
| Modules Window
| Ctrl-Alt-L
|-
| Breakpoints Window
| Ctrl-Alt-B
|-
| Bookmarks Window
| Ctrl-Alt-K
|-
| Disassembly Window
| Ctrl-Alt-D
|-
| Disassembly Window from Current Line
| Ctrl-D
|-
| Registers window
| Ctrl-Alt-G
|-
| Memory Dump 1 Window
| Ctrl-Alt-M
|-
| Toggle Breakpoint
| F9
|-
| Toggle Hard/Soft Breakpoint
| Ctrl-F9
|-
| Step Into
| F11
|-
| Step out of
| Shift-F11
|-
| Step Over
| F10
|-
| Run To Cursor
| Ctrl-F10
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Project
|-
| New Project
| Ctrl-Shift-N
|-
| Open Project
| Ctrl-Shift-O
|-
| Add Module to Project
| Ctrl-Shift-A
|-
| Create Project Item
| Ctrl-N
|-
| Create Project Item in Existing Package
| Ctrl-Alt-N
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
IDE
|-
| Add qualification
| Ctrl-Shift-S
|-
| Close all other editors
| Ctrl-Q
|-
| Prune open editors
| Ctrl-Shift-Q
|-
| Close the active window
| Ctrl-F4
|-
| Project window
| Ctrl-Alt-P
|-
| Project Settings
| Alt-F7
|-
| Open File
| Ctrl-O
|-
| Save File
| F2
|-
| Save Project
| Ctrl-S
|-
| Source Browser
| Ctrl-B
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Other
|-
| Help
| F1
|-
| Messages Window
| Ctrl-Alt-O
|-
| Error/Warnings Window
| Ctrl-Alt-E
|-
| Print
| Ctrl-P
|-
| Exit IDE
| Alt-F4
|}

[[ru:IDE:Горячие Клавиши]]

Ide/Key Bindings

2013-05-23T12:09:43Z

GalinaTchekmareva:

{{ideNavbar|Key Bindings}}

A number of Visual Prolog menu entries have accelerator keys (hot keys) associated with them.

Beginning with Visual Prolog 7.0 some key binding have been changed to comply with Microsoft de facto standards.
The table below shows Visual Prolog 7.2 accelerator keys by functions.

:{| {{prettytable}}
|- class="header2"
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Function
|align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Key
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Edit
|-
| Copy
| Ctrl-C
|-
| Cut
| Ctrl-X or Shift-Del
|-
| Paste
| Ctrl-V or Shift-Ins
|-
| Paste
| Ctrl-Ins
|-
| Undo
| Ctrl-Z
|-
| Redo
| Ctrl-Y or Ctrl-Shift-Z
|-
| Select All
| Ctrl-A
|-
| Select Current Word
| Ctrl-W
|-
| Box Editor: Size To Content
| Shift-F6
|-
| Code Expert
| Ctrl-Shift-W
|-
| Delete
| Del
|-
| Delete Line
| Ctrl-Shift-L
|-
| Delete to End of Line
| Ctrl-Shift-E
|-
| Word Delete To End
Delete Object from Facts Tree
Retract Fact(s)
| Ctrl-Del
|-
| Insert Predicate
| Ctrl-Shift-I
|-
| Replace
| Ctrl-H
|-
| Lower Case
| Ctrl-U
|-
| Upper Case
| Ctrl-Shift-U
|-
| Toggle Case
| Ctrl-Alt-U
|-
| Zoom In
| Ctrl-[+] or Ctrl-Scroll mouse wheel up
|-
| Zoom Out
| Ctrl-[-] or Ctrl-Scroll mouse wheel down
|-
| Zoom to Normal
| Ctrl-0
|-
| Comment Line(s)
| Ctrl-Alt-5
|-
| Uncomment Line(s)
| Ctrl-Alt-Shift-5
|-
| Duplcate Line
| Ctrl-Alt-R
|-
| Insert Date Stamp
| Ctrl-Shift-Y
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Navigation
|-
| Find
| Ctrl-F
|-
| Find in Files
| Ctrl-Shift-F
|-
| Find Next
| F3
|-
| Find Previous
| Shift-F3
|-
| Last Searchs Result Window
| Ctrl-Alt-S
|-
| Locate in Project Tree
| Ctrl-T
|-
| Go Back
| Ctrl-Shift-F8
|-
| Go to Address
| Ctrl-G
|-
| Go to Definition
| F12
Ctrl-Shift-C
|-
| Go To Declaration
| Ctrl-F12
Ctrl-Shift-D
|-
| Go to Related Files
| Ctrl-R
|-
| Go to Executing Predicate Source
| Ctrl-E
|-
| Go To Line
| Ctrl-F2
|-
| Go To Position on Clipboard
| Shift-F2
|-
| Go To Next Error
| F8
|-
| Go To Previous Error
| Shift-F8
|-
| Go To Next Bookmark
| F6
|-
| Go To Previous Bookmark
| Shift-F6
|-
| Window Navigation Dialog
| Ctrl-Tab or Ctrl-F6
|-
| Set/Remove bookmark
| Ctrl-K
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Compile
|-
| Build
| Ctrl-Shift-B
|-
| Stop Build
| Ctrl-Break
|-
| Build Resource Only
| Alt-F8
|-
| Compile
| Ctrl-F7
|-
| Rebuild Project
| Ctrl-Shift-Alt-B
|-
| Run
| Ctrl-F5
|-
| Run in Window
| Alt-F5
|-
| 32 bit Platform
| Ctrl-Alt-3
|-
| 64 bit Platform
| Ctrl-Alt-6
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Debug
|-
| Start Debugging
| F5
|-
| Run Debugging Skipping Soft Breakpoints
| Ctrl-Shft-F10
|-
| Stop Debugging
| Shift-F5
|-
| Restart Debugging
| Ctrl-Shift-F5
|-
| Breakpoint Properties
| Alt-F9
|-
| Refresh Debug Window
| Ctrl-R
|-
| CallStack Window
| Ctrl-Alt-C
|-
| Variable Window
| Ctrl-Alt-V
|-
| Watch Window
| Ctrl-Alt-W
|-
| Facts Window
| Ctrl-Alt-F
|-
| Threads Window
| Ctrl-Alt-H
|-
| Modules Window
| Ctrl-Alt-L
|-
| Breakpoints Window
| Ctrl-Alt-B
|-
| Bookmarks Window
| Ctrl-Alt-K
|-
| Disassembly Window
| Ctrl-Alt-D
|-
| Disassembly Window from Current Line
| Ctrl-D
|-
| Registers window
| Ctrl-Alt-G
|-
| Memory Dump 1 Window
| Ctrl-Alt-M
|-
| Toggle Breakpoint
| F9
|-
| Toggle Hard/Soft Breakpoint
| Ctrl-F9
|-
| Step Into
| F11
|-
| Step out of
| Shift-F11
|-
| Step Over
| F10
|-
| Run To Cursor
| Ctrl-F10
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Project
|-
| New Project
| Ctrl-Shift-N
|-
| Open Project
| Ctrl-Shift-O
|-
| Add Module to Project
| Ctrl-Shift-A
|-
| Create Project Item
| Ctrl-N
|-
| Create Project Item in Existing Package
| Ctrl-Alt-N
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
IDE
|-
| Add qualification
| Ctrl-Shift-S
|-
| Close all other editors
| Ctrl-Q
|-
| Prune open editors
| Ctrl-Shift-Q
|-
| Close the active window
| Ctrl-F4
|-
| Project window
| Ctrl-Alt-P
|-
| Project Settings
| Alt-F7
|-
| Open File
| Ctrl-O
|-
| Save File
| F2
|-
| Save Project
| Ctrl-S
|-
| Source Browser
| Ctrl-B
|-
|colspan="2" align="center" style="background:#cee0f2; text-align:center; font-weight:bold; color: #006B9C;" |
Other
|-
| Help
| F1
|-
| Messages Window
| Ctrl-Alt-O
|-
| Error/Warnings Window
| Ctrl-Alt-E
|-
| Print
| Ctrl-P
|}

[[ru:IDE:Горячие Клавиши]]

Visual Prolog Demo Examples

2013-05-20T12:24:35Z

GalinaTchekmareva:

{{ideNavbar|IDE Projects}}

In the '''bin''' subdirectory you can find the '''SetupExamples.msi''' setup program file with which you can install Visual Prolog examples. The default subdirectory for examples is '''"Visual Prolog 7.4 Examples"'''. In the '''SetupExamples.msi''' program you can set it as subdirectory of your main Visual Prolog directory or somewhere else.

=== Visual Prolog Personal Edition Examples ===

{|{{prettytable}}
|-
| '''animationControlDemo'''
|
|-
| '''askDialogDemo'''
| This program demonstrates how to program dialogs that ask the user for something and return an answer.
|-
| '''buttonDemo'''
| This program demonstrates how to handle OK and Cancel buttons, how to handle default buttons, how to handle button responders
|-
| '''diskUsage'''
| This example demonstrates usage of the PFC fileSystem package to get information about files in different specified directories. The PFC VPI/vpiTreeView package is used as a GUI interface end.
|-
| '''editor'''
| This example demonstrates how to open editor and save edited text.
|-
| '''formWindowDemo'''
| This program demonstrates a simple form and how a new form can be created dynamically.
|-
| '''GDIplus'''
| The examples demonstrates drawing pictures using GDI .
|-
| '''genericsExample'''
|
|-
| '''GUIDemo'''
| This example demonstrates how to manipulate with dialogs and controls in conventional GUI applications. It also demonstrates difference between class and object facts.
|-
| '''listDemo'''
| This program demonstrates how to handle list button, list edit and list control.
|-
| '''listViewDemo'''
| This example demonstrates how you can create dialogs with '''vpiListView''' controls using the PFC VPI/vpiListView package.
|-
| '''LZDecompression'''
|
|-
| '''mdiWin'''
| This MDI mode example demonstrates how to change the standard "Windows" submenu items with user-defined items.
|-
| '''MultiThreadDemo'''
| This example demonstrates how to create the multi-thread application and handle interactions between threads. In the example, each thread produces the results in the single (common for all threads) "queue", and the primary thread reads them one by one and displays on the screen.
|-
| '''pictureDraw'''
| This example demonstrates how to draw pictures using the GdiPlusX.lib containing some graphical primitives. The example declares the '''gdiPlus''' package. The package maintains drawing pictures using the '''GdiPlusX.lib''' graphical primitives. The '''pictWin''' package contains invocations of drawing predicates for BMP and JPG files.
|-
| style="padding-right: 10px; padding-left: 10px" |
'''Pie'''
| style="padding-right: 10px; padding-left: 10px" |
This example demonstrates a GUI Prolog Inference Engine (PIE) interpreter program. It uses a standard Prolog syntax (K&M) and releases the most popular set of predicates.
|-
| '''pieDemo'''
|
|-
| '''prologSourceBrowser'''
| This is an example of using such pfc\gui controls as treeViewControl, listViewControl and editorControl.
|-
| '''radioButtonDemo'''
| This program demonstrates how to use single radio button group, multiple radio button groups or how to use check boxes.
|-
| '''SandClocks'''
| The example demonstrates: How to program a simple enumeration of possibilities algorithm to solve the goal: "There are several sand clocks. How can we measure a given time interval?"
|-
| '''StreamDemo'''
| The example demonstrates Visual Prolog streams: <vp>outputStream_string</vp>, <vp>outputStream_file</vp>, <vp>console::getConsoleOutputStream</vp>. It also illustrates that facts databases can be written to any outputStream.
|-
| '''Sudoku'''
| A currently very popular logical Sudoku puzzle is used as an example. We show how such a problem can be solved using constraint programming and explain a simple approach to finite domains constraint solving. Furthermore, we show how to build an interactive GUI that visualizes the workings of the constraint solver.
|-
| '''tabControlDemo'''
| This program demonstrates how to handle tab control.
|-
| '''toolTipDemo'''
| Example demonstrates most aspects and styles of tooltips.
|-
| '''validationDemo'''
| This program demonstrates how to use validation. Validation is usually a check, which is performed on pressing OK button. Such check makes sure that all necessary controls with input values contains valid values.
|-
| style="padding-right: 10px; padding-left: 10px" |
'''WatchDir'''
|
|}

=== Visual Prolog Commercial Edition Examples ===

{|{{prettytable}}
|-
| '''balloonTipsDemo'''
|
|-
| '''bgDemo'''
|
|-
| '''BITS Example'''
|
|-
|'''CallProcess'''
| An example of an external process invocation.
|-
| '''CGI'''
| A CGI version of the Towers of Hanoi puzzle.
|-
| '''Com'''
| These examples illustrate how COM components can be created by Visual Prolog and how COM components can be used from Visual Prolog program.
|-
| '''DDE'''
| This directory contains examples demonstrating Windows DDE interprocess communications. In the '''Server''' and '''Client''' subdirectories there are examples of a DDE server and a DDE client applications. The DDE client initiates and controls A communication with the DDE server. In the '''Office''' subdirectory there is an example of a DDE client applications, which can communicate with Microsoft Office programs. (With the MS Word, for example.) All programs use the '''vpiDDE''' class from PFC VPI package.
|-
| '''Dll'''
| The examples illustrates how to create and use Prolog DLLs.
|-
| '''dockingDemo'''
|
|-
| '''dragNdropDemo'''
| This project demonstrates how to use the pfc/gui/dragNdrop package for application-wide drag-and-drop support.
|-
| '''ESTA'''
| Expert System Shell.
|-
| '''gridControlDemo'''
| This program contains an example of Grid Control and demonstrates how to use it.
|-
| '''GridForm'''
| This example demonstrates how to can create grid controls.
|-
| '''isApiDemo'''
| The example demonstrates creating an ISAPI DLL.
|-
| '''MSXML Example'''
|
|-
| '''OdbcDemo'''
| This rather complex example demonstrates Visual Prolog ODBC connections. This is a GUI application providing several different complex functions. It uses the PFC ODBC package.
|-
| '''Parser Generator'''
|
|-
| '''ProgressBarDemo'''
|
|-
| '''ribbonDemo'''
| This demo project illustrates how to develop applications using the Ribbon and Command packages of pfc/gui.
|-
| '''shellDDEdemo'''
| This project demonstrates how to easily integrate Visual Prolog with Windows Shell (Explorer).
|-
| '''simpleOdbc'''
| This is an extremely simple example (comparing with the complex '''OdbcDemo''') also demonstrating A ODBC connection. This is console application, which can open only the supplied '''odbc.mdb''' database and providing minimal functions. It uses the PFC ODBC package.
|-
| '''toolboxDemo'''
|
|-
| '''toyIDE'''
|
|-
| '''treeControlDemo'''
|
|-
| '''useVipInDotNet'''
| This example shows how to create and use Visual Prolog DLLs from Visual Basic applications under Dot Net. The example supplies sources for both Visual Prolog and Visual Basic projects.
|-
| '''WebBrowser'''
| This example demonstrates how you can easy program full functioning WEB Browser in Visual Prolog. The example uses Microsoft ActiveX WebBrowser control.
|-
| '''workspaceDemo'''
|
|-
| '''xmlLiteDemo'''
|
|}

Ide/$(ProDir) Subdirectories

2013-05-20T12:06:10Z

GalinaTchekmareva:

{{ideNavbar|IDE Projects}}

=== $(ProDir) Subdirectories ===

Visual Prolog is the complete programming environment based on the Prolog programming language. It contains everything needed for building large-scale commercial applications: Integrated Development Environment (IDE), compiler, linker, debugger, on-line Help, and Visual Prolog Foundation Classes (PFC). PFC is the collection of classes and interfaces that constitutes the foundation for writing various kinds of applications and software components. The classes and interfaces are organized in the package hierarchy. PFC supports: GUI, file system, fact databases, external databases, arithmetic, string handling, date and time, ODBC, registry, CGI, sockets/HTTP/FTP, Microsoft COM, multi-Threading, etc.

After installation of Visual Prolog you will have the following subdirectories created in your Visual Prolog installation directory:

{|{{prettytable}}
|-
| {{ide|$(ProDir) Subdirectories#Files in the BIN Subdirectory|'''bin'''}}
| Contains executables and some supplementary files for Visual Prolog.
|-
| {{ide|$(ProDir) Subdirectories#Files in the BIN64 Subdirectory|'''bin64'''}}
| Contains executables and some supplementary files for Visual Prolog support for 64bit platforms.
|-
| {{ide|$(ProDir) Subdirectories#Files in the DLL\WIN32 Subdirectory|'''dll\win32'''}}
| Contains Visual Prolog DLLs for 32bit targets.
|-
| {{ide|$(ProDir) Subdirectories#Files in the DLL\X64 Subdirectory|'''dll\x64'''}}
| Contains Visual Prolog DLLs for 64bit targets.
|-
| '''doc'''
| Contains this Visual Prolog on-line help file '''vip.chm'''.
|-
| {{ide|$(ProDir) Subdirectories#Files in the LIB Subdirectory|'''lib'''}}
| Contains the Visual Prolog libraries.
|-
| '''pfc'''
| Contains the Visual Prolog Foundation Classes (PFC) and some import libraries for the correspondent DLLs.
|}

==== Files in the BIN Subdirectory ====

The '''BIN''' subdirectory contains 32bit executables and main supplementary files of Visual Prolog.

{|{{prettytable}}
|-
| '''Vip.exe'''
| Integrated Development Environment (IDE) is the main executable file. It includes text and various resource editors, code generating tools (Code Experts), build control logic, and the built-in debugger. The IDE calls the Visual Prolog compiler and the linker to build target files.
|-
| {{ide|IDE Tools#Command Line Compiler|'''VipCompiler.exe'''}} '''Vip7CompilerC.dll vipParser.dll'''
| Visual Prolog command line compiler.
|-
| {{ide|IDE Tools#Command Line Compiler|'''Vip6Link.exe
'''}}
| Visual Prolog command line Link Editor used to combine object files and library modules into a single image file: an executable file or a dynamic-link library (DLL).
|-
| '''VipBuilder.exe'''
| Visual Prolog command line builder. It receives {{ide|Projects|Visual Prolog project files}} and generates the target file specified in this project.
|-
| '''ProDoc.exe MILHTMLParser.dll'''
| ProDoc - Prolog Documentation utility is the tool that allows making on-line references from Visual Prolog source code files with comments of special kinds included in them.
|- style="x-cell-content-align: top" valign="top"
| '''MemProfileAnalysis.exe'''
| This is the simple tool helping to display charts of the heap memory used by some program. This program must create the heap usage file with a call to <vp>profileMemory::profileBegin : ( ProfileFilename)</vp>. Then this <vp>ProfileFilename</vp> should be loaded into the '''MemProfileAnalysis.exe'''
|-
| '''coverageAnalysis.exe'''
| The coverage analysis gives information about the predicates that have been called during execution of the program. The coverage analysis program reads '''.deb''' files to get information about a set of classes and predicates in a program and coverage files to get information about the predicates that have been called during execution of the program. The program must be compiled with options ''' /profile:min''' and '''/debug:full''' to use this new tool.
|-
| '''Vip7associations.exe'''
| Assistant utility to set Visual Prolog file associations.
|-
| '''SetupExamples.msi'''
| The SETUP program file with which you can install {{ide|Visual Prolog Examples|'''Visual Prolog examples'''}}.
|-
| '''IdeDebug.dll ideVault.dll idestorage.dll comWrapper.dll activate.exe act.exe'''
| Assistant IDE components.
|-
| '''Project7.fkb Project7.bs2 intelliSpeed.prodb'''
| Assistant files for the IDE.
|-
| '''Prolog.bmp'''
| The startup picture for Visual Prolog IDE.
|-
| '''HelpTopic.db'''
| This database is used by the IDE to display context sensitive help. For example, when the cursor is on a PFC predicate or domain and you press the '''F1''' key then the IDE will use information form '''HelpTopic.db''' to display an appropriate help topic describing the pointed predicate or domain.
|-
| '''RES'''
| The resource files contained in the '''RES''' subdirectory are used by the IDE as the default resources, which are copied into created projects.
|-
| '''Vip7Kernel.dll Vip7Run.dll Vip7res.dll Vip7vpi.dll Vip7chainDB.dll Vip7RegExp2.dll boostRegex.dll SciLexer.dll'''
| See the description of 32bit DLLs below.
|-
| '''dbghelp.dll'''
|
|-
| '''solutionmanager.exe'''
| Tool to support solutions handling.
|}

==== Files in the BIN64 Subdirectory ====

The '''BIN64''' subdirectory contains 64bit version of some Visual Prolog executables.

{|{{prettytable}}
|-
| '''RemoteDebugger.exe'''
| Visual Prolog Debugger component to support the debugging of 64bit programs.
|-
| '''vip7Kernel.x64.dll vip7Run.x64.dll etc.'''
| 64bit versions of some Visual Prolog run-time DLLs. All of them have suffix '''.x64'''
|}

==== Files in the LIB Subdirectory ====

The '''LIB''' subdirectory contains the Visual Prolog libraries and import libraries.

{|{{prettytable}}
|-
| '''Vip7init.lib vip7init.x64.lib'''
| Visual Prolog runtime startup code.
|-
| '''Win32.lib Win32.x64.lib'''
| This library provides interface to Windows 32 / 64 API functions.
|-
| '''Vip7Kernel.lib Vip7Kernel.x64.lib Vip7run.lib vip7run.x64.lib etc'''.
| These are import libraries to the correspondent DLLs copied into the '''DLL\WIN32''' and '''DLL\X64''' subdirectories.
|}

==== Files in the DLL\WIN32 Subdirectory ====

The '''DLL\WIN32''' subdirectory contains 32bit versions of Visual Prolog DLLs.

{|{{prettytable}}
|-
| '''Vip7Kernel.dll Vip7Run.dll'''
| These libraries implement run-time Visual Prolog execution system.
|-
| '''SciLexer.dll'''
| This library supports the implementation of '''pfc\gui\controls\sciLexer package''' ('''Scintilla text editor''').
|-
| '''Vip7Edit.dll'''
| This library supports usage of the old version of Visual Prolog text editor.
|-
| '''Vip7res.dll'''
| This library supports usage of the PFC '''vpiResourceSupport''' Resource Support package.
|-
| '''vip7vpi.dll'''
| This library supports usage of the PFC '''VPI''' package.
|-
| '''Vip7chainDB.dll'''
| This library supports usage of Visual Prolog external databases implemented in the PFC '''chainDB''' package.
|-
| '''Vip7RegExp2.dll'''
| This library supports usage of the old version of PFC regular expressions support.
|-
|'''boostRegex.dll'''
| This library supports usage of the '''pfc\regEx\regEx package'''.
|}

==== Files in the DLL\X64 Subdirectory ====

The '''DLL\X64''' subdirectory contains 64bit version Visual Prolog DLLs which are described above. Their names have suffix '''.x64'''. There are no 64bit versions of Vip7Edit.dll and Vip7RegExp2.dll.

Ide/Text Editor

2013-05-17T13:42:23Z

GalinaTchekmareva:

{{ideNavbar|Text Editor}}

== About the Text Editor ==

The Visual Prolog '''Text Editor''' is used for creating and editing of any text files. However, the Visual Prolog text editor is specially oriented for editing Visual Prolog source code files from the IDE, for example, it supports color highlighting of Visual Prolog language syntax elements (keywords, variables, and other language elements). Also when the text editor is used in the IDE, it supports such Visual Prolog specific functions as '''{{ide|Text Editor#Go to Declaration|Go to Name Declaration}}''', '''{{ide|Text Editor#Go to Definition|Go to Name Definition}}''', '''{{ide|Text Editor#Insert Known Names|Insert Interface}}''', '''Insert Class''', '''Insert Predicate''', etc.

The text editor supports: undo/redo features (standard restriction is 512 steps), search, replace, changing case of letters, cut, copy, and paste operations with the clipboard, and drag and drop for quick block movements with the mouse, etc.

Programmers can create the Visual Prolog '''Text Editor''' in their applications using the '''pfc\gui\controls\sciLexer package'''.

The most often used text editor commands have hot keys or can be called with the right mouse button pop-up context menu.

== Getting Assistance ==

Press '''F1''' (or the [[Image:Ide_TE_Help.png]] button in the toolbar or the '''Help | Visual Prolog Help''' command) when the input focus is in any text editor window to display this help information.

== Set the Editor Options ==

Text editor options are grouped in the {{ide|Options|Options}} dialog.

== How to Work with Files ==

=== Create a New Text File ===

Execute the '''File | New...''' command (or '''Ctrl+N''', or click the [[Image:Ide_TE_New.png]] toolbar button) to open the '''Create Project Item''' dialog. In the left pane of this dialog select '''Text File'''. For more detailed description see {{ide|Creating new Project Items#Creating a Text File|New Text File Creation}}.

=== Open an Existing File ===

There are several ways to open existing text files:

* Using the standard '''File Open''' dialog box. To activate it you can use the '''File | Open''' command, or the '''Ctrl+O''' hot key, or clicking the [[Image:Ide_TE_Open.png]] toolbar button.
* Clicking a text file in the {{ide|Project Tree|project tree}} in the '''Project''' window.
* The IDE keeps tracking of text files you last worked on. You can quickly open one of them by selecting it from the list at the bottom of the '''File''' menu.
You can have many files opened in text editor windows simultaneously. The '''Open''' command does not close any already opened text editor windows. The Visual Prolog IDE is restricted to editing a single version of anyone file; therefore, if you try to open an already edited file, then the IDE simply sets the focus into the editor window with this file.

Notice that the text editor can open both UNICODE and DOS character set text files. When it saves files that had DOS character set (before they were opened), then they are saved with the DOS character set. The same for UNICODE files.

=== Save an Edited File ===

There are several ways to save a text file being edited:
* Using the '''File | Save''' command, or the '''F2''' hot key, or clicking the [[Image:Ide_TE_Save.png]] toolbar button.
* Notice that all modified text files are ALWAYS saved before the IDE compiles them.

=== Save a File under Different Name ===

Use the '''File | Save as ...''' menu command.

=== Print an Edited File ===

Use the '''File | Print''' menu command to print the currently edited file. The standard Windows '''Print''' dialog appears. In it you can select some printing options.

== How to Edit Text ==

When you open a text file, then the text editor loads the entire file into memory. So the original file is not changed until changes are saved.

Saving changes you can optionally keep the {{ide|Text Editor#Save an Edited File|backup copy}} of an original file.

While you edit a file, the IDE checks whether the file is changed externally. For example, let us open a text file. Then go to a '''S'''ource code '''C'''ontrol '''S'''ystem (SCS), for example, like Microsoft Visual SourceSafe. This SCS stores the master copy of the opened project. Let us get the latest version of some project files from the master copy in the SCS. When you return the focus into the IDE, it checks whether any of the opened text (and any other) files differ from their versions updated from the SCS. If the IDE detects such difference, then it display the warning dialog like this:

<vipbnf>The file "ExternallyChangedFileName"
has been modified outside the IDE text editor.
Do you want to reload the file or ignore external changes?</vipbnf>

The basic functions for moving around in texts and making simple edits follow the ordinary conventions of other Windows applications. So you can get started immediately. The more powerful editing commands are all on the menus, with their shortcuts shown against them, so you should be able to get up to speed quickly. Most of editing commands are in the pop-up menu, which can be activated with the right mouse button.

Any changes you make can be undone, and you can redo changes that you have undone. You can undo changes even after saving the changed file. However, notice that the undo buffer has the limited length.

'''Remember''' that, while loading the text from the selected file, the text editor converts all non-viewable symbols into space characters. Notice that the text editor will also save all such characters like space characters!

=== Insert Text ===

Text is entered at the cursor position (the insertion point). The location of the cursor can be set by the keyboard or the mouse.

The '''cursor''' (also known as the '''caret''') is the vertical line that indicates the insertion position for text. Contrast this with the '''mouse cursor''' that tracks the mouse position.

If any text is selected, it will be deleted before inserting the first character that you type.

To change to the '''Overwrite''' mode, where each typed character replaces the one at the cursor position, press the '''Insert''' key once. This will also change the '''Insert''' indicator on the status bar to '''Overwrite'''. Press the '''Insert''' key again, to switch back to the '''Insert''' mode.

=== Move in Text ===

The cursor is constrained to positions within the existing text only, it cannot be free placed anywhere in the document window outside of the existing text.

The following key combinations can be used to move the cursor:

'''Cursor Moving Operations'''
{|{{prettytable}}
|-
! To Move the Cursor:
! Press This Key:
|-
| To the mouse cursor position
| Mouse left button
|-
| To the beginning of the file
| '''Ctrl+Home'''
|-
| To the end of the file
| '''Ctrl+End'''
|-
| From the beginning of the line to the first non-space character in the line
| '''Ctrl+Right Arrow'''
|-
| To the left margin
| '''Home'''
|-
| To the end of the line
| '''End'''
|-
| Forward one character
| '''Right Arrow'''
|-
| Back one character
| '''Left Arrow'''
|-
| Down one line
| '''Down Arrow'''
|-
| Up one line
| '''Up Arrow'''
|-
| Forward to the end of the current word
| '''Ctrl+Right Arrow'''
|-
| Back to the end of the previous word
| '''Ctrl+Left Arrow'''
|-
| Scroll one page (window) up
| '''Page Up'''
|-
| Scroll one page (window) down
| '''Page Down'''
|-
| Scroll up and down
| Rotate the '''Mouse Roll'''
|-
| To a specified line number
| '''Ctrl+F2''' and fill in the number
|-
| To the '''Declaration''' of a pointed name (predicate, fact, domain, etc.)
| '''Ctrl+F12'''
|-
| To the '''Definition''' of a pointed name (to the '''C'''lauses of a pointed predicate)
| '''F12'''
|}

You can use the '''Shift''' key in conjunction with the keystrokes given in the table (excluding the three last items), to extend the selection.

=== Move Using Bookmarks ===

Sometimes you can wish to mark a line with a bookmark in order to be able to find this line quickly. The Visual Prolog text editor does not support this possibility directly. However, when the text editor is used inside the IDE, then it provides some kind of bookmarking on the base of breakpoints implemented in the Debugger.

'''How to Set Bookmarks'''

:Place the cursor in a line on which you wish to set a bookmark and press the '''F9''' key (you can also use the '''Breakpoint -> Toggle Breakpoint''' pop-up menu and the '''Debug | Toggle Breakpoint''' menu commands). Then in the beginning of this line the [[Image:Ide_db_BreakPoints_en.png]] breakpoint icon appears. In the text editor window status bar find the line number and remember it.

'''How to Retrieve Bookmarks'''

:Press the '''Ctrl+Alt+B''' key (or select the '''View | Breakpoints''' menu command). The '''Breakpoints''' window appears:
:[[Image:Ide_TE_Breakpoints.png]]
:In this window you see all breakpoints currently set in all files. Notice that breakpoints (bookmarks) will be seen even in closed files.

:To retrieve the desired bookmark in the text editor:
:# In the '''Breakpoints''' window select the correspondent breakpoint (using the breakpoint file name and the line number).
:# Double-click the breakpoint - the focus will be set into the text editor window with the file in which the breakpoint is set (this file will be opened in the text editor if needed) and the cursor will be positioned on the line on which the breakpoint is set. You can also click the right mouse button in the '''Breakpoints''' window. In the appeared pop-up menu select the '''Go to Source''' command:

:[[Image:Ide_TE_GoTo.png|center]]

'''How to Remove Bookmarks'''

:There are several ways to remove existing breakpoints (bookmarks):
:# When you in the text editor and the cursor is in the line marked with the breakpoint, simply press the '''F12''' key (you can also use the '''Breakpoint -> Toggle Breakpoint''' pop-up menu and the '''Debug | Toggle Breakpoint''' menu commands).
:# You can remove the selected breakpoint with the pop-up menu '''Remove''' command (you can also use the '''Breakpoints | Remove''' menu command).
:# You can remove all existing breakpoint with the pop-up menu '''Remove All''' command (you can also use the '''Breakpoints | Remove All''' menu command).

=== Move by "Go to ..." Commands ===

The '''Go to''' IDE menu contains several commands:

[[Image:Ide_TE_GoToCommands.png|center|frame|'''"Go to ..." commands''']]

These commands help you to fast navigation inside project text files. The target files can be as already opened in the text editor so still are not opened. Let us discuss these commands:

==== Go to Declaration ====

To use this command the cursor should be positioned on some name declared in the project. This name can be any predicate, fact, domain, constant, interface, or class name declared in the project (including declared in PFC packages used in the project).

Press the hot key combination '''Ctrl+F12''' (the '''Go to Declaration''' pop-up menu command, or the '''Go to | Go to Declaration''' menu command) and the cursor jumps onto declaration of this name. The correspondent source code file will be opened in the text editor (if it was not). If this name is declared in several scopes, then the dialog {{ide|IDE Dialogs#Resolve Ambiguity|'''Resolve Ambiguity'''}} displaying these scopes appears:

[[Image:Ide_TE_ResolveAmbiguity.png|center]]

and you will be able to select the required scope.

==== Go to Definition ====

To use this command the cursor should be positioned on a name of some predicate defined in the project.

Now press the key '''F12''' (the '''Go to Definition''' pop-up menu command, or the '''Go to | Go to Definition''' menu command) and the cursor jumps onto clauses defining this predicate. The correspondent source code file will be opened in the text editor (if it was not). If clauses defining this predicate explicitly exist in several scopes, then the dialog {{ide|IDE Dialogs#Resolve Ambiguity|'''Resolve Ambiguity'''}} displaying these scopes appears. Notice that only scopes explicitly containing text of clauses for the predicate are displayed.

==== Go To Related Files ====

Press the hot key combination '''Ctrl+R''' and the IDE will open the file which relates to the current file and place the cursor at the beginning of the file. If there is more than one file, which relate to the current file, then the dialog '''Related Files''' displaying these files appears:

[[Image:Ide_TE_RelatedFiles.png|center]]

The following file types of the same class relate to each other:
* Declaration of the class
* Implementation of the class
* Interface of the object, which is produced by the class
* Some resource files (e.g. GUI dialogs, windows and forms) that represent the object, which is produced by the class

==== Go to Resource Editor ====

To use this command you should be in a text editor window and the cursor should be placed at the valid resource identifier.

Press the hot key combination '''Ctrl+Shift+C''' and the IDE will open the resource file that is associated with the resource identifier at which the cursor is placed. The file would be opened in corresponding editor window.

==== Go to Line Number ====

To use this command you should be in a text editor window.
Now press the hot key combination '''Ctrl+F2''' (the '''Go to Line Number''' pop-up menu command, or the '''Go to | Go to Line Number''' menu command) and the small dialog '''Go to Line''' appears:

[[Image:Ide_TE_LineNumber.png|center]]

Type in the desired line number and the cursor jumps onto this line in the current text editor.

==== Go to Position on Clipboard ====

When a runtime error occurs in a Visual Prolog program, then the Visual Prolog exception handling system displays the '''Program Error''' dialog, which contains information about this runtime error. This information includes the short error description, the filename and the position of the predicate that raises the error.

The '''Program Error''' dialog contains the '''Copy to Clipboard''' button. Pressing this button you can place the filename and the error position onto the Windows system clipboard.

Now you can load the correspondent project into the IDE and press the '''Shift+F2''' hot key (or execute the IDE menu command '''Go to | Go to Position on Clipboard'''). Then the IDE opens the file that name was stored in the clipboard and places the cursor onto the error position stored in the clipboard.

==== Go to Error (Warning) ====
'''Go to Selected Error (Warning)'''

:When errors and/or warnings are generated while compiling project files, then their short descriptions, filenames, and positions are displayed in the '''Errors (Warnings)''' window.

:In the '''Errors (Warnings)''' window you can double-click some error, then the IDE opens the correspondent file and places the cursor onto the position of this error/warning message. The same action is accepted if you first select some error and then press '''Enter''' (or execute the '''Go to Code''' pop-up menu command).

'''Go to Next Error (Warning)'''

:In the '''Errors (Warnings)''' window you can select one of this error/warning messages. (If you do not make such selection, then the first error/warning message is accepted as the selected.) Then you can go into any other IDE window, make some actions, and then press the '''F8''' hot key (or execute the IDE menu command '''Go to | Go to Next Error (Warning)'''). The IDE opens the correspondent file and places the cursor onto the position of the error/warning message next to the current.

'''Go to Previous Error (Warning)'''

:Similarly, when you press the '''Shift+F8''' hot key (or execute the IDE menu command '''Go to | Go to Previous Error (Warning)'''). The IDE opens the correspondent file and place the cursor onto the position of the error/warning message previous to the current.

=== Select Text ===

Text is always selected as a stream of consecutive characters.
* You can select any text with the mouse:
*# Press and hold the left mouse button at the start of the text you want to select. Then drag the cursor to the end of the selection, and release the button.
*# Click the left mouse button at the start of the selection. Hold the '''Shift''' key down and click the left button at the end of the selection.
* You can select any text using the keyboard:
*:Use any of the cursor motion keys (see the table '''Cursor Moving Operations''' above) to move the cursor to the start of the text you want to select. Then press and hold the '''Shift''' key down while using the motion keys to move the cursor to the end of the selection.
* You can select the whole edited text:
*:Choose the '''Edit | Select All''' menu command or press '''Ctrl+A'''.
* You can cancel a selection pressing '''Esc'''.

=== Drag and Drop ===

* To move a selected text:
*:Hold the '''Left''' mouse button down insider the selection. Drag the mouse cursor to the new location (you will see that the shape of the mouse pointer changes). Release the '''Left''' button.
* To copy a selected text:
*:Hold the '''Ctrl+Left''' mouse button down in the selection. Drag the mouse cursor to the new location (you will see that the shape of the mouse pointer changes). Release the '''Left''' button.

=== Delete Text ===

You can delete parts of an edited text with the following actions:
{|{{prettytable}}
|-
! To Delete This:
! Do This:
|-
| Selected piece of text
| '''Delete''' or '''Backspace'''
|-
| The next character
| '''Delete'''
|-
| The previous character
| '''Backspace'''
|-
| Till the end of the current word
| '''Ctrl+Delete''' or '''Delete -> Delete Word Right''' pop-up menu command
|-
| Back to the last start of the word
| '''Ctrl+Backspace''' or '''Delete -> Delete Word Left''' pop-up menu command
|-
| The current line
| '''Ctrl+Y''' or '''Delete -> Delete Line''' pop-up menu command
|-
| To the end of the line
| '''Delete -> Delete Line''' pop-up menu command
|-
| The current word
|Double-click a word to select it and '''Delete''' or '''Backspace'''
|-
| The whole document
| '''Ctrl+A''' to select the whole text and '''Delete''' or '''Backspace'''
|}

=== Use Clipboard ===

The Windows clipboard can be used to copy text fragments as inside the text editor so to exchange text fragments with external text editors/viewers.

The following clipboard commands are accessible from the text editor pop-up context menu, from the '''Edit''' submenu, and from the toolbar:

* '''Cut''' command
*:Hot key: '''Ctrl+X''' or '''Shift+Del'''.
*:'''Edit | Cut''' or '''Cut''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Cut.png]]
*:This command is enabled only when some text fragment is selected. Use this command to remove the selected text and place it on the clipboard. Cutting text to the clipboard replaces any text previously stored in the clipboard.
* '''Copy''' command
*:Hot key: '''Ctrl+C''' or '''Ctrl+Insert'''.
*:'''Edit | Copy''' or '''Copy''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Copy.png]]
*:This command is enabled only when some text fragment is selected. Use this command to copy the selected text on the clipboard. Copying text to the clipboard replaces any text previously stored in the clipboard.
* '''Paste''' command
*:Hot key: '''Ctrl+V''' or '''Shift+Ins'''.
*:'''Edit | Paste''' or '''Paste''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Paste.png]]
*:This command places a copy of the clipboard contents at the insertion point. It is unavailable if the clipboard is empty. Notice that the editor converts all non-viewable symbols from the clipboard contents into space characters.
*:If there is a selected block in an active text editor, then the '''Paste''' command replaces the selected block with the contents of the clipboard text buffer.

Remember that the clipboard contents is the same for all windows in all applications opened in the Windows session.

=== Change Case ===

You can use the following commands to change case of selected text fragments:
* Change all selected letters to '''UPPER''' case:
*:'''Edit | Upper Case''' or '''Ctrl+Shift+U'''.
* Change all selected letters to '''lower''' case:
*:'''Edit | Lower Case''' or '''Ctrl+U'''.
* Invert case of each character:
*:'''Edit | Toggle Case''' or '''Ctrl+Alt+U'''.

== Find Text ==

You can use the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog to find each occurrence of any character combination (including uppercase and lowercase characters, whole words or parts of words, using regular expression, etc.) in the file being edited.

You can activate the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog with the '''Ctrl+F''' hot key, or the '''Find''' pop-up menu command, or the '''Edit | Find''' menu command.

When you press the '''Find''' button in the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog, the dialog is closed and the text editor starts searching for the specified string (regular expression) with the specified options. If the text editor finds the string, it selects the found string (highlights) and displays the page containing the highlighted string.

If you wish to find the next occurrence of the specified string, then you can use the '''Find Next''' command. Just press '''F3''' key (use the '''Edit | Find Next''' menu command or the '''Find Next''' mouse pop-up menu command).

== Replace Text ==

You can use the {{ide|IDE Dialogs#Replace Text|'''Replace Text'''}} dialog to find and replace some occurrences of a text pattern in the file being edited.

You can activate the {{ide|IDE Dialogs#Replace Text|'''Replace Text'''}} dialog with the '''Ctrl+H''' hot key, or the '''Replace''' pop-up menu command, or the '''Edit | Replace''' menu command).

== Find Text in Several Files ==

You can use the {{ide|IDE Dialogs#Find Text in Files|'''Find in Files'''}} dialog to find each occurrence of any character combination (including uppercase and lowercase characters, whole words, or parts of words, or using regular expression) in a specified set of files.

You can activate the {{ide|IDE Dialogs#Find Text in Files|'''Find in Files'''}} dialog with the '''Ctrl+Shift+F''' hot key, or the '''Find in Files''' pop-up menu command, or the '''Edit | Find in Files''' menu command).

== Find Names Containing a Substring ==

You can use the {{ide|Code Experts#Source Browser|'''Source Browser'''}} to find in the project all Visual Prolog names (of some kind) containing some substring. For example, you can find all predicates, which names contain the <vp>"string"</vp> sub-part.

== Insert Known Names ==

When used in the IDE, the text editor provides some rather useful {{ide|Code Experts#Insert Commands|'''Insert'''}} menu commands:

[[Image:Ide_Insert_Commands.png|center|frame|'''Insert menu commands''']]

Using these commands one can easy insert declared in the project predicates, facts, domains, constants, etc. (with scopes in which these names are declared). Most of these commands use
{{ide|Code Experts#Source Browser|Browse information}} generated by the compiler. Therefore, in order to new declared names appear in the dialogs of the {{ide|Code Experts#Insert Commands|'''Insert'''}} menu commands, you need to compile the editing file using the '''Build | Compile''' (or '''Ctrl+F9''') or any other compilation command.

Ide/Text Editor

2013-05-17T13:25:28Z

GalinaTchekmareva:

{{ideNavbar|Text Editor}}

== About the Text Editor ==

The Visual Prolog '''Text Editor''' is used for creating and editing of any text files. However, the Visual Prolog text editor is specially oriented for editing Visual Prolog source code files from the IDE, for example, it supports color highlighting of Visual Prolog language syntax elements (keywords, variables, and other language elements). Also when the text editor is used in the IDE, it supports such Visual Prolog specific functions as '''{{ide|Text Editor#Go to Declaration|Go to Name Declaration}}''', '''{{ide|Text Editor#Go to Definition|Go to Name Definition}}''', '''{{ide|Text Editor#Insert Known Names|Insert Interface}}''', '''Insert Class''', '''Insert Predicate''', etc.

The text editor supports: undo/redo features (standard restriction is 512 steps), search, replace, changing case of letters, cut, copy, and paste operations with the clipboard, and drag and drop for quick block movements with the mouse, etc.

Programmers can create the Visual Prolog '''Text Editor''' in their applications using the '''pfc\gui\controls\sciLexer package'''.

The most often used text editor commands have hot keys or can be called with the right mouse button pop-up context menu.

== Getting Assistance ==

Press '''F1''' (or the [[Image:Ide_TE_Help.png]] button in the toolbar or the '''Help | Visual Prolog Help''' command) when the input focus is in any text editor window to display this help information.

== Set the Editor Options ==

Text editor options are grouped in the {{ide|Options|Options}} dialog.

== How to Work with Files ==

=== Create a New Text File ===

Execute the '''File | New...''' command (or '''Ctrl+N''', or click the [[Image:Ide_TE_New.png]] toolbar button) to open the '''Create Project Item''' dialog. In the left pane of this dialog select '''Text File'''. For more detailed description see {{ide|Creating new Project Items#Creating a Text File|New Text File Creation}}.

=== Open an Existing File ===

There are several ways to open existing text files:

* Using the standard '''File Open''' dialog box. To activate it you can use the '''File | Open''' command, or the '''Ctrl+O''' hot key, or clicking the [[Image:Ide_TE_Open.png]] toolbar button.
* Clicking a text file in the {{ide|Project Tree|project tree}} in the '''Project''' window.
* The IDE keeps tracking of text files you last worked on. You can quickly open one of them by selecting it from the list at the bottom of the '''File''' menu.
You can have many files opened in text editor windows simultaneously. The '''Open''' command does not close any already opened text editor windows. The Visual Prolog IDE is restricted to editing a single version of anyone file; therefore, if you try to open an already edited file, then the IDE simply sets the focus into the editor window with this file.

Notice that the text editor can open both UNICODE and DOS character set text files. When it saves files that had DOS character set (before they were opened), then they are saved with the DOS character set. The same for UNICODE files.

=== Save an Edited File ===

There are several ways to save a text file being edited:
* Using the '''File | Save''' command, or the '''F2''' hot key, or clicking the [[Image:Ide_TE_Save.png]] toolbar button.
* Notice that all modified text files are ALWAYS saved before the IDE compiles them.

=== Save a File under Different Name ===

Use the '''File | Save as ...''' menu command.

=== Print an Edited File ===

Use the '''File | Print''' menu command to print the currently edited file. The standard Windows '''Print''' dialog appears. In it you can select some printing options.

== How to Edit Text ==

When you open a text file, then the text editor loads the entire file into memory. So the original file is not changed until changes are saved.

Saving changes you can optionally keep the {{ide|Text Editor#Save an Edited File|backup copy}} of an original file.

While you edit a file, the IDE checks whether the file is changed externally. For example, let us open a text file. Then go to a '''S'''ource code '''C'''ontrol '''S'''ystem (SCS), for example, like Microsoft Visual SourceSafe. This SCS stores the master copy of the opened project. Let us get the latest version of some project files from the master copy in the SCS. When you return the focus into the IDE, it checks whether any of the opened text (and any other) files differ from their versions updated from the SCS. If the IDE detects such difference, then it display the warning dialog like this:

<vipbnf>The file "ExternallyChangedFileName"
has been modified outside the IDE text editor.
Do you want to reload the file or ignore external changes?</vipbnf>

The basic functions for moving around in texts and making simple edits follow the ordinary conventions of other Windows applications. So you can get started immediately. The more powerful editing commands are all on the menus, with their shortcuts shown against them, so you should be able to get up to speed quickly. Most of editing commands are in the pop-up menu, which can be activated with the right mouse button.

Any changes you make can be undone, and you can redo changes that you have undone. You can undo changes even after saving the changed file. However, notice that the undo buffer has the limited length.

'''Remember''' that, while loading the text from the selected file, the text editor converts all non-viewable symbols into space characters. Notice that the text editor will also save all such characters like space characters!

=== Insert Text ===

Text is entered at the cursor position (the insertion point). The location of the cursor can be set by the keyboard or the mouse.

The '''cursor''' (also known as the '''caret''') is the vertical line that indicates the insertion position for text. Contrast this with the '''mouse cursor''' that tracks the mouse position.

If any text is selected, it will be deleted before inserting the first character that you type.

To change to the '''Overwrite''' mode, where each typed character replaces the one at the cursor position, press the '''Insert''' key once. This will also change the '''Insert''' indicator on the status bar to '''Overwrite'''. Press the '''Insert''' key again, to switch back to the '''Insert''' mode.

=== Move in Text ===

The cursor is constrained to positions within the existing text only, it cannot be free placed anywhere in the document window outside of the existing text.

The following key combinations can be used to move the cursor:

'''Cursor Moving Operations'''
{|{{prettytable}}
|-
! To Move the Cursor:
! Press This Key:
|-
| To the mouse cursor position
| Mouse left button
|-
| To the beginning of the file
| '''Ctrl+Home'''
|-
| To the end of the file
| '''Ctrl+End'''
|-
| From the beginning of the line to the first non-space character in the line
| '''Ctrl+Right Arrow'''
|-
| To the left margin
| '''Home'''
|-
| To the end of the line
| '''End'''
|-
| Forward one character
| '''Right Arrow'''
|-
| Back one character
| '''Left Arrow'''
|-
| Down one line
| '''Down Arrow'''
|-
| Up one line
| '''Up Arrow'''
|-
| Forward to the end of the current word
| '''Ctrl+Right Arrow'''
|-
| Back to the end of the previous word
| '''Ctrl+Left Arrow'''
|-
| Scroll one page (window) up
| '''Page Up'''
|-
| Scroll one page (window) down
| '''Page Down'''
|-
| Scroll up and down
| Rotate the '''Mouse Roll'''
|-
| To a specified line number
| '''Ctrl+F2''' and fill in the number
|-
| To the '''Declaration''' of a pointed name (predicate, fact, domain, etc.)
| '''Ctrl+F12'''
|-
| To the '''Definition''' of a pointed name (to the '''C'''lauses of a pointed predicate)
| '''F12'''
|}

You can use the '''Shift''' key in conjunction with the keystrokes given in the table (excluding the three last items), to extend the selection.

=== Move Using Bookmarks ===

Sometimes you can wish to mark a line with a bookmark in order to be able to find this line quickly. The Visual Prolog text editor does not support this possibility directly. However, when the text editor is used inside the IDE, then it provides some kind of bookmarking on the base of breakpoints implemented in the Debugger.

'''How to Set Bookmarks'''

:Place the cursor in a line on which you wish to set a bookmark and press the '''F9''' key (you can also use the '''Breakpoint -> Toggle Breakpoint''' pop-up menu and the '''Debug | Toggle Breakpoint''' menu commands). Then in the beginning of this line the [[Image:Ide_db_BreakPoints_en.png]] breakpoint icon appears. In the text editor window status bar find the line number and remember it.

'''How to Retrieve Bookmarks'''

:Press the '''Ctrl+Alt+B''' key (or select the '''View | Breakpoints''' menu command). The '''Breakpoints''' window appears:
:[[Image:Ide_TE_Breakpoints.png]]
:In this window you see all breakpoints currently set in all files. Notice that breakpoints (bookmarks) will be seen even in closed files.

:To retrieve the desired bookmark in the text editor:
:# In the '''Breakpoints''' window select the correspondent breakpoint (using the breakpoint file name and the line number).
:# Double-click the breakpoint - the focus will be set into the text editor window with the file in which the breakpoint is set (this file will be opened in the text editor if needed) and the cursor will be positioned on the line on which the breakpoint is set. You can also click the right mouse button in the '''Breakpoints''' window. In the appeared pop-up menu select the '''Go to Source''' command:

:[[Image:Ide_TE_GoTo.png|center]]

'''How to Remove Bookmarks'''

:There are several ways to remove existing breakpoints (bookmarks):
:# When you in the text editor and the cursor is in the line marked with the breakpoint, simply press the '''F12''' key (you can also use the '''Breakpoint -> Toggle Breakpoint''' pop-up menu and the '''Debug | Toggle Breakpoint''' menu commands).
:# You can remove the selected breakpoint with the pop-up menu '''Remove''' command (you can also use the '''Breakpoints | Remove''' menu command).
:# You can remove all existing breakpoint with the pop-up menu '''Remove All''' command (you can also use the '''Breakpoints | Remove All''' menu command).

=== Move by "Go to ..." Commands ===

The '''Go to''' IDE menu contains several commands:

[[Image:Ide_TE_GoToCommands.png|center|frame|'''"Go to ..." commands''']]

These commands help you to fast navigation inside project text files. The target files can be as already opened in the text editor so still are not opened. Let us discuss these commands:

==== Go to Declaration ====

To use this command the cursor should be positioned on some name declared in the project. This name can be any predicate, fact, domain, constant, interface, or class name declared in the project (including declared in PFC packages used in the project).

Press the hot key combination '''Ctrl+F12''' (the '''Go to Declaration''' pop-up menu command, or the '''Go to | Go to Declaration''' menu command) and the cursor jumps onto declaration of this name. The correspondent source code file will be opened in the text editor (if it was not). If this name is declared in several scopes, then the dialog {{ide|IDE Dialogs#Resolve Ambiguity|'''Resolve Ambiguity'''}} displaying these scopes appears:

[[Image:Ide_TE_ResolveAmbiguity.png|center]]

and you will be able to select the required scope.

==== Go to Definition ====

To use this command the cursor should be positioned on a name of some predicate defined in the project.

Now press the key '''F12''' (the '''Go to Definition''' pop-up menu command, or the '''Go to | Go to Definition''' menu command) and the cursor jumps onto clauses defining this predicate. The correspondent source code file will be opened in the text editor (if it was not). If clauses defining this predicate explicitly exist in several scopes, then the dialog {{ide|IDE Dialogs#Resolve Ambiguity|'''Resolve Ambiguity'''}} displaying these scopes appears. Notice that only scopes explicitly containing text of clauses for the predicate are displayed.

==== Go To Related Files ====

Press the hot key combination '''Ctrl+R''' and the IDE will open the file which relates to the current file and place the cursor at the beginning of the file. If there is more than one file, which relate to the current file, then the dialog '''Related Files''' displaying these files appears:

[[Image:Ide_TE_RelatedFiles.png|center]]

The following file types of the same class relate to each other:
* Declaration of the class
* Implementation of the class
* Interface of the object, which is produced by the class
* Some resource files (e.g. GUI dialogs, windows and forms) that represent the object, which is produced by the class

==== Go to Resource Editor ====

To use this command you should be in a text editor window and the cursor should be placed at the valid resource identifier.

Press the hot key combination '''Ctrl+Shift+C''' and the IDE will open the resource file that is associated with the resource identifier at which the cursor is placed. The file would be opened in corresponding editor window.

==== Go to Line Number ====

To use this command you should be in a text editor window.
Now press the hot key combination '''Ctrl+F2''' (the '''Go to Line Number''' pop-up menu command, or the '''Go to | Go to Line Number''' menu command) and the small dialog '''Go to Line''' appears:

[[Image:Ide_TE_LineNumber.png|center]]

Type in the desired line number and the cursor jumps onto this line in the current text editor.

==== Go to Position on Clipboard ====

When a runtime error occurs in a Visual Prolog program, then the Visual Prolog exception handling system displays the '''Program Error''' dialog, which contains information about this runtime error. This information includes the short error description, the filename and the position of the predicate that raises the error.

The '''Program Error''' dialog contains the '''Copy to Clipboard''' button. Pressing this button you can place the filename and the error position onto the Windows system clipboard.

Now you can load the correspondent project into the IDE and press the '''Shift+F2''' hot key (or execute the IDE menu command '''Go to | Go to Position on Clipboard'''). Then the IDE opens the file that name was stored in the clipboard and places the cursor onto the error position stored in the clipboard.

==== Go to Error (Warning) ====
'''Go to Selected Error (Warning)'''

:When errors and/or warnings are generated while compiling project files, then their short descriptions, filenames, and positions are displayed in the '''Errors (Warnings)''' window.

:In the '''Errors (Warnings)''' window you can double-click some error, then the IDE opens the correspondent file and places the cursor onto the position of this error/warning message. The same action is accepted if you first select some error and then press '''Enter''' (or execute the '''Go to Code''' pop-up menu command).

'''Go to Next Error (Warning)'''

:In the '''Errors (Warnings)''' window you can select one of this error/warning messages. (If you do not make such selection, then the first error/warning message is accepted as the selected.) Then you can go into any other IDE window, make some actions, and then press the '''F8''' hot key (or execute the IDE menu command '''Go to | Go to Next Error (Warning)'''). The IDE opens the correspondent file and places the cursor onto the position of the error/warning message next to the current.

'''Go to Previous Error (Warning)'''

:Similarly, when you press the '''Shift+F8''' hot key (or execute the IDE menu command '''Go to | Go to Previous Error (Warning)'''). The IDE opens the correspondent file and place the cursor onto the position of the error/warning message previous to the current.

=== Select Text ===

Text is always selected as a stream of consecutive characters.
* You can select any text with the mouse:
*# Press and hold the left mouse button at the start of the text you want to select. Then drag the cursor to the end of the selection, and release the button.
*# Click the left mouse button at the start of the selection. Hold the '''Shift''' key down and click the left button at the end of the selection.
* You can select any text using the keyboard:
*:Use any of the cursor motion keys (see the table '''Cursor Moving Operations''' above) to move the cursor to the start of the text you want to select. Then press and hold the '''Shift''' key down while using the motion keys to move the cursor to the end of the selection.
* You can select the whole edited text:
*:Choose the '''Edit | Select All''' menu command or press '''Ctrl+A'''.
* You can cancel a selection pressing '''Esc'''.

=== Drag and Drop ===

* To move a selected text:
*:Hold the '''Left''' mouse button down insider the selection. Drag the mouse cursor to the new location (you will see that the shape of the mouse pointer changes). Release the '''Left''' button.
* To copy a selected text:
*:Hold the '''Ctrl+Left''' mouse button down in the selection. Drag the mouse cursor to the new location (you will see that the shape of the mouse pointer changes). Release the '''Left''' button.

=== Delete Text ===

You can delete parts of an edited text with the following actions:
{|{{prettytable}}
|-
! To Delete This:
! Do This:
|-
| Selected piece of text
| '''Delete''' or '''Backspace'''
|-
| The next character
| '''Delete'''
|-
| The previous character
| '''Backspace'''
|-
| Till the end of the current word
| '''Ctrl+Delete''' or '''Delete -> Delete Word Right''' pop-up menu command
|-
| Back to the last start of the word
| '''Ctrl+Backspace''' or '''Delete -> Delete Word Left''' pop-up menu command
|-
| The current line
| '''Ctrl+Y''' or '''Delete -> Delete Line''' pop-up menu command
|-
| To the end of the line
| '''Delete -> Delete Line''' pop-up menu command
|-
| The current word
|Double-click a word to select it and '''Delete''' or '''Backspace'''
|-
| The whole document
| '''Ctrl+A''' to select the whole text and '''Delete''' or '''Backspace'''
|}

=== Use Clipboard ===

The Windows clipboard can be used to copy text fragments as inside the text editor so to exchange text fragments with external text editors/viewers.

The following clipboard commands are accessible from the text editor pop-up context menu, from the '''Edit''' submenu, and from the toolbar:

* '''Cut''' command
*:Hot key: '''Ctrl+X''' or '''Shift+Del'''.
*:'''Edit | Cut''' or '''Cut''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Cut.png]]
*:This command is enabled only when some text fragment is selected. Use this command to remove the selected text and place it on the clipboard. Cutting text to the clipboard replaces any text previously stored in the clipboard.
* '''Copy''' command
*:Hot key: '''Ctrl+C''' or '''Ctrl+Insert'''.
*:'''Edit | Copy''' or '''Copy''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Copy.png]]
*:This command is enabled only when some text fragment is selected. Use this command to copy the selected text on the clipboard. Copying text to the clipboard replaces any text previously stored in the clipboard.
* '''Paste''' command
*:Hot key: '''Ctrl+V''' or '''Shift+Ins'''.
*:'''Edit | Paste''' or '''Paste''' pop-up menu commands.
*:Toolbar: [[Image:Ide_TE_Paste.png]]
*:This command places a copy of the clipboard contents at the insertion point. It is unavailable if the clipboard is empty. Notice that the editor converts all non-viewable symbols from the clipboard contents into space characters.
*:If there is a selected block in an active text editor, then the '''Paste''' command replaces the selected block with the contents of the clipboard text buffer.

Remember that the clipboard contents is the same for all windows in all applications opened in the Windows session.

=== Change Case ===

You can use the following commands to change case of selected text fragments:
* Change all selected letters to '''UPPER''' case:
*:'''Edit | Upper Case''' or '''Ctrl+Shift+U'''.
* Change all selected letters to '''lower''' case:
*:'''Edit | Lower Case''' or '''Ctrl+U'''.
* Invert case of each character:
*:'''Edit | Toggle Case''' or '''Ctrl+Alt+U'''.

== Find Text ==

You can use the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog to find each occurrence of any character combination (including uppercase and lowercase characters, whole words or parts of words, using regular expression, etc.) in the file being edited.

You can activate the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog with the '''Ctrl+F''' hot key, or the '''Find''' pop-up menu command, or the '''Edit | Find''' menu command.

When you press the '''Find''' button in the {{ide|IDE Dialogs#Find Text|'''Find Text'''}} dialog, the dialog is closed and the text editor starts searching for the specified string (regular expression) with the specified options. If the text editor finds the string, it selects the found string (highlights) and displays the page containing the highlighted string.

If you wish to find the next occurrence of the specified string, then you can use the '''Find Next''' command. Just press '''F3''' key (use the '''Edit | Find Next''' menu command or the '''Find Next''' mouse pop-up menu command).

== Replace Text ==

You can use the {{ide|IDE Dialogs#Replace Text|'''Replace Text'''}} dialog to find and replace some occurrences of a text pattern in the file being edited.

You can activate the {{ide|IDE Dialogs#Replace Text|'''Replace Text'''}} dialog with the '''Ctrl+H''' hot key, or the '''Replace''' pop-up menu command, or the '''Edit | Replace''' menu command).

== Find Text in Several Files ==

You can use the {{ide|IDE Dialogs#Find Text in Files|'''Find in Files'''}} dialog to find each occurrence of any character combination (including uppercase and lowercase characters, whole words, or parts of words, or using regular expression) in a specified set of files.

You can activate the {{ide|IDE Dialogs#Find Text in Files|'''Find in Files'''}} dialog with the '''Ctrl+Shift+F''' hot key, or the '''Find in Files''' pop-up menu command, or the '''Edit | Find in Files''' menu command).

== Find Names Containing a Substring ==

You can use the {{ide|Code Experts#Source Browser|'''Source Browser'''}} to find in the project all Visual Prolog names (of some kind) containing some substring. For example, you can find all predicates, which names contain the <vp>"string"</vp> sub-part.

== Insert Known Names ==

When used in the IDE, the text editor provides some rather useful {{ide|Code Experts#Insert Commands|'''Insert'''}} menu commands:

[[Image:Ide_Insert_Commands.png|center|frame|'''Insert menu commands''']]

Using these commands one can easy insert declared in the project predicates, facts, domains, constants, etc. (with scopes in which these names are declared). Most of these commands use
{{ide|Code Experts#Source Browser|Source Browser}} generated by the compiler. Therefore, in order to new declared names appear in the dialogs of the {{ide|Code Experts#Insert Commands|'''Insert'''}} menu commands, you need to compile the editing file using the '''Build | Compile''' (or '''Ctrl+F9''') or any other compilation command.

Ide/IDE Dialogs

2013-05-17T12:59:04Z

GalinaTchekmareva:

{{ideNavbar|IDE Dialogs}}

=== Warning: These files will be overwritten ===

When you create a new project with the IDE {{ide|Project Settings#General Tab|Project Settings}} facility, you can specify the '''Subdirectory''' in which the project will be placed (notice that usually this name is generated automatically from the specified project name). Notice that each project contains several standard files (always automatically generated by the IDE) with standard names. Therefore, if the specified subdirectory name coincides with one in which a previously created project already exists, then these 2 projects should have several standard files with the same names. Because the old versions of these files can be incompatible with the new project, the {{ide|Project Settings#General Tab|Project Settings}} generates the warning dialog with the title:

'''These files will be overwritten:'''

In the central pane of this dialog you see a list of files which should be overwritten.

You can select the following actions:

'''Continue'''

If you select this button, then the old versions of files specified in the list will be overwritten with the new versions.

'''Cancel'''

If you select this button, then no files will be overwritten, the IDE returns into the {{ide|Project Settings#General Tab|Project Settings}} dialog where you can the specify other name in the '''Subdirectory''' control.

=== Resolve Ambiguity ===

This dialog appears when you execute the:

* '''Go to Declaration''' ('''Ctrl+Shift+D'''),
* '''Go to Definition''' ('''Ctrl+Shift+C'''), or
* '''Show Visual Prolog Help''' ('''F1''')

commands and the cursor points onto a "'''''name'''''", which has several versions of the "'''''name'''''" references in the generated {{ide|Code Experts#Source Browser|browse information}} and cannot resolve this ambiguity using all additional information about the "'''''name'''''", which The IDE can gather in the edited file.

Correspondently it have titles:

* '''Resolve Ambiguity of "''name''" Declaration'''
* '''Resolve Ambiguity of "''name''" Definition'''
* '''Choose "''name''" to Show Help Topic'''

These dialogs display lists of references to the "'''''name'''''" with additional information (gathered in the generated by the compiler {{ide|Code Experts#Source Browser|browse information}}, which helps you to resolve ambiguity of the "'''''name'''''".

Names are prefixed with the same {{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window.

To continue an initiated command execution you need to select (click) one of displayed lines containing unique references to the "'''''name'''''".

=== Send Bug Report to Support ===

Normally you should use '''Help | Send Bug Report...''' IDE command to send a bug report or feedback. You can also send a mail directly to the '''Visual Prolog Support Service'''.

'''About Visual Prolog Support Service'''

'''Visual Prolog Support''' is responsible for answering questions only about bugs and problems with using of Visual Prolog language, the IDE, and other tools and packages supplied in '''Commercial''' editions of Visual Prolog.

'''Guidelines for preparing Bug Reports to Visual Prolog Support'''
----

'''1. Please check the following information sources before submitting your E-mail:'''

* [http://www.visual-prolog.com/vip6/support/faq.htm Frequently Asked Questions]
* [http://kb.visual-prolog.com Visual Prolog Knowledge Base]

'''2. Please do not ask Visual Prolog Support about general problems like: "Visual Prolog and Fuzzy Logic?"'''

For things please use [http://discuss.visual-prolog.com/ Visual Prolog Discussion Forum], where you are free to discuss any question deals with Visual Prolog. Anybody can read the debate, but you need to register if you want to make postings.

Prolog Development Center will follow and participate as much as possible in the debates. But we cannot make any "answer guarantee"; this is mainly your forum.

This forum will receive all major announcements from Prolog Development Center.

'''3. Your message MUST contain information generated by "Help | Send Bug Report | Show Details" IDE command.'''

This information contains some parameters about your computer and your project that are useful for correct understanding of the problem. It should be copied to the mail.

'''4. How to write a message:'''

*'''To:'''
*:The address of Visual Prolog International Support Group is: '''support@visual-prolog.com'''
*'''Subject:'''
*:Use a short, precise, and relevant Subject (title line). Please, do not use subjects like: '''My 1st problem with Prolog'''
*'''Message Text:'''
*:One problem per message, please.
*:Here you should describe your problem as detailed and precise, as it is possible.
*:Please supply examples of code illustrating your problem.
*:The information supplied in your message should be sufficient to reproduce your problem on our computers.

Please follow the above guidelines when you E-mail Bug Reports to Visual Prolog Support.

Regards

The Visual Prolog International Support Group

support@visual-prolog.com

=== Replace Text ===

Using this dialog you can find and replace each or every occurrence of a text pattern (a string or a regular expression) in the edited file.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''New Text'''
:Type the replacement string, or ''regular replacement expression'' in the '''New Text''' box, or choose a previous string from the drop-down list. Notice that ''regular replacement expressions'' have limited syntax regarding to ''regular expressions'' used in the '''Text to Find''' patterns.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:*'''Entire Scope'''
:*:Defines that the string should be searched in all file.
:*'''From Cursor'''
:*:Defines that the string should be searched beginning from the current cursor position.
:*'''Selected Text'''
:*:Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:*'''Forward'''
:*:Search the document below the insertion point.
:*'''Backward'''
:*:Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:*'''Case Sensitive'''
:*:Find strings having the given pattern of uppercase and lowercase letters.
:*'''Whole Words Only'''
:*:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
:*'''Use Regular Expressions'''
:*:See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.
'''Replace'''
:Press the '''Replace''' button to replace the current selection or to invoke searching of the specified string (regular expression) with the specified options if there are no selection.
'''Find Next'''
:Press the '''Find''' button to invoke searching of the next occurrence of the specified string (regular expression) with the specified options.
'''Change All'''
:Press the '''Change All''' button to replace all occurrences of the search text, in the specified scope.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Find Text in Files ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions in the specified group of files.

[[Image:Ide_FindInFiles.png]]

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''Find in All Opened Editors'''
:Check this option if you wish that the IDE search the specified string only in that text files, which are currently opened in the IDE text editors.
'''Find in Project Files Only'''
:Check this option if you wish that the IDE search the specified string only in text files, which are parts of the project currently loaded into the IDE.
:This button is disabled when the project is not loaded.
'''Show Search Results in New Window'''
:If this option is checked ON, then the IDE will open new '''Search results''' window each time the search is completed, otherwise it will display search results in the same window.
'''In Files:'''
:In this list editor you can specify (or select from the list of previously used) the file mask which will be used to restrict files in which the IDE will search for the string. For example, you can use <vp>*</vp> operator to specify that any sub-string can be used instead of this operator.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''In Folder:'''
:In this list editor you can specify (or select from the list of previously used) the folder, which will be used to restrict files in which the IDE will search for the string.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Browse'''
:Press this button to open the '''Set New Directory''' dialog in which you can select the folder, which name will be inserted into the '''In Folder''' field.
: Notice that when '''Find in Project Files Only''' is checked ON, then this dialog will gives you access only to the folders known to the project.
:This button is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Search Subfolders'''
:When this option is checked ON (the default), then the IDE will search in all subfolders of the folder specified in the '''In Folder''' field.
:Otherwise, search will be only in the files directly in the folder specified in the '''In Folder''' field.
'''Whole Words Only'''
:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
'''Case Sensitive'''
:The selected item specifies whether the search should match case of the whole search string ('''Case Sensitive'''), ignore the case ('''Case Insensitive''') or match the case of the first character of the search string ('''Prolog Sensitive'''). The last option is unavailable, when '''Regular Expressions''' option is checked ON.

==== Regular Expressions ====

Provides possibility to perform advanced string searching operations (searching, matching and replacing) using regular expressions.

'''Regular Expressions '''
:A ''regular expression'' (or pattern) is a text string that describes some (mathematical) group of strings. A string <vp>S</vp> "matches" a regular expression <vp>R</vp> if <vp>S</vp> belongs to the set of strings described by <vp>R</vp>. Using regular expression, you can:
:* check whether the specified string matches the specified pattern;
:* search within a string for a substring matching the specified pattern;
:* perform replacing within matched substrings.
:Some regular expressions can match only one substring. That is, a set of strings such regular expression describes has only one member. For example, the regular expression '''foo''' matches only the substring '''foo''' and no others. Other regular expressions can match more than one substring. That is, a set of strings such regular expression describes has more than one member. For example, the regular expression <vp>f*</vp> matches the set of strings made up of any number (including zero) of '''f''' characters. Some characters in regular expressions match themselves (such as '''f''') and some do not match to any concrete character (such as <vp>*</vp>). Characters that do not match themselves are used to specify patterns, which describe sets of different strings.
'''Regular Expression Syntax'''
See the [pfc\regEx\packRegEx.htm regEx] package for more details of regular expression syntax.

'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Stop'''
:Press the '''Stop''' button to stop searching.
'''Help'''
:Displays this help topic.

==== Search results ====

[[Image:Ide_FindInFilesResults.png]]

This window displays the table which contains the names of files in which the specified string is found, the line number and the position, where the specified text is located and the content of the whole line.

If you double-click any filename, then this file will be opened in the text editor.

=== Find Text ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or regular expression, or choose a previous string from the drop-down list.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:'''Entire Scope'''
::Defines that the string should be searched in all file.
:'''From Cursor'''
::Defines that the string should be searched beginning from the current cursor position.
:'''Selected Text'''
::Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:'''Forward'''
::Search the document below the insertion point.
:'''Backward'''
::Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:'''Case Sensitive'''
::Find strings having the given pattern of uppercase and lowercase letters.
:'''Whole Words Only'''
::Find occurrences of the string as whole words.
:'''Use Regular Expressions'''
::See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.
'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Window Navigation Dialog ===

The order, in which '''Ctrl-TAB''' shifts between IDE windows, has been changed to visit most-recently-visited windows first.

Furthermore, '''Ctrl-TAB''' also brings up a navigation dialog listing all the open windows. The dialog stays up as long as Ctrl-key is pressed. In this dialog you can see the windows in the order they will be shifted to, but you can also choose a window directly using the mouse or the arrow keys. If you press letters the list will be filtered to windows starting with the letters you have pressed.

'''Ctrl-F1''' Help,

'''Ctrl-Del''' will close the selected window,

'''Ctrl-BackSpace''' removes the last letter,

'''Ctrl-Alt''' switches on/off showing only read-write files.

'''Ctrl-*''' switches on/off alternate filter by letter.

Ide/IDE Dialogs

2013-05-17T12:52:17Z

GalinaTchekmareva:

{{ideNavbar|IDE Dialogs}}

=== Warning: These files will be overwritten ===

When you create a new project with the IDE {{ide|Project Settings#General Tab|Project Settings}} facility, you can specify the '''Subdirectory''' in which the project will be placed (notice that usually this name is generated automatically from the specified project name). Notice that each project contains several standard files (always automatically generated by the IDE) with standard names. Therefore, if the specified subdirectory name coincides with one in which a previously created project already exists, then these 2 projects should have several standard files with the same names. Because the old versions of these files can be incompatible with the new project, the {{ide|Project Settings#General Tab|Project Settings}} generates the warning dialog with the title:

'''These files will be overwritten:'''

In the central pane of this dialog you see a list of files which should be overwritten.

You can select the following actions:

'''Continue'''

If you select this button, then the old versions of files specified in the list will be overwritten with the new versions.

'''Cancel'''

If you select this button, then no files will be overwritten, the IDE returns into the {{ide|Project Settings#General Tab|Project Settings}} dialog where you can the specify other name in the '''Subdirectory''' control.

=== Resolve Ambiguity ===

This dialog appears when you execute the:

* '''Go to Declaration''' ('''Ctrl+Shift+D'''),
* '''Go to Definition''' ('''Ctrl+Shift+C'''), or
* '''Show Visual Prolog Help''' ('''F1''')

commands and the cursor points onto a "'''''name'''''", which has several versions of the "'''''name'''''" references in the generated {{ide|Code Experts#Source Browser|browse information}} and cannot resolve this ambiguity using all additional information about the "'''''name'''''", which The IDE can gather in the edited file.

Correspondently it have titles:

* '''Resolve Ambiguity of "''name''" Declaration'''
* '''Resolve Ambiguity of "''name''" Definition'''
* '''Choose "''name''" to Show Help Topic'''

These dialogs display lists of references to the "'''''name'''''" with additional information (gathered in the generated by the compiler {{ide|Code Experts#Source Browser|browse information}}, which helps you to resolve ambiguity of the "'''''name'''''".

Names are prefixed with the same {{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window.

To continue an initiated command execution you need to select (click) one of displayed lines containing unique references to the "'''''name'''''".

=== Send Bug Report to Support ===

Normally you should use '''Help | Send Bug Report...''' IDE command to send a bug report or feedback. You can also send a mail directly to the '''Visual Prolog Support Service'''.

'''About Visual Prolog Support Service'''

'''Visual Prolog Support''' is responsible for answering questions only about bugs and problems with using of Visual Prolog language, the IDE, and other tools and packages supplied in '''Commercial''' editions of Visual Prolog.

'''Guidelines for preparing Bug Reports to Visual Prolog Support'''
----

'''1. Please check the following information sources before submitting your E-mail:'''

* [http://www.visual-prolog.com/vip6/support/faq.htm Frequently Asked Questions]
* [http://kb.visual-prolog.com Visual Prolog Knowledge Base]

'''2. Please do not ask Visual Prolog Support about general problems like: "Visual Prolog and Fuzzy Logic?"'''

For things please use [http://discuss.visual-prolog.com/ Visual Prolog Discussion Forum], where you are free to discuss any question deals with Visual Prolog. Anybody can read the debate, but you need to register if you want to make postings.

Prolog Development Center will follow and participate as much as possible in the debates. But we cannot make any "answer guarantee"; this is mainly your forum.

This forum will receive all major announcements from Prolog Development Center.

'''3. Your message MUST contain information generated by "Help | Send Bug Report | Show Details" IDE command.'''

This information contains some parameters about your computer and your project that are useful for correct understanding of the problem. It should be copied to the mail.

'''4. How to write a message:'''

*'''To:'''
*:The address of Visual Prolog International Support Group is: '''support@visual-prolog.com'''
*'''Subject:'''
*:Use a short, precise, and relevant Subject (title line). Please, do not use subjects like: '''My 1st problem with Prolog'''
*'''Message Text:'''
*:One problem per message, please.
*:Here you should describe your problem as detailed and precise, as it is possible.
*:Please supply examples of code illustrating your problem.
*:The information supplied in your message should be sufficient to reproduce your problem on our computers.

Please follow the above guidelines when you E-mail Bug Reports to Visual Prolog Support.

Regards

The Visual Prolog International Support Group

support@visual-prolog.com

=== Replace Text ===

Using this dialog you can find and replace each or every occurrence of a text pattern (a string or a regular expression) in the edited file.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''New Text'''
:Type the replacement string, or ''regular replacement expression'' in the '''New Text''' box, or choose a previous string from the drop-down list. Notice that ''regular replacement expressions'' have limited syntax regarding to ''regular expressions'' used in the '''Text to Find''' patterns.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:*'''Entire Scope'''
:*:Defines that the string should be searched in all file.
:*'''From Cursor'''
:*:Defines that the string should be searched beginning from the current cursor position.
:*'''Selected Text'''
:*:Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:*'''Forward'''
:*:Search the document below the insertion point.
:*'''Backward'''
:*:Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:*'''Case Sensitive'''
:*:Find strings having the given pattern of uppercase and lowercase letters.
:*'''Whole Words Only'''
:*:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
:*'''Use Regular Expressions'''
:*:See [Find_Text_in_Files.htm #Regular_Expressions2 Regular Expressions] for details.
'''Replace'''
:Press the '''Replace''' button to replace the current selection or to invoke searching of the specified string (regular expression) with the specified options if there are no selection.
'''Find Next'''
:Press the '''Find''' button to invoke searching of the next occurrence of the specified string (regular expression) with the specified options.
'''Change All'''
:Press the '''Change All''' button to replace all occurrences of the search text, in the specified scope.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Find Text in Files ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions in the specified group of files.

[[Image:Ide_FindInFiles.png]]

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or ''regular expression'', or choose a previous string from the drop-down list.
'''Find in All Opened Editors'''
:Check this option if you wish that the IDE search the specified string only in that text files, which are currently opened in the IDE text editors.
'''Find in Project Files Only'''
:Check this option if you wish that the IDE search the specified string only in text files, which are parts of the project currently loaded into the IDE.
:This button is disabled when the project is not loaded.
'''Show Search Results in New Window'''
:If this option is checked ON, then the IDE will open new '''Search results''' window each time the search is completed, otherwise it will display search results in the same window.
'''In Files:'''
:In this list editor you can specify (or select from the list of previously used) the file mask which will be used to restrict files in which the IDE will search for the string. For example, you can use <vp>*</vp> operator to specify that any sub-string can be used instead of this operator.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''In Folder:'''
:In this list editor you can specify (or select from the list of previously used) the folder, which will be used to restrict files in which the IDE will search for the string.
:This option is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Browse'''
:Press this button to open the '''Set New Directory''' dialog in which you can select the folder, which name will be inserted into the '''In Folder''' field.
: Notice that when '''Find in Project Files Only''' is checked ON, then this dialog will gives you access only to the folders known to the project.
:This button is disabled when the '''Find in All Opened Editors''' option is checked ON.
'''Search Subfolders'''
:When this option is checked ON (the default), then the IDE will search in all subfolders of the folder specified in the '''In Folder''' field.
:Otherwise, search will be only in the files directly in the folder specified in the '''In Folder''' field.
'''Whole Words Only'''
:Find occurrences of the string as whole words. It only displays instances of the Find what string that are matched in complete words. For example, a search for "my::List" will return "my::List" but not "cmy::List" or "my::Listtt".
'''Case Sensitive'''
:The selected item specifies whether the search should match case of the whole search string ('''Case Sensitive'''), ignore the case ('''Case Insensitive''') or match the case of the first character of the search string ('''Prolog Sensitive'''). The last option is unavailable, when '''Regular Expressions''' option is checked ON.

==== Regular Expressions ====

Provides possibility to perform advanced string searching operations (searching, matching and replacing) using regular expressions.

'''Regular Expressions '''
:A ''regular expression'' (or pattern) is a text string that describes some (mathematical) group of strings. A string <vp>S</vp> "matches" a regular expression <vp>R</vp> if <vp>S</vp> belongs to the set of strings described by <vp>R</vp>. Using regular expression, you can:
:* check whether the specified string matches the specified pattern;
:* search within a string for a substring matching the specified pattern;
:* perform replacing within matched substrings.
:Some regular expressions can match only one substring. That is, a set of strings such regular expression describes has only one member. For example, the regular expression '''foo''' matches only the substring '''foo''' and no others. Other regular expressions can match more than one substring. That is, a set of strings such regular expression describes has more than one member. For example, the regular expression <vp>f*</vp> matches the set of strings made up of any number (including zero) of '''f''' characters. Some characters in regular expressions match themselves (such as '''f''') and some do not match to any concrete character (such as <vp>*</vp>). Characters that do not match themselves are used to specify patterns, which describe sets of different strings.
'''Regular Expression Syntax'''
See the [pfc\regEx\packRegEx.htm regEx] package for more details of regular expression syntax.

'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Stop'''
:Press the '''Stop''' button to stop searching.
'''Help'''
:Displays this help topic.

==== Search results ====

[[Image:Ide_FindInFilesResults.png]]

This window displays the table which contains the names of files in which the specified string is found, the line number and the position, where the specified text is located and the content of the whole line.

If you double-click any filename, then this file will be opened in the text editor.

=== Find Text ===

Using this dialog you can find each occurrence of a combination of any characters, including uppercase and lowercase characters, whole words, or parts of words, or regular expressions.

'''Text to Find'''
:In the '''Text to Find''' box, type in the search string, or regular expression, or choose a previous string from the drop-down list.
'''Origin'''
:Options in the '''Origin''' group box defines the file scope in which the string should be searched.
:'''Entire Scope'''
::Defines that the string should be searched in all file.
:'''From Cursor'''
::Defines that the string should be searched beginning from the current cursor position.
:'''Selected Text'''
::Defines that the string should be searched only in the selected piece of the edited text.
'''Direction'''
:Options in the '''Direction''' group box defines the direction in which the string should be searched.
:'''Forward'''
::Search the document below the insertion point.
:'''Backward'''
::Search the document above the insertion point.
'''Options'''
:In this group box you defines the search options.
:'''Case Sensitive'''
::Find strings having the given pattern of uppercase and lowercase letters.
:'''Whole Words Only'''
::Find occurrences of the string as whole words.
:'''Use Regular Expressions'''
::See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.
'''Find'''
:Press the '''Find''' button to invoke searching of the specified string (regular expression) with the specified options.
'''Close'''
:Close this dialog.
'''Help'''
:Displays this help topic.

=== Window Navigation Dialog ===

The order, in which '''Ctrl-TAB''' shifts between IDE windows, has been changed to visit most-recently-visited windows first.

Furthermore, '''Ctrl-TAB''' also brings up a navigation dialog listing all the open windows. The dialog stays up as long as Ctrl-key is pressed. In this dialog you can see the windows in the order they will be shifted to, but you can also choose a window directly using the mouse or the arrow keys. If you press letters the list will be filtered to windows starting with the letters you have pressed.

'''Ctrl-F1''' Help,

'''Ctrl-Del''' will close the selected window,

'''Ctrl-BackSpace''' removes the last letter,

'''Ctrl-Alt''' switches on/off showing only read-write files.

'''Ctrl-*''' switches on/off alternate filter by letter.

Ide/Resource Editor/Editing a Toolbar

2013-05-17T10:11:54Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
To edit a toolbar, double-click (or press '''Enter''') the name of a file with a toolbar description in the project tree in the '''Project''' window's list of project files. The '''Toolbar Editor''' window appears and you can create whatever form of a toolbar you wish.

[[Image:Ide_ToolbarEditor.png|center|frame|The '''Toolbar Editor''']]

In the top of the picture you see edited toolbar ('''ProjectToolbar''' in the picture).

==== Controls Toolbar in the Toolbar Editor ====

In the bottom of the previous picture you see the '''Controls''' toolbar. Using the '''Controls''' toolbar you can easily add desired controls into the edited toolbar.

There are the Controls toolbar commands inserting the following kinds of controls into toolbars:

{|{{prettytable}}
|-
| [[Image:Ide_Ctrl_PushBtn.png]]
! Push Button
| Enables inserting of the '''push button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_PushBtn.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_CheckBx.png]]
! Check Button
| Enables inserting of the '''check button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_CheckBx.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_StaText.png]]
! Static Text
| Enables inserting of the '''static text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_StaText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. In this dialog you can specify the '''Initial Text''' that will be displayed in the control. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_TB_ContextText.png]]
! Context Sensitive Text
| Enables inserting of the '''context sensitive text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_TB_ContextText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_ListBtn.png]]
! List Button
| Enables inserting of the '''list button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_ListBtn.png]], the {{ide|Resource Editor#Text Control Attributes|List Button Attributes}} dialog appears. Press the '''OK''' button to create the control. List buttons can be used to select one item from a list of possible values.
|-
| [[Image:Ide_TB_Separator.png]]
! Separator
| Enables inserting of a '''separator''' into the edited toolbar. Click inside the toolbar to specify the place where the '''separator''' should be inserted, press on the button [[Image:Ide_TB_Separator.png]], the '''separator''' will be inserted. The separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| [[Image:Ide_TB_NewRow.png]]
! New Row
| Enables inserting of a '''new row''' into the edited toolbar. Click inside the toolbar to specify the place where the '''new row''' should start, press on the button [[Image:Ide_TB_NewRow.png]], the '''new row''' will be created. Notice that the '''new rows''' are relevant only for toolbars with the styles ''Inside'' and ''Movable''. A '''new row''' control will cause breaking of the current line, the following controls appear on the next line.
|}

==== Control Types Used in Toolbars ====

In the lower part of the previous picture we see the
{{ide|Resource Editor#Controls Toolbar in the Toolbar Editor|'''Controls toolbar'''}} toolbar, which contains all kinds of controls that can be used in toolbars.

{|{{prettytable}}
|-
! width="30%"|Control
! width="70%"|Description
|-
| '''Push Button'''
| This is a standard push button. When pressed it sends an <vp>vpiDomains::e_Menu</vp> event to the parent window. The bitmap must be registered for the button.
|-
| '''Check Button'''
| This is used to indicate the state of a property that can have two states; either checked or unchecked. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_CheckBox,_,_)</vp> event to the parent window. You must register a bitmap for a check button.
|-
| '''List Button'''
| A list button can be used to select one item from a number of values. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_LBoxButton,_,_)</vp> event to the parent window.
|-
| '''Static Text'''
| Text may be placed in this control initially and also dynamically. A '''Static Text''' is often used for titles.
|-
| '''Context Sensitive Text'''
| If a Context Sensitive Text field is put into the toolbar, this field will display help information about the control the mouse is currently located over.
|-
| '''Separator'''
| A separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| '''New Row'''
| New row is relevant only for toolbars with the styles '''Inside''' and '''Movable'''. A New Row control will cause the current line to break, and the following controls to appear on the next line of the toolbar.
|}

==== Toolbar Layout Editing ====

The layout of the toolbar can be done both with the keyboard, and with the mouse. There is an insertion point that is marked with a colored bar. This insertion point can be moved with the arrow keys, or by clicking the mouse on the new location. When the insertion bar is at a given location, the control to the right of the bar can be deleted by pressing the '''Delete''' key, the control to the left can be deleted by pressing the '''Backspace''' key.

To place a new control at the insertion point:

* select an item from the '''Controls''' menu or
* choose a control from the ones shown in the '''Controls''' floating dialog or
* click the right mouse button anywhere in the Toolbars Editor window area outside the toolbar to display a pop up from which a desired control can be selected.

==== Attributes of Toolbar Controls ====

After a control is inserted, it is possible to change the control attributes. Just double-click the control.

===== Push and Check Button Attributes =====

Double-click a Push button or a Check button calls the '''Button Attributes''' dialog.

[[Image:Ide_Toolbar_ButtonAttributes.png|center]]
<center>'''Specifying properties of push buttons and check buttons'''</center>

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the button control. This is the constant that will be used in the <vp>vpiDomains::e_Menu</vp> events. Therefore, it is recommended to use the same constant as is used for the menu item correspondent to the same command.

The '''Constant''' input box is where you can select or type in the symbolic constant that will be used as the control identifier. It can be input directly from the keyboard or selected from the list of available constants (by clicking the [[Image:Ide_ListButton_Button.png]] button). It must be either a legal symbolic constant (for example, '''''idt_file_open''''' ) or an integer value.

If you enter a symbolic constant, then the IDE automatically places this symbolic constant into the '''resourceidentifiers.i''' file and generates an appropriate integer value for it. The '''Toolbar Editor''' automatically generates the default symbolic constants (for example, '''''idt_7''''' from the ''toolbar constant prefix'' '''''idt_''''' and the number of this control in the toolbar.
|-
| '''Status Text'''
|The string entered into this field can consist from 2 sub-strings separated by a semicolon. The sub-string specified before the semicolon (if specified) is used as the button Tool Tip text. The sub-string specified after the semicolon (or if the semicolon is not specified) will be displayed in the '''Context Sensitive Text''' field (when the mouse cursor is positioned over this button).

For example, the text '''''New;New file''''' will cause '''New''' to be shown in the yellow tool tip while '''New file''' will be shown in a context sensitive field when the mouse is over the button.
|-
|'''Checked'''
|If this check box is checked than the button initial state is "pressed" and the icon shaped as ''pressed'' is initially displayed. Otherwise the button initial state is "released" and the icon shaped as ''released'' is displayed.
|-
|'''Disabled'''
|If this check box is checked then the button initially does not accept a user input and is grayed. Otherwise the button is initially enabled (accepts a user input) and has initial state specified by the '''Checked''' check box.
|-
|'''Push Button''' or '''Check Button'''
|Select the appropriate button style ('''Push Button''' or '''Check Button'''). The style can be changed at any time. At runtime the state (''pressed'' or ''released'') of a check button can be switched by clicking the check button.
|-
|'''Bitmap Name'''
|This bitmap will be used to display a button. This bitmap should be selected from the list of bitmaps registered in the '''Project''' window (by clicking the [[Image:_Ide_ListButton_Button.png]] button). Before a bitmap name will appear in the registered bitmap list, it should be registered in the project with the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').

In Visual Prolog v.7 we use a single bitmap for each button and automatically draw different state ornamentations for the ''released'' state, the ''pressed'' state, and the ''disabled'' state of the button.
|-
|'''Edit'''
|If the '''Edit''' button is pressed, then the {{ide|Resource Editor#Graphics Editor|'''Graphics Editor'''}} will come up with the given bitmap allowing you to view and edit the bitmap.
|}

===== Text Control Attributes =====

Double-clicking a Static Text or a Context Sensitive Text control calls the '''Text Attributes''' dialog:

[[Image:Ide_Toolbar_TextControl.png|center|frame|'''Specifying properties of text controls in a toolbar''']]

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the Text control.
|-
| '''Initial Text'''
| The default text to display in the field.
|-
| '''Static''' or '''Context Sensitive'''
| Select the appropriate text control type. The style can be changed at any time.
|-
| '''Font '''
| Select a font name, font style (Normal, Bold, Italic ...), and font size for the displayed text.
|-
| '''Text Width'''
| Determines a width in pixels of the Text control field. It can be entered manually or, by pushing the '''"<nowiki>|</nowiki><---Text---><nowiki>|</nowiki>"''' button. In this case the width of the field will be optimized to display the '''Initial Text''' with the selected Font.
|-
| '''Foreground Color'''
| Select the Foreground Color for the displayed text.
|}

===== List Button Attributes =====

Double-clicking a List Button control calls the '''List Button Attributes''' dialog.

[[Image:Ide_Toolbar_ListButtonAttributes.png|center]]
<center>'''Specifying properties of list buttons in a toolbar'''</center>

Only two parameters can be set for a list button in a toolbar:

{|{{prettytable}}
|-
| width="30%"|'''Constant '''
| width="70%"|A constant name to identify the List Button control.
|-
| '''Width '''
| Determines the width in pixels of the List Button control field.
|}

Ide/Resource Editor/Editing a Toolbar

2013-05-17T10:03:11Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
To edit a toolbar, double-click (or press '''Enter''') the name of a file with a toolbar description in the project tree in the '''Project''' window's list of project files. The '''Toolbar Editor''' window appears and you can create whatever form of a toolbar you wish.

[[Image:Ide_ToolbarEditor.png|center|frame|The '''Toolbar Editor''']]

In the top of the picture you see edited toolbar ('''ProjectToolbar''' in the picture).

==== Controls Toolbar ====

In the bottom of the previous picture you see the '''Controls''' toolbar. Using the '''Controls''' toolbar you can easily add desired controls into the edited toolbar.

There are the Controls toolbar commands inserting the following kinds of controls into toolbars:

{|{{prettytable}}
|-
| [[Image:Ide_Ctrl_PushBtn.png]]
! Push Button
| Enables inserting of the '''push button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_PushBtn.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_CheckBx.png]]
! Check Button
| Enables inserting of the '''check button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_CheckBx.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_StaText.png]]
! Static Text
| Enables inserting of the '''static text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_StaText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. In this dialog you can specify the '''Initial Text''' that will be displayed in the control. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_TB_ContextText.png]]
! Context Sensitive Text
| Enables inserting of the '''context sensitive text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_TB_ContextText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_ListBtn.png]]
! List Button
| Enables inserting of the '''list button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_ListBtn.png]], the {{ide|Resource Editor#Text Control Attributes|List Button Attributes}} dialog appears. Press the '''OK''' button to create the control. List buttons can be used to select one item from a list of possible values.
|-
| [[Image:Ide_TB_Separator.png]]
! Separator
| Enables inserting of a '''separator''' into the edited toolbar. Click inside the toolbar to specify the place where the '''separator''' should be inserted, press on the button [[Image:Ide_TB_Separator.png]], the '''separator''' will be inserted. The separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| [[Image:Ide_TB_NewRow.png]]
! New Row
| Enables inserting of a '''new row''' into the edited toolbar. Click inside the toolbar to specify the place where the '''new row''' should start, press on the button [[Image:Ide_TB_NewRow.png]], the '''new row''' will be created. Notice that the '''new rows''' are relevant only for toolbars with the styles ''Inside'' and ''Movable''. A '''new row''' control will cause breaking of the current line, the following controls appear on the next line.
|}

==== Control Types Used in Toolbars ====

In the lower part of the previous picture we see the
{{ide|Resource Editor#Controls Toolbar|'''Controls toolbar'''}} toolbar, which contains all kinds of controls that can be used in toolbars.

{|{{prettytable}}
|-
! width="30%"|Control
! width="70%"|Description
|-
| '''Push Button'''
| This is a standard push button. When pressed it sends an <vp>vpiDomains::e_Menu</vp> event to the parent window. The bitmap must be registered for the button.
|-
| '''Check Button'''
| This is used to indicate the state of a property that can have two states; either checked or unchecked. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_CheckBox,_,_)</vp> event to the parent window. You must register a bitmap for a check button.
|-
| '''List Button'''
| A list button can be used to select one item from a number of values. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_LBoxButton,_,_)</vp> event to the parent window.
|-
| '''Static Text'''
| Text may be placed in this control initially and also dynamically. A '''Static Text''' is often used for titles.
|-
| '''Context Sensitive Text'''
| If a Context Sensitive Text field is put into the toolbar, this field will display help information about the control the mouse is currently located over.
|-
| '''Separator'''
| A separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| '''New Row'''
| New row is relevant only for toolbars with the styles '''Inside''' and '''Movable'''. A New Row control will cause the current line to break, and the following controls to appear on the next line of the toolbar.
|}

==== Toolbar Layout Editing ====

The layout of the toolbar can be done both with the keyboard, and with the mouse. There is an insertion point that is marked with a colored bar. This insertion point can be moved with the arrow keys, or by clicking the mouse on the new location. When the insertion bar is at a given location, the control to the right of the bar can be deleted by pressing the '''Delete''' key, the control to the left can be deleted by pressing the '''Backspace''' key.

To place a new control at the insertion point:

* select an item from the '''Controls''' menu or
* choose a control from the ones shown in the '''Controls''' floating dialog or
* click the right mouse button anywhere in the Toolbars Editor window area outside the toolbar to display a pop up from which a desired control can be selected.

==== Attributes of Toolbar Controls ====

After a control is inserted, it is possible to change the control attributes. Just double-click the control.

===== Push and Check Button Attributes =====

Double-click a Push button or a Check button calls the '''Button Attributes''' dialog.

[[Image:Ide_Toolbar_ButtonAttributes.png|center]]
<center>'''Specifying properties of push buttons and check buttons'''</center>

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the button control. This is the constant that will be used in the <vp>vpiDomains::e_Menu</vp> events. Therefore, it is recommended to use the same constant as is used for the menu item correspondent to the same command.

The '''Constant''' input box is where you can select or type in the symbolic constant that will be used as the control identifier. It can be input directly from the keyboard or selected from the list of available constants (by clicking the [[Image:Ide_ListButton_Button.png]] button). It must be either a legal symbolic constant (for example, '''''idt_file_open''''' ) or an integer value.

If you enter a symbolic constant, then the IDE automatically places this symbolic constant into the '''resourceidentifiers.i''' file and generates an appropriate integer value for it. The '''Toolbar Editor''' automatically generates the default symbolic constants (for example, '''''idt_7''''' from the ''toolbar constant prefix'' '''''idt_''''' and the number of this control in the toolbar.
|-
| '''Status Text'''
|The string entered into this field can consist from 2 sub-strings separated by a semicolon. The sub-string specified before the semicolon (if specified) is used as the button Tool Tip text. The sub-string specified after the semicolon (or if the semicolon is not specified) will be displayed in the '''Context Sensitive Text''' field (when the mouse cursor is positioned over this button).

For example, the text '''''New;New file''''' will cause '''New''' to be shown in the yellow tool tip while '''New file''' will be shown in a context sensitive field when the mouse is over the button.
|-
|'''Checked'''
|If this check box is checked than the button initial state is "pressed" and the icon shaped as ''pressed'' is initially displayed. Otherwise the button initial state is "released" and the icon shaped as ''released'' is displayed.
|-
|'''Disabled'''
|If this check box is checked then the button initially does not accept a user input and is grayed. Otherwise the button is initially enabled (accepts a user input) and has initial state specified by the '''Checked''' check box.
|-
|'''Push Button''' or '''Check Button'''
|Select the appropriate button style ('''Push Button''' or '''Check Button'''). The style can be changed at any time. At runtime the state (''pressed'' or ''released'') of a check button can be switched by clicking the check button.
|-
|'''Bitmap Name'''
|This bitmap will be used to display a button. This bitmap should be selected from the list of bitmaps registered in the '''Project''' window (by clicking the [[Image:_Ide_ListButton_Button.png]] button). Before a bitmap name will appear in the registered bitmap list, it should be registered in the project with the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').

In Visual Prolog v.7 we use a single bitmap for each button and automatically draw different state ornamentations for the ''released'' state, the ''pressed'' state, and the ''disabled'' state of the button.
|-
|'''Edit'''
|If the '''Edit''' button is pressed, then the {{ide|Resource Editor#Graphics Editor|'''Graphics Editor'''}} will come up with the given bitmap allowing you to view and edit the bitmap.
|}

===== Text Control Attributes =====

Double-clicking a Static Text or a Context Sensitive Text control calls the '''Text Attributes''' dialog:

[[Image:Ide_Toolbar_TextControl.png|center|frame|'''Specifying properties of text controls in a toolbar''']]

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the Text control.
|-
| '''Initial Text'''
| The default text to display in the field.
|-
| '''Static''' or '''Context Sensitive'''
| Select the appropriate text control type. The style can be changed at any time.
|-
| '''Font '''
| Select a font name, font style (Normal, Bold, Italic ...), and font size for the displayed text.
|-
| '''Text Width'''
| Determines a width in pixels of the Text control field. It can be entered manually or, by pushing the '''"<nowiki>|</nowiki><---Text---><nowiki>|</nowiki>"''' button. In this case the width of the field will be optimized to display the '''Initial Text''' with the selected Font.
|-
| '''Foreground Color'''
| Select the Foreground Color for the displayed text.
|}

===== List Button Attributes =====

Double-clicking a List Button control calls the '''List Button Attributes''' dialog.

[[Image:Ide_Toolbar_ListButtonAttributes.png|center]]
<center>'''Specifying properties of list buttons in a toolbar'''</center>

Only two parameters can be set for a list button in a toolbar:

{|{{prettytable}}
|-
| width="30%"|'''Constant '''
| width="70%"|A constant name to identify the List Button control.
|-
| '''Width '''
| Determines the width in pixels of the List Button control field.
|}

Ide/Resource Editor/Graphics Editor

2013-05-17T09:20:42Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Graphics Editor Window ===

When the Graphics Editor is started to edit an image, the Graphics Editor window will appear on the screen:

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics Editor Window''']]

The Graphics Editor window is divided into several areas. Each area is responsible for a definite function or combines a number of tools, which are associated by purpose.

==== Areas of the Graphics Editor Window ====

===== Graphics Editor Title Bar =====

The title bar of the Graphics Editor window serves to display information about the type of the image (icon, cursor or bitmap), the image size in pixels, the number of colors which are available for use, and the name of the file which is opened for the current image.

For example, the title bar '''ProjectIcon.ico Size 32*32 Colors:16''' says that:
* the type of current image is an icon;
* the size of the current image is 32*32 pixels;
* 16 colors may be used in the image;
* the name of the file, which is opened for current image, is <vp>ProjectIcon.ico</vp>.

===== Graphic Field =====

The Graphic Field is situated in the middle of the Graphics Editor window.

[[Image:Ide_GE_GraphicField.png|center|frame|'''Typical contents of the Graphic Field''']]

The Graphic Field lets you see and edit the current image in expanded mode. The Graphic Field consists of small cells, where each cell corresponds to one pixel on the actual size image. The number of cells in each horizontal row and the number of cells in each vertical column give the image size, which is displayed in the title bar of the Graphics Editor window. It is possible to turn on and off a grid in the Graphic field.

===== Image Screen =====

To the right of the {{ide|Resource Editor#Graphic Field|Graphic Field}} in the Graphics Editor window you can see the Image Screen, painted in background color. In the middle of Image Screen you can see the current image in actual size on the selected background color. By changing the background color you can see how your current image will look in various surroundings.

[[Image:Ide_GE_ImageScreen.png|center]]

'''Icon'''

Under the {{ide|Resource Editor#Graphic Field|Graphic Field}}, you can see the Icon drop-down list:

[[Image:Ide_GE_IconComboBox.png|center]]

You can choose, which of the icon images in the current file to load into the editor.

===== Move Toolbar =====
(Moving, Rotating and Flipping an Image)
To the right of the Graphic Field, under the {{ide|Resource Editor#Image Screen|Image Screen}}, you can see the Image Move toolbar:

[[Image:Ide_I06.png|center|frame|'''Image Move toolbar''']]

By clicking the appropriate button you can move, rotate or flip the current image.

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I064.png]]
| '''Shift Left'''
| Moves the image one column to the left. The left edge column crosses the left borderline of the Graphic Field and returns to the Graphic Field as the right edge column
|-
| [[Image:Ide_I063.png]]
| '''Shift Right'''
| Moves the image one pixel column to the right. The right edge column crosses the right borderline of the Graphic Field and returns to the Graphic Field as the left edge column
|-
| [[Image:Ide_I061.png]]
| '''Shift Up'''
| Moves the image one pixel row up. The top row crosses the upper borderline of the Graphic Field and returns to the Graphic Field as the bottom row
|-
| [[Image:Ide_I062.png]]
| '''Shift Down'''
| Moves the image one pixel row down. The bottom row crosses the bottom borderline of the Graphic Field and returns to the Graphic Field as the top row
|-
| [[Image:Ide_I066.png]]
| '''Rotate Left'''
| Rotates the image 90 degrees counter-clockwise around its center
|-
| [[Image:Ide_I065.png]]
| '''Rotate Right'''
| Rotates the image 90 degrees clockwise around its center
|-
| [[Image:Ide_I068.png]]
| '''Flip Horizontal'''
| Flips the image around the vertical axis
|-
| [[Image:Ide_I067.png]]
| '''Flip Vertical'''
| Flips the image around the horizontal axis
|}

Notice that the '''Resource | Move''' menu contains the same commands as the '''Image Move''' toolbar.

===== Color Palette =====

At the top of the Graphics Editor window you can see the Color Palette.

[[Image:Ide_GE_ColorPalette.png|center|frame|'''The Color Palette''']]

The Color Palette lets you choose colors for the drawing operations:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Setting the Draw and Edit Colors}}
* {{ide|Resource Editor#Setting the Background Color|Setting the Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Setting the Inverse (to Background) Color}}

===== Color Modes Toolbar =====

Under the {{ide|Resource Editor#Image Screen|Image Screen}} you can see the Color Modes tool box:

[[Image:Ide_I10.png|center]]
<center>'''The Color Modes toolbar'''</center>

The Color Modes tool box is used to set:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Draw and Edit colors}}
* {{ide|Resource Editor#Setting the Background Color|Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Inverse (to Background) Color}}

===== Draw and Edit Toolbar =====
'''Using Draw and Edit Tools'''

To the left of the Graphic Field of the Graphics Editor window you can see the Draw and Edit Toolbar. It contains the main tools for drawing and editing:

[[Image:Ide_GE_DrawEditToolbox.png|center]]
<center>'''The Draw and Edit toolbar'''</center>

The Graphics Editor provides a number of tools to make creating your image easy. The tools can be activated either from the '''Resource | Tools''' menu or from the Draw and Edit toolbar.

===== Draw and Edit Tools =====

By clicking any of the buttons in the Draw and Edit toolbar you can select the required draw or edit tool. Here are short descriptions of them:

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I15.png]]
| '''Pen'''
| The Pen tool can be used to color an individual pixel on the Graphic Field or to make a free-hand drawing.
|-
| [[Image:Ide_I16.png]]
| '''Brush'''
| The Brush tool works the same as Pen tool, except that the Brush tool leaves a larger mark than the Pen. The style of the Brush can be changed by selecting among the '''Small''', '''Big''', and '''Star''' in the '''Brush Style''' list button (in the right bottom corner of the Graphics Editor window).
|-
| [[Image:Ide_I18.png]]
| '''Eraser'''
| To erase a fragment of the image (the same as painting it with the Screen Color), you can use the Eraser Tool in the toolbar. The size of the Eraser can be changed by selecting among the '''Small''' and '''Big''' in the '''Eraser Style''' list button (in the right bottom corner of the Graphics Editor window)
|-
| [[Image:Ide_I20.png]]
| '''Color Eraser'''
| The Erase Color tool will erase cells of the selected color without changing other colors.
|-
| [[Image:Ide_I21.png]]
| '''Fill Contour'''
| The fastest way to color an area, which has an enclosed boundary, is to use the Fill Contour tool. Move the cursor into the area to be colored and click the mouse button. The interior of the bounded region will be colored.
|-
| [[Image:Ide_I26.png]]
| '''Mirror'''
| To create symmetrical images use the Mirror tool. The Mirror tool sets the points that are the reflections of the cursor trail point relative to the different axes of symmetry. To choose the appropriate axes of symmetry for the Mirror tool select the '''Resource <nowiki>|</nowiki> {{ide|Resource Editor#Mirror Style Dialog|Set Mirror Style}}''' menu command in the Task window menu.
|-
| [[Image:Ide_I22.png]]
| '''Line'''
| Selecting this button enables you to draw a line between any two points in the image.
|-
| [[Image:Ide_I23.png]]
| '''Draw Rectangle'''
| Click this button if you need a rectangle. Size the Rectangle by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I24.png]]
| '''Draw Ellipse'''
| Choose this tool if you need to draw a circle or an ellipse. Size the circle or ellipse by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I25.png]]
|'''Enter Text'''
| Click this button to insert some text in your image. Move the cursor to the position on the Graphic Field where you want to start the text and click the mouse button. You will see a text cursor, which shows you the height of the letters and digits, and the starting point for the current line of text. When you type some text, it will be drawn in the currently selected color, with the currently selected font. To select the desired font settings press '''Ctrl+F'''. While the text is still selected, it is possible to move the starting point clicking in the new position.
|-
| [[Image:Ide_I28.png]]
| '''Mark Area'''
|To mark a rectangular fragment of the image on the Graphic Field to be cut, copied or moved, click the '''Mark Area''' tool. Then move the cursor to the Graphic Field cell, which you want to be one corner of a marked rectangular area, and press and hold the mouse button. Release the mouse when the rectangle is of the appropriate size and you will see a sub-region of the image marked accordingly. You can move the marked region to another part of the Graphic Field by means of "drag and drop". Move the cursor into the marked region and press and hold the mouse button. Then, keeping the mouse button depressed, drag the marked fragment to the place of your choice and release the mouse button. Now the marked region is fixed in its new place. If you want to copy the marked region to another place, do as described under move, but hold down the '''Ctrl''' key, while pressing the mouse button in the marked region. When a region is marked:
* '''Edit|Cut''' or '''Edit|Copy''' (from the main menu, or the main IDE toolbar '''Cut''' and '''Copy''' buttons, or the standard accelerator keys '''Ctrl+X''' and '''Ctrl+C''')can be used to place it to the clipboard;
* '''Edit|Paste''' (or the '''Paste''' toolbar button or accelerator '''Ctrl+V''')can be used to scale a image from the clipboard into the region.
* The '''Paste & Scale''' tool can be used.
'''Note''' When you use '''Edit|Paste''' , the image fragment will appear in the left top corner of Graphic Field. The region may be moved to another place by the mouse.
|-
| [[Image:Ide_I29.png]]
| '''Paste & Scale in Rectangle'''
| When an image has been copied to the clipboard, this image can be pasted back into another marked area by pressing this button. This button will stay disabled until there are both an image on the clipboard, and a region has been selected.
|-
| [[Image:Ide_I30.png]]
| '''Clear Graphic Field'''
| To clear the Graphic Field, click the Clear button. The white color is used for bitmaps and transparent color is used for icons and cursors.
|-
| [[Image:Ide_I31.png]]
| '''Change a Selected Color'''
| With this button you can change all pixels that have a given color into another color. The two colors should first be set for the '''Color''' and '''Alt+Color''' selections. '''Note''' Any pixels, which were colored in background color or in "inverse" color by '''Inverse''' tool, will keep their original colors.
|-
|[[Image:Ide_I32.png]]
| '''Inverse Colors'''
| This button can be used to invert all colors on the image. In this case, any pixels, which were colored in background color or in inverse to background color, will retain their existing colors.
|-
| [[Image:Ide_I33.png]]
| '''Grid'''
| This button can be used to turn on and off a grid in the Graphic Field
|}

==== Mirror Style Dialog ====

The '''Mirror Style''' dialog is activated by the '''Resource | Set Mirror Style''' menu command in the Task window menu:

[[Image:Ide_GE_MirrorStyle.png|center]]
<center>'''The Mirror Style dialog'''</center>

The '''Mirror Style''' dialog is used to choose the appropriate axes of symmetry for the '''Mirror''' tool.

The '''Mirror''' tool [[Image:Ide_I26.png]] sets the points that are the reflections of the '''cursor ''trail'' point''' relative to the different axes of symmetry.

When you place the mouse cursor onto some point inside an edited image and click the left mouse button, then we say that you set the '''cursor ''trail'' point'''.

Using the '''Mirror''' tool, you can (by one click) set up to 8 reflections of the specified cursor ''trail'' point. A reflection point will be painted to each checked ON type of reflections. They are:

'''Main -> Trial'''
:When checked ON, then paints the clicked '''cursor ''trail'' point'''.
'''Main -> Reverse'''
:When checked ON, then paints the point opposite to the clicked cursor trail point.
'''Reflect -> Horizontal'''
:When checked ON, then paints the point, which is the horizontal reflection of the clicked cursor trail point.
'''Reflect -> Vertical'''
:When checked ON, then paints the point, which is the vertical reflection of the clicked cursor trail point.
'''Orthogonal -> Left'''
:When checked ON, then paints the point, which is 90 degrees left rotation of the clicked cursor trail point.
'''Orthogonal -> Right'''
:When checked ON, then paints the point, which is 90 degrees right rotation of the clicked cursor trail point.
'''Reflect Diagonal -> Left'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''left''' upper corner to the right lower corner of the image.
'''Reflect Diagonal -> Right'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''right''' upper corner to the left lower corner of the image.

=== Using Tools and Colors ===

==== Setting Colors ====

===== Setting the Draw and Edit Colors =====

To choose colors for the drawing and editing tools you can select one of the following four switches.

[[Image:Ide_GE_Mode_DrawColor.png|center]]
<center>'''The Color Modes toolbar with selected "color" mode'''</center>

The color of selection will be used for the drawing. It is possible to choose a new color for the active selection by a click in the {{ide|Resource Editor#Color Palette|Color Palette}}.

The '''color''' and the '''alt-color''' can be used in all drawing operations, the '''screen''' (or transparent) and '''inverse''' selections have different purposes depending on the image type.

'''Note.'''
There are 16 color fields on the {{ide|Resource Editor#Color Palette|Color Palette}}, and all of them are available for drawing and editing in the {{ide|Resource Editor#Graphic Field|Graphic Field}}.

===== Setting the Background Color =====

To see how your image looks on the different background colors or to color the image fragments in "transparent" (to let the background color show through) use the '''screen''' color selection.

[[Image:Ide_GE_Mode_BackgroundColor.png|center]]
<center>'''The "screen" mode should be used for Background color'''</center>

To change the background color, be sure that the '''screen''' switch is selected, then you can choose the background color by clicking in the {{ide|Resource Editor#Color Palette|Color Palette}}. The background color on the {{ide|Resource Editor#Image Screen|Image Screen}}, any details of the image, which were colored in (transparent) background color, and the '''screen''' indicator of '''Color Modes''' toolbar, all will change to the new color.

'''Usage of the "screen" Colors for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Screen Colors
|-
! Bitmaps
| Used to set the color of the surrounding area
|-
! Cursors and Icons
| Used to specify transparent pixels and to set the color of the surrounding area
|}

===== Setting the Inverse (to Background) Color =====

Using the inverse color is a convenient way to mark the boundary of the image or to color the details, which should be always be in contrast to any background color.

[[Image:Ide_GE_Mode_InverseBackground.png|center]]
<center>'''The "inverse" mode should be used for Inverse color'''</center>

'''Usage of the Inverse color for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Inverse Color
|-
! Bitmaps
| Cannot be used
|-
! Cursors and Icons
| Used to specify pixels that should get a color inverse of the actual background
|}

==== Understanding Colors ====

*'''Colors for Bitmaps'''

The Visual Prolog Graphics Editor can create bitmaps with either 2 or 16 colors. A pixel in a bitmap can not have the inverse and screen colors.

*'''Colors for Cursors'''

Any pixel in a cursor can have one of four color control values:

{|{{prettytable}}
|-
! Cursor
! Color Effect
|-
! Black
| Pixels will be black
|-
! White
| Pixels will be white
|-
! Inverse
| Pixels will be converted to the inverse of the original color
|-
! Screen
| Pixels will be transparent, they will just keep their old color
|}

To understand how this works, you should create a little cursor having four areas, with these four color control values. Then select the '''Resources | Tools | Test Cursor''', and study how the cursor looks.

[[Image:Ide_GE_TestCursorColors.png|center]]
<center>'''In this test cursor the left upper quoter of the cursor is painted with the "color"'''</center>
<center>'''and the left bottom quarter is painted with the "inverse"'''</center>

Place the cursor over the Grid and you will see effects of "inverse" color.

*'''Colors for Icons'''

Icons can either have 2 or 16 colors, and in addition to those, the pixels can also use the {{ide|Resource Editor#Setting the Background Color|'''screen'''}} and
{{ide|Resource Editor#Setting the Inverse (to Background) Color|'''inverse'''}} colors.

==== Cursor Handling Tools ====

'''Setting Cursor Hot Spots'''

When working with a cursor, the menu command Resource | Set Cursor Hotspot activates a dialog box:

[[Image:Ide_GE_CursorHotSpot.png|center]]
<center>'''Defining the Hotspot for a cursor'''</center>

As long as this dialog is open you can point to the pixel, which is to be the cursor Hotspot. This pixel in the cursor will determine the screen pixel which will be acted upon and which will be reported during a mouse action.

'''Testing a Cursor'''

When working with a cursor, the '''Resource | Tools | Test Cursor''' menu item allows you to see what your newly designed cursor will look like.

==== Undo / Redo Buffer ====

The Graphics Editor supports '''Edit|Undo''' and '''Edit|Redo''' operations, just as the other editors do.

Ide/Creating new Project Items/Creating a Image

2013-05-17T08:58:45Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
==== Creating a New Image (Bitmap, Cursor or Icon) ====

To create and register a new image (a bitmap, an icon or a cursor) in a project you need to use the '''File | New''' menu item. In the opened '''New''' dialog you should select the '''Bitmap''', the '''Icon''' or the '''Cursor''' type of creating item. Then the following dialog (in case if you have selected the '''Bitmap''') appears:

[[Image:Ide_GE_MyBitmap.png|center|frame|'''Creating a new bitmap image''']]

In this dialog you should specify the following items:

'''Name'''
:In this dialog you should type in the '''Name''' which will be associated with this image in the code generated by default. This '''Name''' should be a correct Visual Prolog name. It should be any sequence of letters, digits, and underscores, beginning with a letter. This is the name of the creating image. It appears as the names of image files in the project tree in the Project window.

'''Package'''
:With the '''Package''' selection the programmer can determine into directory of which package will be placed the image file.

==== Image Attributes Dialog ====

After you press the '''OK''' button in the '''New Bitmap''' dialog, the '''Bitmap Attributes''' dialog appears. The similar dialogs appear in case if you will create a cursor or an icon.

[[Image:Ide_GE_BitmapAttributes.png|center|frame|'''The Bitmap Attributes dialog while creation of a new bitmap''']]

After clicking the '''OK''' button the new bitmap will be created and its name will be added to the existing bitmaps for the current project.

The similar (but little simpler) dialogs appear when you create a new Icon:

[[Image:Ide_GE_IconAttributes.png|center|frame|'''The Icon Attributes dialog while creation of a new icon''']]

and a new Cursor:

[[Image:Ide_GE_CursorAttributes.png|center|frame|'''The Cursor Attributes dialog while creation of a new cursor''']]

In these dialogs you can change only the '''Constant''' attribute. The attributes '''Name''' and '''File''' are generated automatically and cannot be changed by the programmer.

'''Name'''
:This is the '''Name''' which was specified for the image in the previous '''New''' dialog. It cannot be changed here.

'''File'''
:Here you will see the name of file, with the path relative to the project root directory, in which the image will be stored. This filename is generated automatically by the IDE and cannot be changed.

'''Constant'''
:The constant is used to identify the image in your program. An image identifier must be unique throughout the project.
: You can either input it directly from the keyboard or allow the IDE to create a default value.

:The default values for constants are:

{|{{prettytable}} width="75%"
|-
! Image Type
! Constant
|-
| ''Bitmap''
| '''''idb_bitmap_name'''''
|-
| ''Icon''
| '''''idi_icon_name'''''
|-
| ''Cursor''
| '''''idc_cursor_name'''''
|}

:Constant must be either legal symbolic constant name (for example, '''''idb_mybitmap''''') or an integer. The IDE automatically places the symbolic identifier into the '''ResourceIdentifiers.i''' file and generates an integer value for it. The Graphics Editor automatically concatenates a sequence number if the project already has an image with the same name.

:In case of Icons and Cursors this is the only attribute which can be edited in this dialog.

In case when you create a new bitmap, you can specify several additional attributes:

'''Width and Height'''
:Defines the Width and Height of the bitmap in pixels. The maximal possible values are 64.

:You may specify the size of the image for bitmaps only. The Graphics Editor allows you to create and edit bitmaps ranging in size from 4x4 pixels to 64x64 pixels.

:The size of icons and cursors is always 32x32.

'''Colors'''
:In this field you may specify using of either a 16-color palette or monochrome shadow palette for bitmaps and icons. Remember that for creating cursor images only 2 colors are available - the color black and transparent for background "color".

Ide/Creating new Project Items/Creating a Image

2013-05-17T08:52:12Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
==== Creating a New Image (Bitmap, Cursor or Icon) ====

To create and register a new image (a bitmap, an icon or a cursor) in a project you need to use the '''File | New''' menu item. In the opened '''New''' dialog you should select the '''Bitmap''', the '''Icon''' or the '''Cursor''' type of creating item. Then the following dialog (in case if you have selected the '''Bitmap''') appears:

[[Image:Ide_GE_MyBitmap.png|center|frame|'''Creating a new bitmap image''']]

In this dialog you should specify the following items:

'''Name'''
:In this dialog you should type in the '''Name''' which will be associated with this image in the code generated by default. This '''Name''' should be a correct Visual Prolog name. It should be any sequence of letters, digits, and underscores, beginning with a letter. This is the name of the creating image. It appears as the names of image files in the project tree in the Project window.

'''Package'''
:With the '''Package''' selection the programmer can determine into directory of which package will be placed the image file.

==== Image Attributes Dialog ====

After you press the '''OK''' button in the '''New Bitmap''' dialog, the '''Bitmap Attributes''' dialog appears. The similar dialogs appear in case if you will create a cursor or an icon.

[[Image:Ide_GE_BitmapAttributes.png|center|frame|'''The Bitmap Attributes dialog while creation of a new bitmap''']]

After clicking the '''OK''' button the new bitmap will be created and its name will be added to the existing bitmaps for the current project.

The similar (but little simpler) dialogs appear when you create a new Icon:

[[Image:Ide_GE_IconAttributes.png|center|frame|'''The Icon Attributes dialog while creation of a new icon''']]

and a new Cursor:

[[Image:Ide_GE_CursorAttributes.png|center|frame|'''The Cursor Attributes dialog while creation of a new cursor''']]

In these dialogs you can change only the '''Constant''' attribute. The attributes '''Name''' and '''File''' are generated automatically and cannot be changed by the programmer.

'''Name'''
:This is the '''Name''' which was specified for the image in the previous '''New''' dialog. It cannot be changed here.

'''File'''
:Here you will see the name of file, with the path relative to the project root directory, in which the image will be stored. This filename is generated automatically by the IDE and cannot be changed.

'''Constant'''
:The constant is used to identify the image in your program. An image identifier must be unique throughout the project.
: You can either input it directly from the keyboard or allow the IDE to create a default value.

:The default values for constants are:

{|{{prettytable}} width="75%"
|-
! Image Type
! Constant
|-
| ''Bitmap''
| '''''idb_bitmap_name'''''
|-
| ''Icon''
| '''''idi_icon_name'''''
|-
| ''Cursor''
| '''''idc_cursor_name'''''
|}

:Constant must be either legal symbolic constant name (for example, '''idb_MyBitmap''') or an integer. The IDE automatically places the symbolic identifier into the '''ResourceIdentifiers.i''' file and generates an integer value for it. The Graphics Editor automatically concatenates a sequence number if the project already has an image with the same name.

:In case of Icons and Cursors this is the only attribute which can be edited in this dialog.

In case when you create a new bitmap, you can specify several additional attributes:

'''Width and Height'''
:Defines the Width and Height of the bitmap in pixels. The maximal possible values are 64.

:You may specify the size of the image for bitmaps only. The Graphics Editor allows you to create and edit bitmaps ranging in size from 4x4 pixels to 64x64 pixels.

:The size of icons and cursors is always 32x32.

'''Colors'''
:In this field you may specify using of either a 16-color palette or monochrome shadow palette for bitmaps and icons. Remember that for creating cursor images only 2 colors are available - the color black and transparent for background "color".

Ide/Resource Editor/Graphics Editor

2013-05-17T08:07:43Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Graphics Editor Window ===

When the Graphics Editor is started to edit an image, the Graphics Editor window will appear on the screen:

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics Editor Window''']]

The Graphics Editor window is divided into several areas. Each area is responsible for a definite function or combines a number of tools, which are associated by purpose.

==== Areas of the Graphics Editor Window ====

===== Graphics Editor Title Bar =====

The title bar of the Graphics Editor window serves to display information about the type of the image (icon, cursor or bitmap), the image size in pixels, the number of colors which are available for use, and the name of the file which is opened for the current image.

For example, the title bar '''ProjectIcon.ico Size 32*32 Colors:16''' says that:
* the type of current image is an icon;
* the size of the current image is 32*32 pixels;
* 16 colors may be used in the image;
* the name of the file, which is opened for current image, is <vp>ProjectIcon.ico</vp>.

===== Graphic Field =====

The Graphic Field is situated in the middle of the Graphics Editor window.

[[Image:Ide_GE_GraphicField.png|center|frame|'''Typical contents of the Graphic Field''']]

The Graphic Field lets you see and edit the current image in expanded mode. The Graphic Field consists of small cells, where each cell corresponds to one pixel on the actual size image. The number of cells in each horizontal row and the number of cells in each vertical column give the image size, which is displayed in the title bar of the Graphics Editor window. It is possible to turn on and off a grid in the Graphic field.

===== Image Screen =====

To the right of the {{ide|Resource Editor#Graphic Field|Graphic Field}} in the Graphics Editor window you can see the Image Screen, painted in background color. In the middle of Image Screen you can see the current image in actual size on the selected background color. By changing the background color you can see how your current image will look in various surroundings.

[[Image:Ide_GE_ImageScreen.png|center]]

'''Icon'''

Under the {{ide|Resource Editor#Graphic Field|Graphic Field}}, you can see the Icon drop-down list:

[[Image:Ide_GE_IconComboBox.png|center]]

You can choose, which of the icon images in the current file to load into the editor.

===== Move Toolbar =====
(Moving, Rotating and Flipping an Image)
To the right of the Graphic Field, under the {{ide|Resource Editor#Image Screen|Image Screen}}, you can see the Image Move toolbar:

[[Image:Ide_I06.png|center|frame|'''Image Move toolbar''']]

By clicking the appropriate button you can move, rotate or flip the current image.

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I064.png]]
| '''Shift Left'''
| Moves the image one column to the left. The left edge column crosses the left borderline of the Graphic Field and returns to the Graphic Field as the right edge column
|-
| [[Image:Ide_I063.png]]
| '''Shift Right'''
| Moves the image one pixel column to the right. The right edge column crosses the right borderline of the Graphic Field and returns to the Graphic Field as the left edge column
|-
| [[Image:Ide_I061.png]]
| '''Shift Up'''
| Moves the image one pixel row up. The top row crosses the upper borderline of the Graphic Field and returns to the Graphic Field as the bottom row
|-
| [[Image:Ide_I062.png]]
| '''Shift Down'''
| Moves the image one pixel row down. The bottom row crosses the bottom borderline of the Graphic Field and returns to the Graphic Field as the top row
|-
| [[Image:Ide_I066.png]]
| '''Rotate Left'''
| Rotates the image 90 degrees counter-clockwise around its center
|-
| [[Image:Ide_I065.png]]
| '''Rotate Right'''
| Rotates the image 90 degrees clockwise around its center
|-
| [[Image:Ide_I068.png]]
| '''Flip Horizontal'''
| Flips the image around the vertical axis
|-
| [[Image:Ide_I067.png]]
| '''Flip Vertical'''
| Flips the image around the horizontal axis
|}

Notice that the '''Resource | Move''' menu contains the same commands as the '''Image Move''' toolbar.

===== Color Palette =====

At the top of the Graphics Editor window you can see the Color Palette.

[[Image:Ide_GE_ColorPalette.png|center|frame|'''The Color Palette''']]

The Color Palette lets you choose colors for the drawing operations:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Setting the Draw and Edit Colors}}
* {{ide|Resource Editor#Setting the Background Colors|Setting the Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Setting the Inverse (to Background) Color}}

===== Color Modes Toolbar =====

Under the {{ide|Resource Editor#Image Screen|Image Screen}} you can see the Color Modes tool box:

[[Image:Ide_I10.png|center]]
<center>'''The Color Modes toolbar'''</center>

The Color Modes tool box is used to set:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Draw and Edit colors}}
* {{ide|Resource Editor#Setting the Background Colors|Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Inverse (to Background) Color}}

===== Draw and Edit Toolbar =====
(Using Draw and Edit Tools)
To the left of the Graphic Field of the Graphics Editor window you can see the Draw and Edit Toolbar. It contains the main tools for drawing and editing:

[[Image:Ide_GE_DrawEditToolbox.png|center]]
<center>'''The Draw and Edit toolbar'''</center>

The Graphics Editor provides a number of tools to make creating your image easy. The tools can be activated either from the '''Resource | Tools''' menu or from the Draw and Edit toolbar.

===== Draw and Edit Tools =====

By clicking any of the buttons in the Draw and Edit toolbar you can select the required draw or edit tool. Here are short descriptions of them:

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I15.png]]
| '''Pen'''
| The Pen tool can be used to color an individual pixel on the Graphic Field or to make a free-hand drawing.
|-
| [[Image:Ide_I16.png]]
| '''Brush'''
| The Brush tool works the same as Pen tool, except that the Brush tool leaves a larger mark than the Pen. The style of the Brush can be changed by selecting among the '''Small''', '''Big''', and '''Star''' in the '''Brush Style''' list button (in the right bottom corner of the Graphics Editor window).
|-
| [[Image:Ide_I18.png]]
| '''Eraser'''
| To erase a fragment of the image (the same as painting it with the Screen Color), you can use the Eraser Tool in the toolbar. The size of the Eraser can be changed by selecting among the '''Small''' and '''Big''' in the '''Eraser Style''' list button (in the right bottom corner of the Graphics Editor window)
|-
| [[Image:Ide_I20.png]]
| '''Color Eraser'''
| The Erase Color tool will erase cells of the selected color without changing other colors.
|-
| [[Image:Ide_I21.png]]
| '''Fill Contour'''
| The fastest way to color an area, which has an enclosed boundary, is to use the Fill Contour tool. Move the cursor into the area to be colored and click the mouse button. The interior of the bounded region will be colored.
|-
| [[Image:Ide_I26.png]]
| '''Mirror'''
| To create symmetrical images use the Mirror tool. The Mirror tool sets the points that are the reflections of the cursor trail point relative to the different axes of symmetry. To choose the appropriate axes of symmetry for the Mirror tool select the '''Resource <nowiki>|</nowiki> {{ide|Resource Editor#Mirror Style Dialog|Set Mirror Style}}''' menu command in the Task window menu.
|-
| [[Image:Ide_I22.png]]
| '''Line'''
| Selecting this button enables you to draw a line between any two points in the image.
|-
| [[Image:Ide_I23.png]]
| '''Draw Rectangle'''
| Click this button if you need a rectangle. Size the Rectangle by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I24.png]]
| '''Draw Ellipse'''
| Choose this tool if you need to draw a circle or an ellipse. Size the circle or ellipse by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I25.png]]
|'''Enter Text'''
| Click this button to insert some text in your image. Move the cursor to the position on the Graphic Field where you want to start the text and click the mouse button. You will see a text cursor, which shows you the height of the letters and digits, and the starting point for the current line of text. When you type some text, it will be drawn in the currently selected color, with the currently selected font. To select the desired font settings press '''Ctrl+F'''. While the text is still selected, it is possible to move the starting point clicking in the new position.
|-
| [[Image:Ide_I28.png]]
| '''Mark Area'''
|To mark a rectangular fragment of the image on the Graphic Field to be cut, copied or moved, click the '''Mark Area''' tool. Then move the cursor to the Graphic Field cell, which you want to be one corner of a marked rectangular area, and press and hold the mouse button. Release the mouse when the rectangle is of the appropriate size and you will see a sub-region of the image marked accordingly. You can move the marked region to another part of the Graphic Field by means of "drag and drop". Move the cursor into the marked region and press and hold the mouse button. Then, keeping the mouse button depressed, drag the marked fragment to the place of your choice and release the mouse button. Now the marked region is fixed in its new place. If you want to copy the marked region to another place, do as described under move, but hold down the '''Ctrl''' key, while pressing the mouse button in the marked region. When a region is marked:
* '''Edit|Cut''' or '''Edit|Copy''' (from the main menu, or the main IDE toolbar '''Cut''' and '''Copy''' buttons, or the standard accelerator keys '''Ctrl+X''' and '''Ctrl+C''')can be used to place it to the clipboard;
* '''Edit|Paste''' (or the '''Paste''' toolbar button or accelerator '''Ctrl+V''')can be used to scale a image from the clipboard into the region.
* The '''Paste&Scale''' tool can be used.
'''Note''' When you use '''Edit|Paste''' , the image fragment will appear in the left top corner of Graphic Field. The region may be moved to another place by the mouse.
|-
| [[Image:Ide_I29.png]]
| '''Paste & Scale in Rectangle'''
| When an image has been copied to the clipboard, this image can be pasted back into another marked area by pressing this button. This button will stay disabled until there are both an image on the clipboard, and a region has been selected.
|-
| [[Image:Ide_I30.png]]
| '''Clear Graphic Field'''
| To clear the Graphic Field, click the Clear button. The white color is used for bitmaps and transparent color is used for icons and cursors.
|-
| [[Image:Ide_I31.png]]
| '''Change a Selected Color'''
| With this button you can change all pixels that have a given color into another color. The two colors should first be set for the '''Color''' and '''Alt-Color''' selections. '''Note''' Any pixels, which were colored in background color or in "inverse" color by '''Inverse''' tool, will keep their original colors.
|-
|[[Image:Ide_I32.png]]
| '''Inverse Colors'''
| This button can be used to invert all colors on the image. In this case, any pixels, which were colored in background color or in inverse to background color, will retain their existing colors.
|-
| [[Image:Ide_I33.png]]
| '''Grid'''
| This button can be used to turn on and off a grid in the Graphic Field
|}

==== Mirror Style Dialog ====

The '''Mirror Style''' dialog is activated by the '''Resource | Set Mirror Style''' menu command in the Task window menu:

[[Image:Ide_GE_MirrorStyle.png|center]]
<center>'''The Mirror Style dialog'''</center>

The '''Mirror Style''' dialog is used to choose the appropriate axes of symmetry for the '''Mirror''' tool.

The '''Mirror''' tool [[Image:Ide_I26.png]] sets the points that are the reflections of the '''cursor ''trail'' point''' relative to the different axes of symmetry.

When you place the mouse cursor onto some point inside an edited image and click the left mouse button, then we say that you set the '''cursor ''trail'' point'''.

Using the '''Mirror''' tool, you can (by one click) set up to 8 reflections of the specified cursor ''trail'' point. A reflection point will be painted to each checked ON type of reflections. They are:

'''Main -> Trial'''
:When checked ON, then paints the clicked '''cursor ''trail'' point'''.
'''Main -> Reverse'''
:When checked ON, then paints the point opposite to the clicked cursor trail point.
'''Reflect -> Horizontal'''
:When checked ON, then paints the point, which is the horizontal reflection of the clicked cursor trail point.
'''Reflect -> Vertical'''
:When checked ON, then paints the point, which is the vertical reflection of the clicked cursor trail point.
'''Orthogonal -> Left'''
:When checked ON, then paints the point, which is 90 degrees left rotation of the clicked cursor trail point.
'''Orthogonal -> Right'''
:When checked ON, then paints the point, which is 90 degrees right rotation of the clicked cursor trail point.
'''Reflect Diagonal -> Left'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''left''' upper corner to the right lower corner of the image.
'''Reflect Diagonal -> Right'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''right''' upper corner to the left lower corner of the image.

=== Using Tools and Colors ===

==== Setting Colors ====

===== Setting the Draw and Edit Colors =====

To choose colors for the drawing and editing tools you can select one of the following four switches.

[[Image:Ide_GE_Mode_DrawColor.png|center]]
<center>'''The Color Modes toolbar with selected "color" mode'''</center>

The color of selection will be used for the drawing. It is possible to choose a new color for the active selection by a click in the {{ide|Resource Editor#Color Palette|Color Palette}}.

The '''color''' and the '''alt-color''' can be used in all drawing operations, the '''screen''' (or transparent) and '''inverse''' selections have different purposes depending on the image type.

'''Note.'''
There are 16 color fields on the {{ide|Resource Editor#Color Palette|Color Palette}}, and all of them are available for drawing and editing in the {{ide|Resource Editor#Graphic Field|Graphic Field}}.

===== Setting the Background Color =====

To see how your image looks on the different background colors or to color the image fragments in "transparent" (to let the background color show through) use the '''screen''' color selection.

[[Image:Ide_GE_Mode_BackgroundColor.png|center]]
<center>'''The "screen" mode should be used for Background color'''</center>

To change the background color, be sure that the '''screen''' switch is selected, then you can choose the background color by clicking in the {{ide|Resource Editor#Color Palette|Color Palette}}. The background color on the {{ide|Resource Editor#Image Screen|Image Screen}}, any details of the image, which were colored in (transparent) background color, and the '''screen''' indicator of '''Color Modes''' toolbar, all will change to the new color.

'''Usage of the "screen" Colors for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Screen Colors
|-
! Bitmaps
| Used to set the color of the surrounding area
|-
! Cursors and Icons
| Used to specify transparent pixels and to set the color of the surrounding area
|}

===== Setting the Inverse (to Background) Color =====

Using the inverse color is a convenient way to mark the boundary of the image or to color the details, which should be always be in contrast to any background color.

[[Image:Ide_GE_Mode_InverseBackground.png|center]]
<center>'''The "inverse" mode should be used for Inverse color'''</center>

'''Usage of the Inverse color for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Inverse Color
|-
! Bitmaps
| Cannot be used
|-
! Cursors and Icons
| Used to specify pixels that should get a color inverse of the actual background
|}

==== Understanding Colors ====

*'''Colors for Bitmaps'''

The Visual Prolog Graphics Editor can create bitmaps with either 2 or 16 colors. A pixel in a bitmap can not have the inverse and screen colors.

*'''Colors for Cursors'''

Any pixel in a cursor can have one of four color control values:

{|{{prettytable}}
|-
! Cursor
! Color Effect
|-
! Black
| Pixels will be black
|-
! White
| Pixels will be white
|-
! Inverse
| Pixels will be converted to the inverse of the original color
|-
! Screen
| Pixels will be transparent, they will just keep their old color
|}

To understand how this works, you should create a little cursor having four areas, with these four color control values. Then select the '''Resources | Tools | Test Cursor''', and study how the cursor looks.

[[Image:Ide_GE_TestCursorColors.png|center]]
<center>'''In this test cursor the left upper quoter of the cursor is painted with the "color"'''</center>
<center>'''and the left bottom quarter is painted with the "inverse"'''</center>

Place the cursor over the Grid and you will see effects of "inverse" color.

*'''Colors for Icons'''

Icons can either have 2 or 16 colors, and in addition to those, the pixels can also use the {{ide|Resource Editor#Setting the Background Color|'''screen'''}} and
{{ide|Resource Editor#Setting the Inverse (to Background) Color|'''inverse'''}} colors.

==== Cursor Handling Tools ====

'''Setting Cursor Hot Spots'''

When working with a cursor, the menu command Resource | Set Cursor Hotspot activates a dialog box:

[[Image:Ide_GE_CursorHotSpot.png|center]]
<center>'''Defining the Hotspot for a cursor'''</center>

As long as this dialog is open you can point to the pixel, which is to be the cursor Hotspot. This pixel in the cursor will determine the screen pixel which will be acted upon and which will be reported during a mouse action.

'''Testing a Cursor'''

When working with a cursor, the '''Resource | Tools | Test Cursor''' menu item allows you to see what your newly designed cursor will look like.

==== Undo / Redo Buffer ====

The Graphics Editor supports '''Edit|Undo''' and '''Edit|Redo''' operations, just as the other editors do.

Ide/Resource Editor/Graphics Editor

2013-04-26T13:42:54Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Graphics Editor Window ===

When the Graphics Editor is started to edit an image, the Graphics Editor window will appear on the screen:

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics Editor Window''']]

The Graphics Editor window is divided into several areas. Each area is responsible for a definite function or combines a number of tools, which are associated by purpose.

==== Areas of the Graphics Editor Window ====

===== Graphics Editor Title Bar =====

The title bar of the Graphics Editor window serves to display information about the type of the image (icon, cursor or bitmap), the image size in pixels, the number of colors which are available for use, and the name of the file which is opened for the current image.

For example, the title bar '''ProjectIcon.ico Size 32*32 Colors:16''' says that:
* the type of current image is an icon;
* the size of the current image is 32*32 pixels;
* 16 colors may be used in the image;
* the name of the file, which is opened for current image, is <vp>ProjectIcon.ico</vp>.

===== Graphic Field =====

The Graphic Field is situated in the middle of the Graphics Editor window.

[[Image:Ide_GE_GraphicField.png|center|frame|'''Typical contents of the Graphic Field''']]

The Graphic Field lets you see and edit the current image in expanded mode. The Graphic Field consists of small cells, where each cell corresponds to one pixel on the actual size image. The number of cells in each horizontal row and the number of cells in each vertical column give the image size, which is displayed in the title bar of the Graphics Editor window. It is possible to turn on and off a grid in the Graphic field.

===== Image Screen =====

To the right of the {{ide|Resource Editor#Graphic Field|Graphic Field}} in the Graphics Editor window you can see the Image Screen, painted in background color. In the middle of Image Screen you can see the current image in actual size on the selected background color. By changing the background color you can see how your current image will look in various surroundings.

[[Image:Ide_GE_ImageScreen.png|center]]

'''Icon'''

Under the {{ide|Resource Editor#Graphic Field|Graphic Field}}, you can see the Icon drop-down list:

[[Image:Ide_GE_IconComboBox.png|center]]

You can choose, which of the icon images in the current file to load into the editor.

===== Move Toolbar =====
(Moving, Rotating and Flipping an Image)
To the right of the Graphic Field, under the {{ide|Resource Editor#Image Screen|Image Screen}}, you can see the Image Move toolbar:

[[Image:Ide_I06.png|center|frame|'''Image Move toolbar''']]

By clicking the appropriate button you can move, rotate or flip the current image.

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I064.png]]
| '''Shift Left'''
| Moves the image one column to the left. The left edge column crosses the left borderline of the Graphic Field and returns to the Graphic Field as the right edge column
|-
| [[Image:Ide_I063.png]]
| '''Shift Right'''
| Moves the image one pixel column to the right. The right edge column crosses the right borderline of the Graphic Field and returns to the Graphic Field as the left edge column
|-
| [[Image:Ide_I061.png]]
| '''Shift Up'''
| Moves the image one pixel row up. The top row crosses the upper borderline of the Graphic Field and returns to the Graphic Field as the bottom row
|-
| [[Image:Ide_I062.png]]
| '''Shift Down'''
| Moves the image one pixel row down. The bottom row crosses the bottom borderline of the Graphic Field and returns to the Graphic Field as the top row
|-
| [[Image:Ide_I066.png]]
| '''Rotate Left'''
| Rotates the image 90 degrees counter-clockwise around its center
|-
| [[Image:Ide_I065.png]]
| '''Rotate Right'''
| Rotates the image 90 degrees clockwise around its center
|-
| [[Image:Ide_I068.png]]
| '''Flip Horizontal'''
| Flips the image around the vertical axis
|-
| [[Image:Ide_I067.png]]
| '''Flip Vertical'''
| Flips the image around the horizontal axis
|}

Notice that the '''Resource | Move''' menu contains the same commands as the '''Image Move''' toolbar.

===== Color Palette =====

At the top of the Graphics Editor window you can see the Color Palette.

[[Image:Ide_GE_ColorPalette.png|center|frame|'''The Color Palette''']]

The Color Palette lets you choose colors for the drawing operations:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Setting the Draw and Edit Colors}}
* {{ide|Resource Editor#Setting the Background Colors|Setting the Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Setting the Inverse (to Background) Color}}

===== Color Modes Toolbar =====

Under the {{ide|Resource Editor#Image Screen|Image Screen}} you can see the Color Modes tool box:

[[Image:Ide_I10.png|center]]
<center>'''The Color Modes toolbar'''</center>

The Color Modes tool box is used to set:

* {{ide|Resource Editor#Setting the Draw and Edit Colors|Draw and Edit colors}}
* {{ide|Resource Editor#Setting the Background Colors|Background Color}}
* {{ide|Resource Editor#Setting the Inverse (to Background) Color|Inverse (to Background) Color}}

===== Draw and Edit Toolbar =====
(Using Draw and Edit Tools)
To the left of the Graphic Field of the Graphics Editor window you can see the Draw and Edit Toolbar. It contains the main tools for drawing and editing:

[[Image:Ide_GE_DrawEditToolbox.png|center]]
<center>'''The Draw and Edit toolbar'''</center>

The Graphics Editor provides a number of tools to make creating your image easy. The tools can be activated either from the '''Resource | Tools''' menu or from the Draw and Edit toolbar.

===== Draw and Edit Tools =====

By clicking any of the buttons in the Draw and Edit toolbar you can select the required draw or edit tool. Here are short descriptions of them:

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I15.png]]
| '''Pen'''
| The Pen tool can be used to color an individual pixel on the Graphic Field or to make a free-hand drawing.
|-
| [[Image:Ide_I16.png]]
| '''Brush'''
| The Brush tool works the same as Pen tool, except that the Brush tool leaves a larger mark than the Pen. The style of the Brush can be changed by selecting among the '''Small''', '''Big''', and '''Star''' in the '''Brush Style''' list button (in the right bottom corner of the Graphics Editor window).
|-
| [[Image:Ide_I18.png]]
| '''Eraser'''
| To erase a fragment of the image (the same as painting it with the Screen Color), you can use the Eraser Tool in the toolbar. The size of the Eraser can be changed by selecting among the '''Small''' and '''Big''' in the '''Eraser Style''' list button (in the right bottom corner of the Graphics Editor window)
|-
| [[Image:Ide_I20.png]]
| '''Color Eraser'''
| The Erase Color tool will erase cells of the selected color without changing other colors.
|-
| [[Image:Ide_I21.png]]
| '''Fill Contour'''
| The fastest way to color an area, which has an enclosed boundary, is to use the Fill Contour tool. Move the cursor into the area to be colored and click the mouse button. The interior of the bounded region will be colored.
|-
| [[Image:Ide_I26.png]]
| '''Mirror'''
| To create symmetrical images use the Mirror tool. The Mirror tool sets the points that are the reflections of the cursor trail point relative to the different axes of symmetry. To choose the appropriate axes of symmetry for the Mirror tool select the '''Resource <nowiki>|</nowiki> {{ide|Resource Editor#Mirror Style Dialog|Set Mirror Style}}''' menu command in the Task window menu.
|-
| [[Image:Ide_I22.png]]
| '''Line'''
| Selecting this button enables you to draw a line between any two points in the image.
|-
| [[Image:Ide_I23.png]]
| '''Draw Rectangle'''
| Click this button if you need a rectangle. Size the Rectangle by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I24.png]]
| '''Draw Ellipse'''
| Choose this tool if you need to draw a circle or an ellipse. Size the circle or ellipse by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I25.png]]
|'''Enter Text'''
| Click this button to insert some text in your image. Move the cursor to the position on the Graphic Field where you want to start the text and click the mouse button. You will see a text cursor, which shows you the height of the letters and digits, and the starting point for the current line of text. When you type some text, it will be drawn in the currently selected color, with the currently selected font. To select the desired font settings press '''Ctrl+F'''. While the text is still selected, it is possible to move the starting point clicking in the new position.
|-
| [[Image:Ide_I28.png]]
| '''Mark Area'''
|To mark a rectangular fragment of the image on the Graphic Field to be cut, copied or moved, click the '''Mark Area''' tool. Then move the cursor to the Graphic Field cell, which you want to be one corner of a marked rectangular area, and press and hold the mouse button. Release the mouse when the rectangle is of the appropriate size and you will see a sub-region of the image marked accordingly. You can move the marked region to another part of the Graphic Field by means of "drag and drop". Move the cursor into the marked region and press and hold the mouse button. Then, keeping the mouse button depressed, drag the marked fragment to the place of your choice and release the mouse button. Now the marked region is fixed in its new place. If you want to copy the marked region to another place, do as described under move, but hold down the '''Ctrl''' key, while pressing the mouse button in the marked region. When a region is marked:
* '''Edit|Cut''' or '''Edit|Copy''' (from the main menu, or the main IDE toolbar '''Cut''' and '''Copy''' buttons, or the standard accelerator keys '''Ctrl+X''' and '''Ctrl+C''')can be used to place it to the clipboard;
* '''Edit|Paste''' (or the '''Paste''' toolbar button or accelerator '''Ctrl+V''')can be used to scale a image from the clipboard into the region.
* The '''Paste&Scale''' tool can be used.
'''Note''' When you use '''Edit|Paste''' , the image fragment will appear in the left top corner of Graphic Field. The region may be moved to another place by the mouse.
|-
| [[Image:Ide_I29.png]]
| '''Paste & Scale in Rectangle'''
| When an image has been copied to the clipboard, this image can be pasted back into another marked area by pressing this button. This button will stay disabled until there are both an image on the clipboard, and a region has been selected.
|-
| [[Image:Ide_I30.png]]
| '''Clear Graphic Field'''
| To clear the Graphic Field, click the Clear button. The white color is used for bitmaps and transparent color is used for icons and cursors.
|-
| [[Image:Ide_I31.png]]
| '''Change a Selected Color'''
| With this button you can change all pixels that have a given color into another color. The two colors should first be set for the '''Color''' and '''Alt-Color''' selections. '''Note''' Any pixels, which were colored in background color or in "inverse" color by '''Inverse''' tool, will keep their original colors.
|-
|[[Image:Ide_I32.png]]
| '''Inverse Colors'''
| This button can be used to invert all colors on the image. In this case, any pixels, which were colored in background color or in inverse to background color, will retain their existing colors.
|-
| [[Image:Ide_I33.png]]
| '''Grid'''
| This button can be used to turn on and off a grid in the Graphic Field
|}

==== Mirror Style Dialog ====

The '''Mirror Style''' dialog is activated by the '''Resource | Set Mirror Style''' menu command in the Task window menu:

[[Image:Ide_GE_MirrorStyle.png|center]]
<center>'''The Mirror Style dialog'''</center>

The '''Mirror Style''' dialog is used to choose the appropriate axes of symmetry for the '''Mirror''' tool.

The '''Mirror''' tool [[Image:Ide_I26.png]] sets the points that are the reflections of the '''cursor ''trail'' point''' relative to the different axes of symmetry.

When you place the mouse cursor onto some point inside an edited image and click the left mouse button, then we say that you set the '''cursor ''trail'' point'''.

Using the '''Mirror''' tool, you can (by one click) set up to 8 reflections of the specified cursor ''trail'' point. A reflection point will be painted to each checked ON type of reflections. They are:

'''Main -> Trial'''
:When checked ON, then paints the clicked '''cursor ''trail'' point'''.
'''Main -> Reverse'''
:When checked ON, then paints the point opposite to the clicked cursor trail point.
'''Reflect -> Horizontal'''
:When checked ON, then paints the point, which is the horizontal reflection of the clicked cursor trail point.
'''Reflect -> Vertical'''
:When checked ON, then paints the point, which is the vertical reflection of the clicked cursor trail point.
'''Orthogonal -> Left'''
:When checked ON, then paints the point, which is 90 degrees left rotation of the clicked cursor trail point.
'''Orthogonal -> Right'''
:When checked ON, then paints the point, which is 90 degrees right rotation of the clicked cursor trail point.
'''Reflect Diagonal -> Left'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''left''' upper corner to the right lower corner of the image.
'''Reflect Diagonal -> Right'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''right''' upper corner to the left lower corner of the image.

=== Using Tools and Colors ===

==== Setting Colors ====

===== Setting the Draw and Edit Colors =====

To choose colors for the drawing and editing tools you can select one of the following four switches.

[[Image:Ide_GE_Mode_DrawColor.png|center]]
<center>'''The Color Modes toolbar with selected "color" mode'''</center>

The color of selection will be used for the drawing. It is possible to choose a new color for the active selection by a click in the {{ide|Resource Editor#Color Palette|Color Palette}}.

The '''color''' and the '''alt-color''' can be used in all drawing operations, the '''screen''' (or transparent) and '''inverse''' selections have different purposes depending on the image type.

'''Note.'''
There are 16 color fields on the {{ide|Resource Editor#Color Palette|Color Palette}}, and all of them are available for drawing and editing in the {{ide|Resource Editor#Graphic Field|Graphic Field}}.

===== Setting the Background Color =====

To see how your image looks on the different background colors or to color the image fragments in "transparent" (to let the background color show through) use the '''screen''' color selection.

[[Image:Ide_GE_Mode_BackgroundColor.png|center]]
<center>'''The "screen" mode should be used for Background color'''</center>

To change the background color, be sure that the '''screen''' switch is selected, then you can choose the background color by clicking in the {{ide|Resource Editor#Color Palette|Color Palette}}. The background color on the {{ide|Resource Editor#Image Screen|Image Screen}}, any details of the image, which were colored in (transparent) background color, and the '''screen''' indicator of '''Color Modes''' toolbar, all will change to the new color.

'''Usage of the "screen" Colors for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Screen Colors
|-
! Bitmaps
| Used to set the color of the surrounding area
|-
! Cursors and Icons
| Used to specify transparent pixels and to set the color of the surrounding area
|}

===== Setting the Inverse (to Background) Color =====

Using the inverse color is a convenient way to mark the boundary of the image or to color the details, which should be always be in contrast to any background color.

[[Image:Ide_GE_Mode_InverseBackground.png|center]]
<center>'''The "inverse" mode should be used for Inverse color'''</center>

'''Usage of the Inverse color for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Inverse Color
|-
! Bitmaps
| Cannot be used
|-
! Cursors and Icons
| Used to specify pixels that should get a color inverse of the actual background
|}

==== Understanding Colors ====

*'''Colors for Bitmaps'''

The Visual Prolog Graphics Editor can create bitmaps with either 2 or 16 colors. A pixel in a bitmap can not have the inverse and screen colors.

*'''Colors for Cursors'''

Any pixel in a cursor can have one of four color control values:

{|{{prettytable}}
|-
! Cursor
! Color Effect
|-
! Black
| Pixels will be black
|-
! White
| Pixels will be white
|-
! Inverse
| Pixels will be converted to the inverse of the original color
|-
! Screen
| Pixels will be transparent, they will just keep their old color
|}

To understand how this works, you should create a little cursor having four areas, with these four color control values. Then select the '''Resources | Tools | Test Cursor''', and study how the cursor looks.

[[Image:Ide_GE_TestCursorColors.png|center]]
<center>'''In this test cursor the left upper quoter of the cursor is painted with the "color"'''</center>
<center>'''and the left bottom quarter is painted with the "inverse"'''</center>

Place the cursor over the Grid and you will see effects of "inverse" color.

*'''Colors for Icons'''

Icons can either have 2 or 16 colors, and in addition to those, the pixels can also use the {{ide|Resource Editor#Setting the Background Color|'''screen'''}} and
{{ide|Resource Editor#Setting the Inverse (to Background) Color|'''colors'''}}.

==== Cursor Handling Tools ====

'''Setting Cursor Hot Spots'''

When working with a cursor, the menu command Resource | Set Cursor Hotspot activates a dialog box:

[[Image:Ide_GE_CursorHotSpot.png|center]]
<center>'''Defining the Hotspot for a cursor'''</center>

As long as this dialog is open you can point to the pixel, which is to be the cursor Hotspot. This pixel in the cursor will determine the screen pixel which will be acted upon and which will be reported during a mouse action.

'''Testing a Cursor'''

When working with a cursor, the '''Resource | Tools | Test Cursor''' menu item allows you to see what your newly designed cursor will look like.

==== Undo / Redo Buffer ====

The Graphics Editor supports '''Edit|Undo''' and '''Edit|Redo''' operations, just as the other editors do.

Ide/Resource Editor

2013-04-26T13:27:32Z

GalinaTchekmareva:

{{ideNavbar|Resource Editor}}

The term ''resource'' is applied to the things like dialogs, forms, icons, cursors, pens, brushes, etc. Resources can be created by one of the IDE resource editors, or just added to a project. The correspondent resource files are referenced from a project file.

During project building IDE generates binary '''ProjectName.res''' file which is provided to a linker. IDE also generates <vp>resourceIdentifiers.i</vp> file which specifies numeric constants for resource identifiers. Resource identifierd can be refered from sources codes to provide the proper resource handling. The names and values for resource identifiers can be set or changed with the help of IDE resource editors.

== GUI and VPI Style Resources ==

Historically windowing programs - that is, programs with the graphical user interface - were developed in Visual Prolog using the VPI (Visual Programming Interface) package supplied as one of packages in Prolog Foundation Classes (PFC).

The Visual Programming Interface (VPI) is a high-level Application Programming Interface (API) and it is designed to make it easy for Prolog applications to provide sophisticated user interfaces utilizing the graphical capabilities of today's operating systems and display hardware. The resources and tools needed by such applications - windows, menus, dialogs, controls, pens, brushes, cursors, carets, pictures, etc. all appear as simple Prolog structures.

However, the VPI layer (PFC\vpi) provides an old style of handling the graphical user interface. This was the reason why the PDC has developed the modern GUI package (pfc\gui), which provides really object-oriented implementation of API handling of the main windowing system features. The GUI package presents the object-oriented windows, dialogs, forms, controls, etc., handling. This package is built on top of the VPI package and delivers a new level of abstraction and ease of use while retaining compatibility with VPI programs since both the GUI and VPI programming styles can be applied in the same program.

Currently for new GUI applications the IDE generates the default program code which use the GUI package features (but it still possible to edit old VPI style dialogs, etc.).

Notice that in VPI style programs, except for ''VPI style dialogs'' and ''VPI style windows'' you can also create ''GUI style forms'', which, of course, are handled by GUI package predicates. From the other side, since each GUI program includes the VPI package, so some VPI features can be embedded into GUI style programs.

To understand difference of GUI and VPI style programs and difference of GUI and VPI style dialogs, windows, forms, controls, etc., we recommend to read carefully VPI and GUI programming tutorials on WEB.

== IDE Designer ==

Editing of dialogs, windows, form, and IDE Controls on the '''IDE Designer''' are very closely related. The only real difference is that definitions of the VPI package dialogs are (normally) put into resource files, whereas GUI package dialogs, windows, and forms are always created dynamically by code.

=== Creating a Dialog ===
----
{{:ide/Creating new Project Items/Creating a Dialog}}

=== Editing a Dialog ===
----
{{:ide/Resource Editor/Editing a Dialog}}

=== Creating and Editing a Window ===
----
The IDE does not support the creation or editing of the old-style VPI windows. You should use
{{ide|Resource Editor#Creating and Editing a Form|'''Forms'''}} instead of windows (see description of forms in the GUI package overview in the PFC part of Help for more details).

However, the IDE automatically creates for GUI applications the special resource file '''TaskWindow.win''' which is placed if the TaskWindow sub-directory of the project root directory. This resource file can be later changed by the IDE resource editor.

=== Creating and Editing a Form ===
----
{{:ide/Creating new Project Items/Creating a Form}}

== Toolbar Editor ==

The '''Toolbar''' editor allows you interactively create various kinds of toolbars.
{{:ide/Creating new Project Items/Creating a Toolbar}}

=== Editing a Toolbar ===

{{:ide/Resource Editor/Editing a Toolbar}}

== Menu Editor ==

The '''Menu Editor''' can be used to create both pull-down menus (for windows), and pop-up menus (useful for object oriented user interfaces).
{{:ide/Creating new Project Items/Creating a Menu}}

==== Editing a Menu ====

To edit a menu, double-click (or press '''Enter''') the name of a file with a menu description in the project tree in the '''Project''' window. For example '''TaskMenu.mnu'''. The '''Menu Editor''' dialog appears and you can create (or modify) whatever kind of a menu you wish.

[[Image:Ide_MenuTask.png|center|frame|'''Menu Editor''']]

The '''Menu Editor''' dialog allows you to modify or delete existing menu items or add new ones. The main pane in this dialog contains the tree of menu items of the edited (it is '''TaskMenu''' in the picture) menu.

By pressing the '''New''' toolbar buttons it is possible to create new menu items and sub-items. You can use: [[Image:Ide_MenuEdit_First.png]] - the '''New First Item''', [[Image:Ide_MenuEdit_New.png]] - the next '''New Item''' , and [[Image:Ide_MenuEdit_Subitem.png]] - the menu '''New SubItem'''.

Menu items can optionally be grouped by inserting separators. To insert a separator just click the '''New Separator''' toolbar button [[Image:Ide_MenuEdit_Separator.png]].

'''Cut''', '''Copy''' and '''Paste''' operations for selected menu items (with all their submenu items) can be executed with '''Ctrl+X''', '''Ctrl+C''', and '''Ctrl+V''' keyboard accelerators.

The '''Menu Editor''' can create nested menus of any level. To enter/create a submenu for the selected menu item click the '''Submenu''' button [[Image:Ide_MenuEdit_Subitem.png]].

By pressing the '''Test''' toolbar button [[Image:Ide_MenuEdit_Test.png]] you activate the test mode in which the edited menu will be displayed instead of the main IDE menu. You can open it submenus, etc. To exit the test mode, you can click somewhere in the IDE window out of the tested menu.

===== Customizing Menu Item Attributes =====

In the bottom of the menu editor dialog you see the big pane (the '''Menu Tree''' pane) in which you can see the edited menu tree. Menu items prefixed with the plus [[Image:Ide_Plus_Icon.png]] icon have submenus. Click the plus [[Image:Ide_Plus_Icon.png]] icon or press the right arrow on the keypad to expand one level of such submenu. Notice that the plus [[Image:Ide_Plus_Icon.png]] icon before expanded menu items is changed for the minus [[Image:Ide_Minus_Icon.png]] icon.

When you select any menu item in the menu tree, the menu editor controls display attributes of this menu item. For each menu item the programmer can specify the following attributes:

*'''Item Title'''
*:Select a menu item in the '''Menu Tree''' pane and click the menu item title. The menu item title becomes surrounded by the frame like:
*:[[Image:Ide_MenuEdit_Title.png]]
*:Here you can specify/edit the menu item title (name).
*:* The menu item title may contain up to 255 characters. It may include the '''\t''' (tab) escape sequence.
*:* In the menu item title the ampersand symbol '''&''' can be used for indicating that the following character is to be underlined. For example, if you type in the string '''&Contents''', then at runtime this menu item will be displayed as '''C''''''ontents'''. I.e. the character '''C''' will be displayed underlined (thus visually indicating that the '''C''' is an accelerator key). The underlined character should be unique on each level of a menu. If you need to display the '''&''' character, use two '''&&'''.

*'''Item Constant'''
*:The '''Item Constant''' input box is where you can select or type in the symbolic (or integer) constant that will be used as the menu item identifier. It can be typed-in directly from the keyboard or selected from the list of available constants (by clicking the [[Image:Ide_ListButton_Button.png]] button). It must be either a legal symbolic constant (for example, '''''id_help_contents''''') or an integer value.
*: If you enter a symbolic constant name, then the IDE automatically places this symbolic constant into the '''resourceidentifiers.i''' file and generates an appropriate integer value for it. The '''Menu Editor''' automatically generates the default symbolic constant name (for example, '''''id_file_exit''''') from the '''Constant Prefix''' '''''id_file''''' and names of menu items ('''Exit''' on the picture).

*'''Constant Prefix'''
*:The '''Constant Prefix''' edit control is where you can input a common prefix for all ''item constants'' of menu items on the current level of submenu.

*'''Checked'''
*:Set the initial state of the menu item to Checked.

*'''Disabled'''
*:Specifies that initially the menu item will be Disabled.

*'''Accelerator'''
*:In the '''Accelerator''' group box you can set an accelerator key (hot key), which will be used to activate this menu item. The accelerator key can be defined as a combination of a basic accelerator key and of the '''Shift''', '''Ctrl''', and '''Alt''' keys. The basic accelerator key can be typed in or chosen from the list in the list edit control. To specify the desired '''Shift''', '''Ctrl''', and '''Alt''' keys check on the corresponding check box. To assign more than one accelerator key to a menu item, use the <vp>vpi::setAccelerators/1</vp> predicate.

*'''Help Constant'''
*:In this list button control you can select one of constants of the existing first-level menu items. The '''Windows''' (system handling) menu item (in MDI mode) will be placed just before the first-level menu item with this constant.
*: Notice that this possibility can be used only for MDI applications. (It is ignored for non-MDI applications since they do not have the '''Windows''' (system handling) menu item.

===== Editing the Window Submenu =====

In MDI applications Windows automatically add the '''Windows''' first-level menu item, which, by default, is placed after (the most right) all other user-created first-level menu items in each application menu. By default, it contains the '''Tile''', '''Cascade''', and '''Arrange Icons''' menu commands and in the bottom of this menu are listed titles of all opened MDI document windows.

To customize items of the '''Windows''' submenu, the programmer should create a new menu with the Item Constant equal to '''''mdiwindow_menu'''''. This menu should include only one level of menu items. Notice that since this user-designed submenu will be used instead of the default system '''Windows''' submenu, so handling of ALL its menu commands should be explicitly programmed. For instance, handling of the '''Tile''', '''Cascade''', and '''Arrange Icons''' menu commands should be programmed if they are included into the designed menu.

== Graphics Editor ==

=== About the Graphics Editor ===

The Graphics Editor is a convenient tool for creating, viewing and editing icons, cursors and small bitmaps. The images can be passed to the Windows Clipboard or saved in files.

The Graphics Editor allows you to create and edit images ranging in size from 4x4 pixels to 64x64 pixels, by using either a 16-color palette or monochrome shadow palette.

The Graphics Editor is invoked from the Project window for Icons, Cursors and Bitmaps. However, when you register large bitmaps in your project, Visual Prolog will call to edit the bitmap an external editor associated in Windows for editing files with .BMP extension.

After the Graphics Editor is started, the Graphics Editor window will appear on the screen.

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics editor window''']]

When you create a new image in a project, you need to specify the '''Name''' of the image, the Constant (resource ID) which will be identify the image in the project, the name of the '''File''', in which the image will be saved, its size, and how many colors it will have.

=== Graphics Editor Menus ===

When the Graphics Editor window is active, the Integrated Development Environment's menu bar displays the Graphics Editor sub-menus of the '''Resource''' menu and looks as follows:

[[Image:Ide_GE_Menu.png|center|frame|'''The Visual Prolog menu bar when the Graphics Editor is active''']]

Note that there are 2 menu items: '''Set Mirror Style''', '''Set Cursor Hotspot''' and 2 sub-menus: '''Tools''' and '''Move'''. Also some menu items under the '''Edit''' menu (like the '''Undo''', '''Redo''', '''Cut''', '''Copy''', '''Paste''') are specially tailored for the Graphics Editor, and the '''File''' menu operations refer now to the image files.

=== Creating a Image ===

{{:ide/Creating new Project Items/Creating a Image}}

=== Editing Image Attributes ===

You can always wake up (with the '''Resource | Attribute''' task menu item or with the '''Attribute''' item from pop up menu) the '''Bitmap/Cursor/Icon Attributes''' dialog for the created bitmap, cursor or icon to view and change some image attributes.

Notice that the appeared '''Bitmap Attributes''' dialog for an existing bitmap will display less bitmap attributes then it has for created bitmaps:

[[Image:Ide_GE_ExistingBitmapAttributes.png|center|frame|'''The Bitmap Attributes dialog for an existing bitmap''']]

You see that for existing bitmap the dialog does not contain the '''Width''', '''Height''', and '''Color''' attributes.

The only image attribute that you can edit is the '''Constant'''.:

'''Constant'''
:In the '''Constant''' list edit the programmer can change the default resource constant for the image (at the picture it is '''''idb_mybitmap''''').
{{:ide/Resource Editor/Graphics Editor}}

Ide/Resource Editor/Editing a Dialog

2013-04-26T12:35:54Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>

To edit a dialog, in the project tree (in the Project window) double click (or press '''Enter''') the name of a file with a dialog description (the '''.dlg''' filename extension). The
{{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} appears and you can edit whatever form of a dialog you wish.

[[Image:Ide_MyDialog_Editor.png|center]]

The IDE Designer After Creation of a New Dialog

When a new dialog is created, it will by default have three push button controls: '''OK''', '''Cancel''' and '''Help'''. These can freely be rearranged or deleted.

==== Controls ====

Each control in a dialog must have an identifying name (constant in VPI style dialogs), which is unique within that dialog. While two controls within one dialog may not have the same name (or constant value), it is actually a good idea if controls in different dialogs, which perform the same action have the same names (or constants).

===== Types of Controls =====

{|{{prettytable}}
|-
| [[Image:Ide_PushButton.png]]
| A '''Push Button''' control serves to initiate a specialized action in an application.
|-
| [[Image:Ide_CheckBox.png]]
| A '''Check Box''' control lets you indicate a choice among two alternatives. For example some facility may be switched ON or switched OFF.
|-
| [[Image:Ide_RadioButton.png]]
| A group of '''Radio Button''' controls serves to indicate one choice from among a list of alternatives.
|-
| [[Image:Ide_StaticText.png]]
| A '''Static Text''' control reserves an area for the text in the dialog. Although called static, in fact the application can change the text during execution. This is often used for prompts or field names relating to other controls.
|-
| [[Image:Ide_EditControl.png]]
| An '''Edit Control''' reserves an area for text editing (e.g. names, numbers, text constants etc.). Editing text strings with multiple lines is possible.
|-
| [[Image:Ide_ListBox.png]]
| A '''List Box''' allows you to view a list of elements and to select one - or several - elements from this list.
|-
| [[Image:Ide_ListButton.png]]
| A '''List Button''' control serves for choosing one from the pop-out set of the alternatives revealed by pressing the button. Pressing the button again pops the list back in again.
|-
| [[Image:Ide_ListEdit.png]]
| A '''List Edit''' control allows single line text editing like an '''Edit''' control, or selection from a list of elements.
|-
| [[Image:Ide_VerticalScrollBar.png]] [[Image:Ide_HorizontalScrollBar.png]]
| The '''Vertical Scroll Bar''' and the '''Horizontal Scroll Bar''' controls serve to select a value within a scale of values.
|-
| [[Image:Ide_GroupBox.png]]
| A '''Group Box''' control serves for assembling together a number of controls in a functional group with a Group Name. Its only function is a visual one.
|-
| [[Image:Ide_Icon.png]]
| An '''Icon''' control reserves an area for an icon image.
|-
| [[Image:Ide_CustomControl.png]]
| A '''Custom Control''' can be either IDE Controls created in the project, it can be VPI user-defined control with a window class defined by <vp>vpi::classCreate</vp>, or it can be controls imported as {{ide|Creating new Project Items#Creating a COM Package|COM packages}} from DLLs, VBXs or OCXs.
|}

===== Inserting Controls =====

To insert a new control in a dialog, click the icon of the desired control type in the '''Controls toolbar'''. (You can also select the desired control type in the '''Controls''' sub-menu of the main IDE menu or in the pop-up menu in the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}}.)

===== Controls Toolbar =====

Originally the '''Controls toolbar''' is displayed below the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} window. You see it in the following picture:

[[Image:Ide_Controls.png|center|frame|'''The Controls Toolbar''']]

Clicking icons in the '''Controls toolbar''' you select a type of a control to be placed into the edited dialog/window/form/IDE control (sometimes we will use the term ''container'' instead of dialog/window/form/IDE control). When you click a control type icon, then the current cursor is replaced with the cursor correspondent to the control type to be inserted. Move the cursor to some position in the container client area and click the mouse button. The control with the default size will be inserted at the specified position.

Instead of dropping a control into a container with a click, it is possible to drag out the rectangle (in the container client area) where a control should be placed; so you can specify not only the control position but also the control size.

After a VPI control is placed with the mouse into a {{ide|Resource_Editor#GUI and VPI Style Resources|VPI style container}}, the correspondent VPI control Attributes dialog appears. In this dialog you can change some control attributes, when you close the dialog, the control appears at the specified location in the container.

After a GUI control is placed with the mouse into a {{ide|Resource_Editor#GUI and VPI Style Resources|GUI style container}}, it immediately appears at the specified location in the container. To change properties of the GUI control, one should select it then the list of GUI control properties appears in the {{ide|Resource Editor#GUI Control Properties Table|GUI control Properties table}}.

There are the following icons in the '''Controls toolbar:'''

{|{{prettytable}}
|-
! Icon
! Insert a new:
! Description
|-
| [[Image:Ide_Ctrl_PushBtn.png]]
| Push Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_PushBtn.png]]
|-
| [[Image:Ide_Ctrl_CheckBx.png]]
| Check Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Check.png]].
|-
| [[Image:Ide_Ctrl_RadioBtn.png]]
| Radio Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_RB.png]].
|-
| [[Image:Ide_Ctrl_StaText.png]]
| Static Text Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Text.png]].
|-
| [[Image:Ide_Ctrl_EditCtrl.png]]
| Edit Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Edit.png]].
|-
| [[Image:Ide_Ctrl_ListBox.png]]
| List Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListBox.png]].
|-
| [[Image:Ide_Ctrl_ListBtn.png]]
| List Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListBtn.png]].
|-
| [[Image:Ide_Ctrl_ListEdit.png]]
| List Edit
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListEdit.png]].
|-
| [[Image:Ide_Ctrl_HScroll.png]]
| Horizontal Scroll Bar
| After selection of this control the cursor becomes [[Image:Ide_Cursor_HScroll.png]].
|-
| [[Image:Ide_Ctrl_VScroll.png]]
| Vertical Scroll Bar
| After selection of this control the cursor becomes [[Image:Ide_Cursor_VScroll.png]].
|-
| [[Image:Ide_Ctrl_GroupBox.png]]
| Group Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Group.png]].
|-
| [[Image:Ide_Ctrl_Icon.png]]
| Icon Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Icon.png]].
|-
| [[Image:Ide_Ctrl_Custom.png]]
| Custom Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Custom.png]].
|}

===== Selecting and Deselecting Controls =====

Click inside a control to select one control. A frame appears around the selected control.

To select a group of controls move the mouse pointer to the point in the dialog you want to be one corner of the selected area and press and hold the left mouse button. While holding the left mouse button move the mouse until all the desired controls in the dialog are inside the selected area. Then release the mouse button. All controls inside the specified rectangle will be selected.

Also after one or more controls are already selected, you can include one extra control in the selection by holding down the '''Ctrl''' key and click the control.

To deselect the control or group of controls click outside the selecting frame. Deselected controls lose their frame.

===== Resizing Controls =====

Once a control has been inserted in the dialog, it has a default size. To re-size a control, first click inside the control area to select it. Then move the cursor to the sizing handles on the selection frame. A new shape of cursor indicates the direction in which you can re-size the control. Press and hold the mouse button, drag until the selected control has the size you want, then release the mouse button.

You can also change the size of a control by double-clicking it to activate the dialog for control attributes setting. Select the position you want to change and after specifying a new position or size, press enter to return to the dialog.

'''Remark:''' You cannot change the size of icons. You can only change their location.

===== Moving Controls =====

To move a control or a group of controls first select them. Then move the cursor inside the selection frame, press and hold the mouse button, drag the mouse pointer to a new location and release the mouse. Also, when one or more controls are selected, it is possible to use the cursor keys to move the selection in small steps (corresponding to the '''Grid''' settings).

===== Arranging Controls =====

To arrange a group of controls first select the group. Then click an appropriate button in the '''Layout''' toolbar or a menu item in the '''Layout''' menu of the IDE menu (or in the pop-up menu).

[[Image:Ide_Layout.png|center|frame|'''The Layout Toolbar''']]

The '''Layout''' commands for justifying and resizing controls:

{|{{prettytable}}
|-
| [[Image:Ide_Layout_AllignLeft.png]]
| '''Align Left'''
| Align the selected controls along their left sides.
|-
| [[Image:Ide_Layout_CenterVertically.png]]
| '''Align Center'''
| Center the selected controls vertically.
|-
| [[Image:Ide_Layout_AllignRight.png]]
| '''Align Right'''
| Align the selected controls along their right sides.
|-
| [[Image:Ide_Layout_AllignTops.png]]
| '''Align Top'''
| Align the selected controls along their tops.
|-
| [[Image:Ide_Layout_CenterHorizontally.png]]
| '''Align Middle'''
| Center the selected controls horizontally.
|-
| [[Image:Ide_Layout_AllignBottom.png]]
| '''Align Bottom'''
| Align the selected controls along their bottoms.
|-
| [[Image:Ide_Layout_SpacingHorizontally.png]]
| '''Even Horizontal Spacing'''
| Spacing the selected controls evenly between the leftmost and the rightmost controls.
|-
| [[Image:Ide_GridButton.png]]
| '''Grid'''
| Toggle the Grid (see below).
|-
| [[Image:Ide_Layout_SpacingVertically.png]]
| '''Even Vertical Spacing'''
| Spacing the selected controls evenly between the topmost and the bottom-most controls.
|-
| [[Image:Ide_Layout_SameSize.png]]
| '''Make Same Size'''
| Make the selected controls the same size as a model control.
|-
| [[Image:Ide_Layout_SameHorizontal.png]]
| '''Make Same Horizontal Size'''
| Make the selected controls the same width as a model control.
|-
| [[Image:Ide_Layout_SameVertical.png]]
| '''Make Same Vertical Size'''
| Make the selected controls the same height as a model control.
|-
|
| '''Size To Contents'''
| Resize the selected controls to optimally display its titles (caption texts).
|}

==== Editing Properties of GUI Controls ====

When you open a GUI dialog or a Form (GUI window) in the '''IDE Designer''', then near from the opened dialog (form) the {{ide|Resource Editor#GUI Control Properties Table|'''Control Properties table'''}} appears.

To change ''properties'' of a GUI package control first select this control (by clicking in it) in the dialog (form). The current set of the control properties appears in the '''Control Properties''' table. Now you can edit the displayed GUI control properties.

'''Click here to view {{ide|Resource Editor#GUI Control Properties Table|GUI Control Properties table}}'''

The displayed set of properties depends on the control type. The {{ide|Resource Editor#GUI Control Properties Table|'''Control Properties table'''}} contains two types of properties. General properties are common to all types of controls and some properties, which are individual to different kinds of controls.

Initially this '''Control Properties''' table is empty. However, as soon as one of controls in the edited dialog (form) is selected this table starts to display properties of the selected control.

If the '''Control Properties''' table is closed, then double-click a control - the '''Control Properties''' table appears. Also the '''Control Attributes''' command, from the '''IDE Designer''' {{ide|Resource Editor#Speed Menu|speed menu}}, can be used to open the '''Control Properties''' table.
{{:ide/Resource Editor/GUI Control Properties Table}}

==== Editing Attributes of VPI Controls ====

To change attributes of a VPI package control double-click it or select the control and activates the '''Control Attributes''' command from the '''IDE Designer''' {{ide|Resource Editor#Speed Menu|speed menu}}. Then the '''''<ControlType>'' Attributes''' dialog appears.

These dialogs contains two levels of attributes. The general group contains attributes, which are common to all types of controls: the '''Text''' determines the control title, the '''Constant''' (name) is used as the control identifier, and the '''Control Size''' group determines position and size of the control.

Notice that the '''Text''' property/attribute is not used for some controls, for instance, it is not used for scroll bars.

Notice that in the '''Text''' fields the ampersand symbol <vp>&</vp> is reserved for indicating that the next to it character is to be underlined. For example, if you use the text string '''E&xit''' as a control name, then this control will be displayed with the title '''Exit''' at runtime. I.e. the char '''x''' will be displayed underlined (thus visually indicating that the '''x''' is an accelerator key). If you need to display the ampersand <vp>&</vp> symbol in the '''Text''' of a control, then use two of them <vp>&&</vp>.

Other attributes are individual to different kinds of controls.

===== Attributes of VPI Controls =====

[Properties_of_VPI_Controls\Push_Button_Flags.htm Push Button Attributes]

[Properties_of_VPI_Controls\Check_Box_Flags.htm Check Box Attributes]

[Properties_of_VPI_Controls\Custom_Control_Attributes.htm Custom Control Attributes]

[Properties_of_VPI_Controls\Radio_Button_Flags.htm Radio Button Attributes]

[Properties_of_VPI_Controls\Static_Text_Flags.htm Static Text Attributes]

[Properties_of_VPI_Controls\Edit_Control_Flags.htm Edit Control Attributes]

[Properties_of_VPI_Controls\List_Box_Attributes.htm List Box Attributes]

[Properties_of_VPI_Controls\List_Button_Attributes.htm List Button Attributes]

[Properties_of_VPI_Controls\List_Edit_Attributes.htm List Edit Attributes]

[Properties_of_VPI_Controls\Scroll_Bar_Attributes.htm Scroll Bar Attributes]

[Properties_of_VPI_Controls\Group_Box_Attributes.htm Group Box Attributes]

[Properties_of_VPI_Controls\Icon_Control_Attributes.htm Icon Attributes]

==== Using Anchors for Positioning GUI Controls while Dialog Resizing ====

VPI controls remember in their attributes ({{ide|Resource Editor#Attributes of VPI Controls|'''Attributes of VPI Controls'''}}) only their absolute positions and sizes. Therefore, when a VPI dialog or a VPI window containing such VPI controls are resized, these VPI controls do not change their positions and sizes!

In difference to them GUI controls have additional ''Anchor'' properties, which help to reposition (and may be resize) GUI controls when containing them GUI dialog (or form) is resized.

Each GUI control has four anchor properties: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', and '''Bottom Anchor''' (see {{ide|Resource Editor#GUI Control Properties Table|'''Anchor Properties of GUI Controls'''}}).

Each anchor determines that the specified ('''Left''', '''Top''', '''Right''' or '''Bottom''') control boundary should be '''always''' positioned on the stated distance from the nearest (correspondent) border of the dialog (frame).

Each of anchors can have the '''True''' or '''False''' values. When the anchor value is '''True''', then this anchor is active (used to position the correspondent control).

For example, when the '''Left Anchor''' is active (has the '''True''' value), then the ''left'' control boundary should be positioned on the stated distance from the nearest (''left'') border of the dialog (frame).

The simplest way to see which anchors are active for a control, is to select this control. Then some red arrows between control boundaries and correspondent boundaries of the dialog can bee seen. Each arrow specifies, that the correspondent anchor is active. For example, the arrow from the control top to the dialog top identifies, that the '''Top Anchor''' is active. In the picture below, you see three arrows, which specify that the '''Left''', '''Top''', and '''Right''' anchors are active to the '''Push Button''' control.

[[Image:Ide_de_Anchors.png|center]]

Numbers near such arrows show distances (in Dialog Base Units) between the correspondent boundaries of the control and the dialog.

Normally each control has one active horizontal and one active vertical anchors. When the dialog is resized, then such control is always positioned on the specified distances from the specified boundaries of the dialog. The size of the control is not changed!

When a control has both horizontal (or/and both vertical) anchors active, then both horizontal (or/and both vertical) boundaries of the control should be placed on some specified distances from the correspondent horizontal (vertical) boundaries of the dialog. Therefore, when the dialog is resized, then such control is also resized accordingly to keep the specified distances.

When no one of horizontal (or vertical) anchors of a control are active, then no one of horizontal (or vertical) boundaries of the control are bounded to the correspondent horizontal (vertical) boundaries of the dialog. Coordinates of such controls are handles on the "proportional basis". For example, when the dialog width is increased onto <vp>Delta</vp> dialog base units, then the <vp>X</vp> coordinate of the control is also increased, but it is increased two times smaller. That is the <vp>X</vp> coordinate of the control is increased only onto <vp>Delta/2</vp> dialog base units.

==== Cut, Copy and Paste, Undo and Redo ====

You can '''Cut''' or '''Copy''' a group of selected controls onto the Windows clipboard, and '''Paste''' controls from the clipboard back into a dialog. The '''Undo''' and '''Redo''' commands serve to delete or restore the last editing operations of your dialog.

==== Grid ====

When the menu (or the pop-up menu) entry '''Resource | Grid''' is activated, or when the [[Image:Ide_GridButton.png]] button from the '''Layout''' toolbar is pressed, the following dialog appears:

[[Image:Ide_GridSpecification.png|center|frame|'''The Dialog to Specify the Grid Properties''']]

With a grid in place, arranging the controls inside a dialog is easier. Also it is possible to tell the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} by the '''Snap to Grid''' that it should place controls at the grid intersections to give a satisfactory result.

[[Image:Ide_MyDialog_withGrid.png|center|frame|'''Using a grid in the Dialog/Window/Form Editor''']]

==== Test Mode ====

The {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} has the '''Test Mode''', so it is possible to see how the dialog with the created controls behaves. To illustrate the '''Test Mode''' we will assign some default values to the controls. The test mode is activated and deactivated from the '''Resource''' menu (or from the pop-up menu).

[[Image:Ide_MyDialog_TestMode.png|center|frame|'''Test Mode for a Dialog''']]

==== Tab Stops ====

When activating the menu (or the pop-up menu) entry '''Resource | Tabstops''', it is possible to specify to which controls you can Tab to in the dialog. When this command is activated a small button with the <vp>+</vp> or <vp>-</vp> appears on controls depending upon whether the control has a tab stop or not. By clicking the small buttons, it is possible to toggle the setting.

[[Image:Ide_MyDialog_TabStops.png|center|frame|'''Specifying Tab Stops for a Dialog''']]

To exit the tab stop mode, just click in the dialog but outside of any controls.

==== Visit Order ====

When the tab stops have been specified for a dialog, then it is possible to specify the order in which controls will receive focus when tabbing.

[[Image:Ide_MyDialog_VisitOrder.png|center|frame|'''Displaying the Visit Order''']]

To change the visit order, click a small rectangle displaying the visit order number for a control that has an incorrect sequence number and this will bring up another dialog to change this sequence:

[[Image:Ide_MyDialog_ChangeVisitOrder.png|center|frame|'''Changing the Visit Order''']]

To stop the visit order mode, just click in the dialog outside any controls.

==== Speed Menu ====

When you are in the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} you can click the right mouse button to activate the Speed Menu. From this menu you can easily call any {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} command:

[[Image:Ide_We_SpeedMenu.png|center|frame|'''The IDE Designer Speed Menu''']]

Ide/Resource Editor

2013-04-26T10:30:26Z

GalinaTchekmareva:

Ide/Resource Editor/Graphics Editor

2013-04-26T10:25:55Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Graphics Editor Window ===

When the Graphics Editor is started to edit an image, the Graphics Editor window will appear on the screen:

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics Editor Window''']]

The Graphics Editor window is divided into several areas. Each area is responsible for a definite function or combines a number of tools, which are associated by purpose.

==== Areas of the Graphics Editor Window ====

===== Graphics Editor Title Bar =====

The title bar of the Graphics Editor window serves to display information about the type of the image (icon, cursor or bitmap), the image size in pixels, the number of colors which are available for use, and the name of the file which is opened for the current image.

For example, the title bar '''ProjectIcon.ico Size 32*32 Colors:16''' says that:
* the type of current image is an icon;
* the size of the current image is 32*32 pixels;
* 16 colors may be used in the image;
* the name of the file, which is opened for current image, is <vp>ProjectIcon.ico</vp>.

===== Graphic Field =====

The Graphic Field is situated in the middle of the Graphics Editor window.

[[Image:Ide_GE_GraphicField.png|center|frame|'''Typical contents of the Graphic Field''']]

The Graphic Field lets you see and edit the current image in expanded mode. The Graphic Field consists of small cells, where each cell corresponds to one pixel on the actual size image. The number of cells in each horizontal row and the number of cells in each vertical column give the image size, which is displayed in the title bar of the Graphics Editor window. It is possible to turn on and off a grid in the Graphic field.

===== Image Screen =====

To the right of the {{ide|Resource Editor#Graphic Field|Graphic Field}} in the Graphics Editor window you can see the Image Screen, painted in background color. In the middle of Image Screen you can see the current image in actual size on the selected background color. By changing the background color you can see how your current image will look in various surroundings.

[[Image:Ide_GE_ImageScreen.png|center]]

'''Icon'''

Under the {{ide|Resource Editor#Graphic Field|Graphic Field}}, you can see the Icon drop-down list:

[[Image:Ide_GE_IconComboBox.png|center]]

You can choose, which of the icon images in the current file to load into the editor.

===== Move Toolbar =====
(Moving, Rotating and Flipping an Image)
To the right of the Graphic Field, under the {{ide|Resource Editor#Image Screen|Image Screen}}, you can see the Image Move toolbar:

[[Image:Ide_I06.png|center|frame|'''Image Move toolbar''']]

By clicking the appropriate button you can move, rotate or flip the current image.

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I064.png]]
| '''Shift Left'''
| Moves the image one column to the left. The left edge column crosses the left borderline of the Graphic Field and returns to the Graphic Field as the right edge column
|-
| [[Image:Ide_I063.png]]
| '''Shift Right'''
| Moves the image one pixel column to the right. The right edge column crosses the right borderline of the Graphic Field and returns to the Graphic Field as the left edge column
|-
| [[Image:Ide_I061.png]]
| '''Shift Up'''
| Moves the image one pixel row up. The top row crosses the upper borderline of the Graphic Field and returns to the Graphic Field as the bottom row
|-
| [[Image:Ide_I062.png]]
| '''Shift Down'''
| Moves the image one pixel row down. The bottom row crosses the bottom borderline of the Graphic Field and returns to the Graphic Field as the top row
|-
| [[Image:Ide_I066.png]]
| '''Rotate Left'''
| Rotates the image 90 degrees counter-clockwise around its center
|-
| [[Image:Ide_I065.png]]
| '''Rotate Right'''
| Rotates the image 90 degrees clockwise around its center
|-
| [[Image:Ide_I068.png]]
| '''Flip Horizontal'''
| Flips the image around the vertical axis
|-
| [[Image:Ide_I067.png]]
| '''Flip Vertical'''
| Flips the image around the horizontal axis
|}

Notice that the '''Resource | Move''' menu contains the same commands as the '''Image Move''' toolbar.

===== Color Palette =====

At the top of the Graphics Editor window you can see the Color Palette.

[[Image:Ide_GE_ColorPalette.png|center|frame|'''The Color Palette''']]

The Color Palette lets you choose colors for the drawing operations:

* [GE_Using_Tools_and_Colors.htm#Setting_the_Draw_and_Edit_Colors Setting the Draw and Edit Colors]
* [GE_Using_Tools_and_Colors.htm#Setting_the_Background_Color Setting the Background Color]
* [GE_Using_Tools_and_Colors.htm#Setting_the_Inverse__to_Background__Color Setting the Inverse (to Background) Color]

===== Color Modes Toolbar =====

Under the {{ide|Resource Editor#Image Screen|Image Screen}} you can see the Color Modes tool box:

[[Image:Ide_I10.png|center]]
<center>'''The Color Modes toolbar'''</center>

The Color Modes tool box is used to set:

* [GE_Using_Tools_and_Colors.htm#Setting_the_Draw_and_Edit_Colors Draw and Edit colors]
* [GE_Using_Tools_and_Colors.htm#Setting_the_Background_Color Background color]
* [GE_Using_Tools_and_Colors.htm#Setting_the_Inverse__to_Background__Color Inverse (to Background) color]

===== Draw and Edit Toolbar =====
(Using Draw and Edit Tools)
To the left of the Graphic Field of the Graphics Editor window you can see the Draw and Edit Toolbar. It contains the main tools for drawing and editing:

[[Image:Ide_GE_DrawEditToolbox.png|center]]
<center>'''The Draw and Edit toolbar'''</center>

The Graphics Editor provides a number of tools to make creating your image easy. The tools can be activated either from the '''Resource | Tools''' menu or from the Draw and Edit toolbar.

===== Draw and Edit Tools =====

By clicking any of the buttons in the Draw and Edit toolbar you can select the required draw or edit tool. Here are short descriptions of them:

{|{{prettytable}}
|-
! Button
! Button Name
! Description
|-
| [[Image:Ide_I15.png]]
| '''Pen'''
| The Pen tool can be used to color an individual pixel on the Graphic Field or to make a free-hand drawing.
|-
| [[Image:Ide_I16.png]]
| '''Brush'''
| The Brush tool works the same as Pen tool, except that the Brush tool leaves a larger mark than the Pen. The style of the Brush can be changed by selecting among the '''Small''', '''Big''', and '''Star''' in the '''Brush Style''' list button (in the right bottom corner of the Graphics Editor window).
|-
| [[Image:Ide_I18.png]]
| '''Eraser'''
| To erase a fragment of the image (the same as painting it with the Screen Color), you can use the Eraser Tool in the toolbar. The size of the Eraser can be changed by selecting among the '''Small''' and '''Big''' in the '''Eraser Style''' list button (in the right bottom corner of the Graphics Editor window)
|-
| [[Image:Ide_I20.png]]
| '''Color Eraser'''
| The Erase Color tool will erase cells of the selected color without changing other colors.
|-
| [[Image:Ide_I21.png]]
| '''Fill Contour'''
| The fastest way to color an area, which has an enclosed boundary, is to use the Fill Contour tool. Move the cursor into the area to be colored and click the mouse button. The interior of the bounded region will be colored.
|-
| [[Image:Ide_I26.png]]
| '''Mirror'''
| To create symmetrical images use the Mirror tool. The Mirror tool sets the points that are the reflections of the cursor trail point relative to the different axes of symmetry. To choose the appropriate axes of symmetry for the Mirror tool select the '''Resource <nowiki>|</nowiki> {{ide|Resource Editor#Mirror Style Dialog|Set Mirror Style}}''' menu command in the Task window menu.
|-
| [[Image:Ide_I22.png]]
| '''Line'''
| Selecting this button enables you to draw a line between any two points in the image.
|-
| [[Image:Ide_I23.png]]
| '''Draw Rectangle'''
| Click this button if you need a rectangle. Size the Rectangle by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I24.png]]
| '''Draw Ellipse'''
| Choose this tool if you need to draw a circle or an ellipse. Size the circle or ellipse by drawing it out with the left button held down, then release.
|-
| [[Image:Ide_I25.png]]
|'''Enter Text'''
| Click this button to insert some text in your image. Move the cursor to the position on the Graphic Field where you want to start the text and click the mouse button. You will see a text cursor, which shows you the height of the letters and digits, and the starting point for the current line of text. When you type some text, it will be drawn in the currently selected color, with the currently selected font. To select the desired font settings press '''Ctrl+F'''. While the text is still selected, it is possible to move the starting point clicking in the new position.
|-
| [[Image:Ide_I28.png]]
| '''Mark Area'''
|To mark a rectangular fragment of the image on the Graphic Field to be cut, copied or moved, click the '''Mark Area''' tool. Then move the cursor to the Graphic Field cell, which you want to be one corner of a marked rectangular area, and press and hold the mouse button. Release the mouse when the rectangle is of the appropriate size and you will see a sub-region of the image marked accordingly. You can move the marked region to another part of the Graphic Field by means of "drag and drop". Move the cursor into the marked region and press and hold the mouse button. Then, keeping the mouse button depressed, drag the marked fragment to the place of your choice and release the mouse button. Now the marked region is fixed in its new place. If you want to copy the marked region to another place, do as described under move, but hold down the '''Ctrl''' key, while pressing the mouse button in the marked region. When a region is marked:
* '''Edit|Cut''' or '''Edit|Copy''' (from the main menu, or the main IDE toolbar '''Cut''' and '''Copy''' buttons, or the standard accelerator keys '''Ctrl+X''' and '''Ctrl+C''')can be used to place it to the clipboard;
* '''Edit|Paste''' (or the '''Paste''' toolbar button or accelerator '''Ctrl+V''')can be used to scale a image from the clipboard into the region.
* The '''Paste&Scale''' tool can be used.
'''Note''' When you use '''Edit|Paste''' , the image fragment will appear in the left top corner of Graphic Field. The region may be moved to another place by the mouse.
|-
| [[Image:Ide_I29.png]]
| '''Paste & Scale in Rectangle'''
| When an image has been copied to the clipboard, this image can be pasted back into another marked area by pressing this button. This button will stay disabled until there are both an image on the clipboard, and a region has been selected.
|-
| [[Image:Ide_I30.png]]
| '''Clear Graphic Field'''
| To clear the Graphic Field, click the Clear button. The white color is used for bitmaps and transparent color is used for icons and cursors.
|-
| [[Image:Ide_I31.png]]
| '''Change a Selected Color'''
| With this button you can change all pixels that have a given color into another color. The two colors should first be set for the '''Color''' and '''Alt-Color''' selections. '''Note''' Any pixels, which were colored in background color or in "inverse" color by '''Inverse''' tool, will keep their original colors.
|-
|[[Image:Ide_I32.png]]
| '''Inverse Colors'''
| This button can be used to invert all colors on the image. In this case, any pixels, which were colored in background color or in inverse to background color, will retain their existing colors.
|-
| [[Image:Ide_I33.png]]
| '''Grid'''
| This button can be used to turn on and off a grid in the Graphic Field
|}

==== Mirror Style Dialog ====

The '''Mirror Style''' dialog is activated by the '''Resource | Set Mirror Style''' menu command in the Task window menu:

[[Image:Ide_GE_MirrorStyle.png|center]]
<center>'''The Mirror Style dialog'''</center>

The '''Mirror Style''' dialog is used to choose the appropriate axes of symmetry for the '''Mirror''' tool.

The '''Mirror''' tool [[Image:Ide_I26.png]] sets the points that are the reflections of the '''cursor ''trail'' point''' relative to the different axes of symmetry.

When you place the mouse cursor onto some point inside an edited image and click the left mouse button, then we say that you set the '''cursor ''trail'' point'''.

Using the '''Mirror''' tool, you can (by one click) set up to 8 reflections of the specified cursor ''trail'' point. A reflection point will be painted to each checked ON type of reflections. They are:

'''Main -> Trial'''
:When checked ON, then paints the clicked '''cursor ''trail'' point'''.
'''Main -> Reverse'''
:When checked ON, then paints the point opposite to the clicked cursor trail point.
'''Reflect -> Horizontal'''
:When checked ON, then paints the point, which is the horizontal reflection of the clicked cursor trail point.
'''Reflect -> Vertical'''
:When checked ON, then paints the point, which is the vertical reflection of the clicked cursor trail point.
'''Orthogonal -> Left'''
:When checked ON, then paints the point, which is 90 degrees left rotation of the clicked cursor trail point.
'''Orthogonal -> Right'''
:When checked ON, then paints the point, which is 90 degrees right rotation of the clicked cursor trail point.
'''Reflect Diagonal -> Left'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''left''' upper corner to the right lower corner of the image.
'''Reflect Diagonal -> Right'''
:When checked ON, then paints the point, which is the reflection of the clicked cursor trail point relative to the diagonal line drawn from the '''right''' upper corner to the left lower corner of the image.

=== Using Tools and Colors ===

==== Setting Colors ====

*'''Setting the Draw and Edit Colors'''

To choose colors for the drawing and editing tools you can select one of the following four switches.

[[Image:Ide_GE_Mode_DrawColor.png|center]]
<center>'''The Color Modes toolbar with selected "color" mode'''</center>

The color of selection will be used for the drawing. It is possible to choose a new color for the active selection by a click in the {{ide|Resource Editor#Color Palette|Color Palette}}.

The '''color''' and the '''alt-color''' can be used in all drawing operations, the '''screen''' (or transparent) and '''inverse''' selections have different purposes depending on the image type.

'''Note.'''
There are 16 color fields on the {{ide|Resource Editor#Color Palette|Color Palette}}, and all of them are available for drawing and editing in the {{ide|Resource Editor#Graphic Field|Graphic Field}}.

*'''Setting the Background Color'''

To see how your image looks on the different background colors or to color the image fragments in "transparent" (to let the background color show through) use the '''screen''' color selection.

[[Image:Ide_GE_Mode_BackgroundColor.png|center]]
<center>'''The "screen" mode should be used for Background color'''</center>

To change the background color, be sure that the '''screen''' switch is selected, then you can choose the background color by clicking in the {{ide|Resource Editor#Color Palette|Color Palette}}. The background color on the {{ide|Resource Editor#Image Screen|Image Screen}}, any details of the image, which were colored in (transparent) background color, and the '''screen''' indicator of '''Color Modes''' toolbar, all will change to the new color.

'''Usage of the "screen" Colors for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Screen Colors
|-
! Bitmaps
| Used to set the color of the surrounding area
|-
! Cursors and Icons
| Used to specify transparent pixels and to set the color of the surrounding area
|}

*'''Setting the Inverse (to Background) Color'''

Using the inverse color is a convenient way to mark the boundary of the image or to color the details, which should be always be in contrast to any background color.

[[Image:Ide_GE_Mode_InverseBackground.png|center]]
<center>'''The "inverse" mode should be used for Inverse color'''</center>

'''Usage of the Inverse color for Bitmaps, Cursors and Icons'''

{|{{prettytable}}
|-
! Image
! Inverse Color
|-
! Bitmaps
| Cannot be used
|-
! Cursors and Icons
| Used to specify pixels that should get a color inverse of the actual background
|}

==== Understanding Colors ====

*'''Colors for Bitmaps'''

The Visual Prolog Graphics Editor can create bitmaps with either 2 or 16 colors. A pixel in a bitmap can not have the inverse and screen colors.

*'''Colors for Cursors'''

Any pixel in a cursor can have one of four color control values:

{|{{prettytable}}
|-
! Cursor
! Color Effect
|-
! Black
| Pixels will be black
|-
! White
| Pixels will be white
|-
! Inverse
| Pixels will be converted to the inverse of the original color
|-
! Screen
| Pixels will be transparent, they will just keep their old color
|}

To understand how this works, you should create a little cursor having four areas, with these four color control values. Then select the '''Resources | Tools | Test Cursor''', and study how the cursor looks.

[[Image:Ide_GE_TestCursorColors.png|center]]
<center>'''In this test cursor the left upper quoter of the cursor is painted with the "color"'''</center>
<center>'''and the left bottom quarter is painted with the "inverse"'''</center>

Place the cursor over the Grid and you will see effects of "inverse" color.

*'''Colors for Icons'''

Icons can either have 2 or 16 colors, and in addition to those, the pixels can also use the {{ide|Resource Editor#Setting the Background Color|'''screen'''}} and
{{ide|Resource Editor#Setting the Inverse (to Background) Color|'''colors'''}}.

==== Cursor Handling Tools ====

'''Setting Cursor Hot Spots'''

When working with a cursor, the menu command Resource | Set Cursor Hotspot activates a dialog box:

[[Image:Ide_GE_CursorHotSpot.png|center]]
<center>'''Defining the Hotspot for a cursor'''</center>

As long as this dialog is open you can point to the pixel, which is to be the cursor Hotspot. This pixel in the cursor will determine the screen pixel which will be acted upon and which will be reported during a mouse action.

'''Testing a Cursor''''

When working with a cursor, the '''Resource | Tools | Test Cursor''' menu item allows you to see what your newly designed cursor will look like.

==== Undo / Redo Buffer ====

The Graphics Editor supports '''Edit|Undo''' and '''Edit|Redo''' operations, just as the other editors do.

File:Ide TB NewRow.png

2013-04-26T10:15:16Z

GalinaTchekmareva:

File:Ide TB Separator.png

2013-04-26T10:14:41Z

GalinaTchekmareva:

File:Ide TB ContextText.png

2013-04-26T10:14:11Z

GalinaTchekmareva:

Ide/Resource Editor/Editing a Toolbar

2013-04-26T10:12:35Z

GalinaTchekmareva: New page: <noinclude>Category:Ide</noinclude> To edit a toolbar, double-click (or press '''Enter''') the name of a file with a toolbar description in the project tree in the '''Project''' window...

<noinclude>[[Category:Ide]]</noinclude>
To edit a toolbar, double-click (or press '''Enter''') the name of a file with a toolbar description in the project tree in the '''Project''' window's list of project files. The '''Toolbar Editor''' window appears and you can create whatever form of a toolbar you wish.

[[Image:Ide_ToolbarEditor.png|center|frame|The '''Toolbar Editor''']]

In the top of the picture you see edited toolbar ('''ProjectToolbar''' in the picture).

==== Controls Toolbar ====

In the bottom of the previous picture you see the '''Controls''' toolbar. Using the '''Controls''' toolbar you can easily add desired controls into the edited toolbar.

There are the Controls toolbar commands inserting the following kinds of controls into toolbars:

{|{{prettytable}}
|-
| [[Image:Ide_Ctrl_PushBtn.png]]
! Push Button
| Enables inserting of the '''push button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_PushBtn.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_CheckBx.png]]
! Check Button
| Enables inserting of the '''check button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_CheckBx.png]], the {{ide|Resource Editor#Push and Check Button Attributes|Button Attributes}} dialog appears. In this dialog you must specify a bitmap that will be used to display the button. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_StaText.png]]
! Static Text
| Enables inserting of the '''static text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_StaText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. In this dialog you can specify the '''Initial Text''' that will be displayed in the control. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_TB_ContextText.png]]
! Context Sensitive Text
| Enables inserting of the '''context sensitive text''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_TB_ContextText.png]], the {{ide|Resource Editor#Text Control Attributes|Text Attributes}} dialog appears. Press the '''OK''' button to create the control.
|-
| [[Image:Ide_Ctrl_ListBtn.png]]
! List Button
| Enables inserting of the '''list button''' control into the edited toolbar. Click inside the toolbar to specify the place where the control should be inserted, press on the button [[Image:Ide_Ctrl_ListBtn.png]], the {{ide|Resource Editor#Text Control Attributes|List Button Attributes}} dialog appears. Press the '''OK''' button to create the control. List buttons can be used to select one item from a list of possible values.
|-
| [[Image:Ide_TB_Separator.png]]
! Separator
| Enables inserting of a '''separator''' into the edited toolbar. Click inside the toolbar to specify the place where the '''separator''' should be inserted, press on the button [[Image:Ide_TB_Separator.png]], the '''separator''' will be inserted. The separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| [[Image:Ide_TB_NewRow.png]]
! New Row
| Enables inserting of a '''new row''' into the edited toolbar. Click inside the toolbar to specify the place where the '''new row''' should start, press on the button [[Image:Ide_TB_NewRow.png]], the '''new row''' will be created. Notice that the '''new rows''' are relevant only for toolbars with the styles ''Inside'' and ''Movable''. A '''new row''' control will cause breaking of the current line, the following controls appear on the next line.
|}

==== Control Types Used in Toolbars ====

In the lower part of the previous picture we see the '''[Controls_Toolbar_in_the_Toolbar_Editor.htm Controls]''' toolbar, which contains all kinds of controls that can be used in toolbars.

{|{{prettytable}}
|-
! width="30%"|Control
! width="70%"|Description
|-
| '''Push Button'''
| This is a standard push button. When pressed it sends an <vp>vpiDomains::e_Menu</vp> event to the parent window. The bitmap must be registered for the button.
|-
| '''Check Button'''
| This is used to indicate the state of a property that can have two states; either checked or unchecked. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_CheckBox,_,_)</vp> event to the parent window. You must register a bitmap for a check button.
|-
| '''List Button'''
| A list button can be used to select one item from a number of values. When pressed it sends an <vp>vpiDomains::e_Control(_, vpiDomains::wc_LBoxButton,_,_)</vp> event to the parent window.
|-
| '''Static Text'''
| Text may be placed in this control initially and also dynamically. A '''Static Text''' is often used for titles.
|-
| '''Context Sensitive Text'''
| If a Context Sensitive Text field is put into the toolbar, this field will display help information about the control the mouse is currently located over.
|-
| '''Separator'''
| A separator is like a space; it is used to make some space and a vertical bar between other controls, usually to divide them into functional groups.
|-
| '''New Row'''
| New row is relevant only for toolbars with the styles '''Inside''' and '''Movable'''. A New Row control will cause the current line to break, and the following controls to appear on the next line of the toolbar.
|}

==== Toolbar Layout Editing ====

The layout of the toolbar can be done both with the keyboard, and with the mouse. There is an insertion point that is marked with a colored bar. This insertion point can be moved with the arrow keys, or by clicking the mouse on the new location. When the insertion bar is at a given location, the control to the right of the bar can be deleted by pressing the '''Delete''' key, the control to the left can be deleted by pressing the '''Backspace''' key.

To place a new control at the insertion point:

* select an item from the '''Controls''' menu or
* choose a control from the ones shown in the '''Controls''' floating dialog or
* click the right mouse button anywhere in the Toolbars Editor window area outside the toolbar to display a pop up from which a desired control can be selected.

==== Attributes of Toolbar Controls ====

After a control is inserted, it is possible to change the control attributes. Just double-click the control.

===== Push and Check Button Attributes =====

Double-click a Push button or a Check button calls the '''Button Attributes''' dialog.

[[Image:Ide_Toolbar_ButtonAttributes.png|center|frame|'''Specifying properties of push buttons and check buttons''']]

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the button control. This is the constant that will be used in the <vp>vpiDomains::e_Menu</vp> events. Therefore, it is recommended to use the same constant as is used for the menu item correspondent to the same command.

The '''Constant''' input box is where you can select or type in the symbolic constant that will be used as the control identifier. It can be input directly from the keyboard or selected from the list of available constants (by clicking the [[Image:Ide_ListButton_Button.png]] button). It must be either a legal symbolic constant (for example, '''''idt_file_open''''' ) or an integer value.

If you enter a symbolic constant, then the IDE automatically places this symbolic constant into the '''resourceidentifiers.i''' file and generates an appropriate integer value for it. The '''Toolbar Editor''' automatically generates the default symbolic constants (for example, '''''idt_7''''' from the ''toolbar constant prefix'' '''''idt_''''' and the number of this control in the toolbar.
|-
| '''Status Text'''
|The string entered into this field can consist from 2 sub-strings separated by a semicolon. The sub-string specified before the semicolon (if specified) is used as the button Tool Tip text. The sub-string specified after the semicolon (or if the semicolon is not specified) will be displayed in the '''Context Sensitive Text''' field (when the mouse cursor is positioned over this button).

For example, the text '''''New;New file''''' will cause '''New''' to be shown in the yellow tool tip while '''New file''' will be shown in a context sensitive field when the mouse is over the button.
|-
|'''Checked'''
|If this check box is checked than the button initial state is "pressed" and the icon shaped as ''pressed'' is initially displayed. Otherwise the button initial state is "released" and the icon shaped as ''released'' is displayed.
|-
|'''Disabled'''
|If this check box is checked then the button initially does not accept a user input and is grayed. Otherwise the button is initially enabled (accepts a user input) and has initial state specified by the '''Checked''' check box.
|-
|'''Push Button''' or '''Check Button'''
|Select the appropriate button style ('''Push Button''' or '''Check Button'''). The style can be changed at any time. At runtime the state (''pressed'' or ''released'') of a check button can be switched by clicking the check button.
|-
|'''Bitmap Name'''
|This bitmap will be used to display a button. This bitmap should be selected from the list of bitmaps registered in the '''Project''' window (by clicking the [[Image:_Ide_ListButton_Button.png]] button). Before a bitmap name will appear in the registered bitmap list, it should be registered in the project with the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').

In Visual Prolog v.7 we use a single bitmap for each button and automatically draw different state ornamentations for the ''released'' state, the ''pressed'' state, and the ''disabled'' state of the button.
|-
|'''Edit'''
|If the '''Edit''' button is pressed, then the {{ide|Resource Editor#Graphics Editor|'''Graphics Editor'''}} will come up with the given bitmap allowing you to view and edit the bitmap.
|}

===== Text Control Attributes =====

Double-clicking a Static Text or a Context Sensitive Text control calls the '''Text Attributes''' dialog:

[[Image:Ide_Toolbar_TextControl.png|center|frame|'''Specifying properties of text controls in a toolbar''']]

The following information must be specified:

{|{{prettytable}}
|-
| width="30%"|'''Constant'''
| width="70%"|A constant name to identify the Text control.
|-
| '''Initial Text'''
| The default text to display in the field.
|-
| '''Static''' or '''Context Sensitive'''
| Select the appropriate text control type. The style can be changed at any time.
|-
| '''Font '''
| Select a font name, font style (Normal, Bold, Italic ...), and font size for the displayed text.
|-
| '''Text Width'''
| Determines a width in pixels of the Text control field. It can be entered manually or, by pushing the '''"<nowiki>|</nowiki><---Text---><nowiki>|</nowiki>"''' button. In this case the width of the field will be optimized to display the '''Initial Text''' with the selected Font.
|-
| '''Foreground Color'''
| Select the Foreground Color for the displayed text.
|}

===== List Button Attributes =====

Double-clicking a List Button control calls the '''List Button Attributes''' dialog.

[[Image:Ide_Toolbar_ListButtonAttributes.png|center|frame|'''Specifying properties of list buttons in a toolbar''']]

Only two parameters can be set for a list button in a toolbar:

{|{{prettytable}}
|-
| width="30%"|'''Constant '''
| width="70%"|A constant name to identify the List Button control.
|-
| '''Width '''
| Determines the width in pixels of the List Button control field.
|}

Ide/Resource Editor

2013-04-26T09:41:31Z

GalinaTchekmareva:

Ide/Resource Editor

2013-04-26T09:28:50Z

GalinaTchekmareva:

{{ideNavbar|Resource Editor}}

The term ''resource'' is applied to the things like dialogs, forms, icons, cursors, pens, brushes, etc. Resources can be created by one of the IDE resource editors, or just added to a project. The correspondent resource files are referenced from a project file.

During project building IDE generates binary '''ProjectName.res''' file which is provided to a linker. IDE also generates <vp>resourceIdentifiers.i</vp> file which specifies numeric constants for resource identifiers. Resource identifierd can be refered from sources codes to provide the proper resource handling. The names and values for resource identifiers can be set or changed with the help of IDE resource editors.

== GUI and VPI Style Resources ==

Historically windowing programs - that is, programs with the graphical user interface - were developed in Visual Prolog using the VPI (Visual Programming Interface) package supplied as one of packages in Prolog Foundation Classes (PFC).

The Visual Programming Interface (VPI) is a high-level Application Programming Interface (API) and it is designed to make it easy for Prolog applications to provide sophisticated user interfaces utilizing the graphical capabilities of today's operating systems and display hardware. The resources and tools needed by such applications - windows, menus, dialogs, controls, pens, brushes, cursors, carets, pictures, etc. all appear as simple Prolog structures.

However, the VPI layer (PFC\vpi) provides an old style of handling the graphical user interface. This was the reason why the PDC has developed the modern GUI package (pfc\gui), which provides really object-oriented implementation of API handling of the main windowing system features. The GUI package presents the object-oriented windows, dialogs, forms, controls, etc., handling. This package is built on top of the VPI package and delivers a new level of abstraction and ease of use while retaining compatibility with VPI programs since both the GUI and VPI programming styles can be applied in the same program.

Currently for new GUI applications the IDE generates the default program code which use the GUI package features (but it still possible to edit old VPI style dialogs, etc.).

Notice that in VPI style programs, except for ''VPI style dialogs'' and ''VPI style windows'' you can also create ''GUI style forms'', which, of course, are handled by GUI package predicates. From the other side, since each GUI program includes the VPI package, so some VPI features can be embedded into GUI style programs.

To understand difference of GUI and VPI style programs and difference of GUI and VPI style dialogs, windows, forms, controls, etc., we recommend to read carefully VPI and GUI programming tutorials on WEB.

== IDE Designer ==

Editing of dialogs, windows, form, and IDE Controls on the '''IDE Designer''' are very closely related. The only real difference is that definitions of the VPI package dialogs are (normally) put into resource files, whereas GUI package dialogs, windows, and forms are always created dynamically by code.

=== Creating a Dialog ===
----
{{:ide/Creating new Project Items/Creating a Dialog}}

=== Editing a Dialog ===
----
{{:ide/Resource Editor/Editing a Dialog}}

=== Creating and Editing a Window ===
----
The IDE does not support the creation or editing of the old-style VPI windows. You should use
{{ide|Resource Editor#Creating and Editing a Form|'''Forms'''}} instead of windows (see description of forms in the GUI package overview in the PFC part of Help for more details).

However, the IDE automatically creates for GUI applications the special resource file '''TaskWindow.win''' which is placed if the TaskWindow sub-directory of the project root directory. This resource file can be later changed by the IDE resource editor.

=== Creating and Editing a Form ===
----
{{:ide/Creating new Project Items/Creating a Form}}

== Toolbar Editor ==

The '''Toolbar''' editor allows you interactively create various kinds of toolbars.
{{:ide/Creating new Project Items/Creating a Toolbar}}

=== Editing a Toolbar ===

{{:ide/Creating new Project Items/Editing a Toolbar}}

== Menu Editor ==

The '''Menu Editor''' can be used to create both pull-down menus (for windows), and pop-up menus (useful for object oriented user interfaces).
{{:ide/Creating new Project Items/Creating a Menu}}

==== Editing a Menu ====

To edit a menu, double-click (or press '''Enter''') the name of a file with a menu description in the project tree in the '''Project''' window. For example '''TaskMenu.mnu'''. The '''Menu Editor''' dialog appears and you can create (or modify) whatever kind of a menu you wish.

[[Image:Ide_MenuTask.png|center|frame|'''Menu Editor''']]

The '''Menu Editor''' dialog allows you to modify or delete existing menu items or add new ones. The main pane in this dialog contains the tree of menu items of the edited (it is '''TaskMenu''' in the picture) menu.

By pressing the '''New''' toolbar buttons it is possible to create new menu items and sub-items. You can use: [[Image:Ide_MenuEdit_First.png]] - the '''New First Item''', [[Image:Ide_MenuEdit_New.png]] - the next '''New Item''' , and [[Image:Ide_MenuEdit_Subitem.png]] - the menu '''New SubItem'''.

Menu items can optionally be grouped by inserting separators. To insert a separator just click the '''New Separator''' toolbar button [[Image:Ide_MenuEdit_Separator.png]].

'''Cut''', '''Copy''' and '''Paste''' operations for selected menu items (with all their submenu items) can be executed with '''Ctrl+X''', '''Ctrl+C''', and '''Ctrl+V''' keyboard accelerators.

The '''Menu Editor''' can create nested menus of any level. To enter/create a submenu for the selected menu item click the '''Submenu''' button [[Image:Ide_MenuEdit_Subitem.png]].

By pressing the '''Test''' toolbar button [[Image:Ide_MenuEdit_Test.png]] you activate the test mode in which the edited menu will be displayed instead of the main IDE menu. You can open it submenus, etc. To exit the test mode, you can click somewhere in the IDE window out of the tested menu.

===== Customizing Menu Item Attributes =====

In the bottom of the menu editor dialog you see the big pane (the '''Menu Tree''' pane) in which you can see the edited menu tree. Menu items prefixed with the plus [[Image:Ide_Plus_Icon.png]] icon have submenus. Click the plus [[Image:Ide_Plus_Icon.png]] icon or press the right arrow on the keypad to expand one level of such submenu. Notice that the plus [[Image:Ide_Plus_Icon.png]] icon before expanded menu items is changed for the minus [[Image:Ide_Minus_Icon.png]] icon.

When you select any menu item in the menu tree, the menu editor controls display attributes of this menu item. For each menu item the programmer can specify the following attributes:

*'''Item Title'''
*:Select a menu item in the '''Menu Tree''' pane and click the menu item title. The menu item title becomes surrounded by the frame like:
*:[[Image:Ide_MenuEdit_Title.png]]
*:Here you can specify/edit the menu item title (name).
*:* The menu item title may contain up to 255 characters. It may include the '''\t''' (tab) escape sequence.
*:* In the menu item title the ampersand symbol '''&''' can be used for indicating that the following character is to be underlined. For example, if you type in the string '''&Contents''', then at runtime this menu item will be displayed as '''C''''''ontents'''. I.e. the character '''C''' will be displayed underlined (thus visually indicating that the '''C''' is an accelerator key). The underlined character should be unique on each level of a menu. If you need to display the '''&''' character, use two '''&&'''.

*'''Item Constant'''
*:The '''Item Constant''' input box is where you can select or type in the symbolic (or integer) constant that will be used as the menu item identifier. It can be typed-in directly from the keyboard or selected from the list of available constants (by clicking the [[Image:Ide_ListButton_Button.png]] button). It must be either a legal symbolic constant (for example, '''''id_help_contents''''') or an integer value.
*: If you enter a symbolic constant name, then the IDE automatically places this symbolic constant into the '''resourceidentifiers.i''' file and generates an appropriate integer value for it. The '''Menu Editor''' automatically generates the default symbolic constant name (for example, '''''id_file_exit''''') from the '''Constant Prefix''' '''''id_file''''' and names of menu items ('''Exit''' on the picture).

*'''Constant Prefix'''
*:The '''Constant Prefix''' edit control is where you can input a common prefix for all ''item constants'' of menu items on the current level of submenu.

*'''Checked'''
*:Set the initial state of the menu item to Checked.

*'''Disabled'''
*:Specifies that initially the menu item will be Disabled.

*'''Accelerator'''
*:In the '''Accelerator''' group box you can set an accelerator key (hot key), which will be used to activate this menu item. The accelerator key can be defined as a combination of a basic accelerator key and of the '''Shift''', '''Ctrl''', and '''Alt''' keys. The basic accelerator key can be typed in or chosen from the list in the list edit control. To specify the desired '''Shift''', '''Ctrl''', and '''Alt''' keys check on the corresponding check box. To assign more than one accelerator key to a menu item, use the <vp>vpi::setAccelerators/1</vp> predicate.

*'''Help Constant'''
*:In this list button control you can select one of constants of the existing first-level menu items. The '''Windows''' (system handling) menu item (in MDI mode) will be placed just before the first-level menu item with this constant.
*: Notice that this possibility can be used only for MDI applications. (It is ignored for non-MDI applications since they do not have the '''Windows''' (system handling) menu item.

===== Editing the Window Submenu =====

In MDI applications Windows automatically add the '''Windows''' first-level menu item, which, by default, is placed after (the most right) all other user-created first-level menu items in each application menu. By default, it contains the '''Tile''', '''Cascade''', and '''Arrange Icons''' menu commands and in the bottom of this menu are listed titles of all opened MDI document windows.

To customize items of the '''Windows''' submenu, the programmer should create a new menu with the Item Constant equal to '''''mdiwindow_menu'''''. This menu should include only one level of menu items. Notice that since this user-designed submenu will be used instead of the default system '''Windows''' submenu, so handling of ALL its menu commands should be explicitly programmed. For instance, handling of the '''Tile''', '''Cascade''', and '''Arrange Icons''' menu commands should be programmed if they are included into the designed menu.

== Graphics Editor ==

=== About the Graphics Editor ===

The Graphics Editor is a convenient tool for creating, viewing and editing icons, cursors and small bitmaps. The images can be passed to the Windows Clipboard or saved in files.

The Graphics Editor allows you to create and edit images ranging in size from 4x4 pixels to 64x64 pixels, by using either a 16-color palette or monochrome shadow palette.

The Graphics Editor is invoked from the Project window for Icons, Cursors and Bitmaps. However, when you register large bitmaps in your project, Visual Prolog will call to edit the bitmap an external editor associated in Windows for editing files with .BMP extension.

After the Graphics Editor is started, the Graphics Editor window will appear on the screen.

[[Image:Ide_GE_ProjectIcon.png|center|frame|'''Graphics editor window''']]

When you create a new image in a project, you need to specify the '''Name''' of the image, the Constant (resource ID) which will be identify the image in the project, the name of the '''File''', in which the image will be saved, its size, and how many colors it will have.

=== Graphics Editor Menus ===

When the Graphics Editor window is active, the Integrated Development Environment's menu bar displays the Graphics Editor sub-menus of the '''Resource''' menu and looks as follows:

[[Image:Ide_GE_Menu.png|center|frame|'''The Visual Prolog menu bar when the Graphics Editor is active''']]

Note that there are 2 menu items: '''Set Mirror Style''', '''Set Cursor Hotspot''' and 2 sub-menus: '''Tools''' and '''Move'''. Also some menu items under the '''Edit''' menu (like the '''Undo''', '''Redo''', '''Cut''', '''Copy''', '''Paste''') are specially tailored for the Graphics Editor, and the '''File''' menu operations refer now to the image files.

=== Creating a Image ===

{{:ide/Creating new Project Items/Creating a Image}}

=== Editing Image Attributes ===

You can always wake up (with the '''Resource | Attribute''' task menu item or with the '''Attribute''' item from pop up menu) the '''Bitmap/Cursor/Icon Attributes''' dialog for the created bitmap, cursor or icon to view and change some image attributes.

Notice that the appeared '''Bitmap Attributes''' dialog for an existing bitmap will display less bitmap attributes then it has for created bitmaps:

[[Image:Ide_GE_ExistingBitmapAttributes.png|center|frame|'''The Bitmap Attributes dialog for an existing bitmap''']]

You see that for existing bitmap the dialog does not contain the '''Width''', '''Height''', and '''Color''' attributes.

The only image attribute that you can edit is the '''Constant'''.:

'''Constant'''
:In the '''Constant''' list edit the programmer can change the default resource constant for the image (at the picture it is '''''idb_mybitmap''''').

{{:ide/Resource Editor/Graphics Editor}}
{{:ide/Resource Editor/Graphics Tools and Colors}}

Ide/Resource Editor/GUI Control Properties Table

2013-04-25T11:33:22Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
===== GUI Control Properties Table =====

When you open a GUI dialog or a form (GUI window) in the '''IDE Designer''', then the '''Control Properties''' table also opens.

The set of properties displayed in the '''Control Properties''' table depends on the control type and contains two groups of properties:

*{{ide|Resource Editor#Common Properties of Almost All GUI Controls|'''General properties'''}} are common to all types of controls. These are: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', '''Bottom Anchor''', '''Container Name''', '''Enabled''', '''Lock to Container''', '''Name''', '''Representation''', '''TabStop''', '''Title''', '''X''', '''Y''', '''Width''', '''Height''' and '''Visible'''.

*{{ide|Resource Editor#Specific Properties of Different GUI Control Types|'''Specific properties'''}} are individual to different types of GUI controls. These are: '''3State''', '''AlignBaseline''', '''Alignment''', '''AllowPartialRows''', '''Auto''', '''AutoNotify''', '''AutoHScroll''', '''AutoVScroll''', '''Border''', '''Case''', '''Class''', '''ExtendedSel''', '''HideSel''', '''HScroll''', '''Icon Name''', '''IgnorePrefix''', '''LeftText''', '''MultiColumn''', '''MultiLine''', '''MultiSelect''', '''Password''', '''ReadOnly''', '''Rows''', '''Sort''', '''StaticScrollbar''', '''Style''', '''UseTabStops''', '''VScroll''', '''WantReturn''', '''Wrap'''.

In '''Control Properties''' table you can edit the displayed properties of the selected GUI control.

Initially this table is empty. However, as soon as any of GUI controls in the edited GUI dialog (form) is selected, the '''Control Properties''' table displays the current set of properties of the selected control.

If the '''Control Properties''' table is closed, double-click a control to show the table. The '''Control Attributes''' command, from the {{ide|Resource Editor#Speed Menu|speed menu}} of the '''IDE Designer''', can also be used to open the '''Control Properties''' table.

===== Common Properties of Almost All GUI Controls =====

There are some basic control properties, which are used by almost all GUI controls. These are:

*'''Name'''
:The '''Name''' input box is where you can specify some correct Visual Prolog name, which will be used as the control name (identifier).
:The default '''Name''' is generated from the ''control type'' (for example, ''pushButton'', ''checkBox'', ''listButton'', etc.) and the <vp>_ctl</vp> suffix. If several controls of the same type are created, then the ''control type'' is suffixed with the number, for example, <vp>pushButton</vp><vp>1</vp><vp>_ctl</vp>.
:You can edit this default name or simply type in your own version.
*'''Representation'''
:This property can have one of the following two values: '''Fact Variable''', '''Variable'''.
:*'''Fact Variable'''
::When '''Fact Variable''' is specified, then the IDE generates the fact variable, which will store the object of the control. This fact variable is used to reference to this control in the code. This fact variable name is determined by the '''Name''' property. For example, <vp>ok_ctl</vp>. Notice that in this case the fact variable name is automatically converted to be started with the lowercase character.
:*'''Variable'''
::When '''Variable''' is specified, then the IDE unifies the object of the control with an ordinary variable. This variable will be used to reference to this control in the code. This variable name is determined by the '''Name''' property. For example, <vp>Cancel_ctl</vp>. Notice that in this case the variable name is automatically converted to be started with the uppercase character.
:The default value is '''Fact Variable'''.
*'''Title'''
:The '''Title''' property is where you specify the title (label), which you want to be displayed as the control caption.
:One character in the Title text may be underlined to indicate an access key. To underline a character precede it with the ampersand <vp>&</vp> character. At runtime this character in the control '''Title''' will be underlined.
:Notice that this character is displayed underlined also in the value cell of the '''Title''' property:
:[[Image:Ide_GUI_Prop_Title.png]]
:The used ampersand <vp>&</vp> character is seen only when the value cell of the '''Title''' property has the focus:
:[[Image:Ide_GUI_Prop_Title2.png]]
:If you need to display the ampersand <vp>&</vp> character in the '''Title''' text, then use two of them <vp>&&</vp>.
*'''Lock to Container'''
:Possible values are '''True''' and '''False'''. '''True''' defines that the control is locked inside the container selected in the '''Container Name''' property.
*'''Container Name'''
:In this list box you can select the '''Name''' of one of containers (currently only the group box <vp>groupBox</vp> type of containers is supported) defined in the dialog or in the form.
:All controls belonging to the same container are in the same ''group'' of related controls. The user may use the arrow keys to move from one control in the ''group'' to the next one.
:Only the '''Names''' of group boxes, inside which the control is placed, appear in the list of '''Container Name''' property values. For example, if you see:
:[[Image:Ide_GUI_Prop_Container.png]]
:this means that the control is placed inside two group boxes with names <vp>GroupBox_ctl</vp> and <vp>GroupBox1_ctl</vp>.
:If you do not need to relate the control to any container, then you should select <vp>[none]</vp>.
*'''X''', '''Y''', '''Width''', '''Height'''
:These properties determine the control coordinates and size:
:*'''X'''
::The '''X''' coordinate of the upper-left corner of the control (in Dialog Base Units).
:*'''Y'''
::The '''Y''' coordinate of the upper-left corner of the control (in Dialog Base Units).
:*'''Width'''
::The '''Width''' of the control (in Dialog Base Units).
:*'''Height'''
::The '''Height''' of the control (in Dialog Base Units).
*'''Left''', '''Top''', '''Right''' and '''Bottom Anchors'''
:These properties determine how the control coordinates (and may be size) will be handled when the dialog or form (containing this control) is resized. The general rules are described in the "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
:*'''Left Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Left''' boundary of the control is always positioned at the specified distance (equal to the '''X''' property) from the '''Left''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units.
:*'''Top Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Top''' of the control is always positioned at the specified distance (equal to the '''Y''' property) from the '''Top''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units.
:*'''Right Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Right''' boundary of the control is always positioned at the specified distance from the '''Right''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
:*'''Bottom Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Bottom''' of the control is always positioned at the specified distance from the '''Bottom''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*'''Enabled'''
:Possible values are '''True''' and '''False'''. They define whether the control will be created initially enabled ('''True''') or disabled ('''False'''). The default value is '''True''' (enabled).
:You can use the <vp>window::getEnabled/0-></vp> predicate to get whether the control is enabled
<blockquote><vip>IsEnabled = checkButtonName:getEnabled(),
IsEnabled = true,</vip></blockquote>
:and the <vp>window::setEnabled/1</vp> predicate
<blockquote><vip>IsEnabled = true,
checkButtonName:setEnabled(IsEnabled),</vip></blockquote>
:to set this flag programmatically.
*'''Visible'''
:Possible values are '''True''' and '''False'''. They define whether the control will be created initially visible ('''True''') or invisible ('''False'''). The default value is '''True''' (visible).
:You can use the <vp>window::getVisible/0-></vp> predicate to get whether the control is visible
<blockquote><vip>IsVisible = checkButtonName:getVisible(),
IsVisible = true,</vip></blockquote>
:and the <vp>window::setVisible/1</vp> predicate
<blockquote><vip>IsVisible = true,
checkButtonName:setVisible(IsVisible),</vip></blockquote>
:to set this flag programmatically.
*'''TabStop'''
:Possible values are '''True''' and '''False'''. They define whether this control belongs to a subset of controls through which the user can move using the TAB key. The default value is '''True''' (the control belongs to a group of controls between which the user can navigate with TAB).
:You can use the <vp>control::getTabStop/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsTabStop = checkButtonName:getTabStop(),
IsTabStop = true,</vip></blockquote>
:and the <vp>control::setTabStop/1</vp> predicate
<blockquote><vip>IsTabStop = true,
checkButtonName:setTabStop(IsTabStop),</vip></blockquote>
:to set this flag programmatically.
:If <vp>IsTabStop</vp> is <vp>true</vp>, then the focus will be able to jump to this control while the Tab pressing navigation. Pressing the TAB key moves the focus to the next control, which has the '''TabStop''' = '''True'''.

===== Specific Properties of Different GUI Control Types =====

The following properties are specific to different types of controls:

*'''Auto'''
:Possible values are '''True''' and '''False'''. They define whether this control is an automatic (an automatic check box or an automatic radio button). When you click an automatic control, then it change its state in the proper way.
:You can use the <vp>checkButton::getStyle/2</vp> and <vp>radioButton::getAuto/0-></vp> predicates to get whether this flag is set to a control:
<blockquote><vip>checkButtonName:getStyle(IsAuto, _Is3State),
IsAuto = true,</vip></blockquote>
:and the <vp>checkButton::setStyle/2</vp> or <vp>radioButton::setAuto/1</vp> predicates
<blockquote><vip>IsAuto = true,
checkButtonName:setStyle(IsAuto, _Is3State),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''True''' (auto).
*'''3State'''
:Possible values are '''True''' and '''False'''. They define whether this check box can have 3 states (''unchecked, checked, undetermined''). You can use the <vp>checkButton::getStyle/2</vp> predicate to get whether this state is set to a control
<blockquote><vip>checkButtonName:getStyle(_IsAuto, Is3State),
Is3State = true,</vip></blockquote>
:and the <vp>checkButton::setStyle/2</vp> predicate
<blockquote><vip>Is3State = true,
checkButtonName:setStyle(_IsAuto, Is3State),</vip></blockquote>
:to set this state programmatically.
:A 3-states check box is the same as an ordinary check box, except that the box can be grayed (dimmed) as well as checked. The grayed state is used to show that the state of the check box is not determined.
:The default value is '''False''' (3State).
*'''LeftText'''
:Possible values are '''True''' and '''False'''. They define whether the control title text should be positioned on the left or on the right of the control (check box or radio button).
:You can use the <vp>checkButton::getLeftText/0-></vp> or <vp>radioButton::getLeftText/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsLeftText = checkButtonName:getLeftText(),
IsLeftText = true,</vip></blockquote>
:and the <vp>checkButton:setLeftText/1</vp> or <vp>radioButton:setLeftText/1</vp> predicates
<blockquote><vip>IsLeftText = true,
checkButtonName:setLeftText(IsLeftText),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''False''' (caption is on the right side).
*'''AlignBaseline'''
:Possible values are '''True''' and '''False'''. They define whether the control caption text should be positioned on the same horizontal line with caption texts of all other controls, which have the same vertical position with this control.
:This property is defined to all controls, which can have captions (static texts, check boxes, edit and list edit controls, etc.)
:You can use the <vp>getAlignBaseline</vp> predicates (like <vp>editControl::getAlignBaseline/0-></vp>) to get whether the control has this flag
<blockquote><vip>IsAllignBaseLine = checkButtonName:getAllignBaseLine(),
IsAllignBaseLine = true,</vip></blockquote>
:and the <vp>setAlignBaseline</vp> (like <vp>textControl::setAlignBaseline/1</vp>) predicates
<blockquote><vip>IsAllignBaseLine = true,
checkButtonName:setAllignBaseLine(IsAllignBaseLine),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''True''' (align captions horizontally).
'''Style'''
:'''Push buttons'''
:For push buttons possible values are '''Cancel''', '''OK''' and '''Regular'''.
:'''Cancel'''
::Push buttons with the '''Cancel''' style are created by the <vp>button::newCancel/1</vp> onstructor.
::When a dialog/form contains a push button with the '''Cancel''' style, then this dialog/form will provide standard handling of the Esc key - the dialog/form is simply closed without any additional actions.
:'''OK'''
::Push buttons with the '''OK''' style are created by the <vp>button::newOk/1</vp> constructor.
::When a dialog/form contains a push button with the '''Ok''' style, then this dialog/form will execute dialog/form validation check when this button is clicked. See "'''Dialog/Form Validation'''" tutorial (on WEB) for more information.
:'''Regular'''
::Push buttons with the '''Regular''' style are created by the ordinary <vp>button::new/1</vp> constructor.
::Such buttons do not initiate any special default handling.
:'''Group boxes'''
:For group boxes possible values are '''Group Box''', '''Simple Border''', '''Horizontal Separator''', '''No Border'''. These values define the border type of the group box control.
:The default is '''Simple Border'''.
:You can use the <vp>groupBox::getBorderStyle/0-></vp> predicate to get the border style
:<vip>GroupBoxBorderStyle = controlName : getBorderStyle(),</vip>
:and the <vp>groupBox::setBorderStyle/1</vp> predicate
<blockquote><vip>GroupBoxBorderStyle = groupBox(),
controlName : setBorderStyle(GroupBoxBorderStyle),</vip></blockquote>
:to set the border style programmatically.
*'''Alignment'''
:Possible values are '''Left''', '''Center''' and '''Right'''. Radio buttons in this group box determine how the text in the control is aligned.
:The default value is '''Left''' (align left).
:*'''Left'''
::Defines that the text in the control will be aligned left.
::You can use the <vp>textControl::getAlignment/0-></vp> predicate to get which of these flags the control has
<blockquote><vip>AlignmentType = textControlName : getAlignment(),
AlignmentType = alignLeft(),</vip></blockquote>
::and the <vp>textControl::setAlignment/1</vp> predicate
<blockquote><vip>AlignmentType = alignLeft(),
textControlName : setAlignment(AlignmentType),</vip></blockquote>
::to set this flag programmatically.
:*'''Center'''
::Defines that the text in the control will be centered.
::The <vp>AlignmentType = alignCenter()</vp>.
:*'''Right'''
::Defines that the text in the control will be aligned right.
::The <vp>AlignmentType = alignRight()</vp>.
*'''Wrap'''
:Possible values are '''True''' and '''False'''. They define whether the text in the control will be wrapped to several lines.
:The default value is '''True''' (wrap).
:You can use the <vp>textControl::getWrap/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsNoWrap = textControlName : getWrap(),
IsNoWrap = true,</vip></blockquote>
:and the <vp>textControl::setWrap/1</vp> predicate
<blockquote><vip>IsNoWrap = false,
textControlName: setWrap(IsNoWrap),</vip></blockquote>
:to set this flag programmatically.
*'''IgnorePrefix'''
:Possible values are '''True''' and '''False'''. Setting '''True''' value prevents interpretation of any <vp>&</vp> characters in the caption of the static text control as access keys (accelerator prefix characters). Accelerator characters are displayed underlined and the prefix <vp>&</vp> character is deleted.
:The default value is '''False'''.
:Notice that static text controls cannot be activated. Therefore, when an access key of a static text control is pressed, then the control next to this static text control, in the tab-stop order of controls in the dialog, is activated.
:Most often this flag is used when filenames, which can contain the <vp>&</vp> character, need to be displayed in static text controls.
:You can use the <vp>textControl::getIgnorePrefix/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsIgnorePrefix = controlName : getIgnorePrefix(),
IsIgnorePrefix = true,</vip></blockquote>
:and the <vp>textControl::setIgnorePrefix/1</vp> predicate
<blockquote><vip>IsIgnorePrefix = true,
controlName : setIgnorePrefix(IsIgnorePrefix),</vip></blockquote>
:to set this flag programmatically.
*'''MultiLine'''
:Possible values are '''True''' and '''False'''. When this property is '''True''', then the edit control allows multiple lines.
:The default value is '''True''' (allows multiple lines).
:Notice that the '''VScroll''', '''HScroll''', '''AutoVScroll''', and '''WantReturn''' properties do not work for single-line ('''False''') edit controls.
:You can use the <vp>editControl::getMultiLine/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiLine = controlName : getMultiLine(),
IsMultiLine = true,</vip></blockquote>
:and the <vp>editControl::setMultiLine/1</vp> predicate
<blockquote><vip>IsMultiLine = true,
controlName : setMultiLine(IsMultiLine),</vip></blockquote>
:to set this flag programmatically.
*'''WantReturn'''
:Possible values are '''True''' and '''False'''.
:If it is '''True''', then a carriage return will be inserted as the part of an edited string, when the user presses the '''Enter''' key while entering text into a multi-line edit control.
:If it is '''False''', then pressing the '''Enter''' key has the same effect as pressing the ''default'' ('''OK''') push button, which has the latest specified '''Default = True''' property value.
:This property has no effect on single-line edit controls.
:The default value is '''False'''.
:You can use the <vp>editControl::getWantReturn/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsWantReturn = controlName : getWantReturn(),
IsWantReturn = true,</vip></blockquote>
:and the <vp>editControl::setWantReturn/1</vp> predicate
<blockquote><vip>IsWantReturn = true,
controlName : setWantReturn(IsWantReturn),</vip></blockquote>
:to set this flag programmatically.
*'''VScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' control gets a vertical scroll bar when it needs one.
:The default value for edit controls is '''True''' for other types of controls is '''False'''.
:This property has no effect on single-line edit controls.
:You can use the <vp>editControl::getVScroll/0-></vp> and <vp>listControl::getVScroll/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsVScrollSet = controlName : getVScroll(),
IsVScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setVScroll/1</vp> and <vp>listControl::setVScroll/0</vp> predicates
<blockquote><vip>IsVScrollSet = true,
controlName : setVScroll(IsVScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''AutoVScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit control automatically scrolls text up when the user presses the '''Enter''' on the last line.
:The default value is '''False''' (does not scroll).
:This property has no effect on single-line edit controls.
:You can use the <vp>editControl::getAutoVScroll/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoVScrollSet = controlName : getAutoVScroll(),
IsAutoVScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setAutoVScroll/1</vp> predicate
<blockquote><vip>IsAutoVScrollSet = true,
controlName : setAutoVScroll(IsAutoVScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''HScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit or list box control gets a horizontal scroll bar when it needs one.
:The default value is '''False''' (does not scroll).
:This property has no effect on single-line ''edit'' controls.
:You can use the <vp>editControl::getHScroll/0-></vp> or <vp>listBox::getHScroll/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsHScrollSet = controlName : getHScroll(),
IsHScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setHScroll/1</vp> or <vp>listBox::setHScroll/1</vp> predicates
<blockquote><vip>IsHScrollSet = true,
controlName : setHScroll(IsHScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''AutoHScroll'''
:Possible values are '''True''' and '''False'''. They define whether the control automatically scrolls text in the control in order to display a typed character, when the user types the character at the end of the line.
:If it is '''False''', then only text that fits within the rectangular boundary is allowed. When the user presses the '''Enter''' key, the control scrolls all text back to the zero position.
:The default value is '''True''' (scrolls text automatically).
:You can use the <vp>editControl::getAutoHScroll/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoHScrollSet = controlName : getAutoHScroll(),
IsAutoHScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setAutoHScroll/1</vp> predicate
<blockquote><vip>IsAutoHScrollSet = true,
controlName : setAutoHScroll(IsAutoHScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''Border'''
:Possible values are '''True''' and '''False'''. They define whether the control is created initially with a border around the control.
:The default value is '''False'''.
:You can use the <vp>editControl::getBorder/0-></vp> or <vp>listBox::getBorder/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>BorderIsSet = controlName : getBorder(),
BorderIsSet = true,</vip></blockquote>
:and the <vp>editControl::setBorder/1</vp> or <vp>listBox::setBorder/1</vp> predicates
<blockquote><vip>BorderIsSet = true,
controlName : setBorder(BorderIsSet),</vip></blockquote>
:to set this flag programmatically.
*'''Password'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control displays all typed-in characters as asterisks (*).
:The default value is '''False''' (displays typed characters "as-is").
:You can use the <vp>editControl::getPassword/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsPassword = controlName : getPassword(),
IsPassword = true,</vip></blockquote>
:and the <vp>editControl::setPassword/1</vp> predicate
<blockquote><vip>IsPassword = true,
controlName : setPassword(IsPassword),</vip></blockquote>
:to set this flag programmatically.
*'''HideSel'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control hides selection, when it loses the input focus, and shows selection, when it receives the input focus.
:The default value is '''True''' (hides selection).
:You can use the <vp>editControl::getHideSel/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsHideSel = controlName : getHideSel(),
IsHideSel = true,</vip></blockquote>
:and the <vp>editControl::setHideSel/1</vp> predicate
<blockquote><vip>IsHideSel = true,
controlName : setHideSel(IsHideSel),</vip></blockquote>
:to set this flag programmatically.
*'''ReadOnly'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control is in the read-only mode.
:The default value is '''False''' (editable).
:You can use the <vp>editControl::getReadOnly/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsReadOnly = controlName : getReadOnly(),
IsReadOnly = true,</vip></blockquote>
:and the <vp>editControl::setReadOnly/1</vp> predicate
<blockquote><vip>IsReadOnly = true,
controlName : setReadOnly(IsReadOnly),</vip></blockquote>
:to set this flag programmatically.
*'''Case'''
:Possible values are '''Insensitive''', '''Upper''', '''Lower'''.
:The default value is '''Insensitive'''.
:*'''Insensitive'''
::Defines that the edit control leaves the typed-in text "as-is".
::This is the default value.
:*'''Upper'''
::Defines that the edit control converts all typed-in characters into the upper case.
::You can use the <vp>editControl::getUpperCase/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsUpperCase = controlName : getUpperCase(),
IsUpperCase = true,</vip></blockquote>
::and the <vp>editControl::setUpperCase/1</vp> predicate
<blockquote><vip>IsUpperCase = true,
controlName : setUpperCase(IsUpperCase),</vip></blockquote>
::to set this flag programmatically.
:*'''Lower'''
::Defines that the edit control converts all typed-in characters into the lower case.
::You can use the <vp>editControl::getLowerCase/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsLowerCase = controlName : getLowerCase(),
IsLowerCase = true,</vip></blockquote>
::and the <vp>editControl::setLowerCase/1</vp> predicate
<blockquote><vip>IsLowerCase = true,
controlName : setLowerCase(IsLowerCase),</vip></blockquote>
::to set this flag programmatically.
*'''Sort'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list control sorts strings alphabetically.
:The default value is '''True''' (sort).
:You can use the <vp>listControl::getSort/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsSort = controlName : getSort(),
IsSort = true,</vip></blockquote>
:and the <vp>listControl::setSort/1</vp> predicate
<blockquote><vip>IsSort = true,
controlName : setSort(IsSort),</vip></blockquote>
:to set this flag programmatically.
*'''ExtendedSel'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items by using the '''Shift''' key and the mouse or using the '''Shift''' key and the '''Up''' or '''Down Arrow''' keys.
:The default value is '''False''' (cannot select multiple items).
:You can use the <vp>listBox::getExtendedSel/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsExtendedSel = controlName : getExtendedSel(),
IsExtendedSel = true,</vip></blockquote>
:and the <vp>listBox::setExtendedSel/1</vp> predicate
<blockquote><vip>IsExtendedSel = true,
controlName : setExtendedSel(IsExtendedSel),</vip></blockquote>
:to set this flag programmatically.
*'''MultiSelect'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items using the mouse.
:The default value is '''False''' (cannot select multiple items).
:You can use the <vp>listBox::getMultiSelect/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiSelect = controlName : getMultiSelect(),
IsMultiSelect = true,</vip></blockquote>
:and the <vp>listBox::setMultiSelect/1</vp> predicate
<blockquote><vip>IsMultiSelect = true,
controlName : setMultiSelect(IsMultiSelect),</vip></blockquote>
:to set this flag programmatically.
*'''AutoNotify'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control notifies the parent window with an input message whenever the user clicks or double-clicks in the list box.
:The default value is '''True''' (notify).
:You can use the <vp>listBox::getAutoNotify/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoNotify = controlName : getAutoNotify(),
IsAutoNotify = true,</vip></blockquote>
:and the <vp>listBox::setAutoNotify/1</vp> predicate
<blockquote><vip>IsAutoNotify = true,
controlName : setAutoNotify(IsAutoNotify),</vip></blockquote>
:to set this flag programmatically.
*'''UseTabStops'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control recognizes and expands TAB characters when drawing strings.
:The default value is '''False''' (does not expand).
:You can use the <vp>control::getUseTabStops/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsUseTabStops = controlName : getUseTabStops(),
IsUseTabStops = true,</vip></blockquote>
:and the <vp>control::setUseTabStops/1</vp> predicate
<blockquote><vip>IsUseTabStops = true,
controlName : setUseTabStops(IsUseTabStops),</vip></blockquote>
:to set this flag programmatically.
*'''StaticScrollbar'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list control shows a disabled vertical scroll bar for the list box when the box does not contain enough items to scroll. If it is '''False''', then the scroll bar is hidden when the list box does not contain enough items.
:The default value is '''True''' (shows vertical scroll bar).
:You can use the <vp>listControl::getStaticScrollbar/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsStaticScrollbar = controlName : getStaticScrollbar(),
IsStaticScrollbar = true,</vip></blockquote>
:and the <vp>listControl::setStaticScrollbar/1</vp> predicate
<blockquote><vip>IsStaticScrollbar = true,
controlName : setStaticScrollbar(IsStaticScrollbar),</vip></blockquote>
:to set this flag programmatically.
*'''AllowPartialRows'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the size of the list box is exactly the size specified by the application when it creates the list box. Normally, Windows re-sizes list boxes so that a list box does not display partial items.
:The default value is '''True''' for list box controls and '''False''' for list button and list edit controls.
:You can use the <vp>listControl::getAllowPartialRows/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAllowPartialRows = controlName : getAllowPartialRows(),
IsAllowPartialRows = true,</vip></blockquote>
:and the <vp>listControl::setAllowPartialRows/1</vp> predicate
<blockquote><vip>IsAllowPartialRows = true,
controlName : setAllowPartialRows(IsAllowPartialRows),</vip></blockquote>
:to set this flag programmatically.
*'''MultiColumn'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control can have multiple columns.
:The default value is '''False'''.
:You can use the <vp>listBox::getMultiColumn/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiColumn = controlName : getMultiColumn(),
IsMultiColumn = true,</vip></blockquote>
:and the <vp>listBox::setMultiColumn/1</vp> predicate
<blockquote><vip>IsMultiColumn = true,
controlName : setMultiColumn(IsMultiColumn),</vip></blockquote>
:to set this flag programmatically.
*'''Rows'''
:Possible values are positive numbers. For list button and list edit controls it specifies the maximal number of rows, which can be displayed in the opened list box sub-control.
:The default value is '''3'''.
:You can use the <vp>listControl::getMaxDropDownRows/0-></vp> predicate to get this number
:<vip>MaxDropDownRowNumber = controlName : getMaxDropDownRows(),</vip>
:and the <vp>listControl::setMaxDropDownRows/1</vp> predicate
<blockquote><vip>MaxDropDownRowNumber = 5,
controlName : setMaxDropDownRows(MaxDropDownRowNumber),</vip></blockquote>
:to set this number programmatically.
*'''Icon Name'''
:The icon name must be selected from the list of icon names registered in the Project (by clicking the [[Image:Ide_ListButton_Button.png]] button). In order to an icon name appears in the list of registered icon names, you should add the icon file (<vp>IconName.ico</vp>) into the project files. To do this you should use the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').
*'''Class'''
:Specify a name of a Windows class for the custom control (your application code must register the custom control by this name).

Ide/Resource Editor/GUI Control Properties Table

2013-04-25T11:25:35Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
===== GUI Control Properties Table =====

When you open a GUI dialog or a form (GUI window) in the '''IDE Designer''', then the '''Control Properties''' table also opens.

The set of properties displayed in the '''Control Properties''' table depends on the control type and contains two groups of properties:

*{{ide|Resource Editor#Common Properties of Almost All GUI Controls|'''General properties'''}} are common to all types of controls. These are: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', '''Bottom Anchor''', '''Container Name''', '''Enabled''', '''Lock to Container''', '''Name''', '''Representation''', '''TabStop''', '''Title''', '''X''', '''Y''', '''Width''', '''Height''' and '''Visible'''.

*{{ide|Resource Editor#Specific Properties of Different GUI Control Types|'''Specific properties'''}} are individual to different types of GUI controls. These are: '''3State''', '''AlignBaseline''', '''Alignment''', '''AllowPartialRows''', '''Auto''', '''AutoNotify''', '''AutoHScroll''', '''AutoVScroll''', '''Border''', '''Case''', '''Class''', '''ExtendedSel''', '''HideSel''', '''HScroll''', '''Icon Name''', '''IgnorePrefix''', '''LeftText''', '''MultiColumn''', '''MultiLine''', '''MultiSelect''', '''Password''', '''ReadOnly''', '''Rows''', '''Sort''', '''StaticScrollbar''', '''Style''', '''UseTabStops''', '''VScroll''', '''WantReturn''', '''Wrap'''.

In '''Control Properties''' table you can edit the displayed properties of the selected GUI control.

Initially this table is empty. However, as soon as any of GUI controls in the edited GUI dialog (form) is selected, the '''Control Properties''' table displays the current set of properties of the selected control.

If the '''Control Properties''' table is closed, double-click a control to show the table. The '''Control Attributes''' command, from the {{ide|Resource Editor#Speed Menu|speed menu}} of the '''IDE Designer''', can also be used to open the '''Control Properties''' table.

===== Common Properties of Almost All GUI Controls =====

There are some basic control properties, which are used by almost all GUI controls. These are:

*'''Name'''
:The '''Name''' input box is where you can specify some correct Visual Prolog name, which will be used as the control name (identifier).
:The default '''Name''' is generated from the ''control type'' (for example, ''pushButton'', ''checkBox'', ''listButton'', etc.) and the <vp>_ctl</vp> suffix. If several controls of the same type are created, then the ''control type'' is suffixed with the number, for example, <vp>pushButton</vp><vp>1</vp><vp>_ctl</vp>.
:You can edit this default name or simply type in your own version.
*'''Representation'''
:This property can have one of the following two values: '''Fact Variable''', '''Variable'''.
:*'''Fact Variable'''
::When '''Fact Variable''' is specified, then the IDE generates the fact variable, which will store the object of the control. This fact variable is used to reference to this control in the code. This fact variable name is determined by the '''Name''' property. For example, <vp>ok_ctl</vp>. Notice that in this case the fact variable name is automatically converted to be started with the lowercase character.
:*'''Variable'''
::When '''Variable''' is specified, then the IDE unifies the object of the control with an ordinary variable. This variable will be used to reference to this control in the code. This variable name is determined by the '''Name''' property. For example, <vp>Cancel_ctl</vp>. Notice that in this case the variable name is automatically converted to be started with the uppercase character.
:The default value is '''Fact Variable'''.
*'''Title'''
:The '''Title''' property is where you specify the title (label), which you want to be displayed as the control caption.
:One character in the Title text may be underlined to indicate an access key. To underline a character precede it with the ampersand <vp>&</vp> character. At runtime this character in the control '''Title''' will be underlined.
:Notice that this character is displayed underlined also in the value cell of the '''Title''' property:
:[[Image:Ide_GUI_Prop_Title.png]]
:The used ampersand <vp>&</vp> character is seen only when the value cell of the '''Title''' property has the focus:
:[[Image:Ide_GUI_Prop_Title2.png]]
:If you need to display the ampersand <vp>&</vp> character in the '''Title''' text, then use two of them <vp>&&</vp>.
*'''Lock to Container'''
:Possible values are '''True''' and '''False'''. '''True''' defines that the control is locked inside the container selected in the '''Container Name''' property.
*'''Container Name'''
:In this list box you can select the '''Name''' of one of containers (currently only the group box <vp>groupBox</vp> type of containers is supported) defined in the dialog or in the form.
:All controls belonging to the same container are in the same ''group'' of related controls. The user may use the arrow keys to move from one control in the ''group'' to the next one.
:Only the '''Names''' of group boxes, inside which the control is placed, appear in the list of '''Container Name''' property values. For example, if you see:
:[[Image:Ide_GUI_Prop_Container.png]]
:this means that the control is placed inside two group boxes with names <vp>GroupBox_ctl</vp> and <vp>GroupBox1_ctl</vp>.
:If you do not need to relate the control to any container, then you should select <vp>[none]</vp>.
*'''X''', '''Y''', '''Width''', '''Height'''
:These properties determine the control coordinates and size:
:*'''X'''
::The '''X''' coordinate of the upper-left corner of the control (in Dialog Base Units).
:*'''Y'''
::The '''Y''' coordinate of the upper-left corner of the control (in Dialog Base Units).
:*'''Width'''
::The '''Width''' of the control (in Dialog Base Units).
:*'''Height'''
::The '''Height''' of the control (in Dialog Base Units).
*'''Left''', '''Top''', '''Right''' and '''Bottom Anchors'''
:These properties determine how the control coordinates (and may be size) will be handled when the dialog or form (containing this control) is resized. The general rules are described in the "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
:*'''Left Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Left''' boundary of the control is always positioned at the specified distance (equal to the '''X''' property) from the '''Left''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units.
:*'''Top Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Top''' of the control is always positioned at the specified distance (equal to the '''Y''' property) from the '''Top''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units.
:*'''Right Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Right''' boundary of the control is always positioned at the specified distance from the '''Right''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
:*'''Bottom Anchor'''
::Possible values are '''True''' and '''False'''. '''True''' defines that the '''Bottom''' of the control is always positioned at the specified distance from the '''Bottom''' boundary of the dialog (form) containing this control.
::The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*'''Enabled'''
:Possible values are '''True''' and '''False'''. They define whether the control will be created initially enabled ('''True''') or disabled ('''False'''). The default value is '''True''' (enabled).
:You can use the <vp>window::getEnabled/0-></vp> predicate to get whether the control is enabled
<blockquote><vip>IsEnabled = checkButtonName:getEnabled(),
IsEnabled = true,</vip></blockquote>
:and the <vp>window::setEnabled/1</vp> predicate
<blockquote><vip>IsEnabled = true,
checkButtonName:setEnabled(IsEnabled),</vip></blockquote>
:to set this flag programmatically.
*'''Visible'''
:Possible values are '''True''' and '''False'''. They define whether the control will be created initially visible ('''True''') or invisible ('''False'''). The default value is '''True''' (visible).
:You can use the <vp>window::getVisible/0-></vp> predicate to get whether the control is visible
<blockquote><vip>IsVisible = checkButtonName:getVisible(),
IsVisible = true,</vip></blockquote>
:and the <vp>window::setVisible/1</vp> predicate
<blockquote><vip>IsVisible = true,
checkButtonName:setVisible(IsVisible),</vip></blockquote>
:to set this flag programmatically.
*'''TabStop'''
:Possible values are '''True''' and '''False'''. They define whether this control belongs to a subset of controls through which the user can move using the TAB key. The default value is '''True''' (the control belongs to a group of controls between which the user can navigate with TAB).
:You can use the <vp>control::getTabStop/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsTabStop = checkButtonName:getTabStop(),
IsTabStop = true,</vip></blockquote>
:and the <vp>control::setTabStop/1</vp> predicate
<blockquote><vip>IsTabStop = true,
checkButtonName:setTabStop(IsTabStop),</vip></blockquote>
:to set this flag programmatically.
:If <vp>IsTabStop</vp> is <vp>true</vp>, then the focus will be able to jump to this control while the Tab pressing navigation. Pressing the TAB key moves the focus to the next control, which has the '''TabStop''' = '''True'''.

===== Specific Properties of Different GUI Control Types =====

The following properties are specific to different types of controls:

*'''Auto'''
:Possible values are '''True''' and '''False'''. They define whether this control is an automatic (an automatic check box or an automatic radio button). When you click an automatic control, then it change its state in the proper way.
:You can use the <vp>checkButton::getStyle/2</vp> and <vp>radioButton::getAuto/0-></vp> predicates to get whether this flag is set to a control:
<blockquote><vip>checkButtonName:getStyle(IsAuto, _Is3State),
IsAuto = true,</vip></blockquote>
:and the <vp>checkButton::setStyle/2</vp> or <vp>radioButton::setAuto/1</vp> predicates
<blockquote><vip>IsAuto = true,
checkButtonName:setStyle(IsAuto, _Is3State),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''True''' (auto).
*'''3State'''
:Possible values are '''True''' and '''False'''. They define whether this check box can have 3 states (''unchecked, checked, undetermined''). You can use the <vp>checkButton::getStyle/2</vp> predicate to get whether this state is set to a control
<blockquote><vip>checkButtonName:getStyle(_IsAuto, Is3State),
Is3State = true,</vip></blockquote>
:and the <vp>checkButton::setStyle/2</vp> predicate
<blockquote><vip>Is3State = true,
checkButtonName:setStyle(_IsAuto, Is3State),</vip></blockquote>
:to set this state programmatically.
:A 3-states check box is the same as an ordinary check box, except that the box can be grayed (dimmed) as well as checked. The grayed state is used to show that the state of the check box is not determined.
:The default value is '''False''' (3State).
*'''LeftText'''
:Possible values are '''True''' and '''False'''. They define whether the control title text should be positioned on the left or on the right of the control (check box or radio button).
:You can use the <vp>checkButton::getLeftText/0-></vp> or <vp>radioButton::getLeftText/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsLeftText = checkButtonName:getLeftText(),
IsLeftText = true,</vip></blockquote>
:and the <vp>checkButton:setLeftText/1</vp> or <vp>radioButton:setLeftText/1</vp> predicates
<blockquote><vip>IsLeftText = true,
checkButtonName:setLeftText(IsLeftText),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''False''' (caption is on the right side).
*'''AlignBaseline'''
:Possible values are '''True''' and '''False'''. They define whether the control caption text should be positioned on the same horizontal line with caption texts of all other controls, which have the same vertical position with this control.
:This property is defined to all controls, which can have captions (static texts, check boxes, edit and list edit controls, etc.)
:You can use the <vp>getAlignBaseline</vp> predicates (like <vp>editControl::getAlignBaseline/0-></vp>) to get whether the control has this flag
<blockquote><vip>IsAllignBaseLine = checkButtonName:getAllignBaseLine(),
IsAllignBaseLine = true,</vip></blockquote>
:and the <vp>setAlignBaseline</vp> (like <vp>textControl::setAlignBaseline/1</vp>) predicates
<blockquote><vip>IsAllignBaseLine = true,
checkButtonName:setAllignBaseLine(IsAllignBaseLine),</vip></blockquote>
:to set this flag programmatically.
:The default value is '''True''' (align captions horizontally).
'''Style'''
:'''Push buttons'''
:For push buttons possible values are '''Cancel''', '''OK''' and '''Regular'''.
:'''Cancel'''
::Push buttons with the '''Cancel''' style are created by the <vp>button::newCancel/1</vp> onstructor.
::When a dialog/form contains a push button with the '''Cancel''' style, then this dialog/form will provide standard handling of the Esc key - the dialog/form is simply closed without any additional actions.
:'''OK'''
::Push buttons with the '''OK''' style are created by the <vp>button::newOk/1</vp> constructor.
::When a dialog/form contains a push button with the '''Ok''' style, then this dialog/form will execute dialog/form validation check when this button is clicked. See "'''Dialog/Form Validation'''" tutorial (on WEB) for more information.
:'''Regular'''
::Push buttons with the '''Regular''' style are created by the ordinary <vp>button::new/1</vp> constructor.
::Such buttons do not initiate any special default handling.
:'''Group boxes'''
:For group boxes possible values are '''Group Box''', '''Simple Border''', '''Horizontal Separator''', '''No Border'''. These values define the border type of the group box control.
:The default is '''Simple Border'''.
:You can use the <vp>groupBox::getBorderStyle/0-></vp> predicate to get the border style
:<vip>GroupBoxBorderStyle = controlName : getBorderStyle(),</vip>
:and the <vp>groupBox::setBorderStyle/1</vp> predicate
<blockquote><vip>GroupBoxBorderStyle = groupBox(),
controlName : setBorderStyle(GroupBoxBorderStyle),</vip></blockquote>
:to set the border style programmatically.
*'''Alignment'''
:Possible values are '''Left''', '''Center''' and '''Right'''. Radio buttons in this group box determine how the text in the control is aligned.
:The default value is '''Left''' (align left).
:*'''Left'''
::Defines that the text in the control will be aligned left.
::You can use the <vp>textControl::getAlignment/0-></vp> predicate to get which of these flags the control has
<blockquote><vip>AlignmentType = textControlName : getAlignment(),
AlignmentType = alignLeft(),</vip></blockquote>
::and the <vp>textControl::setAlignment/1</vp> predicate
<blockquote><vip>AlignmentType = alignLeft(),
textControlName : setAlignment(AlignmentType),</vip></blockquote>
::to set this flag programmatically.
:*'''Center'''
::Defines that the text in the control will be centered.
::The <vp>AlignmentType = alignCenter()</vp>.
:*'''Right'''
::Defines that the text in the control will be aligned right.
::The <vp>AlignmentType = alignRight()</vp>.
*'''Wrap'''
:Possible values are '''True''' and '''False'''. They define whether the text in the control will be wrapped to several lines.
:The default value is '''True''' (wrap).
:You can use the <vp>textControl::getWrap/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsNoWrap = textControlName : getWrap(),
IsNoWrap = true,</vip></blockquote>
:and the <vp>textControl::setWrap/1</vp> predicate
<blockquote><vip>IsNoWrap = false,
textControlName: setWrap(IsNoWrap),</vip></blockquote>
:to set this flag programmatically.
*'''IgnorePrefix'''
:Possible values are '''True''' and '''False'''. Setting '''True''' value prevents interpretation of any <vp>&</vp> characters in the caption of the static text control as access keys (accelerator prefix characters). Accelerator characters are displayed underlined and the prefix <vp>&</vp> character is deleted.
:The default value is '''False'''.
:Notice that static text controls cannot be activated. Therefore, when an access key of a static text control is pressed, then the control next to this static text control, in the tab-stop order of controls in the dialog, is activated.
:Most often this flag is used when filenames, which can contain the <vp>&</vp> character, need to be displayed in static text controls.
:You can use the <vp>textControl::getIgnorePrefix/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsIgnorePrefix = controlName : getIgnorePrefix(),
IsIgnorePrefix = true,</vip></blockquote>
:and the <vp>textControl::setIgnorePrefix/1</vp> predicate
<blockquote><vip>IsIgnorePrefix = true,
controlName : setIgnorePrefix(IsIgnorePrefix),</vip></blockquote>
:to set this flag programmatically.
*'''MultiLine'''
:Possible values are '''True''' and '''False'''. When this property is '''True''', then the edit control allows multiple lines.
:The default value is '''True''' (allows multiple lines).
:Notice that the '''VScroll''', '''HScroll''', '''AutoVScroll''', and '''WantReturn''' properties do not work for single-line ('''False''') edit controls.
:You can use the <vp>editControl::getMultiLine/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiLine = controlName : getMultiLine(),
IsMultiLine = true,</vip></blockquote>
:and the <vp>editControl::setMultiLine/1</vp> predicate
<blockquote><vip>IsMultiLine = true,
controlName : setMultiLine(IsMultiLine),</vip></blockquote>
:to set this flag programmatically.
*'''WantReturn'''
:Possible values are '''True''' and '''False'''.
:If it is '''True''', then a carriage return will be inserted as the part of an edited string, when the user presses the '''Enter''' key while entering text into a multi-line edit control.
:If it is '''False''', then pressing the '''Enter''' key has the same effect as pressing the ''default'' ('''OK''') push button, which has the latest specified '''Default = True''' property value.
:This property has no effect on single-line edit controls.
:The default value is '''False'''.
:You can use the <vp>editControl::getWantReturn/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsWantReturn = controlName : getWantReturn(),
IsWantReturn = true,</vip></blockquote>
:and the <vp>editControl::setWantReturn/1</vp> predicate
<blockquote><vip>IsWantReturn = true,
controlName : setWantReturn(IsWantReturn),</vip></blockquote>
:to set this flag programmatically.
*'''VScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' control gets a vertical scroll bar when it needs one.
:The default value for edit controls is '''True''' for other types of controls is '''False'''.
:This property has no effect on single-line edit controls.
:You can use the <vp>editControl::getVScroll/0-></vp> and <vp>listControl::getVScroll/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsVScrollSet = controlName : getVScroll(),
IsVScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setVScroll/1</vp> and <vp>listControl::setVScroll/0</vp> predicates
<blockquote><vip>IsVScrollSet = true,
controlName : setVScroll(IsVScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''AutoVScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit control automatically scrolls text up when the user presses the '''Enter''' on the last line.
:The default value is '''False''' (does not scroll).
:This property has no effect on single-line edit controls.
:You can use the <vp>editControl::getAutoVScroll/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoVScrollSet = controlName : getAutoVScroll(),
IsAutoVScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setAutoVScroll/1</vp> predicate
<blockquote><vip>IsAutoVScrollSet = true,
controlName : setAutoVScroll(IsAutoVScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''HScroll'''
:Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit or list box control gets a horizontal scroll bar when it needs one.
:The default value is '''False''' (does not scroll).
:This property has no effect on single-line ''edit'' controls.
:You can use the <vp>editControl::getHScroll/0-></vp> or <vp>listBox::getHScroll/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>IsHScrollSet = controlName : getHScroll(),
IsHScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setHScroll/1</vp> or <vp>listBox::setHScroll/1</vp> predicates
<blockquote><vip>IsHScrollSet = true,
controlName : setHScroll(IsHScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''AutoHScroll'''
:Possible values are '''True''' and '''False'''. They define whether the control automatically scrolls text in the control in order to display a typed character, when the user types the character at the end of the line.
:If it is '''False''', then only text that fits within the rectangular boundary is allowed. When the user presses the '''Enter''' key, the control scrolls all text back to the zero position.
:The default value is '''True''' (scrolls text automatically).
:You can use the <vp>editControl::getAutoHScroll/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoHScrollSet = controlName : getAutoHScroll(),
IsAutoHScrollSet = true,</vip></blockquote>
:and the <vp>editControl::setAutoHScroll/1</vp> predicate
<blockquote><vip>IsAutoHScrollSet = true,
controlName : setAutoHScroll(IsAutoHScrollSet),</vip></blockquote>
:to set this flag programmatically.
*'''Border'''
:Possible values are '''True''' and '''False'''. They define whether the control is created initially with a border around the control.
:The default value is '''False'''.
:You can use the <vp>editControl::getBorder/0-></vp> or <vp>listBox::getBorder/0-></vp> predicates to get whether the control has this flag
<blockquote><vip>BorderIsSet = controlName : getBorder(),
BorderIsSet = true,</vip></blockquote>
:and the <vp>editControl::setBorder/1</vp> or <vp>listBox::setBorder/1</vp> predicates
<blockquote><vip>BorderIsSet = true,
controlName : setBorder(BorderIsSet),</vip></blockquote>
:to set this flag programmatically.
*'''Password'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control displays all typed-in characters as asterisks (*).
:The default value is '''False''' (displays typed characters "as-is").
:You can use the <vp>editControl::getPassword/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsPassword = controlName : getPassword(),
IsPassword = true,</vip></blockquote>
:and the <vp>editControl::setPassword/1</vp> predicate
<blockquote><vip>IsPassword = true,
controlName : setPassword(IsPassword),</vip></blockquote>
:to set this flag programmatically.
*'''HideSel'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control hides selection, when it loses the input focus, and shows selection, when it receives the input focus.
:The default value is '''True''' (hides selection).
:You can use the <vp>editControl::getHideSel/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsHideSel = controlName : getHideSel(),
IsHideSel = true,</vip></blockquote>
:and the <vp>editControl::setHideSel/1</vp> predicate
<blockquote><vip>IsHideSel = true,
controlName : setHideSel(IsHideSel),</vip></blockquote>
:to set this flag programmatically.
*'''ReadOnly'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control is in the read-only mode.
:The default value is '''False''' (editable).
:You can use the <vp>editControl::getReadOnly/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsReadOnly = controlName : getReadOnly(),
IsReadOnly = true,</vip></blockquote>
:and the <vp>editControl::setReadOnly/1</vp> predicate
<blockquote><vip>IsReadOnly = true,
controlName : setReadOnly(IsReadOnly),</vip></blockquote>
:to set this flag programmatically.
*'''Case'''
:Possible values are '''Insensitive''', '''Upper''', '''Lower'''.
:The default value is '''Insensitive'''.
:*'''Insensitive'''
::Defines that the edit control leaves the typed-in text "as-is".
::This is the default value.
:*'''Upper'''
::Defines that the edit control converts all typed-in characters into the upper case.
::You can use the <vp>editControl::getUpperCase/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsUpperCase = controlName : getUpperCase(),
IsUpperCase = true,</vip></blockquote>
::and the <vp>editControl::setUpperCase/1</vp> predicate
<blockquote><vip>IsUpperCase = true,
controlName : setUpperCase(IsUpperCase),</vip></blockquote>
::to set this flag programmatically.
:*'''Lower'''
::Defines that the edit control converts all typed-in characters into the lower case.
::You can use the <vp>editControl::getLowerCase/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsLowerCase = controlName : getLowerCase(),
IsLowerCase = true,</vip></blockquote>
::and the <vp>editControl::setLowerCase/1</vp> predicate
<blockquote><vip>IsLowerCase = true,
controlName : setLowerCase(IsLowerCase),</vip></blockquote>
::to set this flag programmatically.
*'''Sort'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list control sorts strings alphabetically.
:The default value is '''True''' (sort).
:You can use the <vp>listControl::getSort/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsSort = controlName : getSort(),
IsSort = true,</vip></blockquote>
:and the <vp>listControl::setSort/1</vp> predicate
<blockquote><vip>IsSort = true,
controlName : setSort(IsSort),</vip></blockquote>
:to set this flag programmatically.
*'''ExtendedSel'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items by using the '''Shift''' key and the mouse or using the '''Shift''' key and the '''Up''' or '''Down Arrow''' keys.
:The default value is '''False''' (cannot select multiple items).
:You can use the <vp>listBox::getExtendedSel/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsExtendedSel = controlName : getExtendedSel(),
IsExtendedSel = true,</vip></blockquote>
:and the <vp>listBox::setExtendedSel/1</vp> predicate
<blockquote><vip>IsExtendedSel = true,
controlName : setExtendedSel(IsExtendedSel),</vip></blockquote>
:to set this flag programmatically.
*'''MultiSelect'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items using the mouse.
:The default value is '''False''' (cannot select multiple items).
:You can use the <vp>listBox::getMultiSelect/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiSelect = controlName : getMultiSelect(),
IsMultiSelect = true,</vip></blockquote>
:and the <vp>listBox::setMultiSelect/1</vp> predicate
<blockquote><vip>IsMultiSelect = true,
controlName : setMultiSelect(IsMultiSelect),</vip></blockquote>
:to set this flag programmatically.
*'''AutoNotify'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control notifies the parent window with an input message whenever the user clicks or double-clicks in the list box.
:The default value is '''True''' (notify).
:You can use the <vp>listBox::getAutoNotify/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAutoNotify = controlName : getAutoNotify(),
IsAutoNotify = true,</vip></blockquote>
:and the <vp>listBox::setAutoNotify/1</vp> predicate
<blockquote><vip>IsAutoNotify = true,
controlName : setAutoNotify(IsAutoNotify),</vip></blockquote>
:to set this flag programmatically.
*'''UseTabStops'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control recognizes and expands TAB characters when drawing strings.
:The default value is '''False''' (does not expand).
:You can use the <vp>control::getUseTabStops/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsUseTabStops = controlName : getUseTabStops(),
IsUseTabStops = true,</vip></blockquote>
:and the <vp>control::setUseTabStops/1</vp> predicate
<blockquote><vip>IsUseTabStops = true,
controlName : setUseTabStops(IsUseTabStops),</vip></blockquote>
:to set this flag programmatically.
*'''StaticScrollbar'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list control shows a disabled vertical scroll bar for the list box when the box does not contain enough items to scroll. If it is '''False''', then the scroll bar is hidden when the list box does not contain enough items.
:The default value is '''True''' (shows vertical scroll bar).
:You can use the <vp>listControl::getStaticScrollbar/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsStaticScrollbar = controlName : getStaticScrollbar(),
IsStaticScrollbar = true,</vip></blockquote>
:and the <vp>listControl::setStaticScrollbar/1</vp> predicate
<blockquote><vip>IsStaticScrollbar = true,
controlName : setStaticScrollbar(IsStaticScrollbar),</vip></blockquote>
:to set this flag programmatically.
*'''AllowPartialRows'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the size of the list box is exactly the size specified by the application when it creates the list box. Normally, Windows re-sizes list boxes so that a list box does not display partial items.
:The default value is '''True''' for list box controls and '''False''' for list button and list edit controls.
:You can use the <vp>listControl::getAllowPartialRows/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsAllowPartialRows = controlName : getAllowPartialRows(),
IsAllowPartialRows = true,</vip></blockquote>
:and the <vp>listControl::setAllowPartialRows/1</vp> predicate
<blockquote><vip>IsAllowPartialRows = true,
controlName : setAllowPartialRows(IsAllowPartialRows),</vip></blockquote>
:to set this flag programmatically.
*'''MultiColumn'''
:Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control can have multiple columns.
:The default value is '''False'''.
:You can use the <vp>listBox::getMultiColumn/0-></vp> predicate to get whether the control has this flag
<blockquote><vip>IsMultiColumn = controlName : getMultiColumn(),
IsMultiColumn = true,</vip></blockquote>
:and the <vp>listBox::setMultiColumn/1</vp> predicate
<blockquote><vip>IsMultiColumn = true,
controlName : setMultiColumn(IsMultiColumn),</vip></blockquote>
:to set this flag programmatically.
*'''Rows'''
:Possible values are positive numbers. For list button and list edit controls it specifies the maximal number of rows, which can be displayed in the opened list box sub-control.
:The default value is '''3'''.
:You can use the <vp>listControl::getMaxDropDownRows/0-></vp> predicate to get this number
:<vip>MaxDropDownRowNumber = controlName : getMaxDropDownRows(),</vip>
:and the <vp>listControl::setMaxDropDownRows/1</vp> predicate
<blockquote><vip>MaxDropDownRowNumber = 5,
controlName : setMaxDropDownRows(MaxDropDownRowNumber),</vip></blockquote>
:to set this number programmatically.
*'''Icon Name'''
:The icon name must be selected from the list of icon names registered in the Project (by clicking the [[Image:Ide_ListButton_button.png]] button). In order to an icon name appears in the list of registered icon names, you should add the icon file (<vp>IconName.ico</vp>) into the project files. To do this you should use the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').
*'''Class'''
:Specify a name of a Windows class for the custom control (your application code must register the custom control by this name).

File:Ide GUI Prop Container.png

2013-04-25T07:16:24Z

GalinaTchekmareva:

File:Ide GUI Prop Title2.png

2013-04-25T07:15:47Z

GalinaTchekmareva:

File:Ide GUI Prop Title.png

2013-04-25T07:15:01Z

GalinaTchekmareva:

Ide/Resource Editor/GUI Control Properties Table

2013-04-24T13:03:31Z

GalinaTchekmareva: New page: <noinclude>Category:Ide</noinclude> ===== GUI Control Properties Table ===== When you open a GUI dialog or a form (GUI window) in the '''IDE Designer''', then the '''Control Properti...

<noinclude>[[Category:Ide]]</noinclude>

===== GUI Control Properties Table =====

When you open a GUI dialog or a form (GUI window) in the '''IDE Designer''', then the '''Control Properties''' table also opens.

The set of properties displayed in the '''Control Properties''' table depends on the control type and contains two groups of properties:

*{{ide|Resource Editor#Common Properties of Almost All GUI Controls|'''General properties'''}} are common to all types of controls. These are: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', '''Bottom Anchor''', '''Container Name''', '''Enabled''', '''Lock to Container''', '''Name''', '''Representation''', '''TabStop''', '''Title''', '''X''', '''Y''', '''Width''', '''Height''' and '''Visible'''.

*{{ide|Resource Editor#Specific Properties of Different GUI Control Types|'''Specific properties'''}} are individual to different types of GUI controls. These are: '''3State''', '''AlignBaseline''', '''Alignment''', '''AllowPartialRows''', '''Auto''', '''AutoNotify''', '''AutoHScroll''', '''AutoVScroll''', '''Border''', '''Case''', '''Class''', '''ExtendedSel''', '''HideSel''', '''HScroll''', '''Icon Name''', '''IgnorePrefix''', '''LeftText''', '''MultiColumn''', '''MultiLine''', '''MultiSelect''', '''Password''', '''ReadOnly''', '''Rows''', '''Sort''', '''StaticScrollbar''', '''Style''', '''UseTabStops''', '''VScroll''', '''WantReturn''', '''Wrap'''.

In '''Control Properties''' table you can edit the displayed properties of the selected GUI control.

Initially this table is empty. However, as soon as any of GUI controls in the edited GUI dialog (form) is selected, the '''Control Properties''' table displays the current set of properties of the selected control.

If the '''Control Properties''' table is closed, double-click a control to show the table. The '''Control Attributes''' command, from the {{ide|Resource Editor#Speed Menu|speed menu}} of the '''IDE Designer''', can also be used to open the '''Control Properties''' table.

===== Common Properties of Almost All GUI Controls =====

There are some basic control properties, which are used by almost all GUI controls. These are:

*'''Name'''
*:The '''Name''' input box is where you can specify some correct Visual Prolog name, which will be used as the control name (identifier).
*:The default '''Name''' is generated from the ''control type'' (for example, ''pushButton'', ''checkBox'', ''listButton'', etc.) and the <vp>_ctl</vp> suffix. If several controls of the same type are created, then the ''control type'' is suffixed with the number, for example, <vp>pushButton</vp><vp>1</vp><vp>_ctl</vp>.
*:You can edit this default name or simply type in your own version.
*'''Representation'''
*:This property can have one of the following two values: '''Fact Variable''', '''Variable'''.
*:*'''Fact Variable'''
*:*:When '''Fact Variable''' is specified, then the IDE generates the fact variable, which will store the object of the control. This fact variable is used to reference to this control in the code. This fact variable name is determined by the '''Name''' property. For example, <vp>ok_ctl</vp>. Notice that in this case the fact variable name is automatically converted to be started with the lowercase character.
*:*'''Variable'''
*:*:When '''Variable''' is specified, then the IDE unifies the object of the control with an ordinary variable. This variable will be used to reference to this control in the code. This variable name is determined by the '''Name''' property. For example, <vp>Cancel_ctl</vp>. Notice that in this case the variable name is automatically converted to be started with the uppercase character.
*:The default value is '''Fact Variable'''.
*'''Title'''
*:The '''Title''' property is where you specify the title (label), which you want to be displayed as the control caption.
*:One character in the Title text may be underlined to indicate an access key. To underline a character precede it with the ampersand <vp>&</vp> character. At runtime this character in the control '''Title''' will be underlined.
*:Notice that this character is displayed underlined also in the value cell of the '''Title''' property:
*:[[Image:Ide_GUI_Prop_Title.png]]
*:The used ampersand <vp>&</vp> character is seen only when the value cell of the '''Title''' property has the focus:
*:[[Image:Ide_GUI_Prop_Title2.png]]
*:If you need to display the ampersand <vp>&</vp> character in the '''Title''' text, then use two of them <vp>&&</vp>.
*'''Lock to Container'''
*:Possible values are '''True''' and '''False'''. '''True''' defines that the control is locked inside the container selected in the '''Container Name''' property.
*'''Container Name'''
*:In this list box you can select the '''Name''' of one of containers (currently only the group box <vp>groupBox</vp> type of containers is supported) defined in the dialog or in the form.
*:All controls belonging to the same container are in the same ''group'' of related controls. The user may use the arrow keys to move from one control in the ''group'' to the next one.
*:Only the '''Names''' of group boxes, inside which the control is placed, appear in the list of '''Container Name''' property values. For example, if you see:
*:[[Image:Ide_GUI_Prop_Container.png]]
*:this means that the control is placed inside two group boxes with names <vp>GroupBox_ctl</vp> and <vp>GroupBox1_ctl</vp>.
*:If you do not need to relate the control to any container, then you should select <vp>[none]</vp>.
*'''X''', '''Y''', '''Width''', '''Height'''
*:These properties determine the control coordinates and size:
*:*'''X'''
*:*:The '''X''' coordinate of the upper-left corner of the control (in Dialog Base Units).
*:*'''Y'''
*:*:The '''Y''' coordinate of the upper-left corner of the control (in Dialog Base Units).
*:*'''Width'''
*:*:The '''Width''' of the control (in Dialog Base Units).
*:*'''Height'''
*:*:The '''Height''' of the control (in Dialog Base Units).
*'''Left''', '''Top''', '''Right''' and '''Bottom Anchors'''
*:These properties determine how the control coordinates (and may be size) will be handled when the dialog or form (containing this control) is resized. The general rules are described in the "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*:*'''Left Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Left''' boundary of the control is always positioned at the specified distance (equal to the '''X''' property) from the '''Left''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units.
*:*'''Top Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Top''' of the control is always positioned at the specified distance (equal to the '''Y''' property) from the '''Top''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units.
*:*'''Right Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Right''' boundary of the control is always positioned at the specified distance from the '''Right''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*:*'''Bottom Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Bottom''' of the control is always positioned at the specified distance from the '''Bottom''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*'''Enabled'''
*:Possible values are '''True''' and '''False'''. They define whether the control will be created initially enabled ('''True''') or disabled ('''False'''). The default value is '''True''' (enabled).
*:You can use the <vp>window::getEnabled/0-></vp> predicate to get whether the control is enabled
<vip>IsEnabled = checkButtonName:getEnabled(),
IsEnabled = true,</vip>
:and the <vp>window::setEnabled/1</vp> predicate
<vip>IsEnabled = true,
checkButtonName:setEnabled(IsEnabled),</vip>
:to set this flag programmatically.
*'''Visible'''
*:Possible values are '''True''' and '''False'''. They define whether the control will be created initially visible ('''True''') or invisible ('''False'''). The default value is '''True''' (visible).
*:You can use the <vp>window::getVisible/0-></vp> predicate to get whether the control is visible
<vip>IsVisible = checkButtonName:getVisible(),
IsVisible = true,</vip>
:and the <vp>window::setVisible/1</vp> predicate
<vip>IsVisible = true,
checkButtonName:setVisible(IsVisible),</vip>
:to set this flag programmatically.
*'''TabStop'''
*:Possible values are '''True''' and '''False'''. They define whether this control belongs to a subset of controls through which the user can move using the TAB key. The default value is '''True''' (the control belongs to a group of controls between which the user can navigate with TAB).
*:You can use the <vp>control::getTabStop/0-></vp> predicate to get whether the control has this flag
<vip>IsTabStop = checkButtonName:getTabStop(),
IsTabStop = true,</vip>
:and the <vp>control::setTabStop/1</vp> predicate
<vip>IsTabStop = true,
checkButtonName:setTabStop(IsTabStop),</vip>
:to set this flag programmatically.
:If <vp>IsTabStop</vp> is <vp>true</vp>, then the focus will be able to jump to this control while the Tab pressing navigation. Pressing the TAB key moves the focus to the next control, which has the '''TabStop''' = '''True'''.

===== Specific Properties of Different GUI Control Types =====

The following properties are specific to different types of controls:

*'''Auto'''
*:Possible values are '''True''' and '''False'''. They define whether this control is an automatic (an automatic check box or an automatic radio button). When you click an automatic control, then it change its state in the proper way.
*:You can use the <vp>checkButton::getStyle/2</vp> and <vp>radioButton::getAuto/0-></vp> predicates to get whether this flag is set to a control:
<vip>checkButtonName:getStyle(IsAuto, _Is3State),
IsAuto = true,</vip>
:and the <vp>checkButton::setStyle/2</vp> or <vp>radioButton::setAuto/1</vp> predicates
<vip>IsAuto = true,
checkButtonName:setStyle(IsAuto, _Is3State),</vip>
:to set this flag programmatically.
:The default value is '''True''' (auto).
*'''3State'''
*:Possible values are '''True''' and '''False'''. They define whether this check box can have 3 states (''unchecked, checked, undetermined''). You can use the <vp>checkButton::getStyle/2</vp> predicate to get whether this state is set to a control
<vip>checkButtonName:getStyle(_IsAuto, Is3State),
Is3State = true,</vip>
:and the <vp>checkButton::setStyle/2</vp> predicate
<vip>Is3State = true,
checkButtonName:setStyle(_IsAuto, Is3State),</vip>
:to set this state programmatically.
:A 3-states check box is the same as an ordinary check box, except that the box can be grayed (dimmed) as well as checked. The grayed state is used to show that the state of the check box is not determined.
:The default value is '''False''' (3State).
*'''LeftText'''
*:Possible values are '''True''' and '''False'''. They define whether the control title text should be positioned on the left or on the right of the control (check box or radio button).
*:You can use the <vp>checkButton::getLeftText/0-></vp> or <vp>radioButton::getLeftText/0-></vp> predicates to get whether the control has this flag
<vip>IsLeftText = checkButtonName:getLeftText(),
IsLeftText = true,</vip>
:and the <vp>checkButton:setLeftText/1</vp> or <vp>radioButton:setLeftText/1</vp> predicates
<vip>IsLeftText = true,
checkButtonName:setLeftText(IsLeftText),</vip>
:to set this flag programmatically.
:The default value is '''False''' (caption is on the right side).
*'''AlignBaseline'''
*:Possible values are '''True''' and '''False'''. They define whether the control caption text should be positioned on the same horizontal line with caption texts of all other controls, which have the same vertical position with this control.
*:This property is defined to all controls, which can have captions (static texts, check boxes, edit and list edit controls, etc.)
*:You can use the <vp>getAlignBaseline</vp> predicates (like <vp>editControl::getAlignBaseline/0-></vp>) to get whether the control has this flag
<vip>IsAllignBaseLine = checkButtonName:getAllignBaseLine(),
IsAllignBaseLine = true,</vip>
:and the <vp>setAlignBaseline</vp> (like <vp>textControl::setAlignBaseline/1</vp>) predicates
<vip>IsAllignBaseLine = true,
checkButtonName:setAllignBaseLine(IsAllignBaseLine),</vip>
:to set this flag programmatically.
:The default value is '''True''' (align captions horizontally).
*'''Style'''
*:'''Push buttons'''
*:For push buttons possible values are '''Cancel''', '''OK''' and '''Regular'''.
*:'''Cancel'''
*::Push buttons with the '''Cancel''' style are created by the <vp>button::newCancel/1</vp> constructor.
*::When a dialog/form contains a push button with the '''Cancel''' style, then this dialog/form will provide standard handling of the Esc key - the dialog/form is simply closed without any additional actions.
*:'''OK'''
*::Push buttons with the '''OK''' style are created by the <vp>button::newOk/1</vp> constructor.
*::When a dialog/form contains a push button with the '''Ok''' style, then this dialog/form will execute dialog/form validation check when this button is clicked. See "'''Dialog/Form Validation'''" tutorial (on WEB) for more information.
*:'''Regular'''
*::Push buttons with the '''Regular''' style are created by the ordinary <vp>button::new/1</vp> constructor.
*::Such buttons do not initiate any special default handling.
*:'''Group boxes'''
*:For group boxes possible values are '''Group Box''', '''Simple Border''', '''Horizontal Separator''', '''No Border'''. These values define the border type of the group box control.
*:The default is '''Simple Border'''.
*:You can use the <vp>groupBox::getBorderStyle/0-></vp> predicate to get the border style
<vip>GroupBoxBorderStyle = controlName : getBorderStyle(),</vip>
:and the <vp>groupBox::setBorderStyle/1</vp> predicate
<vip>GroupBoxBorderStyle = groupBox(),
controlName : setBorderStyle(GroupBoxBorderStyle),</vip>
:to set the border style programmatically.
*'''Alignment'''
*:Possible values are '''Left''', '''Center''' and '''Right'''. Radio buttons in this group box determine how the text in the control is aligned.
*:The default value is '''Left''' (align left).
*:*'''Left'''
*::Defines that the text in the control will be aligned left.
*::You can use the <vp>textControl::getAlignment/0-></vp> predicate to get which of these flags the control has
<vip>AlignmentType = textControlName : getAlignment(),
AlignmentType = alignLeft(),</vip>
:::and the <vp>textControl::setAlignment/1</vp> predicate
<vip>AlignmentType = alignLeft(),
textControlName : setAlignment(AlignmentType),</vip>
:::to set this flag programmatically.
::*'''Center'''
:::Defines that the text in the control will be centered.
:::The <vp>AlignmentType = alignCenter()</vp>.
::*'''Right'''
:::Defines that the text in the control will be aligned right.
:::The <vp>AlignmentType = alignRight()</vp>.
*'''Wrap'''
*:Possible values are '''True''' and '''False'''. They define whether the text in the control will be wrapped to several lines.
*:The default value is '''True''' (wrap).
*:You can use the <vp>textControl::getWrap/0-></vp> predicate to get whether the control has this flag
<vip>IsNoWrap = textControlName : getWrap(),
IsNoWrap = true,</vip>
::and the <vp>textControl::setWrap/1</vp> predicate
<vip>IsNoWrap = false,
textControlName: setWrap(IsNoWrap),</vip>
::to set this flag programmatically.
*'''IgnorePrefix'''
*:Possible values are '''True''' and '''False'''. Setting '''True''' value prevents interpretation of any <vp>&</vp> characters in the caption of the static text control as access keys (accelerator prefix characters). Accelerator characters are displayed underlined and the prefix <vp>&</vp> character is deleted.
*:The default value is '''False'''.
*:Notice that static text controls cannot be activated. Therefore, when an access key of a static text control is pressed, then the control next to this static text control, in the tab-stop order of controls in the dialog, is activated.
*:Most often this flag is used when filenames, which can contain the <vp>&</vp> character, need to be displayed in static text controls.
*:You can use the <vp>textControl::getIgnorePrefix/0-></vp> predicate to get whether the control has this flag
<vip>IsIgnorePrefix = controlName : getIgnorePrefix(),
IsIgnorePrefix = true,</vip>
::and the <vp>textControl::setIgnorePrefix/1</vp> predicate
<vip>IsIgnorePrefix = true,
controlName : setIgnorePrefix(IsIgnorePrefix),</vip>
::to set this flag programmatically.
*'''MultiLine'''
*:Possible values are '''True''' and '''False'''. When this property is '''True''', then the edit control allows multiple lines.
*:The default value is '''True''' (allows multiple lines).
*:Notice that the '''VScroll''', '''HScroll''', '''AutoVScroll''', and '''WantReturn''' properties do not work for single-line ('''False''') edit controls.
*:You can use the <vp>editControl::getMultiLine/0-></vp> predicate to get whether the control has this flag
<vip>IsMultiLine = controlName : getMultiLine(),
IsMultiLine = true,</vip>
::and the <vp>editControl::setMultiLine/1</vp> predicate
<vip>IsMultiLine = true,
controlName : setMultiLine(IsMultiLine),</vip>
::to set this flag programmatically.
*'''WantReturn'''

Possible values are '''True''' and '''False'''.

If it is '''True''', then a carriage return will be inserted as the part of an edited string, when the user presses the '''Enter''' key while entering text into a multi-line edit control.

If it is '''False''', then pressing the '''Enter''' key has the same effect as pressing the ''default'' ('''OK''') push button, which has the latest specified '''Default = True''' property value.

This property has no effect on single-line edit controls.

The default value is '''False'''.

You can use the editControl::getWantReturn/0-> predicate to get whether the control has this flag

IsWantReturn = controlName : getWantReturn (), IsWantReturn <nowiki>= true,</nowiki>

and the editControl::setWantReturn/1 predicate

IsWantReturn <nowiki>= true, controlName : setWantReturn (</nowiki>IsWantReturn),

to set this flag programmatically.

VScroll

Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' control gets a vertical scroll bar when it needs one.

The default value for edit controls is '''True''' for other types of controls is '''False'''.

This property has no effect on single-line edit controls.

You can use the editControl::getVScroll/0-> and listControl::getVScroll/0-> predicates to get whether the control has this flag

IsVScrollSet = controlName : getVScroll (), IsVScrollSet = true,

and the editControl::setVScroll/1 and listControl::setVScroll/0 predicates

IsVScrollSet = true, controlName : setVScroll (IsVScrollSet),

to set this flag programmatically.

AutoVScroll

Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit control automatically scrolls text up when the user presses the '''Enter''' on the last line.

The default value is '''False''' (does not scroll).

This property has no effect on single-line edit controls.

You can use the editControl::getAutoVScroll/0-> predicate to get whether the control has this flag

IsAutoVScrollSet = controlName : getAutoVScroll (), IsAutoVScrollSet = true,

and the editControl::setAutoVScroll/1 predicate

IsAutoVScrollSet = true, controlName : setAutoVScroll (IsAutoVScrollSet),

to set this flag programmatically.

HScroll

Possible values are '''True''' and '''False'''. They define whether the ''multi-line'' edit or list box control gets a horizontal scroll bar when it needs one.

The default value is '''False''' (does not scroll).

This property has no effect on single-line ''edit'' controls.

You can use the editControl::getHScroll/0-> or listBox::getHScroll/0-> predicates to get whether the control has this flag

IsHScrollSet = controlName : getHScroll (), IsHScrollSet = true,

and the editControl::setHScroll/1 or listBox::setHScroll/1 predicates

IsHScrollSet = true, controlName : setHScroll (IsHScrollSet),

to set this flag programmatically.

AutoHScroll

Possible values are '''True''' and '''False'''. They define whether the control automatically scrolls text in the control in order to display a typed character, when the user types the character at the end of the line.

If it is '''False''', then only text that fits within the rectangular boundary is allowed. When the user presses the '''Enter''' key, the control scrolls all text back to the zero position.

The default value is '''True''' (scrolls text automatically).

You can use the editControl::getAutoHScroll/0-> predicate to get whether the control has this flag

IsAutoHScrollSet = controlName : getAutoHScroll (), IsAutoHScrollSet = true,

and the editControl::setAutoHScroll/1 predicate

IsAutoHScrollSet = true, controlName : setAutoHScroll (IsAutoHScrollSet),

to set this flag programmatically.

Border

Possible values are '''True''' and '''False'''. They define whether the control is created initially with a border around the control.

The default value is '''False'''.

You can use the editControl::getBorder/0-> or listBox::getBorder/0-> predicates to get whether the control has this flag

BorderIsSet = controlName : getBorder (), BorderIsSet <nowiki>= true,</nowiki>

and the editControl::setBorder/1 or listBox::setBorder/1 predicates

BorderIsSet <nowiki>= true, controlName : setBorder (</nowiki>BorderIsSet),

to set this flag programmatically.

Password

Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control displays all typed-in characters as asterisks (*).

The default value is '''False''' (displays typed characters "as-is").

You can use the editControl::getPassword/0-> predicate to get whether the control has this flag

IsPassword = controlName : getPassword (), IsPassword <nowiki>= true,</nowiki>

and the editControl::setPassword/1 predicate

IsPassword <nowiki>= true, controlName : setPassword (</nowiki>IsPassword),

to set this flag programmatically.

HideSel

Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control hides selection, when it loses the input focus, and shows selection, when it receives the input focus.

The default value is '''True''' (hides selection).

You can use the editControl::getHideSel/0-> predicate to get whether the control has this flag

IsHideSel = controlName : getHideSel (), IsHideSel <nowiki>= true,</nowiki>

and the editControl::setHideSel/1 predicate

IsHideSel <nowiki>= true, controlName : setHideSel (</nowiki>IsHideSel),

to set this flag programmatically.

ReadOnly

Possible values are '''True''' and '''False'''. If it is '''True''', then the edit control is in the read-only mode.

The default value is '''False''' (editable).

You can use the editControl::getReadOnly/0-> predicate to get whether the control has this flag

IsReadOnly = controlName : getReadOnly (), IsReadOnly <nowiki>= true,</nowiki>

and the editControl::setReadOnly/1 predicate

IsReadOnly <nowiki>= true, controlName : setReadOnly (</nowiki>IsReadOnly),

to set this flag programmatically.

Case

Possible values are '''Insensitive''', '''Upper''', '''Lower'''.

The default value is '''Insensitive'''.

Insensitive

Defines that the edit control leaves the typed-in text "as-is".

This is the default value.

Upper

Defines that the edit control converts all typed-in characters into the upper case.

You can use the editControl::getUpperCase/0-> predicate to get whether the control has this flag

IsUpperCase = controlName : getUpperCase (), IsUpperCase <nowiki>= true,</nowiki>

and the editControl::setUpperCase/1 predicate

IsUpperCase <nowiki>= true</nowiki>, controlName : setUpperCase (IsUpperCase),

to set this flag programmatically.

Lower

Defines that the edit control converts all typed-in characters into the lower case.

You can use the editControl::getLowerCase/0-> predicate to get whether the control has this flag

IsLowerCase = controlName : getLowerCase (), IsLowerCase <nowiki>= true,</nowiki>

and the editControl::setLowerCase/1 predicate

IsLowerCase <nowiki>= true</nowiki>, controlName : setLowerCase (IsLowerCase),

to set this flag programmatically.

Sort

Possible values are '''True''' and '''False'''. If it is '''True''', then the list control sorts strings alphabetically.

The default value is '''True''' (sort).

You can use the listControl::getSort/0-> predicate to get whether the control has this flag

IsSort = controlName : getSort (), IsSort <nowiki>= true,</nowiki>

and the listControl::setSort/1 predicate

IsSort = true, controlName : setSort (IsSort),

to set this flag programmatically.

ExtendedSel

Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items by using the '''Shift''' key and the mouse or using the '''Shift''' key and the '''Up''' or '''Down Arrow''' keys.

The default value is '''False''' (cannot select multiple items).

You can use the listBox::getExtendedSel/0-> predicate to get whether the control has this flag

IsExtendedSel = controlName : getExtendedSel (), IsExtendedSel = true,

and the listBox::setExtendedSel/1 predicate

IsExtendedSel = true, controlName : setExtendedSel (IsExtendedSel),

to set this flag programmatically.

MultiSelect

Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control allows selection of multiple items using the mouse.

The default value is '''False''' (cannot select multiple items).

You can use the listBox::getMultiSelect/0-> predicate to get whether the control has this flag

IsMultiSelect = controlName : getMultiSelect (), IsMultiSelect = true,

and the listBox::setMultiSelect/1 predicate

IsMultiSelect = true, controlName : setMultiSelect (IsMultiSelect),

to set this flag programmatically.

AutoNotify

Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control notifies the parent window with an input message whenever the user clicks or double-clicks in the list box.

The default value is '''True '''(notify).

You can use the listBox::getAutoNotify/0-> predicate to get whether the control has this flag

IsAutoNotify = controlName : getAutoNotify (), IsAutoNotify = true,

and the listBox::setAutoNotify/1 predicate

IsAutoNotify = true, controlName : setAutoNotify (IsAutoNotify),

to set this flag programmatically.

UseTabStops

Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control recognizes and expands TAB characters when drawing strings.

The default value is '''False''' (does not expand).

You can use the control::getUseTabStops/0-> predicate to get whether the control has this flag

IsUseTabStops = controlName : getUseTabStops (), IsUseTabStops = true,

and the control::setUseTabStops/1 predicate

IsUseTabStops = true, controlName : setUseTabStops (IsUseTabStops),

to set this flag programmatically.

StaticScrollbar

Possible values are '''True''' and '''False'''. If it is '''True''', then the list control shows a disabled vertical scroll bar for the list box when the box does not contain enough items to scroll. If it is '''False''', then the scroll bar is hidden when the list box does not contain enough items.

The default value is '''True '''(shows vertical scroll bar).

You can use the listControl::getStaticScrollbar/0-> predicate to get whether the control has this flag

IsStaticScrollbar = controlName : getStaticScrollbar (), IsStaticScrollbar = true,

and the listControl::setStaticScrollbar/1 predicate

IsStaticScrollbar = true, controlName : setStaticScrollbar (IsStaticScrollbar),

to set this flag programmatically.

AllowPartialRows

Possible values are '''True''' and '''False'''. If it is '''True''', then the size of the list box is exactly the size specified by the application when it creates the list box. Normally, Windows re-sizes list boxes so that a list box does not display partial items.

The default value is '''True''' for list box controls and '''False''' for list button and list edit controls.

You can use the listControl::getAllowPartialRows/0-> predicate to get whether the control has this flag

IsAllowPartialRows = controlName : getAllowPartialRows (), IsAllowPartialRows <nowiki>= true,</nowiki>

and the listControl::setAllowPartialRows/1 predicate

IsAllowPartialRows = true, controlName : setAllowPartialRows (IsAllowPartialRows),

to set this flag programmatically.

MultiColumn

Possible values are '''True''' and '''False'''. If it is '''True''', then the list box control can have multiple columns.

The default value is '''False'''.

You can use the listBox::getMultiColumn/0-> predicate to get whether the control has this flag

IsMultiColumn = controlName : getMultiColumn (), IsMultiColumn = true,

and the listBox::setMultiColumn/1 predicate

IsMultiColumn = true, controlName : setMultiColumn (IsMultiColumn),

to set this flag programmatically.

Rows

Possible values are positive numbers. For list button and list edit controls it specifies the maximal number of rows, which can be displayed in the opened list box sub-control.

The default value is '''3'''.

You can use the listControl::getMaxDropDownRows/0-> predicate to get this number

MaxDropDownRowNumber = controlName : getMaxDropDownRows (),

and the listControl::setMaxDropDownRows/1 predicate

MaxDropDownRowNumber = 5, controlName : setMaxDropDownRows (MaxDropDownRowNumber),

to set this number programmatically.

Icon Name

The icon name must be selected from the list of icon names registered in the Project (by clicking the [[Image:ListButton_button.png]] button). In order to an icon name appears in the list of registered icon names, you should add the icon file (IconName.ICO) into the project files. To do this you should use the '''File | Add''' command (the '''Resource Files''' should be selected in the '''Files of Type''').

Class

Specify a name of a Windows class for the custom control (your application code must register the custom control by this name).

Ide/Resource Editor/Editing a Dialog

2013-04-24T08:53:04Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>

To edit a dialog, in the project tree (in the Project window) double click (or press '''Enter''') the name of a file with a dialog description (the '''.dlg''' filename extension). The
{{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} appears and you can edit whatever form of a dialog you wish.

[[Image:Ide_MyDialog_Editor.png|center]]

The IDE Designer After Creation of a New Dialog

When a new dialog is created, it will by default have three push button controls: '''OK''', '''Cancel''' and '''Help'''. These can freely be rearranged or deleted.

==== Controls ====

Each control in a dialog must have an identifying name (constant in VPI style dialogs), which is unique within that dialog. While two controls within one dialog may not have the same name (or constant value), it is actually a good idea if controls in different dialogs, which perform the same action have the same names (or constants).

===== Types of Controls =====

{|{{prettytable}}
|-
| [[Image:Ide_PushButton.png]]
| A '''Push Button''' control serves to initiate a specialized action in an application.
|-
| [[Image:Ide_CheckBox.png]]
| A '''Check Box''' control lets you indicate a choice among two alternatives. For example some facility may be switched ON or switched OFF.
|-
| [[Image:Ide_RadioButton.png]]
| A group of '''Radio Button''' controls serves to indicate one choice from among a list of alternatives.
|-
| [[Image:Ide_StaticText.png]]
| A '''Static Text''' control reserves an area for the text in the dialog. Although called static, in fact the application can change the text during execution. This is often used for prompts or field names relating to other controls.
|-
| [[Image:Ide_EditControl.png]]
| An '''Edit Control''' reserves an area for text editing (e.g. names, numbers, text constants etc.). Editing text strings with multiple lines is possible.
|-
| [[Image:Ide_ListBox.png]]
| A '''List Box''' allows you to view a list of elements and to select one - or several - elements from this list.
|-
| [[Image:Ide_ListButton.png]]
| A '''List Button''' control serves for choosing one from the pop-out set of the alternatives revealed by pressing the button. Pressing the button again pops the list back in again.
|-
| [[Image:Ide_ListEdit.png]]
| A '''List Edit''' control allows single line text editing like an '''Edit''' control, or selection from a list of elements.
|-
| [[Image:Ide_VerticalScrollBar.png]] [[Image:Ide_HorizontalScrollBar.png]]
| The '''Vertical Scroll Bar''' and the '''Horizontal Scroll Bar''' controls serve to select a value within a scale of values.
|-
| [[Image:Ide_GroupBox.png]]
| A '''Group Box''' control serves for assembling together a number of controls in a functional group with a Group Name. Its only function is a visual one.
|-
| [[Image:Ide_Icon.png]]
| An '''Icon''' control reserves an area for an icon image.
|-
| [[Image:Ide_CustomControl.png]]
| A '''Custom Control''' can be either IDE Controls created in the project, it can be VPI user-defined control with a window class defined by <vp>vpi::classCreate</vp>, or it can be controls imported as {{ide|Creating new Project Items#Creating a COM Package|COM packages}} from DLLs, VBXs or OCXs.
|}

===== Inserting Controls =====

To insert a new control in a dialog, click the icon of the desired control type in the '''Controls toolbar'''. (You can also select the desired control type in the '''Controls''' sub-menu of the main IDE menu or in the pop-up menu in the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}}.)

===== Controls Toolbar =====

Originally the '''Controls toolbar''' is displayed below the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} window. You see it in the following picture:

[[Image:Ide_Controls.png|center|frame|'''The Controls Toolbar''']]

Clicking icons in the '''Controls toolbar''' you select a type of a control to be placed into the edited dialog/window/form/IDE control (sometimes we will use the term ''container'' instead of dialog/window/form/IDE control). When you click a control type icon, then the current cursor is replaced with the cursor correspondent to the control type to be inserted. Move the cursor to some position in the container client area and click the mouse button. The control with the default size will be inserted at the specified position.

Instead of dropping a control into a container with a click, it is possible to drag out the rectangle (in the container client area) where a control should be placed; so you can specify not only the control position but also the control size.

After a VPI control is placed with the mouse into a {{ide|Resource_Editor#GUI and VPI Style Resources|VPI style container}}, the correspondent VPI control Attributes dialog appears. In this dialog you can change some control attributes, when you close the dialog, the control appears at the specified location in the container.

After a GUI control is placed with the mouse into a {{ide|Resource_Editor#GUI and VPI Style Resources|GUI style container}}, it immediately appears at the specified location in the container. To change properties of the GUI control, one should select it then the list of GUI control properties appears in the {{ide|Resource Editor#GUI Control Properties Table|GUI control Properties table}}.

There are the following icons in the '''Controls toolbar:'''

{|{{prettytable}}
|-
! Icon
! Insert a new:
! Description
|-
| [[Image:Ide_Ctrl_PushBtn.png]]
| Push Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_PushBtn.png]]
|-
| [[Image:Ide_Ctrl_CheckBx.png]]
| Check Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Check.png]].
|-
| [[Image:Ide_Ctrl_RadioBtn.png]]
| Radio Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_RB.png]].
|-
| [[Image:Ide_Ctrl_StaText.png]]
| Static Text Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Text.png]].
|-
| [[Image:Ide_Ctrl_EditCtrl.png]]
| Edit Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Edit.png]].
|-
| [[Image:Ide_Ctrl_ListBox.png]]
| List Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListBox.png]].
|-
| [[Image:Ide_Ctrl_ListBtn.png]]
| List Button
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListBtn.png]].
|-
| [[Image:Ide_Ctrl_ListEdit.png]]
| List Edit
| After selection of this control the cursor becomes [[Image:Ide_Cursor_ListEdit.png]].
|-
| [[Image:Ide_Ctrl_HScroll.png]]
| Horizontal Scroll Bar
| After selection of this control the cursor becomes [[Image:Ide_Cursor_HScroll.png]].
|-
| [[Image:Ide_Ctrl_VScroll.png]]
| Vertical Scroll Bar
| After selection of this control the cursor becomes [[Image:Ide_Cursor_VScroll.png]].
|-
| [[Image:Ide_Ctrl_GroupBox.png]]
| Group Box
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Group.png]].
|-
| [[Image:Ide_Ctrl_Icon.png]]
| Icon Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Icon.png]].
|-
| [[Image:Ide_Ctrl_Custom.png]]
| Custom Control
| After selection of this control the cursor becomes [[Image:Ide_Cursor_Custom.png]].
|}

===== Selecting and Deselecting Controls =====

Click inside a control to select one control. A frame appears around the selected control.

To select a group of controls move the mouse pointer to the point in the dialog you want to be one corner of the selected area and press and hold the left mouse button. While holding the left mouse button move the mouse until all the desired controls in the dialog are inside the selected area. Then release the mouse button. All controls inside the specified rectangle will be selected.

Also after one or more controls are already selected, you can include one extra control in the selection by holding down the '''Ctrl''' key and click the control.

To deselect the control or group of controls click outside the selecting frame. Deselected controls lose their frame.

===== Resizing Controls =====

Once a control has been inserted in the dialog, it has a default size. To re-size a control, first click inside the control area to select it. Then move the cursor to the sizing handles on the selection frame. A new shape of cursor indicates the direction in which you can re-size the control. Press and hold the mouse button, drag until the selected control has the size you want, then release the mouse button.

You can also change the size of a control by double-clicking it to activate the dialog for control attributes setting. Select the position you want to change and after specifying a new position or size, press enter to return to the dialog.

'''Remark:''' You cannot change the size of icons. You can only change their location.

===== Moving Controls =====

To move a control or a group of controls first select them. Then move the cursor inside the selection frame, press and hold the mouse button, drag the mouse pointer to a new location and release the mouse. Also, when one or more controls are selected, it is possible to use the cursor keys to move the selection in small steps (corresponding to the '''Grid''' settings).

===== Arranging Controls =====

To arrange a group of controls first select the group. Then click an appropriate button in the '''Layout''' toolbar or a menu item in the '''Layout''' menu of the IDE menu (or in the pop-up menu).

[[Image:Ide_Layout.png|center|frame|'''The Layout Toolbar''']]

The '''Layout''' commands for justifying and resizing controls:

{|{{prettytable}}
|-
| [[Image:Ide_Layout_AllignLeft.png]]
| '''Align Left'''
| Align the selected controls along their left sides.
|-
| [[Image:Ide_Layout_CenterVertically.png]]
| '''Align Center'''
| Center the selected controls vertically.
|-
| [[Image:Ide_Layout_AllignRight.png]]
| '''Align Right'''
| Align the selected controls along their right sides.
|-
| [[Image:Ide_Layout_AllignTops.png]]
| '''Align Top'''
| Align the selected controls along their tops.
|-
| [[Image:Ide_Layout_CenterHorizontally.png]]
| '''Align Middle'''
| Center the selected controls horizontally.
|-
| [[Image:Ide_Layout_AllignBottom.png]]
| '''Align Bottom'''
| Align the selected controls along their bottoms.
|-
| [[Image:Ide_Layout_SpacingHorizontally.png]]
| '''Even Horizontal Spacing'''
| Spacing the selected controls evenly between the leftmost and the rightmost controls.
|-
| [[Image:Ide_GridButton.png]]
| '''Grid'''
| Toggle the Grid (see below).
|-
| [[Image:Ide_Layout_SpacingVertically.png]]
| '''Even Vertical Spacing'''
| Spacing the selected controls evenly between the topmost and the bottom-most controls.
|-
| [[Image:Ide_Layout_SameSize.png]]
| '''Make Same Size'''
| Make the selected controls the same size as a model control.
|-
| [[Image:Ide_Layout_SameHorizontal.png]]
| '''Make Same Horizontal Size'''
| Make the selected controls the same width as a model control.
|-
| [[Image:Ide_Layout_SameVertical.png]]
| '''Make Same Vertical Size'''
| Make the selected controls the same height as a model control.
|-
|
| '''Size To Contents'''
| Resize the selected controls to optimally display its titles (caption texts).
|}

==== Editing Properties of GUI Controls ====

When you open a GUI dialog or a Form (GUI window) in the '''IDE Designer''', then near from the opened dialog (form) the {{ide|Resource Editor#GUI Control Properties Table|'''Control Properties table'''}} appears.

To change ''properties'' of a GUI package control first select this control (by clicking in it) in the dialog (form). The current set of the control properties appears in the '''Control Properties''' table. Now you can edit the displayed GUI control properties.

'''Click here to view {{ide|Resource Editor#GUI Control Properties Table|GUI Control Properties table}}'''

The displayed set of properties depends on the control type. The {{ide|Resource Editor#GUI Control Properties Table|'''Control Properties table'''}} contains two types of properties. General properties are common to all types of controls and some properties, which are individual to different kinds of controls.

Initially this '''Control Properties''' table is empty. However, as soon as one of controls in the edited dialog (form) is selected this table starts to display properties of the selected control.

If the '''Control Properties''' table is closed, then double-click a control - the '''Control Properties''' table appears. Also the '''Control Attributes''' command, from the '''IDE Designer''' {{ide|Resource Editor#Speed Menu|speed menu}}, can be used to open the '''Control Properties''' table.

{{:ide/Resource Editor/GUI Control Properties Table}}

==== Editing Attributes of VPI Controls ====

To change attributes of a VPI package control double-click it or select the control and activates the '''Control Attributes''' command from the '''IDE Designer''' {{ide|Resource Editor#Speed Menu|speed menu}}. Then the '''''<ControlType>'' Attributes''' dialog appears.

These dialogs contains two levels of attributes. The general group contains attributes, which are common to all types of controls: the '''Text''' determines the control title, the '''Constant''' (name) is used as the control identifier, and the '''Control Size''' group determines position and size of the control.

Notice that the '''Text''' property/attribute is not used for some controls, for instance, it is not used for scroll bars.

Notice that in the '''Text''' fields the ampersand symbol <vp>&</vp> is reserved for indicating that the next to it character is to be underlined. For example, if you use the text string '''E&xit''' as a control name, then this control will be displayed with the title '''Exit''' at runtime. I.e. the char '''x''' will be displayed underlined (thus visually indicating that the '''x''' is an accelerator key). If you need to display the ampersand <vp>&</vp> symbol in the '''Text''' of a control, then use two of them <vp>&&</vp>.

Other attributes are individual to different kinds of controls.

===== Attributes of VPI Controls =====

[Properties_of_VPI_Controls\Push_Button_Flags.htm Push Button Attributes]

[Properties_of_VPI_Controls\Check_Box_Flags.htm Check Box Attributes]

[Properties_of_VPI_Controls\Custom_Control_Attributes.htm Custom Control Attributes]

[Properties_of_VPI_Controls\Radio_Button_Flags.htm Radio Button Attributes]

[Properties_of_VPI_Controls\Static_Text_Flags.htm Static Text Attributes]

[Properties_of_VPI_Controls\Edit_Control_Flags.htm Edit Control Attributes]

[Properties_of_VPI_Controls\List_Box_Attributes.htm List Box Attributes]

[Properties_of_VPI_Controls\List_Button_Attributes.htm List Button Attributes]

[Properties_of_VPI_Controls\List_Edit_Attributes.htm List Edit Attributes]

[Properties_of_VPI_Controls\Scroll_Bar_Attributes.htm Scroll Bar Attributes]

[Properties_of_VPI_Controls\Group_Box_Attributes.htm Group Box Attributes]

[Properties_of_VPI_Controls\Icon_Control_Attributes.htm Icon Attributes]

==== Using Anchors for Positioning GUI Controls while Dialog Resizing ====

VPI controls remember in their attributes ({{ide|Resource Editor#Attributes of VPI Controls|Attributes of VPI Controls}}) only their absolute positions and sizes. Therefore, when a VPI dialog or a VPI window containing such VPI controls are resized, these VPI controls do not change their positions and sizes!

In difference to them GUI controls have additional ''Anchor'' properties, which help to reposition (and may be resize) GUI controls when containing them GUI dialog (or form) is resized.

Each GUI control has four anchor properties: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', and '''Bottom Anchor''' (see '''[Properties_of_GUI_Controls\Properties_of_GUI_Controls.htm#Anchors Anchor Properties of GUI Controls]''').

Each anchor determines that the specified ('''Left''', '''Top''', '''Right''' or '''Bottom''') control boundary should be '''always''' positioned on the stated distance from the nearest (correspondent) border of the dialog (frame).

Each of anchors can have the '''True''' or '''False''' values. When the anchor value is '''True''', then this anchor is active (used to position the correspondent control).

For example, when the '''Left Anchor''' is active (has the '''True''' value), then the ''left'' control boundary should be positioned on the stated distance from the nearest (''left'') border of the dialog (frame).

The simplest way to see which anchors are active for a control, is to select this control. Then some red arrows between control boundaries and correspondent boundaries of the dialog can bee seen. Each arrow specifies, that the correspondent anchor is active. For example, the arrow from the control top to the dialog top identifies, that the '''Top Anchor''' is active. In the picture below, you see three arrows, which specify that the '''Left''', '''Top''', and '''Right''' anchors are active to the '''Push Button''' control.

[[Image:Ide_de_Anchors.png|center]]

Numbers near such arrows show distances (in Dialog Base Units) between the correspondent boundaries of the control and the dialog.

Normally each control has one active horizontal and one active vertical anchors. When the dialog is resized, then such control is always positioned on the specified distances from the specified boundaries of the dialog. The size of the control is not changed!

When a control has both horizontal (or/and both vertical) anchors active, then both horizontal (or/and both vertical) boundaries of the control should be placed on some specified distances from the correspondent horizontal (vertical) boundaries of the dialog. Therefore, when the dialog is resized, then such control is also resized accordingly to keep the specified distances.

When no one of horizontal (or vertical) anchors of a control are active, then no one of horizontal (or vertical) boundaries of the control are bounded to the correspondent horizontal (vertical) boundaries of the dialog. Coordinates of such controls are handles on the "proportional basis". For example, when the dialog width is increased onto <vp>Delta</vp> dialog base units, then the <vp>X</vp> coordinate of the control is also increased, but it is increased two times smaller. That is the <vp>X</vp> coordinate of the control is increased only onto <vp>Delta/2</vp> dialog base units.

==== Cut, Copy and Paste, Undo and Redo ====

You can '''Cut''' or '''Copy''' a group of selected controls onto the Windows clipboard, and '''Paste''' controls from the clipboard back into a dialog. The '''Undo''' and '''Redo''' commands serve to delete or restore the last editing operations of your dialog.

==== Grid ====

When the menu (or the pop-up menu) entry '''Resource | Grid''' is activated, or when the [[Image:Ide_GridButton.png]] button from the '''Layout''' toolbar is pressed, the following dialog appears:

[[Image:Ide_GridSpecification.png|center|frame|'''The Dialog to Specify the Grid Properties''']]

With a grid in place, arranging the controls inside a dialog is easier. Also it is possible to tell the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} by the '''Snap to Grid''' that it should place controls at the grid intersections to give a satisfactory result.

[[Image:Ide_MyDialog_withGrid.png|center|frame|'''Using a grid in the Dialog/Window/Form Editor''']]

==== Test Mode ====

The {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} has the '''Test Mode''', so it is possible to see how the dialog with the created controls behaves. To illustrate the '''Test Mode''' we will assign some default values to the controls. The test mode is activated and deactivated from the '''Resource''' menu (or from the pop-up menu).

[[Image:Ide_MyDialog_TestMode.png|center|frame|'''Test Mode for a Dialog''']]

==== Tab Stops ====

When activating the menu (or the pop-up menu) entry '''Resource | Tabstops''', it is possible to specify to which controls you can Tab to in the dialog. When this command is activated a small button with the <vp>+</vp> or <vp>-</vp> appears on controls depending upon whether the control has a tab stop or not. By clicking the small buttons, it is possible to toggle the setting.

[[Image:Ide_MyDialog_TabStops.png|center|frame|'''Specifying Tab Stops for a Dialog''']]

To exit the tab stop mode, just click in the dialog but outside of any controls.

==== Visit Order ====

When the tab stops have been specified for a dialog, then it is possible to specify the order in which controls will receive focus when tabbing.

[[Image:Ide_MyDialog_VisitOrder.png|center|frame|'''Displaying the Visit Order''']]

To change the visit order, click a small rectangle displaying the visit order number for a control that has an incorrect sequence number and this will bring up another dialog to change this sequence:

[[Image:Ide_MyDialog_ChangeVisitOrder.png|center|frame|'''Changing the Visit Order''']]

To stop the visit order mode, just click in the dialog outside any controls.

==== Speed Menu ====

When you are in the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} you can click the right mouse button to activate the Speed Menu. From this menu you can easily call any {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} command:

[[Image:Ide_We_SpeedMenu.png|center|frame|'''The IDE Designer Speed Menu''']]

Ide/Project Tree

2013-04-23T09:51:18Z

GalinaTchekmareva:

{{ideNavbar|Project Window and Project Tree}}

=== The Project Tree ===

The '''Project''' window is opened when you load a project into the IDE or create a new project.

The '''Project''' window provides the main view onto the loaded project. The '''Project''' window consists of two panes:

* The '''Project Tree''' pane. It is the '''left''' pane. It displays the ''Project tree''. In the ''Project tree'' you can see all modules included into the project.
* The '''Browse Information''' pane. It is the '''right''' pane. It displays the Browse information from the file selected in the '''Project Tree''' pane. These are: names of interfaces, classes, predicates, and other Visual Prolog names declared/defined in this file.

In the ''Project tree'' you can see files that are registered in the project: object libraries (and type libraries), DLLs (Dynamically Linked Libraries), object files, resource description (descriptions of menus, dialogs, windows, forms, toolbars) and resource files (bitmaps, icons, cursors), the manifest file and Visual Prolog packages (<vp>*.pack</vp>).

[[Image:Ide_PT_NotCompiled.png|center|frame|'''The ''Project tree'' for a new not compiled GUI style project''']]

After a package is compiled, the Project tree starts to show some additional information about the package files. You can see the package headers (<vp>*.ph</vp>) and Visual Prolog source files (interfaces - <vp>*.i</vp>, classes - <vp>*.cl</vp>, class implementations - <vp>*.pro</vp>).

And the '''Browse Information''' pane starts to display for each file:

* Interfaces and classes that are declared in the file.
* Classes that are implemented in the file.
* Constructors, class predicates, object predicates, and local predicates that are declared and implemented in the file. Declarations and implementations are displayed with their arities.
* Class and object facts that are defined in the file.
* Domains and constants that are defined in the file.
* Properties that are defined in the file. They are displayed with their flow patterns.

[[Image:Ide_PT_Compiled.png|center|frame|'''The ''Project tree'' - as you see it for a compiled project''']]

=== Icons Used in the Project Window ===

The Project window uses the following icons to identify different kinds of items:

'''Icons Used in the Project Tree Pane'''

{|{{prettytable}}
|-
! Icon
! Description
|-
|colspan="2"|'''Project Directories'''
|-
| [[Image:Ide_PT_Folder.png]]
| The Visual Prolog root directory. This is the root directory of your Visual Prolog system installation.
|-
| [[Image:Ide_PT_Folder.png]]
| Project subdirectories
|-
|colspan="2"|'''Project Source Files'''
|-
| [[Image:Ide_PT_Gui.png]]
| Project file
|-
| [[Image:Ide_PT_Package.png]]
| Package file
|-
| [[Image:Ide_PT_ComPackage.png]]
| VPCom Package file
|-
| [[Image:Ide_PT_CFolder.png]]
| Project module file that is not a package or a type library. For example, object libraries <vp>*.lib</vp>
|-
| [[Image:Ide_PT_SubModule.png]]
| A project include file. Such files are included into one or more project packages (modules)
|-
| [[Image:Ide_PT_Manifest.png]]
| {{ide|Project Settings#Platform|Manifest file}}
|-
|colspan="2"|'''Project Resource Files'''
|-
| [[Image:Ide_PT_Image.png]]
| Image (bitmap, cursor or icon) file
|-
| [[Image:Ide_PT_Menu.png]]
| Menu description file
|-
| [[Image:Ide_PT_Toolbar.png]]
| Toolbar description file
|-
| [[Image:Ide_PT_Dialog.png]]
| Dialog description file
|-
| [[Image:Ide_PT_Control.png]]
| IDE custom control description file
|-
| [[Image:Ide_PT_Window.png]]
| Window description file
|}

'''Icons Used in the Browse Information Pane'''

{|{{prettytable}}
|-
! Icon
! Description
|-
|colspan="2"|'''Compilation Items'''
|-
| [[Image:Ide_PT_Interface.png]]
| Interface definition
|-
| [[Image:Ide_PT_Class.png]]
| Class declaration
|-
| [[Image:Ide_PT_Class_Impl.png]]
| Class implementation or a goal section
|-
|colspan="2"|'''Constants, Domains, Predicates and Facts'''
|-
| [[Image:Ide_PT_NetDisk.png]]
| Groups of <vp>constants</vp>, <vp>domains</vp>, <vp>predicates</vp>, <vp>facts</vp> or <vp>properties</vp>. When you check ON the '''Group Members''' in the '''Browse Information''' pop-up menu, then it groups together all constants, domains, predicates, and facts (declared or defined in a file). This icon is displayed before each such group.
|-
| [[Image:Ide_PT_Facts_section.png]]
| <vp>facts</vp> sections. This icon is displayed before each named <vp>facts</vp> section. All unnamed <vp>facts</vp> sections in one compilation item are merged into one
|-
| [[Image:Ide_PT_Constructor.png]]
| Public constructor
|-
| [[Image:Ide_PT_Constructor_local.png]]
| Private constructor
|-
| [[Image:Ide_PT_Pred_cl.png]]
| Public class predicate
|-
| [[Image:Ide_PT_Pred_loc.png]]
| Private class predicate
|-
| [[Image:Ide_PT_Pred_obj.png]]
| Public object predicate
|-
| [[Image:Ide_PT_Pred_locObj.png]]
| Private object predicate
|-
| [[Image:Ide_PT_Domains_cl.png]]
| Public domain
|-
| [[Image:Ide_PT_Domains.png]]
| Private domain
|-
| [[Image:Ide_PT_Constant_cl.png]]
| Public constant
|-
| [[Image:Ide_PT_Constant.png]]
| Private constant
|-
| [[Image:Ide_PT_Facts.png]]
| Class fact or private class property
|-
| [[Image:Ide_PT_Facts_obj.png]]
| Object fact or private object property
|-
| [[Image:Ide_PT_Property.png]]
| Public class property
|-
| [[Image:Ide_PT_Property_obj.png]]
| Public object property
|}

=== Project Tree Properties ===

Using the '''File |New''' and the '''File | Add''' commands, you should register in the '''Project Tree''' pane all source modules that you wish to be used while project compiling and linking. Notice that '''Project Settings''' automatically registers here (during creation of a new project) standard libraries, which are referenced by {{ide|Make Facility#Build Symbols|build script symbols}} (see also {{ide|Make Facility#Build Symbols|Make facility}}), and PFC packages used in the project. Notice that if you delete some of PFC packages required for the project, then the IDE restores these packages using <vp>#requires</vp> directives.

Initially (before packages are compiled) only the '''Project Tree''' pane of the '''Project window''' displays the reduced view of the Project tree, which contains only names of registered modules, libraries, and resource files. The '''Browse Information''' pane of the '''Project window''' is initially empty.

After compilation of a package, the package "browse" information generated by the compiler (for the {{ide|Code Experts#Source Browser|Source Code Browser}}) is used to display additional information about the package in both the '''Project Tree''' and '''Browse Information''' panes. The '''Project Tree''' pane starts to display names of all Prolog source files in the package (not only the package file). The '''Browse Information''' pane starts to display information about Prolog instances declared/defined in Prolog source files.

In the '''Project Tree''' pane. Double clicking (or pressing '''Enter''') the name of a Prolog source file loads this file into the text editor (activates the corresponding text editor window if the file is already edited). Double clicking (or pressing '''Enter''') the name of a resource description file opens this resource in the corresponding resource editor.

You can click (or press the right arrow) the plus [[Image:Ide_Plus_Icon.png]] icon to expand this tree node. Click the mouse button (or press the left arrow) on a minus [[Image:Ide_Minus_Icon.png]] icon to collapse the correspondent sub-tree, which is started from this node.

In the '''Browse Information''' pane. When a Prolog source file is selected in the '''Project Tree''' pane, then the '''Browse Information''' pane displays names of all declared interfaces and classes, implemented classes, supported interfaces, inherited classes, and all other Prolog instances declared/defined in a file. Usually each file contains only one interface or class declaration or only one class implementation.

Names of interfaces, classes, class implementations are prefixed with the plus [[Image:Ide_Plus_Icon.png]] or minus [[Image:Ide_Minus_Icon.png]] icons. Clicking a plus [[Image:Ide_Plus_Icon.png]] or minus [[Image:Ide_Minus_Icon.png]] icon (or pressing the right and left arrows) you expand (or collapse) the correspondent node.

Notice that the displayed view depends on the chosen '''Group Members''' mode in the pop-up menu. When it is checked ON, then the tree displays the program sections (<vp>predicates</vp>, <vp>facts</vp>, <vp>domains</vp>, <vp>constants</vp>) prefixed with the [[Image:Ide_PT_NetDisk.png]] icon, which is prefixed with the plus [[Image:Ide_Plus_Icon.png]] or minus [[Image:Ide_Minus_Icon.png]] icons.

Double-click any Prolog name (predicate, domain, constant, fact, class, etc.) loads the correspondent file into the text-editor (activates the correspondent editor window if the file is already edited) and positions the caret onto the declaration/definition of the selected name. Notice that predicate names are suffixed with the predicate arity and return value mark (->, if any).

Notice that icons prefixing class entities contain double colons, like this [[Image:Ide_PT_Facts.png]]. Icons prefixing object entities contain single colons, like this [[Image:Ide_PT_Facts_obj.png]].

Notice that icons prefixing public entities have colored background, like this [[Image:Ide_PT_Pred_obj.png]]. Icons prefixing private entities have white background, like this [[Image:Ide_PT_Pred_locObj.png]].

=== Pop-up Menus ===

Depending on the type of the node selected in the '''Project''' window, clicking the right mouse button activates context pop-up menus.

[[Image:Ide_PT_Folder.png]] '''Project Root Node or Folders'''

[[Image:Ide_PT_Popup_Folder.png]]

The menu contains:

* '''New''' and '''Add''' items activate the '''File | New''' and '''File | Add''' commands correspondingly (giving you possibility to add new project items into the selected folder).
* '''Remove From Project''' command deletes this folder from the project.
* '''Explore''' command activates the standard Windows Explorer with this folder selected.
* '''Build Directory''' command activates the '''Build | Build''' command, which compiles packages in the selected folder.
* '''Rebuild Directory''' command activates the '''Build | Rebuild ALL''' command. This command deletes all object (and other intermediate) files generated from files in the selected folder and then compiles all packages in the selected folder.
* '''Optimal Set of Include Directives''' command activates the check for the structure of included files in order to make it optimal. This feature allows to exclude not needed inclusion directives and / or to add the obligatory inclusion directives which will make the units all-sufficient.
* '''View Unused Predicates''' command displays some information for public predicates which are not used in a project, duplicated domain and constant names, etc.

'''Project File'''

When you click the right mouse button on project file (<vp>*.prj6</vp>), then the following pop-up menu appears:

[[Image:Ide_PT_Popup_Project.png]]

The menu contains:

* '''Build''' command activates the '''Build | Build''' command, which compiles project.
* '''Rebuild All''' command activates the '''Build | Rebuild ALL''' command. This command deletes all object (and other intermediate) files generated from files and then compiles all packages in the project.
* '''Settings...''' item opens the '''{{ide|Project Settings|Project Settings}}''' dialog.
* '''Explore Containg Folder...''' item explores the folder for a file.
* '''File Properties...''' item activates the standard Windows dialog ''''SelectedFileName' Properties''' in which you can view/modify some Windows properties of the ''' 'SelectedFileName'''' file.

'''Project Source Files and Package Header Files'''

When you click the right mouse button on Visual Prolog source files (containing interfaces - <vp>*.i</vp>, classes - <vp>*.cl</vp>, and class implementations - <vp>*.pro</vp>) of the project, or package header file (<vp>*.ph</vp>), then the following pop-up menu appears:

[[Image:Ide_PT_Popup_Source.png]]

This pop-up menu contains:

* '''Compile Package''' item activates the '''Build | Compile''' command that compiles the package into which the selected file is included.
* '''Open''' command activates the text editor for the selected file (or switches to the text editor window with this file if it is already edited).
* '''Explore Containg Folder...''' item (it is described above).
* '''File Properties...''' command (it is described above).

'''Packages'''

When you click the right mouse button on package files (<vp>*.pack</vp>), a pop-up menu appears:

[[Image:Ide_PT_Popup_Package.png]]

This pop-up menu contains:

* '''New''' and '''Add''' commands activate the '''File | New''' and '''File | Add''' commands correspondingly (giving you possibility to add new project items into the selected folder).
* '''Compile''' activates the '''Build | Compile''' command that compiles the selected package.
* '''Open''' item (it is described above).
* '''Remove From Project''' command deletes the selected package from the project.
* '''Explore Containg Folder...''' item (it is described above).
* '''File Properties...''' item (it is described above).

'''Resource Description Files'''

When you click the right mouse button on resource description files (dialogs - <vp>*.dlg</vp>, windows - <vp>*.win</vp>, forms - <vp>*.frm</vp>, menus - <vp>*.mnu</vp>, toolbars - <vp>*.tb</vp>, bitmaps - <vp>*.bmp</vp>, icons - <vp>*.ico</vp>, and cursors - <vp>*.cur</vp>), then the following pop-up menu appears:

[[Image:Ide_PT_Popup_Resource.png]]

This pop-up menu contains:

* '''Attribute''' command activates the '''Attributes''' dialog for this resource.
* '''Open''' command opens this resource for editing in the correspondent resource editor.
* '''Remove From Project''' command deletes this resource from the project.
* '''Explore Containg Folder...''' item (it is described above).
* '''File Properties...''' item (it is described above).

'''Prolog Names'''

When you click the right mouse button on Visual Prolog names (interfaces, classes, class implementations, or names of predicates, facts, domains, and constants), the following pop-up menu that contains the following entries appears:

[[Image:Ide_PT_Popup_Prolog.png]]

* '''Go to Declaration''' command opens the text editor, loads the selected file and jumps on this name declaration.
* '''Go to Definition''' command opens the text editor, loads the selected file and jumps on this name definition.

Ide/Project Settings

2013-04-18T11:48:36Z

GalinaTchekmareva:

{{ideNavbar|IDE Project Settings}}

The '''Project Settings''' utility is used to create new Visual Prolog Projects and to change some settings of existing projects.

To activate the '''Project Settings''' dialog, select the '''Project | Settings''' menu item. '''Project Settings''' is also activated when you create a new project (with the '''Project | New''' command).

== General Tab ==

When creating a new project the sheet looks like:

[[Image:Ide_ApplicationExpert_General_Create.png]]

You need to specify a mandatory project name and other options. After the needed information is specified, press the '''OK''' button. The '''Project Settings''' utility will create the default files, define the {{ide|Make Facility#Build Script|build script}}, etc.

=== Project Name ===

The project name must be specified in the '''Project Name''' option while a project creation. '''Project Settings''' uses this project name to generate name for the project file: <vpbnf><ProjectName>.prj6</vpbnf>. The specified project name is also used as the default name of '''Subdirectory''' in which the project is placed.

=== Project Kind ===

Sets which type the application will have.

[[Image:Ide_ApplicationExpert_UI_Strategy.png]]

The IDE automatically generates different default sets of files (and codes) for each application type.

'''Note.''' DLL option is available for the Visual Prolog Commercial Edition only.

=== MDI Mode/SDI Mode ===

Specifies whether the IDE creates a ''multi document interface-'' or ''single document interface-'' project template respectively.

'''Note.''' This option is available for the Visual Prolog Commercial Edition only. Otherwise the ''MDI Mode'' is assumed by the default.

=== Base Directory and Subdirectory ===

The name of the directory, in which the project is placed, is generated from the path specified in '''Base Directory''' that is concatenated with the folder name specified in '''Subdirectory'''.

*'''Base Directory'''
*:Specifies the base directory for the project being created.With the '''Browse''' button, you can open up a directory browser to find a proper '''Base Directory.'''
*'''Subdirectory'''
*:Specifies the subdirectory (relative to the '''Base Directory'''), which should be the root directory for the project being created.By default the '''Subdirectory''' name is equal to the specified '''Project Name''', but it can be changed while the project creation.

'''Note.''' That if you choose a directory that already contains some project as the directory in which to place the project being created, then the '''Project Settings''' utility displays the '''These files will be overwritten''' warning dialog. It displays names of already existing files which will be overwritten after you push the '''Create''' button. Therefore, it is a good idea to store each project in its own directory.

=== Platform ===

Specifies the project target platform as one of the following:

* 32bit
* 64bit
* 32bit+64bit

When the two 32bit 64bit platforms are specified as the project target, the active platform can be choosen through the '''Build''' menu.

'''Note.''' This option is available for the Visual Prolog Commercial Edition only. Otherwise the ''32bit'' is assumed by the default.

'''Manifest File'''

When it is checked '''ON''', then the '''Manifest''' file is generated for the project.

A Win32 side-by-side assembly contains a collection of resources—a group of DLLs, windows classes, COM servers, type libraries, or interfaces—that are always provided together with applications. These are described in the assembly '''Manifest''' files. For more details about '''Manifest''' files see descriptions in MSDN.

'''Require commctrl v.6'''

Specifies that the generated manifest file contains a statement to require the system '''commctrl.dll''' version 6 for the application.

'''Require Administrative Rights'''

Specifies that the generated manifest file contains a statement to require the administrative privileges for the application.

To open the '''Project Settings '''dialog for the existing project, use the '''Project | Settings''' menu item.

The General tab will look, in this case, as foolows:

[[Image:Ide_ApplicationExpert_General.png]]

== Directories Tab ==

Here you can specify directories that will be used by the project. In '''Directories''' tab you can set up the project subdirectories to be used by the compiler, linker, resource generators, etc.

Directory names refer to the {{ide|Make Facility#Build Symbols|build script symbols}}. For example, when giving the name '''$(ProDir)''', it is automatically expanded to the actual path where the Visual Prolog system is installed.

When all these project subdirectories are defined, then it is possible to move a project to another place and still be able to use it without need to redefine the {{ide|Make Facility#Build Script|project build scripts}} manually. This is possible because:

* Usually these project subdirectories are defined relatively to the project root directory. Therefore, they are automatically redefined when the project is moved.
* Each of these subdirectories generates correspondent {{ide|Make Facility#Build Symbols|build symbols}} and namely these built symbols are used to define file locations in the {{ide|Make Facility#Build Script|project build scripts}}.

=== Intermediate ===

'''$(ObjDir)''' - This directory is used to place all intermediate (temporary) files of the project generated by the IDE. It defines the '''$(ObjDir)''' {{ide|Make Facility#Build Symbols|build script symbols}}. The IDE automatically adds suffix '''64''' to the intermediate directory name.

=== Final ===

'''$(ExeDir)''' - This directory is the place for the generated target module (executable or DLL). It defines the '''$(ExeDir)''' {{ide|Make Facility#Build Symbols|build script symbols}}. The IDE automatically adds suffix '''64''' to the final directory name.

=== Import Library ===

'''$(LibDir)''' - This directory is used for DLL projects to place the generated import library. It defines the '''$(LibDir)''' {{ide|Make Facility#Build Symbols|build script symbols}}.

=== Prolog Root ===

'''$(ProDir)''' - It is the root directory of the used Visual Prolog version. This directory defines the '''$(ProDir)''' {{ide|Make Facility#Build Symbols|build script symbols}}.

=== Include Directories ===

'''$(IncDir)''' - This list box displays the list of the project include directories.

Each line contains one directory. In these directories the compiler will search for included files (specified in <vp>#include</vp> or <vp>#bininclude</vp> compiler directives), if the specified filename does not contain an absolute path. A single dot indicates the current directory, which is always the project directory. Two dots indicate the parent directory of the current directory.

You can add a new directory to the list of the project include directories using the '''Browse''' button. The '''Browse''' button activates the '''Set New Directory''' dialog. Also you can use the '''Edit''' button, which activates the '''Edit Include Directory''' dialog. In this dialog you can directly type in a path. Using '''Up''' and '''Down''' buttons you can change the order in which the compiler will search in the specified include directories.

This directory defines the '''$(IncDir)''' {{ide|Make Facility#Build Symbols|build script symbols}}.

== Build Options Tab ==

Here you can edit the project {{ide|Make Facility#Make Rules|build script '''Rules'''}} and the project {{ide|Make Facility#Build Script|'''Build Script'''}}, specify the '''Type Library File''', etc.

=== Rules ===

Determine how to compile files with given extensions. An example is the following:

<vipbnf>pack->obj:$(Compiler) /L:R /L:I /L:STAT $(IncDir) /MAXE:200 /MAXW:1000
"$**.pack" /OBJECTFILE:"$(ObjDir)$*.obj" /DEBUGFILE:"$(ObjDir)$*.deb" /debug:full</vipbnf>

For more information about {{ide|Make Facility#Make Rules|Rules}} syntax see the {{ide|Make Facility|Make Facility}}.

=== Build Script ===

Describes how to build the final target. An example is the following,

<vipbnf>"$(ProDir)Bin\VIP6Link.exe" -F<< -E_VIPStartUp@0 -d -TPE -SGUI -o"$(ExeDir)$*.exe"
-M"$(ObjDir)$*.map" $(PROJECT_OBJ) "$(ObjDir)$*.res" $(PROJECT_LIB)<<</vipbnf>

For more information about {{ide|Make Facility#Build Script|Build Scripts}} see the '''Make Facility''', the {{ide|IDE Tools#Command Line Compiler|Command Line Compiler}}, and the {{ide|IDE Tools#Command Line Linker|Command Line Linker}}.

=== Definition (.def) File ===

'''[$(DEF_FILE)]''': A {{ide|IDE Tools#Definition Files|module-definition}} ('''.DEF''') file provides additional input for the linker. The module-definition files describe the essential characteristics of a target application or library.

Ordinary module-definition files should be used when the project target is a DLL or when the target file should use DLLs.

When the project target is a DLL, then names of all predicates exported from the DLL have to be added to the {{ide|IDE Tools#Definition Files|EXPORT}} section of the module-definition file, which is used to build the DLL.

When an import library is included into the project modules, then the correspondent DLL is linked statically to the application (load-time linking). Such projects must have module-definition files, whose {{ide|IDE Tools#Definition Files|IMPORTS}} sections should specify names of all predicates imported from the DLL.

See {{ide|IDE Tools#Definition Files|Definition Files}} in the {{ide|IDE Tools#Command Line Linker|Command Line Linker}} for more information.

=== Type Library File ===

Here you can use the '''Browse''' button to specify a Type Library, which should be used in your project. Usually, you need this when creating COM objects.

== Version Information Tab ==

Here you specify some information about the project: '''Company''', '''Author''', '''Copyright''', '''File Version''', '''Trademarks''', etc.

Some of version information attributes can be shown by the operation system '''File Properties''' dialog and can be used to validate version of DLL or EXE, before loading them.

Version information contains the following fields:

*'''Company'''
*:Usually is the name of the company that is the Copyright owner to the project.
*'''Author'''
*:Represents information about the author of the project.
*'''Copyright'''
*:Represents the Copyright information, which is visible in the '''File Properties''' dialog.
*'''Description'''
*:Contains a short description.
*'''File Version'''
*:Is written in the A.B.C.D format, where A, B, C, D are integers. A means major version.
*'''Product Version'''
*:Is written in format A.B.C.D, where A, B, C, D are integers. A means major version.
*'''Trademarks:'''
*:Represents the project Trademarks information.
*'''File Flags:'''
*:These are flags that describe the target file of the project:
*#'''Debug'''
*#:This flag means that the project is built with debugging information.
*#'''Prerelease'''
*#:This flag means that the target file is an intermediate version.
*#'''Patched'''
*#:This flag means that the target file has been modified comparing with the original file, which has the same version number.
*#'''Special Build'''
*#:This flag means that the target file was built using standard release procedures but for special purpose.
*#'''Private Build'''
*#:This flag means that the target file was built for private purpose.

== File Templates Tab ==

*'''Comment Header'''
*:The text from this file will be added as a header to each created Visual Prolog source file.
*'''Interface Declaration'''
*:The text from this file will be added as a header to each created interface declaration file.
*'''Class Declaration'''
*:The text from this file will be added as a header to each created class declaration file.
*'''Class Implementation'''
*:The text from this file will be added as a header to each created class implementation file.

== Run Options Tab ==

*'''Run Arguments'''
*:Here it is possible to specify command line parameters that will be passed to the target application when it starts from the IDE.
*'''Executable for Debugger'''
*:Here you can specify an executable filename that will be loaded by the IDE for debugging.
*'''External Project for Debugger'''
*:Here you can specify a project with the debug information that should be used by the IDE while debugging.
*'''Working Directory for Run/Debug'''
*:If this option is set, a user application will use this directory as a working directory for Run/Debug comands, otherwise the final directory will be used. If the relative path is defined then the path is calculated from the project directory.

Ide/Collaboration

2013-04-18T10:27:31Z

GalinaTchekmareva:

{{ideNavbar|Collaboration}}
== Handling a Project by Several Programmers ==

When several programmers are working with the same project, they normally use some source code control systems (SCS) like SourceGear Vault, Microsoft Visual SourceSafe, etc.

A source code control system is a program for maintaining version control of source files being developed. It allow members of your development team to retrieve, modify, and return any revision of a file in a secure, systematic, and compatible manner. With SCS you minimize the risk of overwriting changes made by another developer and you do not have to worry about losing data, because all changes are easily accessible.

== Using the SCS from IDE ==

You can tune IDE to handle the '''Check Out''' and '''Check In''' commands of the SourceGear Vault or Microsoft Visual SourceSafe (or similar commands in other Source Control Systems). When you add '''Check Out''' and '''Check In''' commands (with '''Tools | Configure Tools''') to IDE commands, then you will be able to '''Check In''' and '''Check Out''' edited files into the Source Control System database (Repository) by pressing some simple hot key like '''Ctrl+1'''. The detailed description of how to add '''Check Out''' and '''Check In''' commands to IDE commands see in "{{ide|External Tools#How to 'Check In' a File in MS Visual Source Safe|How to "Check In" a File in MS Visual Source Safe}}" and "{{ide|External Tools#How to 'Check Out' a File in Vault|How to "Check Out" and "Check In" a File in Vault}}".

== Defining the Source Control Repository ==

If you are using a Source Control System, then '''Tools | Source Control Repository...''' menu entry can be used to configure a SCS repository. Here you can set a repository name and the correspondent working folder which will be used for this repository. This will define values for variables '''$(repsitory)''' and '''$(scfile)''' for the tools (like the '''Check Out''' command).

Additionally, '''Tools | IDE Variables''' menu entry can be used to configure other SCS parameters, like user name (variable '''$(user)'''), host name (variable '''$(host)''') and password (varaible '''$(password)''').

Ide/Debugger/Debugger Views

2013-04-18T10:00:44Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Run Stack Window ===
----
The '''Run Stack''' consists of three kinds of items:
*'''Continue''' item – marked with [[Image:Ide_db_RunStack_up.png]]. It describes ordinary executable clauses, which do not produce backtrack points and are not trapped.
*'''BackTrack''' item – marked with [[Image:Ide_db_RunStack_dn.png]].It describes a clause of a nondeterministic predicate. The next clause of this predicate can be executed when a program failure of this clause occurs. Such items occur when a clause of a predicate, which creates a '''backtrack''' point (can produce more than one solution) is called.
*'''TrapTrack''' item – marked with [[Image:Ide_db_RunStack_rh.png]] or [[Image:Ide_db_RunStack_dn_rh.png]]. They describe a continue item (clause), which will be resumed in any case independently whether an error condition occurs or no. For example, such item is created when a predicate call is trapped with the <vp>trap/3</vp> predicate. The [[Image:Ide_db_RunStack_rh.png]] icon is used to mark trapped clauses of deterministic predicates. The [[Image:Ide_db_RunStack_dn_rh.png]] icon is used to mark trapped clauses of nondeterministic predicates.

The '''BackTrack''' (marked with [[Image:Ide_db_RunStack_dn.png]]) and '''TrapTrack''' items (marked with [[Image:Ide_db_RunStack_dn_rh.png]]) are backtracking points. The clause, marked by one of these items, will be resumed and the program execution will be continued after the corresponding failure or an error occurs.

The typical example of the '''Run Stack''' window is presented in the following picture:

[[Image:Ide_db_RunStack.png]]

'''Pop-up Menu'''

The '''Run Stack''' window has the pop-up context menu:

[[Image:Ide_db_RunStack_menu.png]]

For each selected item in the tree, this menu contains items:

*'''Refresh'''
*:It refreshes all the '''Run Stack''' window contents, rebuilds the tree.
*: It also refreshes the {{ide|Debugger#Variables Window|'''Variables'''}} window (if it is displayed).

*'''Go To Code'''
*:Activates the Prolog source editor and places the cursor at the Prolog clause corresponding to the item selected in the '''Run Stack''' window. If the item does not correspond to a Prolog module with debug information, then the '''Disassembly''' window will be opened and the cursor will be placed onto the corresponding assembler instruction. The same action is caused by double-click a predicate call in the '''Run Stack''' window.

*'''Copy Line'''
*:It copies the selected line contents to the clipboard.

*'''Show Domains'''
*:This option turns ON/OFF displaying domains of variables.

*'''Show Values'''
*:This option turns ON/OFF displaying values of variables.

The '''Run Stack''' window can be activated by the IDE menu '''View | Run Stack'''.

=== Variables Window ===
----
The '''Variables''' window can be activated either by '''Ctrl+Alt+V''' or from the IDE menu '''View | Variables for Current Clause'''.

'''Variables Window Contents'''

The '''Variables''' window displays the tree of all program variables and facts from the traced clause, which are already created by the program at the current tracing step. These are: all variables and all object facts (fact variables), which are created in the clause before the executing instruction, and all class facts (fact variables), which can be used in this clause (declared in this class implementation).

The top line of the window displays the declaration of the predicate, whose clause is executed.

[[Image:Ide_db_Vars_Top.png]]

The '''Variables''' window content is updated after every trace step.

'''Pop-up Context Menu'''

The '''Variables in the Current Clause''' window has the following pop-up context menu:

[[Image:Ide_db_Vars_Menu.png]]

This menu contains items:

*''Insert into Watch Window''
*:Opens the '''Watch Window''' and moves there selected variable.

*''Copy''
*:This command copies the contents of the line selected in the '''Variables''' window to the clipboard.

*''Show as Hexadecimal''
*:Shows integral values in the hexadecimal format.

*''Show as Decimal''
*:Shows integral values in the decimal format.

*''Show as Octal''
*:Shows integral values in the octal format.

*''Show Domains''
*:This option turns '''ON/OFF''' displaying the domains after variable names.

*''Show Variable Addresses''
*:This option turns '''ON/OFF''' displaying the addresses after variable names.

*''Find''
*:This command allows search variable by name.

*''Copy Tree''
*:This command copies the contents of the window to the clipboard.

=== Facts Window ===
----
'''Class Facts'''

The '''Facts''' window always shows the current contents of all '''class''' fact databases defined in the program being debugged.

Simple example:

[[Image:Ide_db_Facts_View.png]]

Pressing '''CTRL+ALT+F''' opens '''Facts''' window:

[[Image:Ide_db_Facts_View3.png]]

Clicking icons opens sub-trees:

[[Image:Ide_db_Facts_View4.png]]

'''Facts''' window automatically goes to the fact that is selected in the text editor (if any):

[[Image:Ide_db_Facts_View11.png]]

[[Image:Ide_db_Facts_View41.png]]

'''Objects Facts''' you cat look like a components of object variables in the {{ide|Debugger#Variables Window|'''Variables''' window}}

'''Pop-up Context Menu'''

The '''Facts Window''' has the following pop-up context menu:

[[Image:Ide_db_Vars_Menu.png]]

This menu contains items:

*''Insert into Watch Window''
*:Opens the '''Watch Window''' and moves there selected fact.

*''Copy''
*:This command copies the contents of the line selected in the '''Facts''' window to the clipboard.

*''Show as Hexadecimal''
*:Shows integral values in the hexadecimal format.

*''Show as Decimal''
*:Shows integral values in the decimal format.

*''Show as Octal''
*:Shows integral values in the octal format.

*''Show Domains''
*:This option turns '''ON/OFF''' displaying the domains after facts names.

*''Show Addresses''
*:This option turns '''ON/OFF''' displaying the addresses after facts names.

*''Find''
*:This command allows search fact by name.

*''Copy Tree''
*:This command copies the contents of the window to the clipboard.

=== Breakpoints Window ===
----
==== Introduction ====

The '''Breakpoints''' window shows all breakpoints, which have been set in the program being debugged.

You can set a breakpoint onto any executable line in program source files (or in the '''Disassembly''' window, where a breakpoint can be set on any instruction of the program being debugged).

There are two kinds of breakpoints: hard and soft. Hard breakpoints are active in any debugging mode. Soft breakpoints are active in normal debugging mode but disabled in a special mode of quick debugging, called ''Fast Forward Mode''.

==== Breakpoints Window Contents ====

The '''Breakpoints''' window for each breakpoint includes '''Status''', '''Source''', '''Line''', '''Count''', '''Comment''' and '''Action''', where:

*'''''Status'''''
*:Shows whether the breakpoint is ''hard'' or ''soft''.
**''Hard''
**:If a breakpoint is ''hard'' then it will be activated in any debugging mode. A hard breakpoint is marked with the filled circle [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_assembler.png]] (for assembler) or [[Image:Ide_db_BreakPoints_shifted.png]] (for relocated breakpoint).
**''Soft''
**:If a breakpoint is ''soft'' then it will be activated only in normal (not Fast Forward) debugging mode. A soft breakpoint is marked with the hollow circle [[Image:Ide_db_BreakPoints_dis.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]] (for assembler).
**''Invalid''
**:A breakpoint is invalid when it is set on a line, which does not contain executable code. An invalid breakpoint is marked with the crossed hollow circle [[Image:Ide_db_BreakPoints_invalid.png]].

*'''''Source'''''
*:This column shows the source string:
*:<vipbnf><SourceName></vipbnf>
*:where:
*:''SourceName''
*:The description of a predicate in the address space of whose clauses the breakpoint is set:
*:*If the breakpoint is set in Prolog sources, then ''SourceName'' is the filename in which the breakpoint is set. It is displayed with the format:
*::<vipbnf><FileName> '(' <Path> ')'</vipbnf>
*::The ''Path'' can use {{ide|Make Facility#Build Symbols|Build script symbols}}.
*:* If the breakpoint is set in the '''Disassembly''' window, then ''SourceName'' has the format:
*::<vipbnf>--- assembler: <AddressValue></vipbnf>
*::''AddressValue'' is the hexadecimal address of the breakpoint in the assembler code of the predicate in which the breakpoint is set.

*'''''Line'''''
*:When the breakpoint is set in a Prolog source file, then this column displays the number of the line the breakpoint is set on. When the breakpoint is set in the Disassembly window, then the number of the line is equal to 0.

*'''''Count'''''
*:This column displays {{ide|Debugger#Breakpoint Properties|counts}} of breakpoints.

*'''''Comment'''''
*:This column displays {{ide|Debugger#Breakpoint Properties|comment strings}} of breakpoints.

*'''''Action'''''
*:This column displays the script text of a breakpoint. The script is performed each time the program reaches the breakpoint.

==== Breakpoints in Prolog and Disassembly Windows ====

Breakpoints can be set in Prolog source files and in the '''Disassembly''' window:

* In Prolog sources valid breakpoints can be set only on lines containing executable instructions. That is, breakpoints can be set only in predicate clauses on lines containing predicate calls, otherwise the breakpoints that are set on non-clause lines would be marked as invalid. The breakpoints that are set on clause lines that do not contain predicate calls would be shifted to the lines containing such calls (if any), but the initial line would be marked with [[Image:Ide_db_BreakPoints_shifted.png]]. Valid breakpoints are marked with red circles [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_dis.png]] in Prolog sources and are shown in the '''Disassembly''' window as blue circles [[Image:Ide_db_BreakPoints_assembler.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]]. If a Prolog clause has several assembler implementations (when the clause has several flow patterns), then each breakpoint in Prolog sources can generate several breakpoints in the '''Disassembly''' window.
* Breakpoints that are set in the '''Disassembly''' window are marked with red circles [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_dis.png]]. Such breakpoint can be later overwritten by a breakpoint (marked with blue circles [[Image:Ide_db_BreakPoints_assembler.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]]) that is set in Prolog sources on the same address as the breakpoint set in the '''Disassembly''' window. Notice that after modification and recompilation of the project some breakpoints that are set in the '''Disassembly''' window can be cleared (if other instructions are placed at breakpoint addresses.)

All breakpoints which are set in a program are seen in the '''Breakpoints''' window.

==== Breakpoint Properties ====

Each breakpoint has properties, which can be modified in the '''Breakpoint Properties''' dialog:

[[Image:Ide_db_BreakPoint_Properties.png]]

In this dialog:

The top line contains:

* If the breakpoint is set in Prolog sources, then the top line has format:
*:'''<vipbnf>File: <FileName> Line: <LineNumber></vipbnf>'''
*:''FileName'' is the name of the Prolog source file in which the breakpoint is set.
*:''LineNumber'' is the number of the line on which the breakpoint is set.

* If the breakpoint is set in the '''Disassembly''' window, then the top line has format:
*:'''<vipbnf>Breakpoint Address:<Address></vipbnf>
*:''Address'' is the breakpoint address in the program memory as it is seen in the '''Disassembly''' window.

'''Count''' ''Value''
:Shows the current number of activations of the breakpoint since its creation. The user cannot modify this value. This value increases by 1 each time when the program reaches the breakpoint.

'''Hard'''
:This check box controls the ''Hard/Soft'' state of the breakpoint. When you turn a breakpoint to Hard, then it will be activated in any debugging mode. When you turn a breakpoint to Soft, then it will be activated only in normal (not Fast Forward) debugging mode.

'''Comment''' ''Comment string''
:In this edit box you can type in a ''Comment string''. By default it has the value of the corresponding line in the source file.

'''Action''' ''Script text''
:In this box you can type in a ''Script text''.

'''Note.''' If a module has been built without debug information (this can be done by changing <vp>/debug:full</vp> to <vp>/nodebug</vp> in the command line compiler options in the
{{ide|Project Settings#Build Options Tab|build script rules}} for <vp>pro->obj:</vp> and <vp>pack->obj:</vp>) then you will not be able to set a breakpoint in the Prolog sources of the module.

Notice that it does not matter in which window you remove a breakpoint (in Prolog sources, in the '''Breakpoints''' window or in the '''Disassembly''' window). In any case, removing a breakpoint deletes the breakpoint from the program.

==== Pop-up Menu ====

The '''Breakpoints''' window has the pop-up context menu:

[[Image:Ide_db_BreakPoints_pop_up.png]]

To activate this menu, select a breakpoint and press the right mouse button. This menu contains items:

*'''Go to Source'''
*:If the breakpoint is set in the Prolog sources, then the '''Go to Code''' activates the Prolog source code editor, and moves the cursor to the Prolog code corresponding to the specified breakpoint. If the breakpoint is set in the '''Disassembly''' window, then the '''Go to Code''' moves the view to this breakpoint in the '''Disassembly''' window. The same action is performed by double-click the breakpoint or by pressing the '''Enter''' on the breakpoint.

*'''Properties'''
*:Invokes the {{ide|Debugger#Breakpoint Properties|'''Breakpoint Properties'''}} dialog for the selected breakpoint.

*'''Toggle (Turn to Hard/Soft)'''
*:Switches the ''Hard/Soft'' state of the selected breakpoints.

*'''Delete'''
*:Deletes the selected breakpoints.

*'''Turn to Hard All'''
*:Sets the state of all breakpoints that are set in the program to ''Hard''.

*'''Turn to Soft All'''
*:Sets the state of all breakpoints that are set in the program to ''Soft''.

*'''Remove All'''
*:Removes all breakpoints that are set in the program.

The '''Breakpoints''' window is auto-updated for any breakpoint updating.

The '''Breakpoints''' window can be activated either by '''Ctrl+Alt+B''' or from the IDE menu '''View | Breakpoints'''.

=== Threads Window ===
----
The '''Threads''' window shows information about the process being debugged and its threads.

The '''Threads''' window looks like following:

[[Image:Ide_db_Threads.png]]

Names displayed in the header of the window columns are the following:

*'''TID'''
*:This column displays thread identifiers of all threads created by the process being debugged.
*'''Current'''
*:This column identifies the current thread by the <vp>*</vp> sign. In the {{ide|Debugger#Variables Window|Variables}} window you can see only variables of predicates executed in the current thread.
*'''State'''
*:Displays states of threads. States can be '''''Running''''', '''''Stopped''''', and '''''Suspend'''''.
*: '''''Running''''' The thread has been started, it is not suspended (see <vp>thread::suspend/0-></vp>, <vp> syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>) or terminated (see <vp>thread::terminate/1</vp>).
*: '''''Suspend''''' The thread is in suspended state (see <vp>thread::createSuspended/3</vp>, <vp>thread::suspend/0-></vp>, <vp>syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>).
*: '''''Stopped''''' The thread was created and then stopped on a breakpoint, but it is not suspended (see <vp>thread::suspend/0-></vp>, <vp>syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>). If you set suspended state to a '''''Stopped''''' thread, then it turns into the '''''Suspend''''' state.
*'''Time'''
*:Thread creation time.
*'''User time'''
*:Processor time in the user-mode used by the thread.
*'''Kernel Time'''
*:Processor time in the kernel-mode used by the thread.
*'''Priority'''
*:The priority level of the thread. Here can be displayed the following numbers <vp>2, 1, 0, -1, -2</vp>.
*'''Predicate'''
*:This field contains the name of the currently executed thread's predicate (if it is possible to determine it).

{|{{prettytable}}
|-
! Displayed Number
! Priority Name
! Description
|-
| 2
| '''Highest'''
| The thread can be scheduled before threads with any other priority.
|-
| 1
| '''AboveNormal'''
| The thread can be scheduled after threads with '''Highest''' priority and before those with '''Normal''' priority.
|-
| 0
| '''Normal'''
| The thread can be scheduled after threads with '''AboveNormal''' priority and before those with '''BelowNormal''' priority. Threads have Normal priority by default.
|-
| -1
| '''BelowNormal'''
| The thread can be scheduled after threads with '''Normal''' priority and before those with '''Lowest''' priority.
|-
| -2
| '''Lowest'''
| The thread can be scheduled after threads with any other priority.
|}

'''Pop-up Menu'''

The '''Threads''' window has the pop-up context menu. The same commands can be activated from the '''Thread''' sub-menu of the IDE task menu.

[[Image:Ide_db_Threads_popup.png]]

*'''Goto Source'''
*:Opens the text editor and places the cursor onto the predicate, which created the selected thread.
*'''Set Current'''
*:Sets the selected thread as current.
*'''Resume'''
*:Resumes the run of the selected thread.
*'''Suspend'''
*:Suspends the selected thread.
*'''Copy'''
*:Copies the contents of the line selected in the '''Threads''' window to the clipboard.
*'''Copy All'''
*:Copies the contents of the '''Threads''' window to the clipboard.

The '''Threads''' window is updated after changing any displayed parameter.

The '''Threads''' window can be activated either by '''CTRL+Alt+H''' or from the IDE menu '''View | Threads'''.

=== Disassembly Window ===
----
==== Disassembly Window Contents ====

The '''Disassembly''' window shows the assembly language interpretation of the inspected code.

The disassembly starts from the specified top address toward the upper memory and prints each instruction on a new line.

Each line is printed by the pattern:

<vipbnf><LineMarkers> <Address> [ <HexCode> ] <AssemblerCommand></vipbnf>

where:

''LineMarkers''
:Are the {{ide|Debugger#Debug Menu Commands|''instruction pointer''}} [[Image:Ide_db_InstructionPointer.png]] and the breakpoint[[Image:Ide_db_BreakPoints_en.png]] (or [[Image:Ide_db_BreakPoints_dis.png]]) markers, which can mark this line.
''Address''
:The start address of the instruction code.
''HexCode''
:This is the hexadecimal instruction code. This field can be shown/hidden from the pop-up menu of the '''Disassembly''' window by checking the '''Show OpCodes''' item.
''AssemblerCommand''
:This is the assembler command corresponding to the instruction code. Assembler commands have the Intel standard assembler abbreviation. If a certain address is resolved to an external name, then this name will be printed in the command column.
: The instruction, which will be executed at the next trace step, is marked with the [[Image:Ide_db_InstructionPointer.png]] ''Instruction pointer'' in the ''LineMarkers'' field.

Example:

[[Image:Ide_db_DisAsm_View.png]]

==== Pop-up Menu ====

The '''Disassembly''' window has the pop-up context menu with the followin commands:

*'''Go To Address'''
*:Invokes the '''Go to Address''' dialog
*:[[Image:Ide_db_DisAsm_Go2Address.png]]
*:to type in the address of the instruction, which should be displayed in the top line of the '''Disassembly''' window. The ''Address'' should be specified in the hexadecimal format. This dialog allows typing symbolic external link names and symbolic CPU register names.
*'''Go To EIP'''
*:Updates the '''Disassembly''' window and places the cursor at the address of the instruction on which the program execution is suspended.
*'''Breakpoint…'''
*:Allows handling the breakpoint [[Image:Ide_db_BreakPoints_en.png]] (or [[Image:Ide_db_BreakPoints_dis.png]]) for the assembler instruction pointed by the cursor. It has the following sub-commands:
*:[[Image:Ide_db_DisAsm_PopUp.png]]
*:*'''Toggle Breakpoint'''
*:*:Sets or removes a breakpoint at the instruction with the address pointed by the cursor.
*:*'''Enable / Disable'''
*:*:''Enables / Disables'' the breakpoint pointed by the cursor. This item is disabled if there is no breakpoint at the address pointed by the cursor.
*:*'''Properties'''
*:*:Invokes the '''Breakpoint Properties''' dialog for the breakpoint pointed by the cursor. This item is disabled if there is no breakpoint at the address pointed by the cursor.
*'''Go To Source'''
*:Activates the IDE source code editor and sets the cursor at the predicate whose assembler instruction is pointed by the cursor in the '''Disassembly''' window. (When it is possible.)
*'''Copy'''
*:Copies lines selected in the '''Disassembly''' window to the clipboard. A selection can be performed with the '''Shift+Up Arrow''' and '''Shift+Down Arrow''' key combinations.
*'''Show OpCodes'''
*:Checking and unchecking this item hides/shows hex images of operation (instruction) codes ('''OpCodes'''). These hex instruction codes are shown in the ''HexCode'' field.
*'''Source Annotation'''
*:Checking OFF/ON this item hides/shows object names, corresponding to predicate entry points. Each object name is printed on a new line before the corresponding instruction line.
*'''Show Hints'''
*:Shows additional information about the instruction being executed.

The '''Disassembly''' window is updated after each trace step of the debugger.

==== Disassembly Window Commands ====

*'''Trace Into''' ('''F11''') command
*:Tracing in the '''Disassembly''' window with the '''Step Into''' ('''F7''') command performs execution of one assembler instruction (including entering into procedures if any). That is, if the '''Step Over''' command will execute a <vp>call</vp> instruction as one trace step, then the '''Step Into''' command will go into the called procedure. It usually executes disassembler instructions line after line.
*'''Step Over''' ('''F10''') command
*:Tracing in the '''Disassembly''' window with the '''Step Over''' ('''F10)''' command performs execution of one assembler instruction (including execution of <vp>call</vp> instructions). So the '''Step Over''' ('''F10''') command works almost the same way as the '''Trace Into''' ('''F11''') command except for execution of <vp>call</vp> instructions. In difference to the '''Trace Into''' ('''F11''') command, it tries to perform <vp >call</vp> instructions as one step and reaches the next line only if the called code returns to that line.
*'''Run to Cursor''' ('''CTRL+F10''') command
*:Tracing in the '''Disassembly''' window with the '''Run to Cursor''' ('''CTRL+F10''') command works in the following way. The debugger places an invisible breakpoint at the address corresponding to the instruction specified by the cursor and performs the '''Debug Run''' ('''F5''') command. It depends only upon the program code whether the program will reach this instruction or will never reach it.

The '''Disassembly''' window can be activated:

* by '''Shift+Alt+1'''
* by '''Ctrl+D''' from the traceable source code. The topmost line of the '''Disassembly''' window displays the address of the disassembler instruction corresponding to the predicate pointed by the cursor in the source code.
* from the IDE menu '''View | Disassembly'''

If the tracing code has no debug information, then the '''Disassembly''' window is opened initially (when the debugger starts) and the instruction pointer [[Image:Ide_db_InstructionPointer.png]] points to the executing assembler instruction.

=== Registers Window ===
----
The '''Registers''' window shows current values of the CPU (Central Processor Unit) registers:

* General registers
* Segment registers
* Flags
* Floating-point registers

A register value is printed:

* '''red''', if it is changed from the last program trace step
* '''blue''', otherwise.

For example:

[[Image:Ide_db_Registers_fpu.png]]

The '''Floating Point''' command from context pop-up menu can be used to turn ON/OFF the displaying of Floating-point registers.

The '''Registers''' window can be activated either by '''Ctr+ Alt+G''' or from the IDE menu '''View | Registers'''.

=== Modules Window ===
----
The Modules Window shows all the modules currently loaded in this debug session. It shows the filename, path, the base address range, the code address range and the type of debug information.

[[Image:Ide_db_Modules.png]]

=== Memory Dump Window ===
----
The '''Memory Dump''' window shows the virtual memory dump of the program being debugged. Memory dump lines have the length, which is determined by the window width. The number of printed lines window height.

'''Information Displayed in the Memory Dump Window'''

Each line in the '''Memory Dump''' window is printed by the pattern:

<vipbnf><Address> | [ <HexValues> ] [ <ASCIIcharacters> ] [ <UnicodeCharacters>]</vipbnf>

where:

''Address''
:This is the hexadecimal address of the first byte of the memory displayed in this line.
''HexValues''
:<vipbnf><HexValues> : <HexValue> [ <HexValues> ]</vipbnf>
:This is the hexadecimal format of the memory dump. Each hex value can be an image of one, two, four or eight continued memory bytes (this is contolled by the '''Memory Dump''' window content pop-up menu).
''ASCIIcharacters''
:<vipbnf><ASCIIcharacters> : <ASCIIcharacter> [ <ASCIIcharacters> ]</vipbnf>
:This is the same memory dump but in the format of ASCII characters (a character represenrs one byte). Unprintable characters are printed as dots.
''UnicodeCharacters''
:<vipbnf><UnicodeCharacters> : <UnicodeCharacter> [ <UnicodeCharacters> ]</vipbnf>
:This is the same memory dump in the format of Unicode characters (a character represents two bytes). Unprintable characters are printed as dots.

Example:

[[Image:Ide_db_Memory_view1.png]]

The '''Memory Dump''' window title shows the module name, which memory is displayed in the window. If the module name cannot be determined, then the title displays ''Unknown module''.

'''Content Pop-up Menu'''

The '''Memory Dump''' window has the pop-up context menu which contains commands:
*'''Go To Address'''
*:'''Ctrl+G'''. Invokes the '''Go to Address''' dialog
*:[[Image:Ide_db_DisAsm_Go2Address.png]]
*: to type a new top address in hex format. This dialog allows typing symbolic external link names and symbolic CPU register names. Double-click in the '''Memory Dump''' window area also activates the '''Go to Address''' dialog.
*'''Go To ''Ptr'''''
*:'''Ctrl+Shift+G'''. Updates the '''Memory Dump''' window starting the first line from the address shown as ''Ptr'' (address defined by the memory contents of four or eight continued bytes at which the cursor is pointing if one of '''4-byte Integer''' or '''8-byte Integer''' is selected).
*'''Undo Go to'''
*:'''Alt+Left Arrow'''. Updates the '''Memory Dump''' window view to start from the previously used top (the first line) address.
*'''Redo Go to'''
*:'''Alt+Right Arrow'''. This operation is the counterpart to the '''Undo Go to'''. It updates the '''Memory Dump''' window view to start from the "next" top address, which was used before the '''Undo Go to''' command was implemented.
*'''Set Memory Breakpoint'''
*:This operation sets a memory breakpoint at address from the left pane.
*'''Remove Memory Breakpoint'''
*:This operation removes a previously set a memory breakpoint.
*'''Copy'''
*:Copies the selected lines to the clipboard. To select a line, click on it while holding the '''shift''' key. You can select multiple lines at one time.
*'''Copy ''Ptr'''''
*:'''Ctrl+C'''. Copies hexadecimal representation of the specified address (four or eight bytes) to the clipboard.
*'''Refresh'''
*:Refresh the '''Memory Dump''' window contents.
*'''Write Block'''
*:This command opens the '''Write Memory Block''' dialog:
*:[[Image:Ide_db_Memory_BlockWrite.png]]
*:*'''Filename'''
*:*:Here you should type in the name of a file in which the specified memory block should be saved.
*:*'''Start Address'''
*:*:Here you should specify a hexadecimal start address of the memory block.
*:*'''Length'''
*:*:Here you should specify a hexadecimal length in bytes of the memory block.
*'''Show Hex'''
*:Shows the column, which displays the memory dump in the hexadecimal format. This is the {{ide|Debugger#Debugger Views|''HexValues''}} column in the right pane.
*'''Show ASCII'''
*:Shows the column, which displays the '''''ASCII''''' format of the memory dump. This is the {{ide|Debugger#Debugger Views|''ASCIIcharacters''}} column in the right pane.
*'''Show Unicode'''
*:Shows the column, which displays the '''''Unicode''''' format of the memory dump. This is the {{ide|Debugger#Debugger Views|''UnicodeCharacters''}} column in the right pane.
*'''Update Speed...'''
*:Defines the rate of the Memory Dump window updating:
*:[[Image:iDE_db_Memory_menu1.png]]
*:*'''High'''
*:*:Performs automatic updating with the high rate.
*:*'''Normal'''
*:*:Performs automatic updating with normal rate.
*:*'''Low'''
*:*:Performs automatic updating with low rate.
*:*'''Manual'''
*:*:No automatic updating.
The '''Memory Dump''' window can be activated either by '''CTRL+Alt+M''' or from the IDE menu '''View | Memory Dump'''.

Ide/Debugger

2013-04-18T09:31:11Z

GalinaTchekmareva:

{{ideNavbar|Debugger}}
== Visual Prolog Debugger ==

Visual Prolog Debugger is a powerful tool for finding errors in programs. Sometimes correcting errors in programs takes about 90% of the total development time. This proves that good tools for debugging are very important.

Visual Prolog Debugger can debug MS Windows 32/64-bit Graphical User Interface and Console applications and DLLs.

Visual Prolog Debugger provides ability to trace program execution. In the debugger one can set breakpoints, step through the source code (with viewing traced code both on Prolog and disassembler levels). The debugger allows inspecting variables used in the currently traced clause, viewing and retracting facts, viewing memory dumps, viewing the stack of predicate calls, viewing breakpoints inserted into the program, viewing registers, etc.

Visual Prolog Debugger is the IDE tool, which can be run with the '''Debug | Run''' menu command, with the '''F5''' hot key, or with the [[Image:Ide_db_Run.png]] toolbar button.

== Generation of Debugging Information ==

Generation of the information for Visual Prolog Debugger is controlled by copmiler's option
{{ide|IDE Tools#Command Line Options|/debug:full}}. By default, the Visual Prolog IDE always generates debugging information while compiling project modules.

== Starting Visual Prolog Debugger ==

When you start Visual Prolog Debugger (with the '''Debug | Run''' menu command, or with the '''F5''' hot key, or with the [[Image:Ide_db_Run.png]] toolbar button), then the IDE builds (if it is needed) the project, runs the target executable under the debugger, and breaks the program execution at the entry point of the goal section:

[[Image:Ide_db_Start.png]]

If in the '''Run Arguments''' edit control (in the '''Build Options''' tab of the '''Project Settings''' dialog) you have specified a string with command line arguments, then this string is passed to the program.

== Debug Menu Commands ==

The '''Debug''' menu is used to control execution of the program being debugged.

[[Image:Ide_db_DebugMenu.png|center|frame|'''The Debug Menu''']]

*'''Run (F5)'''
*:This command continues running the application. Issuing this command, when the IDE does not debug an application, builds (if needed) the application and starts its execution under the debugger. This command is often used in conjunction with setting of breakpoints.
*'''Run Skipping Soft Breakpoints (Ctrl+Shift+F10)'''
*:This command continues running the application without breaks at ''Soft Breakpoint'' (see {{ide|Debugger#Breakpoints Window|Breakpoints Window}} for more details).

*'''Stop Debugging (Shift+F5)'''
*:This command stops the program execution. The IDE becomes active in the ordinary mode.

*'''Break Program'''
*:When a program is executed (the program instructions are executed and the debugger is waiting till the program stops and returns control to the debugger), then with this command it is possible to break the program execution and to return control to the debugger. Then it is possible to inspect the call stack to see what the program is actually doing or to set a breakpoint where to catch the execution. Notice that this command is disabled while the debugger is active (when the program instructions are not executed).

*'''Restart'''
*:This command restarts the application execution under the debugger.

*'''Attach process...'''
*:It commands the debugger to attach to a process.

*'''Step Over (F10)'''
*:It instructs the debugger to execute the next line of code. If the line contains a predicate call, '''Step Over''' executes the entire predicate, then halts at the first line outside the predicate.
*: If this command is used, then when you reach a predicate call, the predicate is executed without stepping through the predicate clauses (without entering into source code of the predicate).
*: Use '''Step Over''' if you want to avoid stepping into predicates.

*'''Step Into (F11)'''
*:'''Step Into''' and '''Step Over''' differ in only one aspect — how they handle predicate calls.
*:'''Step Into''' instructs the debugger to execute the next line of code.
*:If the line contains a predicate call, '''Step Into''' executes only the call itself, then halts at the first line of code inside the predicate.
*: '''Step Into''' if you want entering into clauses of each called predicate.

*'''Step out of (Shift+F11)'''
*:This command accomplishes execution of clauses of the currently executing predicate and calls the next predicate.

*'''Run to Cursor (CTRL+F10)'''
*:It commands the debugger to run the application until it reaches the location where the cursor is set. This location can be both in Visual Prolog source code or in Disassembly window.
*: Place the cursor on a line and activate this command; the application will start execution until the line pointed by the cursor (if it can come to this predicate call). The ''Instruction Pointer'' will point to this line.

*'''Go to Executing Predicate Source (Ctrl+E)'''
*:If you have moved in the program source windows and have lost the ''Instruction Pointer'', then you may execute this command. It sets the cursor to the line containing the currently executing predicate (pointed by the ''Instruction Pointer'').

*'''Break on Exception'''
*:When this option is checked ON and if an exception occurs, then execution of program is stopped. Then you will be able to use the '''Run Stack''' window to locate your predicate in which the exception occurs. See how to {{ide|Debugger#How to Use Break on Exception|Use Break on Exception}} for more information.

*'''Toggle Breakpoint (F9)'''
*:Using this command you can set a breakpoint to any executable line in program source files.

*'''Remove All Breakpoints'''
*:This command removes all previously set breakpoints.

== How to Use Break on Exception ==

Some times, it is difficult to locate which your source code predicate generates an exception. In such situation the '''Break on Exception''' option can be helpful.

Start to debug your program. When its execution will be close to the expected exception, turn ON the '''Break on Exception''' option. (It can be inconvenient to turn the '''Break on Exception''' option from the begin of the debugger execution since this can bother you with some otherwise masked exceptions.)

When an exception occurs, Debugger catches it and execution of a debugged program is stopped.

Then you will be able to use the '''Run Stack''' window to locate the predicate in which the exception occurs and to inspect the sequence of calls which lead the exception. The topmost in the '''Run Stack''' window line corresponds to the last executed predicate. You can double click a line in this window to inspect a clause of the correspondent predicate. If there are no available sources for the '''Run Stack''' window entry, the Debugger will show the machine instructions in the '''Disassembler''' window.

== Debugger Views ==

Several debugger windows can be opened from the '''View''' menu:

[[Image:Ide_db_ViewWndows.png|center|frame|'''The View Sub-menu''']]

The windows, which can be used in the debugger (debugger views), are:

*{{ide|Debugger#Run Stack Window|Run Stack}} ('''CTRL+Alt+C''')
*{{ide|Debugger#Variables Window|Variables for Current Clause}} ('''CTRL+Alt+V''')
*{{ide|Debugger#Facts Window|Facts}} ('''CTRL+Alt+F''')
*{{ide|Debugger#Breakpoints Window|BreakPoints}} ('''CTRL+Alt+B''')
*{{ide|Debugger#Threads Window|Threads}} ('''CTRL+Alt+H''')]
*{{ide|Debugger#Modules Window|Modules}}
*{{ide|Debugger#Disassembly Window|Disassembly}} ('''CTRL+Alt+D''')]
*{{ide|Debugger#Registers Window|Registers}} ('''CTRL+Alt+G''')]
*{{ide|Debugger#Memory Dump Window|Memory Dump}} ('''CTRL+Alt+M''')]

Also the following two windows, which are not only debugger windows (debugger views), can also be used while debugging:

*{{ide|Debugger#Project Tree|Project Tree}}
*{{ide|Debugger#Source Code Windows|Source Code Windows}}

=== Project Tree ===
----
When the debugger is started, you can click the '''View | Project Window''' to display the Project Files Tree (the {{ide|Project Tree|Project window}}) and the structure of the project files can be examined by exploring the project tree.

[[Image:Ide_db_ProjectWin.png|center|frame|'''The Project Tree View''']]

In this view, it is possible to double-click files (the project consists of) and double-click individual predicates. The result will be that a source code editor opens up with the caret pointing to the clicked item.

=== Source Code Windows ===
----
When the IDE starts debugging a project, it automatically runs the target executable under the debugger, and breaks the program execution at the <vp>goal</vp> section entry point. The debugger opens the correspondent (containing the <vp>goal</vp> section) Visual Prolog source file in the IDE text editor.

[[Image:Ide_db_StartDebugging.png|center|frame|'''The Source Code View''']]

Notice the blue arrow [[Image:Ide_db_ArrowBlue.png]] pointing to the executing predicate:

<vip>mainExe::run(main::run).</vip>

This arrow is the ''Instruction Pointer'', which always points to the currently executing predicate in source code windows. That is, you can follow the ''Instruction Pointer'' moving to trace execution of the program.

The debugger changes the color of the ''Instruction Pointer'' arrow when it executes a predicate, which fails or which raises an exception.

If you have moved in the program source windows and have lost the ''Instruction Pointer'', then you can easy find it with the menu command '''Debug | Go to Executing Predicate Source (Ctrl+E)'''. It sets the cursor to the line containing the currently executing predicate (to the line pointed by the ''Instruction Pointer'').
{{:ide/Debugger/Debugger Views}}

Ide/Debugger/Debugger Views

2013-04-18T07:49:23Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
=== Run Stack Window ===
----
The '''Run Stack''' consists of three kinds of items:
*'''Continue''' item – marked with [[Image:Ide_db_RunStack_up.png]]. It describes ordinary executable clauses, which do not produce backtrack points and are not trapped.
*'''BackTrack''' item – marked with [[Image:Ide_db_RunStack_dn.png]].It describes a clause of a nondeterministic predicate. The next clause of this predicate can be executed when a program failure of this clause occurs. Such items occur when a clause of a predicate, which creates a '''backtrack''' point (can produce more than one solution) is called.
*'''TrapTrack''' item – marked with [[Image:Ide_db_RunStack_rh.png]] or [[Image:Ide_db_RunStack_dn_rh.png]]. They describe a continue item (clause), which will be resumed in any case independently whether an error condition occurs or no. For example, such item is created when a predicate call is trapped with the <vp>trap/3</vp> predicate. The [[Image:Ide_db_RunStack_rh.png]] icon is used to mark trapped clauses of deterministic predicates. The [[Image:Ide_db_RunStack_dn_rh.png]] icon is used to mark trapped clauses of nondeterministic predicates.

The '''BackTrack''' (marked with [[Image:Ide_db_RunStack_dn.png]]) and '''TrapTrack''' items (marked with [[Image:Ide_db_RunStack_dn_rh.png]]) are backtracking points. The clause, marked by one of these items, will be resumed and the program execution will be continued after the corresponding failure or an error occurs.

The typical example of the '''Run Stack''' window is presented in the following picture:

[[Image:Ide_db_RunStack.png]]

'''Pop-up Menu'''

The '''Run Stack''' window has the pop-up context menu:

[[Image:Ide_db_RunStack_menu.png]]

For each selected item in the tree, this menu contains items:

*'''Refresh'''
*:It refreshes all the '''Run Stack''' window contents, rebuilds the tree.
*: It also refreshes the {{ide|Debugger#Variables Window|'''Variables'''}} window (if it is displayed).

*'''Go To Code'''
*:Activates the Prolog source editor and places the cursor at the Prolog clause corresponding to the item selected in the '''Run Stack''' window. If the item does not correspond to a Prolog module with debug information, then the '''Disassembly''' window will be opened and the cursor will be placed onto the corresponding assembler instruction. The same action is caused by double-click a predicate call in the '''Run Stack''' window.

*'''Copy Line'''
*:It copies the selected line contents to the clipboard.

*'''Show Domains'''
*:This option turns ON/OFF displaying domains of variables.

*'''Show Values'''
*:This option turns ON/OFF displaying values of variables.

The '''Run Stack''' window can be activated by the IDE menu '''View | Run Stack'''.

=== Variables Window ===
----
The '''Variables''' window can be activated either by '''Ctrl+Alt+V''' or from the IDE menu '''View | Variables for Current Clause'''.

'''Variables Window Contents'''

The '''Variables''' window displays the tree of all program variables and facts from the traced clause, which are already created by the program at the current tracing step. These are: all variables and all object facts (fact variables), which are created in the clause before the executing instruction, and all class facts (fact variables), which can be used in this clause (declared in this class implementation).

The top line of the window displays the declaration of the predicate, whose clause is executed.

[[Image:Ide_db_Vars_Top.png]]

The '''Variables''' window content is updated after every trace step.

'''Pop-up Context Menu'''

The '''Variables in the Current Clause''' window has the following pop-up context menu:

[[Image:Ide_db_Vars_Menu.png]]

This menu contains items:

*''Insert into Watch Window''
*:Opens the '''Watch Window''' and moves there selected variable.

*''Copy''
*:This command copies the contents of the line selected in the '''Variables''' window to the clipboard.

*''Show as Hexadecimal''
*:Shows integral values in the hexadecimal format.

*''Show as Decimal''
*:Shows integral values in the decimal format.

*''Show as Octal''
*:Shows integral values in the octal format.

*''Show Domains''
*:This option turns '''ON/OFF''' displaying the domains after variable names.

*''Show Variable Addresses''
*:This option turns '''ON/OFF''' displaying the addresses after variable names.

*''Find''
*:This command allows search variable by name.

*''Copy Tree''
*:This command copies the contents of the window to the clipboard.

=== Facts Window ===
----
'''Class Facts'''

The '''Facts''' window always shows the current contents of all '''class''' fact databases defined in the program being debugged.

Simple example:

[[Image:Ide_db_Facts_View.png]]

Pressing '''CTRL+ALT+F''' opens '''Facts''' window:

[[Image:Ide_db_Facts_View3.png]]

Clicking icons opens sub-trees:

[[Image:Ide_db_Facts_View4.png]]

'''Facts''' window automatically goes to the fact that is selected in the text editor (if any):

[[Image:Ide_db_Facts_View11.png]]

[[Image:Ide_db_Facts_View41.png]]

'''Objects Facts''' you cat look like a components of object variables in the {{ide|Debugger#Variables Window|'''Variables''' window}}

'''Pop-up Context Menu'''

The '''Facts Window''' has the following pop-up context menu:

[[Image:Ide_db_Vars_Menu.png]]

This menu contains items:

*''Insert into Watch Window''
*:Opens the '''Watch Window''' and moves there selected fact.

*''Copy''
*:This command copies the contents of the line selected in the '''Facts''' window to the clipboard.

*''Show as Hexadecimal''
*:Shows integral values in the hexadecimal format.

*''Show as Decimal''
*:Shows integral values in the decimal format.

*''Show as Octal''
*:Shows integral values in the octal format.

*''Show Domains''
*:This option turns '''ON/OFF''' displaying the domains after facts names.

*''Show Addresses''
*:This option turns '''ON/OFF''' displaying the addresses after facts names.

*''Find''
*:This command allows search fact by name.

*''Copy Tree''
*:This command copies the contents of the window to the clipboard.

=== Breakpoints Window ===
----
==== Introduction ====

The '''Breakpoints''' window shows all breakpoints, which have been set in the program being debugged.

You can set a breakpoint onto any executable line in program source files (or in the '''Disassembly''' window, where a breakpoint can be set on any instruction of the program being debugged).

There are two kinds of breakpoints: hard and soft. Hard breakpoints are active in any debugging mode. Soft breakpoints are active in normal debugging mode but disabled in a special mode of quick debugging, called ''Fast Forward Mode''.

==== Breakpoints Window Contents ====

The '''Breakpoints''' window for each breakpoint includes '''Status''', '''Source''', '''Line''', '''Count''', '''Comment''' and '''Action''', where:

*'''''Status'''''
*:Shows whether the breakpoint is ''hard'' or ''soft''.
**''Hard''
**:If a breakpoint is ''hard'' then it will be activated in any debugging mode. A hard breakpoint is marked with the filled circle [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_assembler.png]] (for assembler) or [[Image:Ide_db_BreakPoints_shifted.png]] (for relocated breakpoint).
**''Soft''
**:If a breakpoint is ''soft'' then it will be activated only in normal (not Fast Forward) debugging mode. A soft breakpoint is marked with the hollow circle [[Image:Ide_db_BreakPoints_dis.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]] (for assembler).
**''Invalid''
**:A breakpoint is invalid when it is set on a line, which does not contain executable code. An invalid breakpoint is marked with the crossed hollow circle [[Image:Ide_db_BreakPoints_invalid.png]].

*'''''Source'''''
*:This column shows the source string:
*:<vipbnf><SourceName></vipbnf>
*:where:
*:''SourceName''
*:The description of a predicate in the address space of whose clauses the breakpoint is set:
*:*If the breakpoint is set in Prolog sources, then ''SourceName'' is the filename in which the breakpoint is set. It is displayed with the format:
*::<vipbnf><FileName> '(' <Path> ')'</vipbnf>
*::The ''Path'' can use {{ide|Make Facility#Build Symbols|Build script symbols}}.
*:* If the breakpoint is set in the '''Disassembly''' window, then ''SourceName'' has the format:
*::<vipbnf>--- assembler: <AddressValue></vipbnf>
*::''AddressValue'' is the hexadecimal address of the breakpoint in the assembler code of the predicate in which the breakpoint is set.

*'''''Line'''''
*:When the breakpoint is set in a Prolog source file, then this column displays the number of the line the breakpoint is set on. When the breakpoint is set in the Disassembly window, then the number of the line is equal to 0.

*'''''Count'''''
*:This column displays {{ide|Debugger#Breakpoint Properties|counts}} of breakpoints.

*'''''Comment'''''
*:This column displays {{ide|Debugger#Breakpoint Properties|comment strings}} of breakpoints.

*'''''Action'''''
*:This column displays the script text of a breakpoint. The script is performed each time the program reaches the breakpoint.

==== Breakpoints in Prolog and Disassembly Windows ====

Breakpoints can be set in Prolog source files and in the '''Disassembly''' window:

* In Prolog sources valid breakpoints can be set only on lines containing executable instructions. That is, breakpoints can be set only in predicate clauses on lines containing predicate calls, otherwise the breakpoints that are set on non-clause lines would be marked as invalid. The breakpoints that are set on clause lines that do not contain predicate calls would be shifted to the lines containing such calls (if any), but the initial line would be marked with [[Image:Ide_db_BreakPoints_shifted.png]]. Valid breakpoints are marked with red circles [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_dis.png]] in Prolog sources and are shown in the '''Disassembly''' window as blue circles [[Image:Ide_db_BreakPoints_assembler.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]]. If a Prolog clause has several assembler implementations (when the clause has several flow patterns), then each breakpoint in Prolog sources can generate several breakpoints in the '''Disassembly''' window.
* Breakpoints that are set in the '''Disassembly''' window are marked with red circles [[Image:Ide_db_BreakPoints_en.png]] or [[Image:Ide_db_BreakPoints_dis.png]]. Such breakpoint can be later overwritten by a breakpoint (marked with blue circles [[Image:Ide_db_BreakPoints_assembler.png]] or [[Image:Ide_db_BreakPoints_assembler_disabled.png]]) that is set in Prolog sources on the same address as the breakpoint set in the '''Disassembly''' window. Notice that after modification and recompilation of the project some breakpoints that are set in the '''Disassembly''' window can be cleared (if other instructions are placed at breakpoint addresses.)

All breakpoints which are set in a program are seen in the '''Breakpoints''' window.

==== Breakpoint Properties ====

Each breakpoint has properties, which can be modified in the '''Breakpoint Properties''' dialog:

[[Image:Ide_db_BreakPoint_Properties.png]]

In this dialog:

The top line contains:

* If the breakpoint is set in Prolog sources, then the top line has format:
*:'''<vipbnf>File: <FileName> Line: <LineNumber></vipbnf>'''
*:''FileName'' is the name of the Prolog source file in which the breakpoint is set.
*:''LineNumber'' is the number of the line on which the breakpoint is set.

* If the breakpoint is set in the '''Disassembly''' window, then the top line has format:
*:'''<vipbnf>Breakpoint Address:<Address></vipbnf>
*:''Address'' is the breakpoint address in the program memory as it is seen in the '''Disassembly''' window.

'''Count''' ''Value''
:Shows the current number of activations of the breakpoint since its creation. The user cannot modify this value. This value increases by 1 each time when the program reaches the breakpoint.

'''Hard'''
:This check box controls the ''Hard/Soft'' state of the breakpoint. When you turn a breakpoint to Hard, then it will be activated in any debugging mode. When you turn a breakpoint to Soft, then it will be activated only in normal (not Fast Forward) debugging mode.

'''Comment''' ''Comment string''
:In this edit box you can type in a ''Comment string''. By default it has the value of the corresponding line in the source file.

'''Action''' ''Script text''
:In this box you can type in a ''Script text''.

'''Note.''' If a module has been built without debug information (this can be done by changing <vp>/debug:full</vp> to <vp>/nodebug</vp> in the command line compiler options in the
{{ide|Project Settings#Build Options Tab|build script rules}} for <vp>pro->obj:</vp> and <vp>pack->obj:</vp>) then you will not be able to set a breakpoint in the Prolog sources of the module.

Notice that it does not matter in which window you remove a breakpoint (in Prolog sources, in the '''Breakpoints''' window or in the '''Disassembly''' window). In any case, removing a breakpoint deletes the breakpoint from the program.

==== Pop-up Menu ====

The '''Breakpoints''' window has the pop-up context menu:

[[Image:Ide_db_BreakPoints_pop_up.png]]

To activate this menu, select a breakpoint and press the right mouse button. This menu contains items:

*'''Go to Source'''
*:If the breakpoint is set in the Prolog sources, then the '''Go to Code''' activates the Prolog source code editor, and moves the cursor to the Prolog code corresponding to the specified breakpoint. If the breakpoint is set in the '''Disassembly''' window, then the '''Go to Code''' moves the view to this breakpoint in the '''Disassembly''' window. The same action is performed by double-click the breakpoint or by pressing the '''Enter''' on the breakpoint.

*'''Properties'''
*:Invokes the {{ide|Debugger#Breakpoint Properties|'''Breakpoint Properties'''}} dialog for the selected breakpoint.

*'''Toggle (Turn to Hard/Soft)'''
*:Switches the ''Hard/Soft'' state of the selected breakpoints.

*'''Delete'''
*:Deletes the selected breakpoints.

*'''Turn to Hard All'''
*:Sets the state of all breakpoints that are set in the program to ''Hard''.

*'''Turn to Soft All'''
*:Sets the state of all breakpoints that are set in the program to ''Soft''.

*'''Remove All'''
*:Removes all breakpoints that are set in the program.

The '''Breakpoints''' window is auto-updated for any breakpoint updating.

The '''Breakpoints''' window can be activated either by '''Ctrl+Alt+B''' or from the IDE menu '''View | Breakpoints'''.

=== Threads Window ===
----
The '''Threads''' window shows information about the process being debugged and its threads.

The '''Threads''' window looks like following:

[[Image:Ide_db_Threads.png]]

Names displayed in the header of the window columns are the following:

*'''TID'''
*:This column displays thread identifiers of all threads created by the process being debugged.
*'''Current'''
*:This column identifies the current thread by the <vp>*</vp> sign. In the {{ide|Debugger#Variables Window|Variables}} window you can see only variables of predicates executed in the current thread.
*'''State'''
*:Displays states of threads. States can be '''''Running''''', '''''Stopped''''', and '''''Suspend'''''.
*: '''''Running''''' The thread has been started, it is not suspended (see <vp>thread::suspend/0-></vp>, <vp> syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>) or terminated (see <vp>thread::terminate/1</vp>).
*: '''''Suspend''''' The thread is in suspended state (see <vp>thread::createSuspended/3</vp>, <vp>thread::suspend/0-></vp>, <vp>syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>).
*: '''''Stopped''''' The thread was created and then stopped on a breakpoint, but it is not suspended (see <vp>thread::suspend/0-></vp>, <vp>syncObject::wait/0-></vp>, <vp>syncObject::wait/1-></vp>). If you set suspended state to a '''''Stopped''''' thread, then it turns into the '''''Suspend''''' state.
*'''Time'''
*:Thread creation time.
*'''User time'''
*:Processor time in the user-mode used by the thread.
*'''Kernel Time'''
*:Processor time in the kernel-mode used by the thread.
*'''Priority'''
*:The priority level of the thread. Here can be displayed the following numbers <vp>2, 1, 0, -1, -2</vp>.
*'''Predicate'''
*:This field contains the name of the currently executed thread's predicate (if it is possible to determine it).

{|{{prettytable}}
|-
! Displayed Number
! Priority Name
! Description
|-
| 2
| '''Highest'''
| The thread can be scheduled before threads with any other priority.
|-
| 1
| '''AboveNormal'''
| The thread can be scheduled after threads with '''Highest''' priority and before those with '''Normal''' priority.
|-
| 0
| '''Normal'''
| The thread can be scheduled after threads with '''AboveNormal''' priority and before those with '''BelowNormal''' priority. Threads have Normal priority by default.
|-
| -1
| '''BelowNormal'''
| The thread can be scheduled after threads with '''Normal''' priority and before those with '''Lowest''' priority.
|-
| -2
| '''Lowest'''
| The thread can be scheduled after threads with any other priority.
|}

'''Pop-up Menu'''

The '''Threads''' window has the pop-up context menu. The same commands can be activated from the '''Thread''' sub-menu of the IDE task menu.

[[Image:Ide_db_Threads_popup.png]]

*'''Goto Source'''
*:Opens the text editor and places the cursor onto the predicate, which created the selected thread.
*'''Set Current'''
*:Sets the selected thread as current.
*'''Resume'''
*:Resumes the run of the selected thread.
*'''Suspend'''
*:Suspends the selected thread.
*'''Copy'''
*:Copies the contents of the line selected in the '''Threads''' window to the clipboard.
*'''Copy All'''
*:Copies the contents of the '''Threads''' window to the clipboard.

The '''Threads''' window is updated after changing any displayed parameter.

The '''Threads''' window can be activated either by '''CTRL+Alt+H''' or from the IDE menu '''View | Threads'''.

=== Disassembly Window ===
----
==== Disassembly Window Contents ====

The '''Disassembly''' window shows the assembly language interpretation of the inspected code.

The disassembly starts from the specified top address toward the upper memory and prints each instruction on a new line.

Each line is printed by the pattern:

<vipbnf><LineMarkers> <Address> [ <HexCode> ] <AssemblerCommand></vipbnf>

where:

''LineMarkers''
:Are the {{ide|Debugger#Debug Menu Commands|''instruction pointer''}} [[Image:Ide_db_InstructionPointer.png]] and the breakpoint[[Image:Ide_db_BreakPoints_en.png]] (or [[Image:Ide_db_BreakPoints_dis.png]]) markers, which can mark this line.
''Address''
:The start address of the instruction code.
''HexCode''
:This is the hexadecimal instruction code. This field can be shown/hidden from the pop-up menu of the '''Disassembly''' window by checking the '''Show OpCodes''' item.
''AssemblerCommand''
:This is the assembler command corresponding to the instruction code. Assembler commands have the Intel standard assembler abbreviation. If a certain address is resolved to an external name, then this name will be printed in the command column.
: The instruction, which will be executed at the next trace step, is marked with the [[Image:Ide_db_InstructionPointer.png]] ''Instruction pointer'' in the ''LineMarkers'' field.

Example:

[[Image:Ide_db_DisAsm_View.png]]

==== Pop-up Menu ====

The '''Disassembly''' window has the pop-up context menu with the followin commands:

*'''Go To Address'''
*:Invokes the '''Go to Address''' dialog
*:[[Image:Ide_db_DisAsm_Go2Address.png]]
*:to type in the address of the instruction, which should be displayed in the top line of the '''Disassembly''' window. The ''Address'' should be specified in the hexadecimal format. This dialog allows typing symbolic external link names and symbolic CPU register names.
*'''Go To EIP'''
*:Updates the '''Disassembly''' window and places the cursor at the address of the instruction on which the program execution is suspended.
*'''Breakpoint…'''
*:Allows handling the breakpoint [[Image:Ide_db_BreakPoints_en.png]] (or [[Image:Ide_db_BreakPoints_dis.png]]) for the assembler instruction pointed by the cursor. It has the following sub-commands:
*:[[Image:Ide_db_DisAsm_PopUp.png]]
*:*'''Toggle Breakpoint'''
*:*:Sets or removes a breakpoint at the instruction with the address pointed by the cursor.
*:*'''Enable / Disable'''
*:*:''Enables / Disables'' the breakpoint pointed by the cursor. This item is disabled if there is no breakpoint at the address pointed by the cursor.
*:*'''Properties'''
*:*:Invokes the '''Breakpoint Properties''' dialog for the breakpoint pointed by the cursor. This item is disabled if there is no breakpoint at the address pointed by the cursor.
*'''Go To Source'''
*:Activates the IDE source code editor and sets the cursor at the predicate whose assembler instruction is pointed by the cursor in the '''Disassembly''' window. (When it is possible.)
*'''Copy'''
*:Copies lines selected in the '''Disassembly''' window to the clipboard. A selection can be performed with the '''Shift+Up Arrow''' and '''Shift+Down Arrow''' key combinations.
*'''Show OpCodes'''
*:Checking and unchecking this item hides/shows hex images of operation (instruction) codes ('''OpCodes'''). These hex instruction codes are shown in the ''HexCode'' field.
*'''Source Annotation'''
*:Checking OFF/ON this item hides/shows object names, corresponding to predicate entry points. Each object name is printed on a new line before the corresponding instruction line.
*'''Show Hints'''
*:Shows additional information about the instruction being executed.

The '''Disassembly''' window is updated after each trace step of the debugger.

==== Disassembly Window Commands ====

*'''Trace Into''' ('''F11''') command
*:Tracing in the '''Disassembly''' window with the '''Step Into''' ('''F7''') command performs execution of one assembler instruction (including entering into procedures if any). That is, if the '''Step Over''' command will execute a <vp>call</vp> instruction as one trace step, then the '''Step Into''' command will go into the called procedure. It usually executes disassembler instructions line after line.
*'''Step Over''' ('''F10''') command
*:Tracing in the '''Disassembly''' window with the '''Step Over''' ('''F10)''' command performs execution of one assembler instruction (including execution of <vp>call</vp> instructions). So the '''Step Over''' ('''F10''') command works almost the same way as the '''Trace Into''' ('''F11''') command except for execution of <vp>call</vp> instructions. In difference to the '''Trace Into''' ('''F11''') command, it tries to perform <vp >call</vp> instructions as one step and reaches the next line only if the called code returns to that line.
*'''Run to Cursor''' ('''CTRL+F10''') command
*:Tracing in the '''Disassembly''' window with the '''Run to Cursor''' ('''CTRL+F10''') command works in the following way. The debugger places an invisible breakpoint at the address corresponding to the instruction specified by the cursor and performs the '''Debug Run''' ('''F5''') command. It depends only upon the program code whether the program will reach this instruction or will never reach it.

The '''Disassembly''' window can be activated:

* by '''Shift+Alt+1'''
* by '''Ctrl+D''' from the traceable source code. The topmost line of the '''Disassembly''' window displays the address of the disassembler instruction corresponding to the predicate pointed by the cursor in the source code.
* from the IDE menu '''View | Disassembly'''

If the tracing code has no debug information, then the '''Disassembly''' window is opened initially (when the debugger starts) and the instruction pointer [[Image:Ide_db_InstructionPointer.png]] points to the executing assembler instruction.

=== Registers Window ===
----
The '''Registers''' window shows current values of the CPU (Central Processor Unit) registers:

* General registers
* Segment registers
* Flags
* Floating-point registers

A register value is printed:

* '''red''', if it is changed from the last program trace step
* '''blue''', otherwise.

For example:

[[Image:Ide_db_Registers_fpu.png]]

The '''Floating Point''' command from context pop-up menu can be used to turn ON/OFF the displaying of Floating-point registers.

The '''Registers''' window can be activated either by '''Ctr+ Alt+G''' or from the IDE menu '''View | Registers'''.

=== Modules Window ===
----
The Modules Window shows all the modules currently loaded in this debug session. It shows the filename, path, the base address range, the code address range and the type of debug information.

[[Image:Ide_db_Modules.png]]

=== Memory Dump Window ===
----
The '''Memory Dump''' window shows the virtual memory dump of the program being debugged. Memory dump lines have the length, which is determined by the window width. The number of printed lines window height.

'''Information Displayed in the Memory Dump Window'''

Each line in the '''Memory Dump''' window is printed by the pattern:

<vipbnf><Address> | [ <HexValues> ] [ <ASCIIcharacters> ] [ <UnicodeCharacters>]</vipbnf>

where:

''Address''
:This is the hexadecimal address of the first byte of the memory displayed in this line.
''HexValues''
:<vipbnf><HexValues> : <HexValue> [ <HexValues> ]</vipbnf>
:This is the hexadecimal format of the memory dump. Each hex value can be an image of one, two, four or eight continued memory bytes (this is contolled by the '''Memory Dump''' window content pop-up menu).
''ASCIIcharacters''
:<vipbnf><ASCIIcharacters> : <ASCIIcharacter> [ <ASCIIcharacters> ]</vipbnf>
:This is the same memory dump but in the format of ASCII characters (a character represenrs one byte). Unprintable characters are printed as dots.
''UnicodeCharacters''
:<vipbnf><UnicodeCharacters> : <UnicodeCharacter> [ <UnicodeCharacters> ]</vipbnf>
:This is the same memory dump in the format of Unicode characters (a character represents two bytes). Unprintable characters are printed as dots.

Example:

[[Image:Ide_db_Memory_view1.png]]

The '''Memory Dump''' window title shows the module name, which memory is displayed in the window. If the module name cannot be determined, then the title displays ''Unknown module''.

'''Content Pop-up Menu'''

The '''Memory Dump''' window has the pop-up context menu which contains commands:
*'''Go To Address'''
*:'''Ctrl+G'''. Invokes the '''Go to Address''' dialog
*:[[Image:Ide_db_DisAsm_Go2Address.png]]
*: to type a new top address in hex format. This dialog allows typing symbolic external link names and symbolic CPU register names. Double-click in the '''Memory Dump''' window area also activates the '''Go to Address''' dialog.
*'''Go To ''Ptr'''''
*:'''Ctrl+Shift+G'''. Updates the '''Memory Dump''' window starting the first line from the address shown as ''Ptr'' (address defined by the memory contents of four or eight continued bytes at which the cursor is pointing if one of '''4-byte Integer''' or '''8-byte Integer''' is selected).
*'''Undo Go to'''
*:'''Alt+Left Arrow'''. Updates the '''Memory Dump''' window view to start from the previously used top (the first line) address.
*'''Redo Go to'''
*:'''Alt+Right Arrow'''. This operation is the counterpart to the '''Undo Go to'''. It updates the '''Memory Dump''' window view to start from the "next" top address, which was used before the '''Undo Go to''' command was implemented.
*'''Set Memory Breakpoint'''
*:This operation sets a memory breakpoint at address from the left pane.
*'''Remove Memory Breakpoint'''
*:This operation removes a previously set a memory breakpoint.
*'''Copy'''
*:Copies the selected lines to the clipboard. To select a line, click on it while holding the '''shift''' key. You can select multiple lines at one time.
*'''Copy ''Ptr'''''
*:'''Ctrl+C'''. Copies hexadecimal representation of the specified address (four or eight bytes) to the clipboard.
*'''Refresh'''
*:Refresh the '''Memory Dump''' window contents.
*'''Write Block'''
*:This command opens the '''Write Memory Block''' dialog:
*:[[Image:Ide_db_Memory_BlockWrite.png]]
*:*'''Filename'''
*:*:Here you should type in the name of a file in which the specified memory block should be saved.
*:*'''Start Address'''
*:*:Here you should specify a hexadecimal start address of the memory block.
*:*'''Length'''
*:*:Here you should specify a hexadecimal length in bytes of the memory block.
*'''Show Hex'''
*:Shows the column, which displays the memory dump in the hexadecimal format. This is the ''HexValues'' column in the right pane.
*'''Show ASCII'''
*:Shows the column, which displays the '''''ASCII''''' format of the memory dump. This is the ''ASCIIcharacters'' column in the right pane.
*'''Show Unicode'''
*:Shows the column, which displays the '''''Unicode''''' format of the memory dump. This is the ''UnicodeCharacters'' column in the right pane.
*'''Update Speed...'''
*:Defines the rate of the Memory Dump window updating:
*:[[Image:iDE_db_Memory_menu1.png]]
*:*'''High'''
*:*:Performs automatic updating with the high rate.
*:*'''Normal'''
*:*:Performs automatic updating with normal rate.
*:*'''Low'''
*:*:Performs automatic updating with low rate.
*:*'''Manual'''
*:*:No automatic updating.
The '''Memory Dump''' window can be activated either by '''CTRL+Alt+M''' or from the IDE menu '''View | Memory Dump'''.

Ide/Creating new Project Items/Creating a COM Package

2013-04-18T07:23:28Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
'''How to Import an Existing COM Component'''
=== Terminology Used in COM ===

The Component Object Model (COM) is a way for software components to communicate with each other. It is a binary standard that allows any two components to communicate regardless of what machine they are running on (as long as the machines are connected), what operating systems the machines are running (as long as they support COM), and what language the components are written in. COM provides location transparency: it does not matter whether components are in DLLs or in EXEs. COM components are binary units of code that include packaging and registration code and that create COM objects. Each COM component, in the COM programming model, is a programming structure encapsulating both data and functionality. It is defined and allocated as a single unit and the only public access to the COM data and functionality is through the programming interfaces.

Each COM is simply a program module: a DLL or an EXE file. It can contain one or more COM ''components''. (In Microsoft MSDN terminology ''components'' are ''coclasses''.) Each component knows about several interfaces. (In MSDN terminology - each component can support several interfaces.) Each component supports the default interface '''iUnknown'''. Using the '''iUnknown::queryInterface/2->''' predicate from the '''iUnknown''' interface, one can retrieve references to all interfaces known to a component. Each interface can provide several predicates (methods).

The main aim of importing a COM component into your project is using predicates defined in this COM component. Therefore, the COM package generated for an imported COM component has to provide some wrapper (glue code) to methods implemented in the COM component. That is, the generated COM package must provide declarations of correspondent interfaces, predicates, and domains.

=== How to Create a New COM Package ===

To create a COM package providing the interface (wrapper) to some COM component, you should activate the '''File | New''' IDE command. Then in the left pane of the opened '''Create Project Item''' dialog you should select '''COM Package'''. Then the dialog accepts the following shape:

[[Image:Ide_How_COMPackage.png|center|frame|Creating '''New COM Package''' Dialog]]

After you fill in all required COM package settings, you can press the '''Create''' button. Then the IDE creates the package subdirectory, the package header file (<vp>XML.ph</vp> for the above picture), and the package implementation file (<vp>XML.pack</vp> for the above picture). They appear in the project tree in the Project Window after the created package is compiled.

=== Options ===

'''Name:'''
:In the '''Name''' edit control you should type in the name (<vp>XML</vp> on the picture) of the COM package (wrapping package) being created.

'''Parent Directory'''
:In the '''Parent Directory''' you should type in or select (using the '''Browse''' button) the ''parent directory'' for the package. The package will be placed into the subdirectory of this ''parent directory''. If you specify a non-existing name, then this directory will be created. By default, '''Parent Directory''' displays the directory selected in the project tree when you activate this dialog. If this directory is one of the project subdirectories, then its path is displayed relatively to the project root directory. If '''Parent Directory''' is empty, than it is equal to the project root directory.
:In the '''Parent Directory''' the IDE creates the new subdirectory with the name correspondent to the specified package name. (It is <vp>XML</vp> for the above picture.). The package will be placed into this subdirectory.

'''Source''' Group Box

Controls in this group box are used to specify a COM module ('''DLL''' or '''EXE''') from which a component should be imported. It contains the following controls:

*'''Type Library'''
*:When this option is checked ON, then in the edit control you should specify a file that contains the ''type library'' describing the COM component.
*:Press the '''Load''' button to activate the '''Load Type Library File''' dialog using which you can find and insert the name of the type library file into the edit control.
*: '''Attention!''' Notice that you '''HAVE to''' press the '''Load''' button to enforce the IDE to load the COM information from the specified type library even if you directly type in the type library filename into the edit control.
*: If a COM client (our program importing COM server components) needs using COM server predicates, then the client application must have information about predicates in COM server components. Predicates often return values and accept parameters. The COM client requires declarations of all these predicates (and domains) in order to use them. This information can be made known in several ways. The Microsoft recommended way is to create a type library. (Remember that type libraries do not provide Prolog declarations.) Type library information can be stored in files with the following filename extensions: '''.tlb''' (type library itself), '''.olb''' (multiple type libraries or foreign object libraries), '''.dll''' (COM DLLs can embed type library resources), '''.exe''' (COM EXEs can embed type library resources), '''.ocx''' (ActiveX controls).

*'''TypeLib ID'''
*:When this option is checked ON, then in the edit control you should specify the '''TypeLib ID''' of the ''type library'' for the COM component that you wish to import. The '''TypeLib ID''' is a universally unique identifier (UUID) under which the type library is registered in the Windows system registry. (See '''CLSID''' for more information.) The '''TypeLib ID''' should be specified as a string of hexadecimal numbers with the following format:
*: <vipbnf>{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}</vipbnf>
*:Then you '''MUST''' press the '''Load''' button to enforce the IDE to load COM information from the type library registered with this '''TypeLib ID'''.
*:In the system registry database you can find all registered '''TypeLib ID'''s under:
*:'''<vipbnf>HKEY_CLASSES_ROOT\TypeLib = {TypeLib ID}</vipbnf>'''

*'''CLSID'''
*:When this option is checked ON, then in the edit control you should specify the '''CLSID''' of the COM component that you wish to import. The '''CLSID''' should be specified as a string of hexadecimal numbers with the following format:
*:<vipbnf>{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}</vipbnf>
*:Then you '''MUST''' press the '''Load''' button to enforce the IDE to load COM information from the COM module that embeds the COM component with the specified '''CLSID'''.
*: '''Note.''' Really a COM module can embed several COM components. If you wish to import one of these COM components, then you can specify a CLSID registered to any COM component in this COM module. (Later you will be able to specify the required COM component (or interface) in the list box in the '''Import''' group box.)
*: In MSDN terminology, '''CLSID''' is a class identifier. In the Visual Prolog PFC terminology (see the COM package description in the PFC) '''CLSID''' is a COM component identifier.
*:'''CLSID''' is a universally unique identifier (UUID) that identifies the type of a COM component. Each COM component has its '''CLSID''' in the Windows system registry database so that it can be loaded and used by other applications. For example, a spreadsheet can create worksheet components, chart components, and macrosheet components. Each of these components has its own '''CLSID''' that uniquely identifies this component to the system. That is, if your COM module (COM server or COM container) allows linking to its embedded components, then you need to register the special '''CLSID''' for each COM component embedded into the COM module.
*:The '''CLSID''' is stored in the Windows registry database under the following registry key:
*:'''<vipbnf>HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID = {CLSID}</vipbnf>'''
*:The '''CLSID''' is a 128-bit number (in the hexadecimal format) within a pair of curly braces. Typically, '''CLSID'''s (and other UUID values) are represented as strings of hexadecimal numbers with the following format:
*:<vipbnf>{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}</vipbnf>
*:For example,
*:<vipbnf>{4208fb66-e22a-11d1-a7d7-00a0c982c00d}</vipbnf>
*:You can use the '''UUIDGEN.exe''' tool to create a new UUID.
*:When you find a '''CLSID''' you can find the associated '''PROGID''' under the following registry sub-key:
*:'''<vipbnf>HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{CLSID}\ProgID = <programatic identifier></vipbnf>'''
*:See the '''PROGID''' options description below.
*: '''Universally unique identifier (UUID)'''
*: The universally unique identifier (UUID) is also known as the globally unique identifier (GUID). The UUID, or GUID, is a unique, 128-bit value used to identify objects. Objects can be OLE servers, interfaces, client objects, etc. Beginning from this moment objects will be identified with UUIDs.

*'''PROGID'''
*:When this option is checked ON. In the edit control you should specify the '''PROGID''' of the COM module from which you wish to import the COM component. The '''PROGID''' should be specified as a string of the following format:
*:'''<Program>.<Component>.<Version>'''
*: Words are separated by dots as in <vp>Word.Document.6</vp>. (Blank spaces cannot be used.)
*:Then you '''MUST''' press the '''Load''' button to enforce the IDE to load COM information from the COM module registered with this '''PROGID'''.
*:'''PROGID'''s are versioned programmatic identifiers. '''PROGID'''s present human-readable versions of class identifiers ('''CLSID''') used to identify COM components. '''PROGID''' is a registry entry that can be associated with '''CLSID'''. Like '''CLSID''', '''PROGID''' identifies a COM component but with less precision because it is not guaranteed to be globally unique. The ''<vp>Version</vp>'' portion is optional but strongly recommended. Using ''<vp>Version</vp>'', even if there is only one version of the '''PROGID''', helps to avoid conflicts. It enables different versions of a component coexist without overwriting '''PROGID'''s. If you do not specify a version for a '''PROGID''', the default ''<vp>Version</vp>'' <vp>= 1</vp>.
*:How to find '''PROGID''' entries in the registry is described in the '''CLSID'''.

*'''IID'''
*:When this option is checked ON, then in the edit control you should specify the '''IID''' of the COM component interface that you wish to import.
*:'''IID''' is a universally unique identifier (UUID) that uniquely identifies a particular COM interface. '''IID''' should be specified as a string of hexadecimal numbers with the following format:
*:<vipbnf>{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}</vipbnf>
*:Then you '''MUST''' press the '''Load''' button to enforce the IDE to load COM information from the COM module that embeds the interface with the specified '''IID'''.
*:Really you can specify an '''IID''' registered to any interface embedded into the same COM module that embeds the interface you wish to import. (Later you will be able to specify the required COM component (or interface) in the list box in the '''Import''' group box.)
*:In the system registry database you can find all registered '''IID'''s under:
*:'''<vipbnf>HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Interface</vipbnf>'''

Ide/Creating new Project Items/Creating a Class

2013-04-17T10:44:13Z

GalinaTchekmareva:

<noinclude>[[Category:Ide]]</noinclude>
'''How to Create a New Class?'''

The declaration of a class defines how the class appears to the surroundings. The surroundings can see and use only those constants, domains, and predicates that are declared in the class declaration. If the class states an interface as the construction type, then the class can construct objects of that type. Everything mentioned in the class declaration belongs to the class, rather than to objects it constructs. Any class declaration must have the accompanying class implementation. The definitions of the predicates declared in the class declaration should be provided by the class implementation.

To create a new class and to add it into one of packages registered in the project you should activates the '''File | New''' IDE command. Then in the left pane of the opened '''Create Project Item''' dialog you should select '''Class'''. Then the dialog accepts the following shape:

[[Image:Ide_How_NewClass.png|center|frame|The '''New Class''' Dialog]]

'''Name:'''
:In the '''Name''' edit control you should type in a class name (the '''newClassName''' on the picture).

'''Package:'''
:In the '''Package''' list button you should select one of the packages registered in the project (the <vp>NewPackage.pack</vp> on the picture). The created class will be included into this package. The created files of this class will be placed into the selected package subdirectory. This subdirectory name is displayed after the package name; it is <vp>(NewPackage\)</vp> in the picture.

'''In namespace'''
:The '''In namespace''' check box controls whether the class will be put into the namespace (e.g. namespace1\newClassName). This allows the same interface/class name to be declared/defined in several name spaces in the same program.

After you fill in all required settings for the class, you can press the '''Create''' button. Then the IDE creates the class declaration and the class implementation (if '''New Interface''' was checked ON) files. These files will appear in the {{ide|Project Tree#The Project Tree|project tree}} in the '''Project Window''' after compilation of the package) and the <vp>#include @"NewPackage\newClassName.cl"</vp> directive will be added into the correspondent package header or the package implementation file.

Notice that information about a new class does not appear in the project {{ide|Code Experts#Source Browser|browse information}} until the class is compiled. To compile a new class, you can, for example, execute the '''Compile''' command for the package containing this class.