GuiMemoIsReadOnly: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Add missing OOP info)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__  
__NOTOC__  
{{New feature/item|3.0156|1.5.5|12246|This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.}}
{{New feature/item|3.0156|1.5.5|12419|This function checking if memo is read only or no.}}


==Syntax==  
==Syntax==  
Line 7: Line 7:
bool guiMemoIsReadOnly ( gui-memo theMemo )
bool guiMemoIsReadOnly ( gui-memo theMemo )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[GuiMemo]]:isReadOnly|readOnly|guiMemoSetReadOnly}}


===Required Arguments===  
===Required Arguments===  
*'''theMemo:''' The memo to change read-only status of.
*'''theMemo:''' The memo to check read-only status of.


===Returns===
===Returns===

Latest revision as of 13:56, 10 August 2021

This function checking if memo is read only or no.

Syntax

bool guiMemoIsReadOnly ( gui-memo theMemo )

OOP Syntax Help! I don't understand this!

Method: GuiMemo:isReadOnly(...)
Variable: .readOnly
Counterpart: guiMemoSetReadOnly


Required Arguments

  • theMemo: The memo to check read-only status of.

Returns

Returns true if the memo is read only, false if the memo isn't read only, nil otherwise.

Example

addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), -- only execute the code when this resource restarts
	function( )
		memo = guiCreateMemo( 0.4, 0.4, 0.2, 0.2, "This is a memo.", true ) -- create a relative memo GUI element
		guiMemoSetReadOnly( memo, true ) -- make it read only, so players won't be able to edit it in-game
                addCommandHandler("isReadOnly",function() -- add a command 'isReadOnly'
                     local isReadOnly = guiMemoIsReadOnly(memo)
                     outputChatBox("Memo read only: "..isReadOnly) -- show info about memo
                end)
	end
)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI