DigitalSpaces::DICEGUIMultiLineEditbox Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	hasInputFocus ()
	return true if the edit box has input focus.
bool	isReadOnly ()
	return true if the edit box is read-only.
unsigned long	getCaratIndex ()
	return the current position of the carat.
unsigned long	getSelectionStartIndex ()
	return the current selection start point.
unsigned long	getSelectionEndIndex ()
	return the current selection end point.
unsigned long	getSelectionLength ()
	return the length of the current selection (in code points / characters).
unsigned long	getMaxTextLength ()
	return the maximum text length set for this edit box.
bool	isWordWrapped ()
	Return whether the text in the edit box will be word-wrapped.
DICEGUIScrollbar *	getVertScrollbar ()
	Return a pointer to the vertical scrollbar component widget for this MultiLineEditbox.
DICEGUIScrollbar *	getHorzScrollbar ()
	Return a pointer to the horizontal scrollbar component widget for this MultiLineEditbox.
void	getTextRenderArea (out_Vector4f *area)
	Return a Rect object describing, in un-clipped pixels, the window relative area that the text should be rendered in to.
unsigned long	getLineNumberFromIndex (unsigned long index)
	Return the line number a given index falls on with the current formatting. Will return last line if index is out of range.
void	setReadOnly (bool setting)
	Specify whether the edit box is read-only.
void	setCaratIndex (unsigned long carat_pos)
	Set the current position of the carat.
void	setSelection (unsigned long start_pos, unsigned long end_pos)
	Define the current selection for the edit box.
void	setMaxTextLength (unsigned long max_len)
	set the maximum text length for this edit box.
void	ensureCaratIsVisible ()
	Scroll the view so that the current carat position is visible.
void	setWordWrapping (bool setting)
	Set whether the text will be word wrapped or not.
void	setSelectionBrushImage (DICEGUIImage *image)
DICEGUIImage *	getSelectionBrushImage ()

---

Member Function Documentation

bool DigitalSpaces::DICEGUIMultiLineEditbox::hasInputFocus

(

)

return true if the edit box has input focus.

Returns:

• true if the edit box has keyboard input focus.
• false if the edit box does not have keyboard input focus.

bool DigitalSpaces::DICEGUIMultiLineEditbox::isReadOnly

(

)

return true if the edit box is read-only.

Returns:

• true if the edit box is read only and can't be edited by the user.
• false if the edit box is not read only and may be edited by the user.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getCaratIndex

(

)

return the current position of the carat.

Returns:

Index of the insert carat relative to the start of the text.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getSelectionStartIndex

(

)

return the current selection start point.

Returns:

Index of the selection start point relative to the start of the text. If no selection is defined this function returns the position of the carat.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getSelectionEndIndex

(

)

return the current selection end point.

Returns:

Index of the selection end point relative to the start of the text. If no selection is defined this function returns the position of the carat.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getSelectionLength

(

)

return the length of the current selection (in code points / characters).

Returns:

Number of code points (or characters) contained within the currently defined selection.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getMaxTextLength

(

)

return the maximum text length set for this edit box.

Returns:

The maximum number of code points (characters) that can be entered into this edit box.

bool DigitalSpaces::DICEGUIMultiLineEditbox::isWordWrapped

(

)

Return whether the text in the edit box will be word-wrapped.

Returns:

• true if the text will be word-wrapped at the edges of the widget frame.
• false if text will not be word-wrapped (a scroll bar will be used to access long text lines).

DICEGUIScrollbar* DigitalSpaces::DICEGUIMultiLineEditbox::getVertScrollbar

(

)

Return a pointer to the vertical scrollbar component widget for this MultiLineEditbox.

Returns:

Pointer to a Scrollbar object.

Exceptions:

UnknownObjectException

Thrown if the vertical Scrollbar component does not exist.

DICEGUIScrollbar* DigitalSpaces::DICEGUIMultiLineEditbox::getHorzScrollbar

(

)

Return a pointer to the horizontal scrollbar component widget for this MultiLineEditbox.

Returns:

Pointer to a Scrollbar object.

Exceptions:

UnknownObjectException

Thrown if the horizontal Scrollbar component does not exist.

void DigitalSpaces::DICEGUIMultiLineEditbox::getTextRenderArea

(

out_Vector4f *

area

)

Return a Rect object describing, in un-clipped pixels, the window relative area that the text should be rendered in to.

Returns:

Rect object describing the area of the Window to be used for rendering text.

unsigned long DigitalSpaces::DICEGUIMultiLineEditbox::getLineNumberFromIndex

(

unsigned long

index

)

Return the line number a given index falls on with the current formatting. Will return last line if index is out of range.

void DigitalSpaces::DICEGUIMultiLineEditbox::setReadOnly

(

bool

setting

)

Specify whether the edit box is read-only.

Parameters:

setting

true if the edit box is read only and can't be edited by the user. false if the edit box is not read only and may be edited by the user.

Returns:

Nothing.

void DigitalSpaces::DICEGUIMultiLineEditbox::setCaratIndex

(

unsigned long

carat_pos

)

Set the current position of the carat.

Parameters:

carat_pos

New index for the insert carat relative to the start of the text. If the value specified is greater than the number of characters in the edit box, the carat is positioned at the end of the text.

Returns:

Nothing.

void DigitalSpaces::DICEGUIMultiLineEditbox::setSelection	(	unsigned long	start_pos,
		unsigned long	end_pos
	)

Define the current selection for the edit box.

Parameters:

	start_pos	Index of the starting point for the selection. If this value is greater than the number of characters in the edit box, the selection start will be set to the end of the text.
	end_pos	Index of the ending point for the selection. If this value is greater than the number of characters in the edit box, the selection start will be set to the end of the text.

Returns:

Nothing.

void DigitalSpaces::DICEGUIMultiLineEditbox::setMaxTextLength

(

unsigned long

max_len

)

set the maximum text length for this edit box.

Parameters:

max_len

The maximum number of code points (characters) that can be entered into this Editbox.

Returns:

Nothing.

void DigitalSpaces::DICEGUIMultiLineEditbox::ensureCaratIsVisible

(

)

Scroll the view so that the current carat position is visible.

void DigitalSpaces::DICEGUIMultiLineEditbox::setWordWrapping

(

bool

setting

)

Set whether the text will be word wrapped or not.

Parameters:

setting

true if the text should word-wrap at the edges of the text box. false if the text should not wrap, but a scroll bar should be used.

Returns:

Nothing.

void DigitalSpaces::DICEGUIMultiLineEditbox::setSelectionBrushImage

(

DICEGUIImage *

image

)

DICEGUIImage* DigitalSpaces::DICEGUIMultiLineEditbox::getSelectionBrushImage

(

)

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h