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

Ide/Code Experts

2019-09-11T11:42:28Z

Boris Belov: /* Options */

{{ideNavbar|Code Experts}}

Visual Prolog IDE contains several Code Experts:

* The {{ide|Project Settings|Project Settings}} feature, which generates all the default code, resources, and make-scripts for an application. It also handles modifications of project settings.
* The {{ide|Code Experts#Source Browser|Source Browser}} is used for searching of Visual Prolog names used in the edited project. This searching is accomplished in all files registered in this project.
* The {{ide|Code Experts#Insert Commands|Insert feature}} simplifies inserting of standard Visual Prolog program elements into the editing source code.
* The {{ide|Code Experts#Code Expert|Code Expert}} is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

== Source Browser ==

[[Image:Ide_SourceBrowser.png]]

The main aim of this tool is multi-file searching for Visual Prolog names used in the project. Displayed in the '''Source Browser''' dialog information is gathered by the compiler while compiling of the project files. Therefore, to update the "browse"information about any modifications in source files you need to recompile these files ('''Build''' menu commands can be used).

=== Options ===

'''Search for:'''
:Here you enter a string to search for. The search string can be specified by selecting a substring in the text editor before calling the '''Source Browser''' dialog. The selected text will appear in the '''Search for''' box.
: The '''Source Browser''' will search for the specified substring in any place of names (not only in the beginning). It will display all names containing this substring.

'''Search in:'''
:Selection in this group of check and radio buttons determines types of user defined names that will be displayed in main pane of the '''Source Browser''' dialog. Here you can select:

:*'''All'''
::If you check ON the '''All''' check box, the '''Source Browser''' dialog will search the specified substring among all program items. In this case, any other check boxes will be disabled.

::The program item types you can specify in this group box are:
:*'''Predicates'''
::Specifies to search among predicates.
:*'''Properties'''
::Specifies to search among properties.
:*'''Facts'''
::Specifies to search among facts.
:*'''Domains'''
::Specifies to search among domains.
:*'''Constants'''
::Specifies to search among constants.
:*'''Classes'''
::Specifies to search among class names.
:*'''Interfaces'''
::Specifies to search among interface names.

'''Use Regular Expressions'''
:See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.

=== Search Results ===

The central pane of the '''Source Browser''' dialog displays Visual Prolog names, which are found in the project.

Type in some string into the '''Search for''' box and press '''Enter''' to activate the search operation.

After the search will be accomplished the central pane of the '''Source Browser''' dialog will display the tree of classes, interfaces, and class implementations in which the '''Search''' has found program items (of selected types) with names containing the specified substring. All items are prefixed with the same
{{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window. Clicking plus [[Image:Ide_Plus_Icon.png]] icons before a class/interface/implementation you can unfold it and see names, which are found in it.

Double-click any name will open the correspondent file in the text editor and jumps to this name.

When in the central pane of the dialog, the right mouse button will open the pop-up menu containing 2 commands:

*'''Go to Declaration'''
*:This command jumps to the declaration of the selected name.
*'''Go to Definition'''
*:This command jumps to the definition of the selected name.

== Code Expert ==

The '''Code Expert''' is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

"Modern" dialogs, forms and custom controls are handled by the {{ideSectionLink|Resource Editor}}.

You can activate the '''Code Expert''' when the focus is in the '''IDE Designer''' by selecting the '''Code Expert''' command in the mouse pop-up menu (or in the '''View''' menu, or alternatively by clicking the '''Ctrl+Shift+W''' hot key). Also you can activate the '''Code Expert''' when the focus is in the '''Project''' window and one of dialog or window type resource files is selected. Otherwise, the '''Code Expert''' command is disabled or the IDE displays the warning that the selected file is not associated with a dialog, window, form, or IDE control.

The name of the selected dialog or window file is displayed in the '''Code Expert''' title. On the picture below it is '''TaskWindow'''.

[[Image:Ide_dwe_defaultShape.png|center|frame|The Code Expert]]

In the upper line of the '''Code Expert''' you see 3 radio buttons: '''All''', '''Handled''' and '''Unhandled'''. Selecting among them you can specify which type of events will be displayed in the central pane:

'''All'''
:'''All''' events coming to the dialog or the window are displayed.
'''Handled'''
:Only events that are caught ('''Handled''') by the correspondent listener or responder are displayed.
'''Unhandled'''
:Only events that are not caught ('''Unhandled''') by the correspondent listener or responder are displayed.

In the central pane of the '''Code Expert''' dialog you see the tree of events that come to this dialog or form. Notice that the event tree displays all possible events that can come to a dialog or a form. So for some dialogs/windows the event tree can display some extra events that never come to these dialogs/forms. For example, if a dialog does not have scroll bars, its listener never receives <vp>HScroll</vp> and <vp>VScroll</vp>, but you can see these events in the event tree.

'''Handled''' events are marked with [[Image:Ide_Tick_mark.png]], and names of handler predicates are displayed after event names. '''Unhandled''' events are marked with [[Image:Ide_Bullet_mark.png]].

Notice that the code for the predicate <vp>generatedInitialize</vp> is 100% automatically maintained by the '''Code Expert'''. You '''MUST NOT''' make any manual correction of this predicate since any your corrections will be overwritten while the resource compilation. You can also see this code is surrounded with special comments '''''do not update it manually'''''

In the central pane you can see the following groups of events:

*'''Window'''
*:These are the events that came to the dialog/window as a whole entity.
*'''Menu'''
*:This group of events exist only for forms. These are the events that came to the form from the menu.
*'''Scroll Bar'''
*:These are the events that came to the dialog/form from the dialog/form scroll bars. Notice that these are not events from the scroll bar controls that you place inside dialogs/forms (events from the scroll bar controls you can see in the '''Control''' group of events).
*'''Control'''
*:These are the events that came to the dialog/form from controls placed in the dialog/form.
*'''Key'''
*:This group of events exist only for windows. These are the keyboard events.
*'''Mouse
*:These are the events that came to the dialog/form from the mouse.
*'''Miscellaneous'''
*:These are the miscellaneous events that do not fit to any of the previous types. They are timer, end session events and etc.

The '''Window''', '''Menu''', '''Scroll Bar''', '''Control''', '''Key''', '''Mouse''' and '''Miscellaneous''' nodes in the events tree can be preceded with the [[Image:Ide_Plus_Icon.png]] or [[Image:Ide_Minus_Icon.png]] icons. Pressing on these icons expands or collapses the correspondent node.

In the bottom of the '''Code Expert''' there are 2 buttons '''Add / Delete''' and '''Set''':

'''Add / Delete'''
:When an event selected in the event tree is '''Unhandled,''' this button has the caption '''Add'''. By pressing this button, you can add Â the clause handling this event into the dialog/form. In addition, the default declaration and definition for the event handling predicate are generated. When the selected event is '''Handled,''' then this button has the caption '''Delete'''. Pressing the '''Delete''' button, you can delete the clause handling this event from the dialog/form.
'''Set'''
:This button is enabled only when the selected event is '''Handled'''. Using the '''Set''' button, you can change the name of the event handling predicate. The clause for the new listener will be generated appropriately. However, the '''Code Expert''' will not delete/change code for the previously used listener. Notice that when the selected event is '''Unhandled''', the '''Set''' button is disabled, but in spite of this, you can type in the desired name of listener into the edit control. This name will be used instead of the default name when you press the '''Add''' button.

There are some advantages and some disadvantages to using the '''Code Expert'''. The main disadvantage is that the code experts insert some extra comments, which used to locate the source code at a later time. However the advantages are:

# It saves a lot of typing.
# It gives a standardized way of handling things, which other Prolog programmers will know.
# You know your application from the user interface; then by using the code experts, you can easily come to the source code through selection of the user interface component.

The '''Code Expert''' can automatically update the source code, when the layout or attributes of a user interface component are modified. This automatic updating is always done only inside comment brackets marked by:
<vip>% This code is maintained by the IDE. Do not update it manually
....% Some code handled by the Code Expert
% end of automatic code</vip>

Ide/Code Experts

2019-09-11T11:40:08Z

Boris Belov:

{{ideNavbar|Code Experts}}

Visual Prolog IDE contains several Code Experts:

* The {{ide|Project Settings|Project Settings}} feature, which generates all the default code, resources, and make-scripts for an application. It also handles modifications of project settings.
* The {{ide|Code Experts#Source Browser|Source Browser}} is used for searching of Visual Prolog names used in the edited project. This searching is accomplished in all files registered in this project.
* The {{ide|Code Experts#Insert Commands|Insert feature}} simplifies inserting of standard Visual Prolog program elements into the editing source code.
* The {{ide|Code Experts#Code Expert|Code Expert}} is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

== Source Browser ==

[[Image:Ide_SourceBrowser.png]]

The main aim of this tool is multi-file searching for Visual Prolog names used in the project. Displayed in the '''Source Browser''' dialog information is gathered by the compiler while compiling of the project files. Therefore, to update the "browse"information about any modifications in source files you need to recompile these files ('''Build''' menu commands can be used).

=== Options ===

'''Search for:'''
:Here you enter a string to search for. The search string can be specified by selecting a substring in the text editor before calling the '''Source Browser''' dialog. The selected text will appear in the '''Search for''' box.
: The '''Source Browser''' will search for the specified substring in any place of names (not only in the beginning). It will display all names containing this substring.

'''Search in:'''
:Selection in this group of check and radio buttons determines types of user defined names that will be displayed in main pane of the '''Source Browser''' dialog. Here you can select:

:*'''All'''
::If you check ON the '''All''' check box, the '''Source Browser''' dialog will search the specified substring among all program items. In this case, any other check boxes will be disabled.

::The program item types you can specify in this group box are:
:*'''Predicates'''
::Specifies to search among predicates.
:*'''Facts'''
::Specifies to search among facts.
:*'''Domains'''
::Specifies to search among domains.
:*'''Constants'''
::Specifies to search among constants.
:*'''Classes'''
::Specifies to search among class names.
:*'''Interfaces'''
::Specifies to search among interface names.

:Also you can select whether search for declarations or definitions of names or for both declarations and definitions of names:

:*'''Declaration'''
::Specifies to search only for declarations of items.
:'''Definition'''
::Specifies to search only for definitions of items.
:*'''Both'''
::Specifies to search both for definitions and declarations of items.

'''Stay Open'''
:When it is checked OFF, then double-click (or select the '''Locate''') any name will opens the correspondent file in the text editor and jumps to this name. The '''Source Browser''' dialog will be closed.
: If this check box is checked ON, then the '''Source Browser''' dialog will NOT be closed when double-click (or select the '''Locate''') a name.

'''Use Regular Expressions'''
:See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.

=== Search Results ===

The central pane of the '''Source Browser''' dialog displays Visual Prolog names, which are found in the project.

Type in some string into the '''Search for''' box and press '''Enter''' to activate the search operation.

After the search will be accomplished the central pane of the '''Source Browser''' dialog will display the tree of classes, interfaces, and class implementations in which the '''Search''' has found program items (of selected types) with names containing the specified substring. All items are prefixed with the same
{{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window. Clicking plus [[Image:Ide_Plus_Icon.png]] icons before a class/interface/implementation you can unfold it and see names, which are found in it.

Double-click any name will open the correspondent file in the text editor and jumps to this name.

When in the central pane of the dialog, the right mouse button will open the pop-up menu containing 2 commands:

*'''Go to Declaration'''
*:This command jumps to the declaration of the selected name.
*'''Go to Definition'''
*:This command jumps to the definition of the selected name.

== Code Expert ==

The '''Code Expert''' is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

"Modern" dialogs, forms and custom controls are handled by the {{ideSectionLink|Resource Editor}}.

You can activate the '''Code Expert''' when the focus is in the '''IDE Designer''' by selecting the '''Code Expert''' command in the mouse pop-up menu (or in the '''View''' menu, or alternatively by clicking the '''Ctrl+Shift+W''' hot key). Also you can activate the '''Code Expert''' when the focus is in the '''Project''' window and one of dialog or window type resource files is selected. Otherwise, the '''Code Expert''' command is disabled or the IDE displays the warning that the selected file is not associated with a dialog, window, form, or IDE control.

The name of the selected dialog or window file is displayed in the '''Code Expert''' title. On the picture below it is '''TaskWindow'''.

[[Image:Ide_dwe_defaultShape.png|center|frame|The Code Expert]]

In the upper line of the '''Code Expert''' you see 3 radio buttons: '''All''', '''Handled''' and '''Unhandled'''. Selecting among them you can specify which type of events will be displayed in the central pane:

'''All'''
:'''All''' events coming to the dialog or the window are displayed.
'''Handled'''
:Only events that are caught ('''Handled''') by the correspondent listener or responder are displayed.
'''Unhandled'''
:Only events that are not caught ('''Unhandled''') by the correspondent listener or responder are displayed.

In the central pane of the '''Code Expert''' dialog you see the tree of events that come to this dialog or form. Notice that the event tree displays all possible events that can come to a dialog or a form. So for some dialogs/windows the event tree can display some extra events that never come to these dialogs/forms. For example, if a dialog does not have scroll bars, its listener never receives <vp>HScroll</vp> and <vp>VScroll</vp>, but you can see these events in the event tree.

'''Handled''' events are marked with [[Image:Ide_Tick_mark.png]], and names of handler predicates are displayed after event names. '''Unhandled''' events are marked with [[Image:Ide_Bullet_mark.png]].

Notice that the code for the predicate <vp>generatedInitialize</vp> is 100% automatically maintained by the '''Code Expert'''. You '''MUST NOT''' make any manual correction of this predicate since any your corrections will be overwritten while the resource compilation. You can also see this code is surrounded with special comments '''''do not update it manually'''''

In the central pane you can see the following groups of events:

*'''Window'''
*:These are the events that came to the dialog/window as a whole entity.
*'''Menu'''
*:This group of events exist only for forms. These are the events that came to the form from the menu.
*'''Scroll Bar'''
*:These are the events that came to the dialog/form from the dialog/form scroll bars. Notice that these are not events from the scroll bar controls that you place inside dialogs/forms (events from the scroll bar controls you can see in the '''Control''' group of events).
*'''Control'''
*:These are the events that came to the dialog/form from controls placed in the dialog/form.
*'''Key'''
*:This group of events exist only for windows. These are the keyboard events.
*'''Mouse
*:These are the events that came to the dialog/form from the mouse.
*'''Miscellaneous'''
*:These are the miscellaneous events that do not fit to any of the previous types. They are timer, end session events and etc.

The '''Window''', '''Menu''', '''Scroll Bar''', '''Control''', '''Key''', '''Mouse''' and '''Miscellaneous''' nodes in the events tree can be preceded with the [[Image:Ide_Plus_Icon.png]] or [[Image:Ide_Minus_Icon.png]] icons. Pressing on these icons expands or collapses the correspondent node.

In the bottom of the '''Code Expert''' there are 2 buttons '''Add / Delete''' and '''Set''':

'''Add / Delete'''
:When an event selected in the event tree is '''Unhandled,''' this button has the caption '''Add'''. By pressing this button, you can add Â the clause handling this event into the dialog/form. In addition, the default declaration and definition for the event handling predicate are generated. When the selected event is '''Handled,''' then this button has the caption '''Delete'''. Pressing the '''Delete''' button, you can delete the clause handling this event from the dialog/form.
'''Set'''
:This button is enabled only when the selected event is '''Handled'''. Using the '''Set''' button, you can change the name of the event handling predicate. The clause for the new listener will be generated appropriately. However, the '''Code Expert''' will not delete/change code for the previously used listener. Notice that when the selected event is '''Unhandled''', the '''Set''' button is disabled, but in spite of this, you can type in the desired name of listener into the edit control. This name will be used instead of the default name when you press the '''Add''' button.

There are some advantages and some disadvantages to using the '''Code Expert'''. The main disadvantage is that the code experts insert some extra comments, which used to locate the source code at a later time. However the advantages are:

# It saves a lot of typing.
# It gives a standardized way of handling things, which other Prolog programmers will know.
# You know your application from the user interface; then by using the code experts, you can easily come to the source code through selection of the user interface component.

The '''Code Expert''' can automatically update the source code, when the layout or attributes of a user interface component are modified. This automatic updating is always done only inside comment brackets marked by:
<vip>% This code is maintained by the IDE. Do not update it manually
....% Some code handled by the Code Expert
% end of automatic code</vip>

File:Ide SourceBrowser.png

2019-09-11T11:37:22Z

Boris Belov: Boris Belov uploaded a new version of File:Ide SourceBrowser.png

Ide/Code Experts

2019-09-11T11:33:48Z

Boris Belov:

{{ideNavbar|Code Experts}}

Visual Prolog IDE contains several Code Experts:

* The {{ide|Project Settings|Project Settings}} feature, which generates all the default code, resources, and make-scripts for an application. It also handles modifications of project settings.
* The {{ide|Code Experts#Source Browser|Source Browser}} is used for searching of Visual Prolog names used in the edited project. This searching is accomplished in all files registered in this project.
* The {{ide|Code Experts#Insert Commands|Insert feature}} simplifies inserting of standard Visual Prolog program elements into the editing source code.
* The {{ide|Code Experts#Code Expert|Code Expert}} is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

== Source Browser ==

[[Image:Ide_SourceBrowser.png]]

The main aim of this tool is multi-file searching for Visual Prolog names used in the project. Displayed in the '''Source Browser''' dialog information is gathered by the compiler while compiling of the project files. Therefore, to update the "browse"information about any modifications in source files you need to recompile these files ('''Build''' menu commands can be used).

=== Search Results ===

The central pane of the '''Source Browser''' dialog displays Visual Prolog names, which are found in the project.

Type in some string into the '''Search for''' box and press '''Enter''' to activate the search operation.

After the search will be accomplished the central pane of the '''Source Browser''' dialog will display the tree of classes, interfaces, and class implementations in which the '''Search''' has found program items (of selected types) with names containing the specified substring. All items are prefixed with the same
{{ide|Project Tree#Icons Used in the Project Window|icons}}, which are used in the Project window. Clicking plus [[Image:Ide_Plus_Icon.png]] icons before a class/interface/implementation you can unfold it and see names, which are found in it.

Double-click any name will open the correspondent file in the text editor and jumps to this name.

When in the central pane of the dialog, the right mouse button will open the pop-up menu containing 2 commands:

*'''Go to Declaration'''
*:This command jumps to the declaration of the selected name.
*'''Go to Definition'''
*:This command jumps to the definition of the selected name.

=== Options ===

'''Search for:'''
:Here you enter a string to search for. The search string can be specified by selecting a substring in the text editor before calling the '''Source Browser''' dialog. The selected text will appear in the '''Search for''' box.
: The '''Source Browser''' will search for the specified substring in any place of names (not only in the beginning). It will display all names containing this substring.

'''Search in:'''
:Selection in this group of check and radio buttons determines types of user defined names that will be displayed in main pane of the '''Source Browser''' dialog. Here you can select:

:*'''All'''
::If you check ON the '''All''' check box, the '''Source Browser''' dialog will search the specified substring among all program items. In this case, any other check boxes will be disabled.

::The program item types you can specify in this group box are:
:*'''Predicates'''
::Specifies to search among predicates.
:*'''Facts'''
::Specifies to search among facts.
:*'''Domains'''
::Specifies to search among domains.
:*'''Constants'''
::Specifies to search among constants.
:*'''Classes'''
::Specifies to search among class names.
:*'''Interfaces'''
::Specifies to search among interface names.

:Also you can select whether search for declarations or definitions of names or for both declarations and definitions of names:

:*'''Declaration'''
::Specifies to search only for declarations of items.
:'''Definition'''
::Specifies to search only for definitions of items.
:*'''Both'''
::Specifies to search both for definitions and declarations of items.

'''Stay Open'''
:When it is checked OFF, then double-click (or select the '''Locate''') any name will opens the correspondent file in the text editor and jumps to this name. The '''Source Browser''' dialog will be closed.
: If this check box is checked ON, then the '''Source Browser''' dialog will NOT be closed when double-click (or select the '''Locate''') a name.

'''Use Regular Expressions'''
:See {{ide|IDE Dialogs#Regular Expressions|Regular Expressions}} for details.

== Code Expert ==

The '''Code Expert''' is a nearly deprecated tool, which is today only used to control menu bindings for the Task Window in an MDI application. In a project that contains old migrated resources it can also play a role for these.

"Modern" dialogs, forms and custom controls are handled by the {{ideSectionLink|Resource Editor}}.

You can activate the '''Code Expert''' when the focus is in the '''IDE Designer''' by selecting the '''Code Expert''' command in the mouse pop-up menu (or in the '''View''' menu, or alternatively by clicking the '''Ctrl+Shift+W''' hot key). Also you can activate the '''Code Expert''' when the focus is in the '''Project''' window and one of dialog or window type resource files is selected. Otherwise, the '''Code Expert''' command is disabled or the IDE displays the warning that the selected file is not associated with a dialog, window, form, or IDE control.

The name of the selected dialog or window file is displayed in the '''Code Expert''' title. On the picture below it is '''TaskWindow'''.

[[Image:Ide_dwe_defaultShape.png|center|frame|The Code Expert]]

In the upper line of the '''Code Expert''' you see 3 radio buttons: '''All''', '''Handled''' and '''Unhandled'''. Selecting among them you can specify which type of events will be displayed in the central pane:

'''All'''
:'''All''' events coming to the dialog or the window are displayed.
'''Handled'''
:Only events that are caught ('''Handled''') by the correspondent listener or responder are displayed.
'''Unhandled'''
:Only events that are not caught ('''Unhandled''') by the correspondent listener or responder are displayed.

In the central pane of the '''Code Expert''' dialog you see the tree of events that come to this dialog or form. Notice that the event tree displays all possible events that can come to a dialog or a form. So for some dialogs/windows the event tree can display some extra events that never come to these dialogs/forms. For example, if a dialog does not have scroll bars, its listener never receives <vp>HScroll</vp> and <vp>VScroll</vp>, but you can see these events in the event tree.

'''Handled''' events are marked with [[Image:Ide_Tick_mark.png]], and names of handler predicates are displayed after event names. '''Unhandled''' events are marked with [[Image:Ide_Bullet_mark.png]].

Notice that the code for the predicate <vp>generatedInitialize</vp> is 100% automatically maintained by the '''Code Expert'''. You '''MUST NOT''' make any manual correction of this predicate since any your corrections will be overwritten while the resource compilation. You can also see this code is surrounded with special comments '''''do not update it manually'''''

In the central pane you can see the following groups of events:

*'''Window'''
*:These are the events that came to the dialog/window as a whole entity.
*'''Menu'''
*:This group of events exist only for forms. These are the events that came to the form from the menu.
*'''Scroll Bar'''
*:These are the events that came to the dialog/form from the dialog/form scroll bars. Notice that these are not events from the scroll bar controls that you place inside dialogs/forms (events from the scroll bar controls you can see in the '''Control''' group of events).
*'''Control'''
*:These are the events that came to the dialog/form from controls placed in the dialog/form.
*'''Key'''
*:This group of events exist only for windows. These are the keyboard events.
*'''Mouse
*:These are the events that came to the dialog/form from the mouse.
*'''Miscellaneous'''
*:These are the miscellaneous events that do not fit to any of the previous types. They are timer, end session events and etc.

The '''Window''', '''Menu''', '''Scroll Bar''', '''Control''', '''Key''', '''Mouse''' and '''Miscellaneous''' nodes in the events tree can be preceded with the [[Image:Ide_Plus_Icon.png]] or [[Image:Ide_Minus_Icon.png]] icons. Pressing on these icons expands or collapses the correspondent node.

In the bottom of the '''Code Expert''' there are 2 buttons '''Add / Delete''' and '''Set''':

'''Add / Delete'''
:When an event selected in the event tree is '''Unhandled,''' this button has the caption '''Add'''. By pressing this button, you can add Â the clause handling this event into the dialog/form. In addition, the default declaration and definition for the event handling predicate are generated. When the selected event is '''Handled,''' then this button has the caption '''Delete'''. Pressing the '''Delete''' button, you can delete the clause handling this event from the dialog/form.
'''Set'''
:This button is enabled only when the selected event is '''Handled'''. Using the '''Set''' button, you can change the name of the event handling predicate. The clause for the new listener will be generated appropriately. However, the '''Code Expert''' will not delete/change code for the previously used listener. Notice that when the selected event is '''Unhandled''', the '''Set''' button is disabled, but in spite of this, you can type in the desired name of listener into the edit control. This name will be used instead of the default name when you press the '''Add''' button.

There are some advantages and some disadvantages to using the '''Code Expert'''. The main disadvantage is that the code experts insert some extra comments, which used to locate the source code at a later time. However the advantages are:

# It saves a lot of typing.
# It gives a standardized way of handling things, which other Prolog programmers will know.
# You know your application from the user interface; then by using the code experts, you can easily come to the source code through selection of the user interface component.

The '''Code Expert''' can automatically update the source code, when the layout or attributes of a user interface component are modified. This automatic updating is always done only inside comment brackets marked by:
<vip>% This code is maintained by the IDE. Do not update it manually
....% Some code handled by the Code Expert
% end of automatic code</vip>

Ide/Project Tree

2019-09-11T11:10:08Z

Boris Belov:

{{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]]
| Vipcom 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_Form.png]]
| Form description file
|-
| [[Image:Ide_PT_Control.png]]
| IDE custom control description file
|-
| [[Image:Ide_PT_Window.png]]
| Task 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>, <vp>properties</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>*.vipprj</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 Tree

2019-09-11T11:09:36Z

Boris Belov:

{{ideNavbar|Project Window and Project Tree111}}

=== 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]]
| Vipcom 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_Form.png]]
| Form description file
|-
| [[Image:Ide_PT_Control.png]]
| IDE custom control description file
|-
| [[Image:Ide_PT_Window.png]]
| Task 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>, <vp>properties</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>*.vipprj</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.

File:Ide We SpeedMenu.png

2019-09-11T09:41:41Z

Boris Belov: Boris Belov uploaded a new version of File:Ide We SpeedMenu.png

Ide/Project Tree

2019-09-11T09:39:32Z

Boris Belov: /* Project Tree Properties */

File:Ide How COMPackage.png

2019-09-11T09:35:35Z

Boris Belov: Boris Belov uploaded a new version of File:Ide How COMPackage.png

File:Ide How NewPackage.png

2019-09-11T09:34:31Z

Boris Belov: Boris Belov uploaded a new version of File:Ide How NewPackage.png

Ide/Options

2019-09-11T09:32:23Z

Boris Belov: /* Image Editors */

{{ideNavbar|IDE Options}}
=== IDE Options - Tools | Options Command ===

The IDE environment options can be set/view in the '''Options''' dialog.

[[Image:Ide Options General.png]]

==== Fonts ====

It is possible to specify font for all IDE windows. Monospace font is used in Disassembly, Registers, etc windows.

'''Choose ...''' push button activates the Windows system '''Font''' dialog where the user can choose the font and font size, which should be used.

==== Message Window ====

It is possible to specify how the '''Messages''' window should be displayed.

'''Messages Window Keep "XXX" lines'''

Specifies the maximum number of lines to keep in the '''Messages''' window buffer. It is the maximum number of (recently displayed) lines, which can be scrolled back (in the '''Messages''' window).

==== Microsoft Linker ====

Specifies the fully qualified filename of the optional Microsoft Linker.

==== Image Editors ====

Here can be specified external graphical editors that are activated by the IDE to edit '''.BMP''', '''.ICO''', or '''.CUR''' files.

Ide/Options

2019-09-11T09:31:28Z

Boris Belov: /* Message Window */

{{ideNavbar|IDE Options}}
=== IDE Options - Tools | Options Command ===

The IDE environment options can be set/view in the '''Options''' dialog.

[[Image:Ide Options General.png]]

==== Fonts ====

It is possible to specify font for all IDE windows. Monospace font is used in Disassembly, Registers, etc windows.

'''Choose ...''' push button activates the Windows system '''Font''' dialog where the user can choose the font and font size, which should be used.

==== Message Window ====

It is possible to specify how the '''Messages''' window should be displayed.

'''Messages Window Keep "XXX" lines'''

Specifies the maximum number of lines to keep in the '''Messages''' window buffer. It is the maximum number of (recently displayed) lines, which can be scrolled back (in the '''Messages''' window).

==== Microsoft Linker ====

Specifies the fully qualified filename of the optional Microsoft Linker.

==== Images ====

Here can be specified external graphical editors that are activated by the IDE to edit '''.BMP''', '''.ICO''', or '''.CUR''' files.

Ide/Options

2019-09-11T09:30:28Z

Boris Belov: /* Microsoft Linker */

{{ideNavbar|IDE Options}}
=== IDE Options - Tools | Options Command ===

The IDE environment options can be set/view in the '''Options''' dialog.

[[Image:Ide Options General.png]]

==== Fonts ====

It is possible to specify font for all IDE windows. Monospace font is used in Disassembly, Registers, etc windows.

'''Choose ...''' push button activates the Windows system '''Font''' dialog where the user can choose the font and font size, which should be used.

==== Message Window ====

It is possible to specify how the '''Messages''' window should be displayed.

'''Messages Window Keep "XXX" lines'''

Specifies the maximum number of lines to keep in the '''Messages''' window buffer. It is the maximum number of (recently displayed) lines, which can be scrolled back (in the '''Messages''' window).

'''Glue to the Left/Top/Right/Bottom/ Edge'''

Specify the location where the '''Messages''' window (relative to the borders of the IDE task window) should be displayed.

==== Microsoft Linker ====

Specifies the fully qualified filename of the optional Microsoft Linker.

==== Images ====

Here can be specified external graphical editors that are activated by the IDE to edit '''.BMP''', '''.ICO''', or '''.CUR''' files.

Ide/Options

2019-09-11T09:29:32Z

Boris Belov: /* Message Window */

{{ideNavbar|IDE Options}}
=== IDE Options - Tools | Options Command ===

The IDE environment options can be set/view in the '''Options''' dialog.

[[Image:Ide Options General.png]]

==== Fonts ====

It is possible to specify font for all IDE windows. Monospace font is used in Disassembly, Registers, etc windows.

'''Choose ...''' push button activates the Windows system '''Font''' dialog where the user can choose the font and font size, which should be used.

==== Message Window ====

It is possible to specify how the '''Messages''' window should be displayed.

'''Messages Window Keep "XXX" lines'''

Specifies the maximum number of lines to keep in the '''Messages''' window buffer. It is the maximum number of (recently displayed) lines, which can be scrolled back (in the '''Messages''' window).

'''Glue to the Left/Top/Right/Bottom/ Edge'''

Specify the location where the '''Messages''' window (relative to the borders of the IDE task window) should be displayed.

==== Linker ====

Specifies the fully qualified filename of the optional Microsoft Linker.

==== Images ====

Here can be specified external graphical editors that are activated by the IDE to edit '''.BMP''', '''.ICO''', or '''.CUR''' files.

Ide/Options

2019-09-11T09:28:55Z

Boris Belov: /* Fonts */

{{ideNavbar|IDE Options}}
=== IDE Options - Tools | Options Command ===

The IDE environment options can be set/view in the '''Options''' dialog.

[[Image:Ide Options General.png]]

==== Fonts ====

It is possible to specify font for all IDE windows. Monospace font is used in Disassembly, Registers, etc windows.

'''Choose ...''' push button activates the Windows system '''Font''' dialog where the user can choose the font and font size, which should be used.

==== Messages Window ====

It is possible to specify how the '''Messages''' window should be displayed.

'''Messages Window Keep "XXX" lines'''

Specifies the maximum number of lines to keep in the '''Messages''' window buffer. It is the maximum number of (recently displayed) lines, which can be scrolled back (in the '''Messages''' window).

'''Glue to the Left/Top/Right/Bottom/ Edge'''

Specify the location where the '''Messages''' window (relative to the borders of the IDE task window) should be displayed.

==== Linker ====

Specifies the fully qualified filename of the optional Microsoft Linker.

==== Images ====

Here can be specified external graphical editors that are activated by the IDE to edit '''.BMP''', '''.ICO''', or '''.CUR''' files.

File:Ide Options General.png

2019-09-11T09:27:16Z

Boris Belov: Boris Belov uploaded a new version of File:Ide Options General.png

File:Ide PT Popup Package.png

2019-09-11T09:18:25Z

Boris Belov: Boris Belov uploaded a new version of File:Ide PT Popup Package.png

File:Ide PT Popup Source.png

2019-09-11T09:17:18Z

Boris Belov: Boris Belov uploaded a new version of File:Ide PT Popup Source.png

File:Ide PT Popup Project.png

2019-09-11T09:15:13Z

Boris Belov: Boris Belov uploaded a new version of File:Ide PT Popup Project.png

Ide/Project Tree

2019-09-11T09:13:27Z

Boris Belov: /* Pop-up Menus */

{{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]]
| Vipcom 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_Form.png]]
| Form description file
|-
| [[Image:Ide_PT_Control.png]]
| IDE custom control description file
|-
| [[Image:Ide_PT_Window.png]]
| Task 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>*.vipprj</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.

File:Ide PT Popup Folder.png

2019-09-11T09:11:32Z

Boris Belov: Boris Belov uploaded a new version of File:Ide PT Popup Folder.png

File:Ide PT Form.png

2019-09-11T09:06:19Z

Boris Belov:

Ide/Project Tree

2019-09-11T09:06:00Z

Boris Belov: /* Icons Used in the Project Window */

{{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]]
| Vipcom 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_Form.png]]
| Form description file
|-
| [[Image:Ide_PT_Control.png]]
| IDE custom control description file
|-
| [[Image:Ide_PT_Window.png]]
| Task 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.

File:Ide PT ComPackage.png

2019-09-11T08:50:40Z