View source for Ide/Resource Editor/GUI Control Properties Table

From wiki.visual-prolog.com
← Ide/Resource Editor/GUI Control Properties Table
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.
<noinclude>[[Category:Ide]]</noinclude>

===== GUI Control Properties Table =====

When you open a GUI dialog or a form (GUI window) in the '''IDE Designer''', then the '''Control Properties''' table also opens.

The set of properties displayed in the '''Control Properties''' table depends on the control type and contains two groups of properties:

*{{ide|Resource Editor#Common Properties of Almost All GUI Controls|'''General properties'''}} are common to all types of controls.<br/>These are: '''Left Anchor''', '''Top Anchor''', '''Right Anchor''', '''Bottom Anchor''', '''Container Name''', '''Enabled''', '''Lock to Container''', '''Name''', '''Representation''', '''TabStop''', '''Title''',  '''X''', '''Y''', '''Width''', '''Height''' and '''Visible'''.

*{{ide|Resource Editor#Specific Properties of Different GUI Control Types|'''Specific properties'''}} are individual to different types of GUI controls.<br/>These are: '''3State''', '''AlignBaseline''', '''Alignment''', '''AllowPartialRows''', '''Auto''', '''AutoNotify''', '''AutoHScroll''', '''AutoVScroll''', '''Border''', '''Case''', '''Class''', '''ExtendedSel''', '''HideSel''', '''HScroll''', '''Icon Name''', '''IgnorePrefix''', '''LeftText''', '''MultiColumn''', '''MultiLine''', '''MultiSelect''', '''Password''', '''ReadOnly''', '''Rows''', '''Sort''', '''StaticScrollbar''', '''Style''', '''UseTabStops''', '''VScroll''', '''WantReturn''', '''Wrap'''.

In '''Control Properties''' table you can edit the displayed properties of the selected GUI control.

Initially this table is empty. However, as soon as any of GUI controls in the edited GUI dialog (form) is selected, the '''Control Properties''' table displays the current set of properties of the selected control.

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

===== Common Properties of Almost All GUI Controls =====

There are some basic control properties, which are used by almost all GUI controls. These are:

*'''Name'''
*:The '''Name''' input box is where you can specify some correct Visual Prolog name, which will be used as the control name (identifier).
*:The default '''Name''' is generated from the ''control type'' (for example, ''pushButton'', ''checkBox'', ''listButton'', etc.) and the <vp>_ctl</vp> suffix. If several controls of the same type are created, then the ''control type'' is suffixed with the number, for example, <vp>pushButton</vp><vp>1</vp><vp>_ctl</vp>. 
*:You can edit this default name or simply type in your own version.
*'''Representation'''
*:This property can have one of the following two values: '''Fact Variable''', '''Variable'''.
*:*'''Fact Variable'''
*:*:When '''Fact Variable''' is specified, then the IDE generates the fact variable, which will store the object of the control. This fact variable is used to reference to this control in the code. This fact variable name is determined by the '''Name''' property. For example, <vp>ok_ctl</vp>. Notice that in this case the fact variable name is automatically converted to be started with the lowercase character.
*:*'''Variable'''
*:*:When '''Variable''' is specified, then the IDE unifies the object of the control with an ordinary variable. This variable will be used to reference to this control in the code. This variable name is determined by the '''Name''' property. For example, <vp>Cancel_ctl</vp>. Notice that in this case the variable name is automatically converted to be started with the uppercase character.
*:The default value is '''Fact Variable'''.
*'''Title'''
*:The '''Title''' property is where you specify the title (label), which you want to be displayed as the control caption.
*:One character in the Title text may be underlined to indicate an access key. To underline a character precede it with the ampersand <vp>&</vp> character. At runtime this character in the control '''Title''' will be underlined.
*:Notice that this character is displayed underlined also in the value cell of the '''Title''' property:
*:[[Image:Ide_GUI_Prop_Title.png]]
*:The used ampersand <vp>&</vp> character is seen only when the value cell of the '''Title''' property has the focus:
*:[[Image:Ide_GUI_Prop_Title2.png]]
*:If you need to display the ampersand <vp>&</vp> character in the '''Title''' text, then use two of them <vp>&&</vp>.
*'''Lock to Container'''
*:Possible values are '''True''' and '''False'''. '''True''' defines that the control is locked inside the container selected in the '''Container Name''' property.
*'''Container Name'''
*:In this list box you can select the '''Name''' of one of containers (currently only the group box <vp>groupBox</vp> type of containers is supported) defined in the dialog or in the form.
*:All controls belonging to the same container are in the same ''group'' of related controls. The user may use the arrow keys to move from one control in the ''group'' to the next one.
*:Only the '''Names''' of group boxes, inside which the control is placed, appear in the list of '''Container Name''' property values. For example, if you see:
*:[[Image:Ide_GUI_Prop_Container.png]]
*:this means that the control is placed inside two group boxes with names <vp>GroupBox_ctl</vp> and <vp>GroupBox1_ctl</vp>.
*:If you do not need to relate the control to any container, then you should select <vp>[none]</vp>.
*'''X''', '''Y''', '''Width''', '''Height'''
*:These properties determine the control coordinates and size:
*:*'''X'''
*:*:The '''X''' coordinate of the upper-left corner of the control (in Dialog Base Units).
*:*'''Y'''
*:*:The '''Y''' coordinate of the upper-left corner of the control (in Dialog Base Units).
*:*'''Width'''
*:*:The '''Width''' of the control (in Dialog Base Units).
*:*'''Height'''
*:*:The '''Height''' of the control (in Dialog Base Units).
*'''Left''', '''Top''', '''Right''' and '''Bottom Anchors'''
*:These properties determine how the control coordinates (and may be size) will be handled when the dialog or form (containing this control) is resized. The general rules are described in the "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*:*'''Left Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Left''' boundary of the control is always positioned at the specified distance (equal to the '''X''' property) from the '''Left''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units.
*:*'''Top Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Top''' of the control is always positioned at the specified distance (equal to the '''Y''' property) from the '''Top''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units.
*:*'''Right Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Right''' boundary of the control is always positioned at the specified distance from the '''Right''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*:*'''Bottom Anchor'''
*:*:Possible values are '''True''' and '''False'''. '''True''' defines that the '''Bottom''' of the control is always positioned at the specified distance from the '''Bottom''' boundary of the dialog (form) containing this control.
*:*:The distance is specified in the Dialog Base Units. The distance value can be seen near the arrow, which appears when the control is selected "{{ide|Resource Editor#Using Anchors for Positioning GUI Controls while Dialog Resizing|'''Using Anchors for Positioning GUI Controls while Dialog Resizing'''}}".
*'''Enabled'''
*:Possible values are '''True''' and '''False'''. They define whether the control will be created initially enabled ('''True''') or disabled ('''False'''). The default value is '''True''' (enabled).
*:You can use the <vp>window::getEnabled/0-></vp> predicate to get whether the control is enabled
<vip>IsEnabled = checkButtonName:getEnabled(),
IsEnabled = true,</vip>
:and the <vp>window::setEnabled/1</vp> predicate
<vip>IsEnabled = true,
checkButtonName:setEnabled(IsEnabled),</vip>
:to set this flag programmatically.
*'''Visible'''
*:Possible values are '''True''' and '''False'''. They define whether the control will be created initially visible ('''True''') or invisible ('''False'''). The default value is '''True''' (visible).
*:You can use the <vp>window::getVisible/0-></vp> predicate to get whether the control is visible
<vip>IsVisible = checkButtonName:getVisible(),
IsVisible = true,</vip>
:and the <vp>window::setVisible/1</vp> predicate
<vip>IsVisible = true,
checkButtonName:setVisible(IsVisible),</vip>
:to set this flag programmatically.
*'''TabStop'''
*:Possible values are '''True''' and '''False'''. They define whether this control belongs to a subset of controls through which the user can move using the TAB key. The default value is '''True''' (the control belongs to a group of controls between which the user can navigate with TAB).
*:You can use the <vp>control::getTabStop/0-></vp> predicate to get whether the control has this flag
<vip>IsTabStop = checkButtonName:getTabStop(),
IsTabStop = true,</vip>
:and the <vp>control::setTabStop/1</vp> predicate
<vip>IsTabStop = true,
checkButtonName:setTabStop(IsTabStop),</vip>
:to set this flag programmatically.
:If <vp>IsTabStop</vp> is <vp>true</vp>, then the focus will be able to jump to this control while the Tab pressing navigation. Pressing the TAB key moves the focus to the next control, which has the '''TabStop''' = '''True'''.

===== Specific Properties of Different GUI Control Types =====

The following properties are specific to different types of controls:

*'''Auto'''
*:Possible values are '''True''' and '''False'''. They define whether this control is an automatic (an automatic check box or an automatic radio button). When you click an automatic control, then it change its state in the proper way.
*:You can use the <vp>checkButton::getStyle/2</vp> and <vp>radioButton::getAuto/0-></vp> predicates to get whether this flag is set to a control:
<vip>checkButtonName:getStyle(IsAuto, _Is3State),
IsAuto = true,</vip>
:and the <vp>checkButton::setStyle/2</vp> or <vp>radioButton::setAuto/1</vp> predicates
<vip>IsAuto = true,
checkButtonName:setStyle(IsAuto, _Is3State),</vip>
:to set this flag programmatically.
:The default value is '''True''' (auto).
*'''3State'''
*:Possible values are '''True''' and '''False'''. They define whether this check box can have 3 states (''unchecked, checked, undetermined''). You can use the <vp>checkButton::getStyle/2</vp> predicate to get whether this state is set to a control
<vip>checkButtonName:getStyle(_IsAuto, Is3State),
Is3State = true,</vip>
:and the <vp>checkButton::setStyle/2</vp> predicate
<vip>Is3State = true,
checkButtonName:setStyle(_IsAuto, Is3State),</vip>
:to set this state programmatically.
:A 3-states check box is the same as an ordinary check box, except that the box can be grayed (dimmed) as well as checked. The grayed state is used to show that the state of the check box is not determined.
:The default value is '''False''' (3State).
*'''LeftText'''
*:Possible values are '''True''' and '''False'''. They define whether the control title text should be positioned on the left or on the right of the control (check box or radio button).
*:You can use the <vp>checkButton::getLeftText/0-></vp> or <vp>radioButton::getLeftText/0-></vp> predicates to get whether the control has this flag
<vip>IsLeftText = checkButtonName:getLeftText(),
IsLeftText = true,</vip>
:and the <vp>checkButton:setLeftText/1</vp> or <vp>radioButton:setLeftText/1</vp> predicates
<vip>IsLeftText = true,
checkButtonName:setLeftText(IsLeftText),</vip>
:to set this flag programmatically.
:The default value is '''False''' (caption is on the right side).
*'''AlignBaseline'''
*:Possible values are '''True''' and '''False'''. They define whether the control caption text should be positioned on the same horizontal line with caption texts of all other controls, which have the same vertical position with this control.
*:This property is defined to all controls, which can have captions (static texts, check boxes, edit and list edit controls, etc.)
*:You can use the <vp>getAlignBaseline</vp> predicates (like <vp>editControl::getAlignBaseline/0-></vp>) to get whether the control has this flag
<vip>IsAllignBaseLine = checkButtonName:getAllignBaseLine(),
IsAllignBaseLine = true,</vip>
:and the <vp>setAlignBaseline</vp> (like <vp>textControl::setAlignBaseline/1</vp>) predicates
<vip>IsAllignBaseLine = true,
checkButtonName:setAllignBaseLine(IsAllignBaseLine),</vip>
:to set this flag programmatically.
:The default value is '''True''' (align captions horizontally).
*'''Style'''
*:'''Push buttons'''
*:For push buttons possible values are '''Cancel''', '''OK''' and '''Regular'''.
*:'''Cancel'''
*::Push buttons with the '''Cancel''' style are created by the <vp>button::newCancel/1</vp> constructor.
*::When a dialog/form contains a push button with the '''Cancel''' style, then this dialog/form will provide standard handling of the Esc key - the dialog/form is simply closed without any additional actions.
*:'''OK'''
*::Push buttons with the '''OK''' style are created by the <vp>button::newOk/1</vp> constructor.
*::When a dialog/form contains a push button with the '''Ok''' style, then this dialog/form will execute dialog/form validation check when this button is clicked. See "'''Dialog/Form Validation'''" tutorial (on WEB) for more information.
*:'''Regular'''
*::Push buttons with the '''Regular''' style are created by the ordinary <vp>button::new/1</vp> constructor.
*::Such buttons do not initiate any special default handling.
*:'''Group boxes'''
*:For group boxes possible values are '''Group Box''', '''Simple Border''', '''Horizontal Separator''', '''No Border'''. These values define the border type of the group box control.
*:The default is '''Simple Border'''.
*:You can use the <vp>groupBox::getBorderStyle/0-></vp> predicate to get the border style
<vip>GroupBoxBorderStyle = controlName : getBorderStyle(),</vip>
:and the <vp>groupBox::setBorderStyle/1</vp> predicate
<vip>GroupBoxBorderStyle = groupBox(),
controlName : setBorderStyle(GroupBoxBorderStyle),</vip>
:to set the border style programmatically.
*'''Alignment'''
*:Possible values are '''Left''', '''Center''' and '''Right'''. Radio buttons in this group box determine how the text in the control is aligned.
*:The default value is '''Left''' (align left).
*:*'''Left'''
*::Defines that the text in the control will be aligned left.
*::You can use the <vp>textControl::getAlignment/0-></vp> predicate to get which of these flags the control has
<vip>AlignmentType = textControlName : getAlignment(),
AlignmentType = alignLeft(),</vip>
:::and the <vp>textControl::setAlignment/1</vp> predicate
<vip>AlignmentType = alignLeft(),
textControlName : setAlignment(AlignmentType),</vip>
:::to set this flag programmatically.
::*'''Center'''
:::Defines that the text in the control will be centered.
:::The <vp>AlignmentType = alignCenter()</vp>.
::*'''Right'''
:::Defines that the text in the control will be aligned right.
:::The <vp>AlignmentType = alignRight()</vp>.
*'''Wrap'''
*:Possible values are '''True''' and '''False'''. They define whether the text in the control will be wrapped to several lines.
*:The default value is '''True''' (wrap).
*:You can use the <vp>textControl::getWrap/0-></vp> predicate to get whether the control has this flag
<vip>IsNoWrap = textControlName : getWrap(),
IsNoWrap = true,</vip>
::and the <vp>textControl::setWrap/1</vp> predicate
<vip>IsNoWrap = false,
textControlName: setWrap(IsNoWrap),</vip>
::to set this flag programmatically.
*'''IgnorePrefix'''
*:Possible values are '''True''' and '''False'''. Setting '''True''' value prevents interpretation of any <vp>&</vp> characters in the caption of the static text control as access keys (accelerator prefix characters). Accelerator characters are displayed underlined and the prefix <vp>&</vp> character is deleted.
*:The default value is '''False'''.
*:Notice that static text controls cannot be activated. Therefore, when an access key of a static text control is pressed, then the control next to this static text control, in the tab-stop order of controls in the dialog, is activated.
*:Most often this flag is used when filenames, which can contain the <vp>&</vp> character, need to be displayed in static text controls.
*:You can use the <vp>textControl::getIgnorePrefix/0-></vp> predicate to get whether the control has this flag
<vip>IsIgnorePrefix = controlName : getIgnorePrefix(),
IsIgnorePrefix = true,</vip>
::and the <vp>textControl::setIgnorePrefix/1</vp> predicate
<vip>IsIgnorePrefix = true,
controlName : setIgnorePrefix(IsIgnorePrefix),</vip>
::to set this flag programmatically.
*'''MultiLine'''
*:Possible values are '''True''' and '''False'''. When this property is '''True''', then the edit control allows multiple lines.
*:The default value is '''True''' (allows multiple lines).
*:Notice that the '''VScroll''', '''HScroll''', '''AutoVScroll''', and '''WantReturn''' properties do not work for single-line ('''False''') edit controls.
*:You can use the <vp>editControl::getMultiLine/0-></vp> predicate to get whether the control has this flag
<vip>IsMultiLine = controlName : getMultiLine(),
IsMultiLine = true,</vip>
::and the <vp>editControl::setMultiLine/1</vp> predicate
<vip>IsMultiLine = true,
controlName : setMultiLine(IsMultiLine),</vip>
::to set this flag programmatically.
*'''WantReturn'''

Possible values are <span>'''True'''</span> and <span>'''False'''</span>.

If it is <span>'''True'''</span>, then a carriage return will be inserted as the part of an edited string, when the user presses the <span>'''Enter'''</span> key while entering text into a multi-line edit control.

If it is <span>'''False'''</span>, then pressing the '''Enter''' key has the same effect as pressing the ''default'' ('''OK''') push button, which has the latest specified <span>'''Default = True'''</span> property value.

This property has no effect on single-line edit controls.

The default value is <span>'''False'''</span>.

You can use the <span class="code-span">editControl::getWantReturn/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsWantReturn</span> = controlName : getWantReturn (),<span class="vp-variable"> IsWantReturn </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setWantReturn/1</span> predicate

 

<span class="vp-variable">IsWantReturn </span><nowiki>= true, controlName : setWantReturn (</nowiki><span class="vp-variable">IsWantReturn</span>),

to set this flag programmatically.

VScroll

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. They define whether the <span>''multi-line''</span> control gets a vertical scroll bar when it needs one.

The default value for edit controls is <span>'''True'''</span> for other types of controls is <span>'''False'''</span>.

This property has no effect on single-line edit controls.

You can use the <span class="code-span">editControl::getVScroll/0-&gt;</span> and <span class="code-span">listControl::getVScroll/0-&gt;</span> predicates to get whether the control has this flag

 

<span class="vp-variable">IsVScrollSet</span> = controlName : getVScroll (),<span class="vp-variable"> IsVScrollSet</span> = true,

and the <span class="code-span">editControl::setVScroll/1</span> and <span class="code-span">listControl::setVScroll/0</span> predicates

 

<span class="vp-variable">IsVScrollSet</span> = true, controlName : setVScroll (<span class="vp-variable">IsVScrollSet</span>),

to set this flag programmatically.

AutoVScroll

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. They define whether the <span>''multi-line''</span> edit control automatically scrolls text up when the user presses the '''Enter''' on the last line.

The default value is <span>'''False'''</span> (does not scroll).

This property has no effect on single-line edit controls.

You can use the <span class="code-span">editControl::getAutoVScroll/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsAutoVScrollSet</span> = controlName : getAutoVScroll (),<span class="vp-variable"> IsAutoVScrollSet</span> = true,

and the <span class="code-span">editControl::setAutoVScroll/1</span> predicate

 

<span class="vp-variable">IsAutoVScrollSet</span> = true, controlName : setAutoVScroll (<span class="vp-variable">IsAutoVScrollSet</span>),

to set this flag programmatically.

HScroll

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. They define whether the <span>''multi-line''</span> edit or list box control gets a horizontal scroll bar when it needs one.

The default value is <span>'''False'''</span> (does not scroll).

This property has no effect on single-line <span>''edit''</span> controls.

You can use the <span class="code-span">editControl::getHScroll/0-&gt;</span> or <span class="code-span">listBox::getHScroll/0-&gt;</span> predicates to get whether the control has this flag

 

<span class="vp-variable">IsHScrollSet</span> = controlName : getHScroll (),<span class="vp-variable"> IsHScrollSet</span> = true,

and the <span class="code-span">editControl::setHScroll/1</span> or <span class="code-span">listBox::setHScroll/1</span> predicates

 

<span class="vp-variable">IsHScrollSet</span> = true, controlName : setHScroll (<span class="vp-variable">IsHScrollSet</span>),

to set this flag programmatically.

AutoHScroll

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. They define whether the control automatically scrolls text in the control in order to display a typed character, when the user types the character at the end of the line.

If it is <span>'''False'''</span>, then only text that fits within the rectangular boundary is allowed. When the user presses the '''Enter''' key, the control scrolls all text back to the zero position.

The default value is <span>'''True'''</span> (scrolls text automatically).

You can use the <span class="code-span">editControl::getAutoHScroll/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsAutoHScrollSet</span> = controlName : getAutoHScroll (),<span class="vp-variable"> IsAutoHScrollSet</span> = true,

and the <span class="code-span">editControl::setAutoHScroll/1</span> predicate

 

<span class="vp-variable">IsAutoHScrollSet</span> = true, controlName : setAutoHScroll (<span class="vp-variable">IsAutoHScrollSet</span>),

to set this flag programmatically.

Border

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. They define whether the control is created initially with a border around the control.

The default value is <span>'''False'''</span>.

You can use the <span class="code-span">editControl::getBorder/0-&gt;</span> or <span class="code-span">listBox::getBorder/0-&gt;</span> predicates to get whether the control has this flag

 

<span class="vp-variable">BorderIsSet</span> = controlName : getBorder (),<span class="vp-variable"> BorderIsSet </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setBorder/1</span> or <span class="code-span">listBox::setBorder/1</span> predicates

 

<span class="vp-variable">BorderIsSet </span><nowiki>= true, controlName : setBorder (</nowiki><span class="vp-variable">BorderIsSet</span>),

to set this flag programmatically.

Password

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the edit control displays all typed-in characters as asterisks (*).

The default value is <span>'''False'''</span> (displays typed characters "as-is").

You can use the <span class="code-span">editControl::getPassword/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsPassword</span> = controlName : getPassword (),<span class="vp-variable"> IsPassword </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setPassword/1</span> predicate

 

<span class="vp-variable">IsPassword </span><nowiki>= true, controlName : setPassword (</nowiki><span class="vp-variable">IsPassword</span>),

to set this flag programmatically.

HideSel

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the edit control hides selection, when it loses the input focus, and shows selection, when it receives the input focus.

The default value is <span>'''True'''</span> (hides selection).

You can use the <span class="code-span">editControl::getHideSel/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsHideSel</span> = controlName : getHideSel (),<span class="vp-variable"> IsHideSel </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setHideSel/1</span> predicate

 

<span class="vp-variable">IsHideSel </span><nowiki>= true, controlName : setHideSel (</nowiki><span class="vp-variable">IsHideSel</span>),

to set this flag programmatically.

ReadOnly

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the edit control is in the read-only mode.

The default value is <span>'''False'''</span> (editable).

You can use the <span class="code-span">editControl::getReadOnly/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsReadOnly</span> = controlName : getReadOnly (),<span class="vp-variable"> IsReadOnly </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setReadOnly/1</span> predicate

 

<span class="vp-variable">IsReadOnly </span><nowiki>= true, controlName : setReadOnly (</nowiki><span class="vp-variable">IsReadOnly</span>),

to set this flag programmatically.

Case

Possible values are <span>'''Insensitive'''</span>, <span>'''Upper'''</span>, <span>'''Lower'''</span>.

The default value is <span>'''Insensitive'''</span>.

Insensitive

Defines that the edit control leaves the typed-in text "as-is".

This is the default value.

Upper

Defines that the edit control converts all typed-in characters into the upper case.

You can use the <span class="code-span">editControl::getUpperCase/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsUpperCase</span> = controlName : getUpperCase (),<span class="vp-variable"> IsUpperCase </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setUpperCase/1</span> predicate

 

<span class="vp-variable">IsUpperCase </span><nowiki>= true</nowiki><span class="vp-variable">,</span> controlName : setUpperCase (<span class="vp-variable">IsUpperCase</span>),

to set this flag programmatically.

Lower

Defines that the edit control converts all typed-in characters into the lower case.

You can use the <span class="code-span">editControl::getLowerCase/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsLowerCase</span> = controlName : getLowerCase (),<span class="vp-variable"> IsLowerCase </span><nowiki>= true,</nowiki>

and the <span class="code-span">editControl::setLowerCase/1</span> predicate

 

<span class="vp-variable">IsLowerCase </span><nowiki>= true</nowiki><span class="vp-variable">,</span> controlName : setLowerCase (<span class="vp-variable">IsLowerCase</span>),

to set this flag programmatically.

Sort

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list control sorts strings alphabetically.

The default value is <span>'''True'''</span> (sort).

You can use the <span class="code-span">listControl::getSort/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsSort</span> = controlName : getSort (),<span class="vp-variable"> IsSort </span><nowiki>= true,</nowiki>

and the <span class="code-span">listControl::setSort/1</span> predicate

 

<span class="vp-variable">IsSort</span> = true, controlName : setSort (<span class="vp-variable">IsSort</span>),

to set this flag programmatically.

ExtendedSel

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list box control allows selection of multiple items by using the <span>'''Shift'''</span> key and the mouse or using the <span>'''Shift'''</span> key and the <span>'''Up'''</span> or <span>'''Down Arrow'''</span> keys.

The default value is <span>'''False'''</span> (cannot select multiple items).

You can use the <span class="code-span">listBox::getExtendedSel/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsExtendedSel</span> = controlName : getExtendedSel (),<span class="vp-variable"> IsExtendedSel</span> = true,

and the <span class="code-span">listBox::setExtendedSel/1</span> predicate

 

<span class="vp-variable">IsExtendedSel</span> = true, controlName : setExtendedSel (<span class="vp-variable">IsExtendedSel</span>),

to set this flag programmatically.

MultiSelect

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list box control allows selection of multiple items using the mouse.

The default value is <span>'''False'''</span> (cannot select multiple items).

You can use the <span class="code-span">listBox::getMultiSelect/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsMultiSelect</span> = controlName : getMultiSelect (),<span class="vp-variable"> IsMultiSelect</span> = true,

and the <span class="code-span">listBox::setMultiSelect/1</span> predicate

 

<span class="vp-variable">IsMultiSelect</span> = true, controlName : setMultiSelect (<span class="vp-variable">IsMultiSelect</span>),

to set this flag programmatically.

AutoNotify

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list box control notifies the parent window with an input message whenever the user clicks or double-clicks in the list box.

The default value is <span>'''True '''</span>(notify).

You can use the <span class="code-span">listBox::getAutoNotify/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsAutoNotify</span> = controlName : getAutoNotify (),<span class="vp-variable"> IsAutoNotify</span> = true,

and the <span class="code-span">listBox::setAutoNotify/1</span> predicate

 

<span class="vp-variable">IsAutoNotify</span> = true, controlName : setAutoNotify (<span class="vp-variable">IsAutoNotify</span>),

to set this flag programmatically.

UseTabStops

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list box control recognizes and expands TAB characters when drawing strings.

The default value is <span>'''False'''</span> (does not expand).

You can use the <span class="code-span">control::getUseTabStops/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsUseTabStops</span> = controlName : getUseTabStops (),<span class="vp-variable"> IsUseTabStops</span> = true,

and the <span class="code-span">control::setUseTabStops/1</span> predicate

 

<span class="vp-variable">IsUseTabStops</span> = true, controlName : setUseTabStops (<span class="vp-variable">IsUseTabStops</span>),

to set this flag programmatically.

StaticScrollbar

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list control shows a disabled vertical scroll bar for the list box when the box does not contain enough items to scroll. If it is <span>'''False'''</span>, then the scroll bar is hidden when the list box does not contain enough items.

The default value is <span>'''True '''</span>(shows vertical scroll bar).

You can use the <span class="code-span">listControl::getStaticScrollbar/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsStaticScrollbar</span> = controlName : getStaticScrollbar (),<span class="vp-variable"> IsStaticScrollbar</span> = true,

and the <span class="code-span">listControl::setStaticScrollbar/1</span> predicate

 

<span class="vp-variable">IsStaticScrollbar</span> = true, controlName : setStaticScrollbar (<span class="vp-variable">IsStaticScrollbar</span>),

to set this flag programmatically.

AllowPartialRows

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the size of the list box is exactly the size specified by the application when it creates the list box. Normally, Windows re-sizes list boxes so that a list box does not display partial items.

The default value is <span>'''True'''</span> for list box controls and <span>'''False'''</span> for list button and list edit controls.

You can use the <span class="code-span">listControl::getAllowPartialRows/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsAllowPartialRows</span> = controlName : getAllowPartialRows (),<span class="vp-variable"> IsAllowPartialRows </span><nowiki>= true,</nowiki>

and the <span class="code-span">listControl::setAllowPartialRows/1</span> predicate

 

<span class="vp-variable">IsAllowPartialRows</span> = true, controlName : setAllowPartialRows (<span class="vp-variable">IsAllowPartialRows</span>),

to set this flag programmatically.

MultiColumn

Possible values are <span>'''True'''</span> and <span>'''False'''</span>. If it is <span>'''True'''</span>, then the list box control can have multiple columns.

The default value is <span>'''False'''</span>.

You can use the <span class="code-span">listBox::getMultiColumn/0-&gt;</span> predicate to get whether the control has this flag

 

<span class="vp-variable">IsMultiColumn</span> = controlName : getMultiColumn (),<span class="vp-variable"> IsMultiColumn</span> = true,

and the <span class="code-span">listBox::setMultiColumn/1</span> predicate

 

<span class="vp-variable">IsMultiColumn</span> = true, controlName : setMultiColumn (<span class="vp-variable">IsMultiColumn</span>),

to set this flag programmatically.

Rows

Possible values are positive numbers. For list button and list edit controls it specifies the maximal number of rows, which can be displayed in the opened list box sub-control.

The default value is <span>'''3'''</span>.

You can use the <span class="code-span">listControl::getMaxDropDownRows/0-&gt;</span> predicate to get this number

 

<span class="vp-variable">MaxDropDownRowNumber</span> = controlName : getMaxDropDownRows (),

and the <span class="code-span">listControl::setMaxDropDownRows/1</span> predicate

 

<span class="vp-variable">MaxDropDownRowNumber</span> = 5, controlName : setMaxDropDownRows (<span class="vp-variable">MaxDropDownRowNumber</span>),

to set this number programmatically.

Icon Name

The icon name must be selected from the list of icon names registered in the Project (by clicking the [[Image:ListButton_button.png]] button). In order to an icon name appears in the list of registered icon names, you should add the icon file (<span class="file">IconName.ICO</span>) into the project files. To do this you should use the <span>'''File | Add'''</span> command (the <span>'''Resource Files'''</span> should be selected in the <span>'''Files of Type'''</span>).

Class

Specify a name of a Windows class for the custom control (your application code must register the custom control by this name).
Templates used on this page:
Return to Ide/Resource Editor/GUI Control Properties Table.
Retrieved from "https://wiki.visual-prolog.com/index.php?title=Ide/Resource_Editor/GUI_Control_Properties_Table"
View source for Ide/Resource Editor/GUI Control Properties Table

Search

Navigation

external links

collaboration

Personal tools

Views
