imgui

Class ImGuiInputTextCallbackData

java.lang.Object

imgui.binding.ImGuiStruct

imgui.ImGuiInputTextCallbackData

public class ImGuiInputTextCallbackData
extends ImGuiStruct

Shared state of InputText(), passed as an argument to your callback when a ImGuiInputTextFlags_Callback* flag is used.

The callback function should return 0 by default.

Callbacks (follow a flag name and see comments in ImGuiInputTextFlags_ declarations for more details)

- ImGuiInputTextFlags_CallbackEdit: Callback on buffer edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)

- ImGuiInputTextFlags_CallbackAlways: Callback on each iteration

- ImGuiInputTextFlags_CallbackCompletion: Callback on pressing TAB

- ImGuiInputTextFlags_CallbackHistory: Callback on pressing Up/Down arrows

- ImGuiInputTextFlags_CallbackCharFilter: Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.

- ImGuiInputTextFlags_CallbackResize: Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow.

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

ptr

Constructor Summary

Constructors

Constructor and Description
ImGuiInputTextCallbackData(long ptr)

Method Summary

Modifier and Type	Method and Description
void	deleteChars(int pos, int bytesCount) Delete Chars
java.lang.String	getBuf() [Resize] Can replace pointer
boolean	getBufDirty() Set if you modify Buf/BufTextLen!
int	getCursorPos() Current cursor position
int	getEventChar() [CharFilter] Character input;
int	getEventFlag() One ImGuiInputTextFlags_Callback*
int	getEventKey() [Completion,History]
int	getFlags() What user passed to InputText()
int	getSelectionEnd() Selection End
int	getSelectionStart() Selection Start
void	insertChars(int pos, java.lang.String str) Insert Chars
void	setBufDirty(boolean dirty) Set if you modify Buf/BufTextLen!
void	setCursorPos(int pos) Set the current cursor position
void	setEventChar(char c) [CharFilter] Replace character with another one, or set to zero to drop.
void	setEventChar(int c) [CharFilter] Replace character with another one, or set to zero to drop.
void	setSelectionEnd(int pos) Set Selection End
void	setSelectionStart(int pos) Set Selection Start

Methods inherited from class imgui.binding.ImGuiStruct

isNotValidPtr, isValidPtr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImGuiInputTextCallbackData

public ImGuiInputTextCallbackData(long ptr)

Method Detail

getEventFlag

public int getEventFlag()

One ImGuiInputTextFlags_Callback*

Returns:

ImGuiInputTextFlags

getFlags

public int getFlags()

What user passed to InputText()

Returns:

ImGuiInputTextFlags

getEventChar

public int getEventChar()

[CharFilter] Character input;

Returns:

Character input

setEventChar

public void setEventChar(char c)

[CharFilter] Replace character with another one, or set to zero to drop. return 1 is equivalent to setting EventChar=0;

Parameters:

c - Replaced characters

setEventChar

public void setEventChar(int c)

[CharFilter] Replace character with another one, or set to zero to drop. return 1 is equivalent to setting EventChar=0;

Parameters:

c - Replaced characters

getEventKey

public int getEventKey()

[Completion,History]

Returns:

Key pressed (Up/Down/TAB)

getBuf

public java.lang.String getBuf()

[Resize] Can replace pointer

[Completion,History,Always] Only write to pointed data, don't replace the actual pointer!

Returns:

Buf

getBufDirty

public boolean getBufDirty()

Set if you modify Buf/BufTextLen!

Returns:

Dirty

setBufDirty

public void setBufDirty(boolean dirty)

Set if you modify Buf/BufTextLen!

Parameters:

dirty - Dirty

getCursorPos

public int getCursorPos()

Current cursor position

Returns:

Current cursor position

setCursorPos

public void setCursorPos(int pos)

Set the current cursor position

Parameters:

pos - Set the current cursor position

getSelectionStart

public int getSelectionStart()

Selection Start

Returns:

Selection Start

setSelectionStart

public void setSelectionStart(int pos)

Set Selection Start

Parameters:

pos - Selection Start

getSelectionEnd

public int getSelectionEnd()

Selection End

Returns:

Selection End

setSelectionEnd

public void setSelectionEnd(int pos)

Set Selection End

Parameters:

pos - Selection End

deleteChars

public void deleteChars(int pos,
                        int bytesCount)

Delete Chars

Parameters:

pos - Start Delete Pos

bytesCount - Delete Char Count

insertChars

public void insertChars(int pos,
                        java.lang.String str)

Insert Chars

Parameters:

pos - insert Psos

str - insert String