Jump to content

GObject class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
Updated for LabVIEW 2020. Removed template.
 
(5 intermediate revisions by the same user not shown)
Line 3: Line 3:
{{stub}}
{{stub}}


The '''GObject class''' is a class in the [[VI Server Class Hierarchy]], (see also [[VI Server]]).
The '''GObject class''' is a class in the [[VI Server Class Hierarchy]], (see also [[VI Server]]). It is a child of the [[Generic]] class and is the parent of all classes of objects that appear on the [[Front Panel]] (i.e. [[Control|Controls]], [[Indicator|Indicators]], [[Decoration|Decorations]], etc.) and that appear on the  [[Block Diagram]] (i.e. [[Node|Nodes]], [[Function|Functions]], [[Structure|Structures]], [[Terminal|Terminals]], [[Wire|Wires]], etc.).  [[Property|Properties]] and [[Method|Methods]] for the GObject class are available to all of the classes that inherit from it.


{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide GObject Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide GObject Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"  
|+ GObject Properties Table
|+ GObject Properties Table
! Property ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE  
|- style="background-color:#D1BB80;"
|- style="background-color:#FFFFCC;"
|632A80C
| data-sort-value=103983104 |632A800
| [[GObject class/BasicObjectFlags property|BasicObjectFlags]]
| [[GObject class/Position property|Position]]
|
| Position of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates.
|R/W
| Read/Write
|
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|632A803
| data-sort-value=103983105 |632A801
| [[GObject class/Position.Left property|Position:Left]]
| Position of the left corner of the bounding rectangle of the object on the front panel window.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"  
| data-sort-value=103983106 |632A802
| [[GObject class/Position.Top property|Position:Top]]
| Position of the top corner of the bounding rectangle of the object on the front panel window.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=103983107 |632A803
| [[GObject class/Bounds property|Bounds]]
| [[GObject class/Bounds property|Bounds]]
|Maximum bounding area of the object specified in terms of width and height in pixels.
| Maximum bounding area of the object specified in terms of width and height in pixels.
 
| Read Only
For a front panel object, this property returns the dimensions of the rectangle enclosing all the visible object components, such as the control, caption, label, graph legends, and so on.
| Yes (Read Only)
 
|- style="background-color:#FFFFCC;"  
You cannot use this property to change the size of an object. To change the size of an object programmatically, use more specific properties such as Text Width or Plot Area:Size.
| data-sort-value=103983108 |632A804
|R
| [[GObject class/Bounds.Area Width property|Bounds:Area Width]]
|X
| Width of the maximum bounding area of the object in pixels.
|- style="background-color:#FFFFCC;"
| Read Only
|632A805
| Yes (Read Only)
| [[GObject class/Area Height property|Area Height]]
|- style="background-color:#FFFFCC;"  
|Height of the maximum bounding area of the object in pixels.
| data-sort-value=103983109 |632A805
 
| [[GObject class/Bounds.Area Height property|Bounds:Area Height]]
This property is an element of the Bounds property.
| Height of the maximum bounding area of the object in pixels.
|R
| Read Only
|X
| Yes (Read Only)
|- style="background-color:#FFFFCC;"
|- style="background-color:#CCFFFF;"  
|632A804
| data-sort-value=103983110 |632A806
| [[GObject class/Area Width property|Area Width]]
|Width of the maximum bounding area of the object in pixels.
 
This property is an element of the Bounds property.
|R
|X
|- style="background-color:#CCFFFF;"
|632A817
| [[GObject class/DependNames property|DependNames]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A816
| [[GObject class/DependPaths property|DependPaths]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A815
| [[GObject class/MissingNames property|MissingNames]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A814
| [[GObject class/MissingPaths property|MissingPaths]]
|
|R
|
|- style="background-color:#D1BB80;"
|632A808
| [[GObject class/GrpMbrRefs() property|GrpMbrRefs()]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A806
| [[GObject class/Grouped property|Grouped]]
| [[GObject class/Grouped property|Grouped]]
|
| Returns TRUE if and only if the GObject is a member of a group (including locked groups).
|R
| Read Only
|X
| No
|- style="background-color:#D1BB80;"
|- style="background-color:#CCFFFF;"  
|632A80D
| data-sort-value=103983111 |632A807
| [[GObject class/IsWizardLocked property|IsWizardLocked]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A807
| [[GObject class/Locked property|Locked]]
| [[GObject class/Locked property|Locked]]
|
| Returns TRUE if and only if the GObject has been locked to prevent editing.
|R
| Read Only
|X
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|632A80B
| data-sort-value=103983112 |632A808
| [[GObject class/MasterRect property|MasterRect]]
| [[GObject class/Group Member Refs() property|Group Member Refs[]]]
|Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object.
| Returns an array of GObject references to all members of the same front panel grouping (including locked groups) as the source object.
|R
| Read Only
|X
| No
|- style="background-color:#FFFFCC;"
|- style="background-color:#CCFFFF;"  
|632A800
| data-sort-value=103983113 |632A809
| [[GObject class/Position property|Position]]
|Position of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates.
 
The bounding rectangle of the object includes all visible parts of the object. For example, if the object label is visible and you wire the top coordinate to this property, LabVIEW positions the top of the label at the coordinate you wired. If the object label is not visible, LabVIEW positions the top of the remaining visible parts of the object at the coordinate you wired.
 
<b>Note</b>  LabVIEW sets the origin for this property when you create a VI. When you scroll the owning pane, the origin does not change but instead scrolls with the owning pane. If you do not move the object, this property returns the same coordinates for the object regardless of whether you scroll the owning pane. Use the Origin property with this property to calculate the current position of an object in relation to the owning pane. For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system.
If you attempt to reposition an object that is grouped with other objects, LabVIEW repositions only the object you specify, not the whole group.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632A801
| [[GObject class/Left property|Left]]
|Position of the left corner of the bounding rectangle of the object on the front panel window.
 
This property is an element of the Position property.
 
<b>Note</b>  For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632A802
| [[GObject class/Top property|Top]]
|Position of the top corner of the bounding rectangle of the object on the front panel window.
 
This property is an element of the Position property.
 
<b>Note</b>  For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system.
|R/W
|X
|- style="background-color:#D1BB80;"
|632A80F
| [[GObject class/ResizeInfoResizeHoriz property|ResizeInfoResizeHoriz]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A810
| [[GObject class/ResizeInfoResizeVert property|ResizeInfoResizeVert]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A812
| [[GObject class/IncludeInResize property|IncludeInResize]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A811
| [[GObject class/ResizeDialogName property|ResizeDialogName]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|632A809
| [[GObject class/Selected property|Selected]]
| [[GObject class/Selected property|Selected]]
|Returns TRUE if the GObject is selected.
| Returns TRUE if the GObject is selected.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|632A80A
| data-sort-value=103983114 |632A80A
| [[GObject class/TotalRect property|TotalRect]]
| [[GObject class/Total Bounds Rect property|Total Bounds Rect]]
|Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object.
| Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object.
|R
| Read Only
|X
| Yes
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|632A813
| data-sort-value=103983115 |632A80B
| [[GObject class/Master Bounds Rect property|Master Bounds Rect]]
| Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object.
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103983116 |632A80C
| [[GObject class/Basic Object Flags property|Basic Object Flags]]
|
| Read/Write
| No
|- style="background-color:#D1BB80;"
| data-sort-value=103983117 |632A80D
| [[GObject class/Is Wizard Locked property|Is Wizard Locked]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103983119 |632A80F
| [[GObject class/Resize Info.Can Resize Horizontally property|Resize Info:Can Resize Horizontally]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103983120 |632A810
| [[GObject class/Resize Info.Can Resize Vertically property|Resize Info:Can Resize Vertically]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103983121 |632A811
| [[GObject class/Resize Info.Name in Resize Dialog property|Resize Info:Name in Resize Dialog]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103983122 |632A812
| [[GObject class/Resize Info.Include In Resize property|Resize Info:Include In Resize]]
|
| Read Only
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=103983123 |632A813
| [[GObject class/UID property|UID]]
| [[GObject class/UID property|UID]]
|Returns the unique identifier (UID) for the object. UIDs are identifiers for LabVIEW objects and are always unique within the same VI. Inspect the UID of an object to verify that it is the exact object that you want to manipulate.
| Returns the unique identifier (UID) for the object. UIDs are identifiers for LabVIEW objects and are always unique within the same VI. Inspect the UID of an object to verify that it is the exact object that you want to manipulate.
 
| Read Only
A UID is always associated with the same object, even after you save the VI. However, if you delete an object, LabVIEW might assign the UID for that deleted object to a different object in the future. To detect this situation and ensure each UID refers to the object that you expect, check the Class Name property or Label property of the object in addition to the UID.
| Yes
|R
|- style="background-color:#CCFFFF;"
|X
| data-sort-value=103983124 |632A814
| [[GObject class/Dependencies.Missing Dependency Paths property|Dependencies:Missing Dependency Paths]]
| Returns the array of paths listing every missing dependency of the given object.
| Read Only
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=103983125 |632A815
| [[GObject class/Dependencies.Missing Dependency Names property|Dependencies:Missing Dependency Names]]
| Returns the array of qualified names listing every missing dependency of the given object.
| Read Only
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=103983126 |632A816
| [[GObject class/Dependencies.Found Dependency Paths property|Dependencies:Found Dependency Paths]]
| Returns the array of paths listing every dependency that is not missing of the given object.
| Read Only
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=103983127 |632A817
| [[GObject class/Dependencies.Found Dependency Names property|Dependencies:Found Dependency Names]]
| Returns the array of qualified names listing every dependency of the given object loaded into memory.
| Read Only
| No
|}
|}
</div>
</div></div>


==Methods==
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide GObject Methods Table</span>
<span class="mw-customtoggle-methodstable">Show/Hide GObject Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{{VIServerLegend|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
{| class="wikitable sortable"
|+ GObject Methods Table
|+ GObject Methods Table
! Method ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! RTE
! RTE  
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|632A407
| data-sort-value=103982080 |632A400
| [[GObject class/GetObjHelp method|GetObjHelp]]
|Returns the help information for the object.
|X
|- style="background-color:#D1BB80;"
|632A405
| [[GObject class/Invalidate method|Invalidate]]
|
|X
|- style="background-color:#D1BB80;"
|632A404
| [[GObject class/Launch Config method|Launch Config]]
|
|
|- style="background-color:#CCFFFF;"
|632A400
| [[GObject class/Move method|Move]]
| [[GObject class/Move method|Move]]
|Moves the object to the specified position.
| Moves the object to the specified position.
 
| No
<b>Note</b>  If you attempt to move an object to the owning VI of another object, LabVIEW makes a copy of the object instead of moving the object.
|- style="background-color:#FFFFCC;"  
|
| data-sort-value=103982081 |632A401
|- style="background-color:#FFFFCC;"
| [[GObject class/Object Highlight method|Object Highlight]]
|632A401
| Given a Gobject Reference, this method scrolls to and highlights the object.
| [[GObject class/ObjHighlight method|ObjHighlight]]
| Yes
|Given a Gobject Reference, this method scrolls to and highlights the object.
|- style="background-color:#CCFFFF;"  
|X
| data-sort-value=103982082 |632A402
|- style="background-color:#CCFFFF;"
|632A402
| [[GObject class/Replace method|Replace]]
| [[GObject class/Replace method|Replace]]
|Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: <b>Style</b>, <b>Path</b>, or <b>Palette String</b>.
| Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: '''Style''', '''Path''', or '''Palette String'''.
|
| No
|- style="background-color:#CCFFFF;"
|- style="background-color:#CCFFFF;"  
|632A403
| data-sort-value=103982083 |632A403
| [[GObject class/Replace No Attrib method|Replace No Attrib]]
| [[GObject class/Replace No Attributes method|Replace No Attributes]]
|Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: <b>Style</b>, <b>Path</b>, or <b>Palette String</b>. This method does not maintain any size or color attributes of the object you replace.
| Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: '''Style''', '''Path''', or '''Palette String'''. This method does not maintain any size or color attributes of the object you replace.
|
| No
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|632A406
| data-sort-value=103982084 |632A404
| [[GObject class/ReplacePreferringStubDDOOnFP method|ReplacePreferringStubDDOOnFP]]
| [[GObject class/Launch Config Page method|Launch Config Page]]
|
|
|
| No
|- style="background-color:#D1BB80;"
| data-sort-value=103982085 |632A405
| [[GObject class/Invalidate method|Invalidate]]
|
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=103982086 |632A406
| [[GObject class/Replace Preferring Stub DDO OnFP method|Replace Preferring Stub DDO OnFP]]
|
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=103982087 |632A407
| [[GObject class/Get Help Info method|Get Help Info]]
| Returns the help information for the object.
| Yes
|}
|}
</div>
</div></div>
 
== Event ==
''This class has no events or it inherits events from its parent: [[Generic class#Events|Generic Class]].''


==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| In [[LabVIEW 2020]] the following changes were made:
* The [[GObject class/Grouped property|Grouped property]] was changed from [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]]
* The [[GObject class/Locked property|Locked property]] was changed from [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]].
* The [[GObject class/Group Member Refs() property|Group Member Refs[] property]] was changed from [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]].
|}
|}


Line 255: Line 235:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 03:46, 17 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name GObject class
Class ID 36
Scope Basic Development Environment
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The GObject class is a class in the VI Server Class Hierarchy, (see also VI Server). It is a child of the Generic class and is the parent of all classes of objects that appear on the Front Panel (i.e. Controls, Indicators, Decorations, etc.) and that appear on the Block Diagram (i.e. Nodes, Functions, Structures, Terminals, Wires, etc.). Properties and Methods for the GObject class are available to all of the classes that inherit from it.

Properties

Show/Hide GObject Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GObject Properties Table
Property ID Long Name (English) Description R/W RTE
632A800 Position Position of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates. Read/Write Yes
632A801 Position:Left Position of the left corner of the bounding rectangle of the object on the front panel window. Read/Write Yes
632A802 Position:Top Position of the top corner of the bounding rectangle of the object on the front panel window. Read/Write Yes
632A803 Bounds Maximum bounding area of the object specified in terms of width and height in pixels. Read Only Yes (Read Only)
632A804 Bounds:Area Width Width of the maximum bounding area of the object in pixels. Read Only Yes (Read Only)
632A805 Bounds:Area Height Height of the maximum bounding area of the object in pixels. Read Only Yes (Read Only)
632A806 Grouped Returns TRUE if and only if the GObject is a member of a group (including locked groups). Read Only No
632A807 Locked Returns TRUE if and only if the GObject has been locked to prevent editing. Read Only No
632A808 Group Member Refs[] Returns an array of GObject references to all members of the same front panel grouping (including locked groups) as the source object. Read Only No
632A809 Selected Returns TRUE if the GObject is selected. Read/Write Yes
632A80A Total Bounds Rect Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object. Read Only Yes
632A80B Master Bounds Rect Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object. Read Only Yes
632A80C Basic Object Flags Read/Write No
632A80D Is Wizard Locked Read Only Yes
632A80F Resize Info:Can Resize Horizontally Read Only Yes
632A810 Resize Info:Can Resize Vertically Read Only Yes
632A811 Resize Info:Name in Resize Dialog Read Only Yes
632A812 Resize Info:Include In Resize Read Only Yes
632A813 UID Returns the unique identifier (UID) for the object. UIDs are identifiers for LabVIEW objects and are always unique within the same VI. Inspect the UID of an object to verify that it is the exact object that you want to manipulate. Read Only Yes
632A814 Dependencies:Missing Dependency Paths Returns the array of paths listing every missing dependency of the given object. Read Only No
632A815 Dependencies:Missing Dependency Names Returns the array of qualified names listing every missing dependency of the given object. Read Only No
632A816 Dependencies:Found Dependency Paths Returns the array of paths listing every dependency that is not missing of the given object. Read Only No
632A817 Dependencies:Found Dependency Names Returns the array of qualified names listing every dependency of the given object loaded into memory. Read Only No

Methods

Show/Hide GObject Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GObject Methods Table
Property ID Long Name (English) Description RTE
632A400 Move Moves the object to the specified position. No
632A401 Object Highlight Given a Gobject Reference, this method scrolls to and highlights the object. Yes
632A402 Replace Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. No
632A403 Replace No Attributes Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. This method does not maintain any size or color attributes of the object you replace. No
632A404 Launch Config Page No
632A405 Invalidate Yes
632A406 Replace Preferring Stub DDO OnFP No
632A407 Get Help Info Returns the help information for the object. Yes

Event

This class has no events or it inherits events from its parent: Generic Class.


History

Version Change(s)
LabVIEW 2020 In LabVIEW 2020 the following changes were made:

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=GObject_class&oldid=28472"