View source for Ide/Resource Editor

From wiki.visual-prolog.com
You do not have permission to edit this page, for the following reasons:
The action you have requested is limited to users in the group: emailconfirmed.
You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.
You can view and copy the source of this page.
{{ideNavbar|Resource Editor}}

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

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

== GUI and VPI Style Resources ==

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

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

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

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

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

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

== IDE Designer ==

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

=== Creating a Dialog ===

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

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

[[Image:Ide_MyDialog_Editor.png|center]]

The IDE Designer After Creation of a New Dialog

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

==== Controls ====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

When you open a GUI dialog or a Form (GUI window) in the '''IDE Designer''', then near from the opened dialog (form) the '''[Properties_of_GUI_Controls\Properties_of_GUI_Controls.htm Control Properties]''' table appears.

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

'''Click here to view [Properties_of_GUI_Controls\Properties_of_GUI_Controls.htm GUI Control Properties table.] '''

The displayed set of properties depends on the control type. The '''[Properties_of_GUI_Controls\Properties_of_GUI_Controls.htm Control Properties]''' table contains two types of properties. General properties are common to all types of controls and some properties, which are individual to different kinds of controls.

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

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

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

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

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

Notice that the '''Text''' property/attribute is not used for some controls, for instance, it is not used for scroll bars.

Notice that in the '''Text''' fields the ampersand symbol <vp>&</vp> is reserved for indicating that the next to it character is to be underlined. For example, if you use the text string '''E&xit''' as a control name, then this control will be displayed with the title '''E<u>x</u>it''' at runtime. I.e. the char '''<u>x</u>''' will be displayed underlined (thus visually indicating that the '''<u>x</u>''' is an accelerator key). If you need to display the ampersand <vp>&</vp> symbol in the '''Text''' of a control, then use two of them <vp>&&</vp>.

Other attributes are individual to different kinds of controls.

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

[Properties_of_VPI_Controls\Push_Button_Flags.htm Push Button Attributes]

[Properties_of_VPI_Controls\Check_Box_Flags.htm Check Box Attributes]

[Properties_of_VPI_Controls\Custom_Control_Attributes.htm Custom Control Attributes]

[Properties_of_VPI_Controls\Radio_Button_Flags.htm Radio Button Attributes]

[Properties_of_VPI_Controls\Static_Text_Flags.htm Static Text Attributes]

[Properties_of_VPI_Controls\Edit_Control_Flags.htm Edit Control Attributes]

[Properties_of_VPI_Controls\List_Box_Attributes.htm List Box Attributes]

[Properties_of_VPI_Controls\List_Button_Attributes.htm List Button Attributes]

[Properties_of_VPI_Controls\List_Edit_Attributes.htm List Edit Attributes]

[Properties_of_VPI_Controls\Scroll_Bar_Attributes.htm Scroll Bar Attributes]

[Properties_of_VPI_Controls\Group_Box_Attributes.htm Group Box Attributes]

[Properties_of_VPI_Controls\Icon_Control_Attributes.htm Icon Attributes]

==== Using Anchors for Positioning GUI Controls while Dialog Resizing ====

VPI controls remember in their attributes ({{ide|Resource Editor#Attributes of VPI Controls|Attributes of VPI Controls}}) only their absolute positions and sizes. Therefore, when a VPI dialog or a VPI window containing such VPI controls are resized, these VPI controls do not change their positions and sizes!

In difference to them GUI controls have additional ''Anchor'' properties, which help to reposition (and may be resize) GUI controls when containing them GUI dialog (or form) is resized.

Each GUI control has four anchor properties: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', and '''Bottom Anchor''' (see '''[Properties_of_GUI_Controls\Properties_of_GUI_Controls.htm#Anchors Anchor Properties of GUI Controls]''').

Each anchor determines that the specified ('''Left''', '''Top''', '''Right''' or '''Bottom''') control boundary should be '''always''' positioned on the stated distance from the nearest (correspondent) border of the dialog (frame).

Each of anchors can have the '''True''' or '''False''' values. When the anchor value is '''True''', then this anchor is active (used to position the correspondent control).

For example, when the '''Left Anchor''' is active (has the '''True''' value), then the ''left'' control boundary should be positioned on the stated distance from the nearest (''left'') border of the dialog (frame).

The simplest way to see which anchors are active for a control, is to select this control. Then some red arrows between control boundaries and correspondent boundaries of the dialog can bee seen. Each arrow specifies, that the correspondent anchor is active. For example, the arrow from the control top to the dialog top identifies, that the '''Top Anchor''' is active. In the picture below, you see three arrows, which specify that the '''Left''', '''Top''', and '''Right''' anchors are active to the '''Push Button''' control.

[[Image:Ide_de_Anchors.png|center]]

Numbers near such arrows show distances (in Dialog Base Units) between the correspondent boundaries of the control and the dialog.

Normally each control has one active horizontal and one active vertical anchors. When the dialog is resized, then such control is always positioned on the specified distances from the specified boundaries of the dialog. The size of the control is not changed!

When a control has both horizontal (or/and both vertical) anchors active, then both horizontal (or/and both vertical) boundaries of the control should be placed on some specified distances from the correspondent horizontal (vertical) boundaries of the dialog. Therefore, when the dialog is resized, then such control is also resized accordingly to keep the specified distances.

When no one of horizontal (or vertical) anchors of a control are active, then no one of horizontal (or vertical) boundaries of the control are bounded to the correspondent horizontal (vertical) boundaries of the dialog. Coordinates of such controls are handles on the "proportional basis". For example, when the dialog width is increased onto <vp>Delta</vp> dialog base units, then the <vp>X</vp> coordinate of the control is also increased, but it is increased two times smaller. That is the <vp>X</vp> coordinate of the control is increased only onto <vp>Delta/2</vp> dialog base units.

==== Cut, Copy and Paste, Undo and Redo ====

You can '''Cut''' or '''Copy''' a group of selected controls onto the Windows clipboard, and '''Paste''' controls from the clipboard back into a dialog. The '''Undo''' and '''Redo''' commands serve to delete or restore the last editing operations of your dialog.

==== Grid ====

When the menu (or the pop-up menu) entry '''Resource | Grid''' is activated, or when the [[Image:Ide_GridButton.png]] button from the '''Layout''' toolbar is pressed, the following dialog appears:

[[Image:Ide_GridSpecification.png|center|frame|'''The Dialog to Specify the Grid Properties''']]

With a grid in place, arranging the controls inside a dialog is easier. Also it is possible to tell the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} by the '''Snap to Grid''' that it should place controls at the grid intersections to give a satisfactory result.

[[Image:Ide_MyDialog_withGrid.png|center|frame|'''Using a grid in the Dialog/Window/Form Editor''']]

==== Test Mode ====

The {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} has the '''Test Mode''', so it is possible to see how the dialog with the created controls behaves. To illustrate the '''Test Mode''' we will assign some default values to the controls. The test mode is activated and deactivated from the '''Resource''' menu (or from the pop-up menu).

[[Image:Ide_MyDialog_TestMode.png|center|frame|'''Test Mode for a Dialog''']]

==== Tab Stops ====

When activating the menu (or the pop-up menu) entry '''Resource | Tabstops''', it is possible to specify to which controls you can Tab to in the dialog. When this command is activated a small button with the <vp>+</vp> or <vp>-</vp> appears on controls depending upon whether the control has a tab stop or not. By clicking the small buttons, it is possible to toggle the setting.

[[Image:Ide_MyDialog_TabStops.png|center|frame|'''Specifying Tab Stops for a Dialog''']]

To exit the tab stop mode, just click in the dialog but outside of any controls.

==== Visit Order ====

When the tab stops have been specified for a dialog, then it is possible to specify the order in which controls will receive focus when tabbing.

[[Image:Ide_MyDialog_VisitOrder.png|center|frame|'''Displaying the Visit Order''']]

To change the visit order, click a small rectangle displaying the visit order number for a control that has an incorrect sequence number and this will bring up another dialog to change this sequence:

[[Image:Ide_MyDialog_ChangeVisitOrder.png|center|frame|'''Changing the Visit Order''']]

To stop the visit order mode, just click in the dialog outside any controls.

==== Speed Menu ====

When you are in the {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} you can click the right mouse button to activate the Speed Menu. From this menu you can easily call any {{ide|Resource Editor#IDE Designer|'''IDE Designer'''}} command:

[[Image:Ide_We_SpeedMenu.png|center|frame|'''The IDE Designer Speed Menu''']]

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

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

=== Creating and Editing a Form ===

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

== Toolbar Editor ==

== Menu Editor ==

== Graphics Editor ==
Return to Ide/Resource Editor.
Retrieved from "https://wiki.visual-prolog.com/index.php?title=Ide/Resource_Editor"
View source for Ide/Resource Editor

Search

Navigation

external links

collaboration

Personal tools

Views
