CIP C++ documentation for class "uifcInputPanel"

Class uifcInputPanel

# include <uifcInputPanel.h> class uifcInputPanel : public virtual uifcText { xaideclare(uifcInputPanel) ... };

Description

Method Summary


`void`	`AddActionListener (uifcInputPanelListener_ptr listener)`


`xbool`	`CanDrawContentDisabled ()`


`xbool`	`CanRedraw ()`


`void`	`CopySelectionToClipboard ()`


`void`	`CreateTimer (uifcInputPanelTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`CutSelectionToClipboard ()`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesActivateOnReturn ()`


`xbool`	`DoesAllowReturnInput ()`


`xbool`	`DoesAllowTabInput ()`


`xbool`	`DoesAlwaysShowValueSign ()`


`xbool`	`DoesAutoCompleteReplace ()`


`xbool`	`DoesHighlightOnFocus ()`


`xbool`	`DoesSizeByContents ()`


`xint`	`GetAutoCompleteLength ()`


`xstringsequence_ptr`	`GetAutoCompleteTextArray ()`


`xint`	`GetCaretPosition ()`


`xint`	`GetDigits ()`


`xstring`	`GetDoubleFormat ()`


`xreal`	`GetDoubleValue ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetIntegerValue ()`


`xint`	`GetLineLength (xint line)`


`xreal`	`GetMaximumDoubleValue ()`


`xint`	`GetMaximumIntegerValue ()`


`xreal`	`GetMinimumDoubleValue ()`


`xint`	`GetMinimumIntegerValue ()`


`xint`	`GetMinimumWidth ()`


`xint`	`GetPasswordCharacter ()`


`xstring`	`GetPrompt ()`


`uifcReadingOrder`	`GetReadingOrder ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcPoint_ptr`	`GetSelectedRange ()`


`xstring`	`GetSelectedText ()`


`xstring`	`GetStringValue ()`


`xint`	`GetTextGravity ()`


`xstring`	`GetTextValue ()`


`xint`	`GetTextValueMaximumLength ()`


`uifcInputType`	`GetValueType ()`


`xstring`	`GetWideStringValue ()`


`xbool`	`HasBorder ()`


`xbool`	`HasTextChanged ()`


`void`	`InputBackspaceKeys (xint count)`


`void`	`InputDeleteKeys (xint count)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`void`	`InsertTextIntoSelection (xrstring text)`


`xbool`	`IsAutoCompleteCaseSensitive ()`


`xbool`	`IsCaretVisible ()`


`xbool`	`IsInMixedState ()`


`xbool`	`IsPassword ()`


`xbool`	`IsSelectionVisible ()`


`xbool`	`IsWidthFixed ()`


`void`	`PasteClipboardToSelection ()`


`void`	`PushAction (uifcInputPanelAction action)`


`void`	`RedoLastUndo ()`


`void`	`ReplaceSelectionWithText (xint start, xint end, xrstring text)`


`void`	`SelectAll ()`


`void`	`SetActivateOnReturn (xbool flag)`


`void`	`SetAllowReturnInput (xbool flag)`


`void`	`SetAllowTabInput (xbool flag)`


`void`	`SetAlwaysShowValueSign (xbool flag)`


`void`	`SetAutoCompleteCaseSensitive (xbool flag)`


`void`	`SetAutoCompleteLength (xint value)`


`void`	`SetAutoCompleteReplace (xbool flag)`


`void`	`SetAutoCompleteTextArray (xstringsequence_ptr values)`


`void`	`SetCanDrawContentDisabled (xbool flag)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetCaretPosition (xint position)`


`void`	`SetCaretVisible (xbool flag)`


`void`	`SetDigits (xint value)`


`void`	`SetDoubleFormat (xrstring value)`


`void`	`SetDoubleValue (xreal value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHasTextChanged (xbool flag)`


`void`	`SetHighlightOnFocus (xbool flag)`


`void`	`SetInMixedState (xbool flag)`


`void`	`SetIntegerValue (xint value)`


`void`	`SetMaximumDoubleValue (xreal value)`


`void`	`SetMaximumIntegerValue (xint value)`


`void`	`SetMinimumDoubleValue (xreal value)`


`void`	`SetMinimumIntegerValue (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetPassword (xbool flag)`


`void`	`SetPasswordCharacter (xint value)`


`void`	`SetPrompt (xrstring value)`


`void`	`SetReadingOrder (uifcReadingOrder value)`


`void`	`SetSelectedRange (uifcPoint_ptr value)`


`void`	`SetSelectionVisible (xbool flag)`


`void`	`SetSizeByContents (xbool flag)`


`void`	`SetStringValue (xrstring value)`


`void`	`SetTextGravity (xint value)`


`void`	`SetTextValue (xrstring value)`


`void`	`SetTextValueMaximumLength (xint value)`


`void`	`SetValueType (uifcInputType value)`


`void`	`SetWideStringValue (xrstring value)`


`void`	`SetWidthFixed (xbool flag)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`


`void`	`UndoLastChange ()`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Methods Inherited from Class uifcText:: GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetWidth, SetWidth, GetFontStyle, SetFontStyle

Method Detail

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

xint GetCaretPosition ()

Get the caret position.

Returns:

void InputBackspaceKeys (xint count)

Execute a number of BACKSPACE key presses in the component.

Parameters:

count

Returns:

void UndoLastChange ()

Undo the last change applied to the text.

Returns:

void InsertTextIntoSelection (xrstring text)

Insert the given text at the current caret position, replacing any selected text.

Parameters:

text

Returns:

xint GetLineLength (xint line)

Get the length of the given line, i.e. the number of characters in it.

Parameters:

line

Returns:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

void ReplaceSelectionWithText (xint start, xint end, xrstring text)

Replace the text between the start and end caret positions with the given text.

Parameters:

start
end
text

Returns:

void SetSelectedRange (uifcPoint_ptr value)

Select the text between the start and end caret positions. Note: If start < 0 then the selection is removed, forcing the selection anchor to move to the caret position. If end < 0, the entire text is selected from the start position onwards.

Parameters:

value

Returns:

void PasteClipboardToSelection ()

Replace the selected text with the contents of the system clipboard.

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

void SelectAll ()

Select all the text of the TextArea. The use of this operation has been superceded by SelectedRange operation is provided for backwards compatibility only.

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void CopySelectionToClipboard ()

Copy the selected text into the system clipboard.

Returns:

void CutSelectionToClipboard ()

Copy the selected text into the system clipboard and then delete the selected text.

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

void InputDeleteKeys (xint count)

Execute a number of DELETE key presses in the component.

Parameters:

count

Returns:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

void SetCaretPosition (xint position)

Set the caret and the selection anchor positions.

Parameters:

position

Returns:

xstring GetSelectedText ()

Get the selected text of the component.

Returns:

uifcPoint_ptr GetSelectedRange ()

Get the caret positions of the start and the end of the selected text.

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

void RedoLastUndo ()

Repeat the last change which was undone.

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

xbool DoesActivateOnReturn ()

Returns:: Flag indicating whether a RETURN key press should generate a OnActivate() callback (xtrue) or whether it should cause the default button in the Dialog to be pressed (xfalse).

void SetActivateOnReturn (xbool flag)

Sets flag indicating whether a RETURN key press should generate a OnActivate() callback (xtrue) or whether it should cause the default button in the Dialog to be pressed (xfalse).

Parameters:

flag

Returns:

xreal GetMaximumDoubleValue ()

Returns:: The maximum double value of the contents of the InputPanel.

void SetMaximumDoubleValue (xreal value)

Sets the maximum double value of the contents of the InputPanel.

Parameters:

value

Returns:

xint GetMinimumWidth ()

Returns:: The minimum width of the InputPanel, in character widths.

void SetMinimumWidth (xint value)

Sets the minimum width of the InputPanel, in character widths.

Parameters:

value

Returns:

xstring GetPrompt ()

Returns:: The text to be displayed in the InputPanel when the component does not have the focus and its contents are empty.

void SetPrompt (xrstring value)

Sets the text to be displayed in the InputPanel when the component does not have the focus and its contents are empty.

Parameters:

value

Returns:

xbool HasBorder ()

Returns:: Flag indicating whether the InputPanel has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the InputPanel has a decorated shadow border.

Parameters:

flag

Returns:

xreal GetDoubleValue ()

Returns:: The double value of the contents of the InputPanel.

void SetDoubleValue (xreal value)

Sets the double value of the contents of the InputPanel.

Parameters:

value

Returns:

xbool DoesAllowReturnInput ()

Returns:: Flag indicating whether to allow RETURN key presses to be ignored by the InputPanel itself and instead passed to the application via a OnKeyDown() callback (xfalse) or whether they should be inserted into the text as a new-line character (xtrue).

void SetAllowReturnInput (xbool flag)

Sets flag indicating whether to allow RETURN key presses to be ignored by the InputPanel itself and instead passed to the application via a OnKeyDown() callback (xfalse) or whether they should be inserted into the text as a new-line character (xtrue).

Parameters:

flag

Returns:

xbool CanDrawContentDisabled ()

Returns:: Flag indicating whether the images embedded in the text contents of the InputPanel should be greyed-out whenever the InputPanel is insensitive.

void SetCanDrawContentDisabled (xbool flag)

Sets flag indicating whether the images embedded in the text contents of the InputPanel should be greyed-out whenever the InputPanel is insensitive.

Parameters:

flag

Returns:

xbool HasTextChanged ()

Returns:: Flag indicating whether the text contents of the InputPanel have been modified.
The InputPanel sets the value of this attribute to xfalse when the entire text is modified programmatically. The value is then automatically set to xtrue when the text is next changed.
This flag is provided for application use so that any "save if needed" functionality can be implemented for text editors. In this case the value should be set to xfalse once the text has been saved.

void SetHasTextChanged (xbool flag)

Sets flag indicating whether the text contents of the InputPanel have been modified.
The InputPanel sets the value of this attribute to xfalse when the entire text is modified programmatically. The value is then automatically set to xtrue when the text is next changed.
This flag is provided for application use so that any "save if needed" functionality can be implemented for text editors. In this case the value should be set to xfalse once the text has been saved.

Parameters:

flag

Returns:

xstring GetStringValue ()

Returns:: The contents of the InputPanel as a string.

void SetStringValue (xrstring value)

Sets the contents of the InputPanel as a string.

Parameters:

value

Returns:

xint GetMaximumIntegerValue ()

Returns:: The maximum integer value of the contents of the InputPanel.

void SetMaximumIntegerValue (xint value)

Sets the maximum integer value of the contents of the InputPanel.

Parameters:

value

Returns:

xbool DoesSizeByContents ()

Returns:: Flag indicating whether the InputPanel should be sized according to its contents (xtrue) or whether it should use its Width attribute.

void SetSizeByContents (xbool flag)

Sets flag indicating whether the InputPanel should be sized according to its contents (xtrue) or whether it should use its Width attribute.

Parameters:

flag

Returns:

xbool IsWidthFixed ()

Returns:: Flag indicating whether the InputPanel should increase its width to accomodate its contents (xfalse) or whether it should maintain its width as the contents grow (xtrue).

void SetWidthFixed (xbool flag)

Sets flag indicating whether the InputPanel should increase its width to accomodate its contents (xfalse) or whether it should maintain its width as the contents grow (xtrue).

Parameters:

flag

Returns:

xbool IsInMixedState ()

Returns:: Flag indicating whether the InputPanel has no value at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user enters a value in the InputPanel it will automatically be reset to xfalse.

void SetInMixedState (xbool flag)

Sets flag indicating whether the InputPanel has no value at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user enters a value in the InputPanel it will automatically be reset to xfalse.

Parameters:

flag

Returns:

xbool DoesHighlightOnFocus ()

Returns:: Flag indicating whether the entire contents of the InputPanel should be selected whenever the InputPanel receives the keyboard input focus.

void SetHighlightOnFocus (xbool flag)

Sets flag indicating whether the entire contents of the InputPanel should be selected whenever the InputPanel receives the keyboard input focus.

Parameters:

flag

Returns:

xbool IsPassword ()

Returns:: Flag indicating whether the component is used for password entry.

void SetPassword (xbool flag)

Sets flag indicating whether the component is used for password entry.

Parameters:

flag

Returns:

xint GetIntegerValue ()

Returns:: The integer value of the contents of the InputPanel.

void SetIntegerValue (xint value)

Sets the integer value of the contents of the InputPanel.

Parameters:

value

Returns:

xint GetMinimumIntegerValue ()

Returns:: The minimum integer value of the contents of the InputPanel.

void SetMinimumIntegerValue (xint value)

Sets the minimum integer value of the contents of the InputPanel.

Parameters:

value

Returns:

uifcInputType GetValueType ()

Returns:

The data-type of the contents of the InputPanel.

INPUT_TYPE_INTEGER	An integer
INPUT_TYPE_DOUBLE	A double
INPUT_TYPE_STRING	A string
INPUT_TYPE_WIDESTRING	A wide-string

void SetValueType (uifcInputType value)

Sets the data-type of the contents of the InputPanel.

INPUT_TYPE_INTEGER	An integer
INPUT_TYPE_DOUBLE	A double
INPUT_TYPE_STRING	A string
INPUT_TYPE_WIDESTRING	A wide-string

Parameters:

value

Returns:

uifcReadingOrder GetReadingOrder ()

Returns:

If the current locale supports multi-directional text (e.g. Hebrew) then this flag indicates the reading order of the text contents of the InputPanel, otherwise the attribute value is ignored.

READING_ORDER_LEFT_TO_RIGHT	The text is displayed left-to-right
READING_ORDER_RIGHT_TO_LEFT	The text is displayed right-to-left

void SetReadingOrder (uifcReadingOrder value)

Sets if the current locale supports multi-directional text (e.g. Hebrew) then this flag indicates the reading order of the text contents of the InputPanel, otherwise the attribute value is ignored.

READING_ORDER_LEFT_TO_RIGHT	The text is displayed left-to-right
READING_ORDER_RIGHT_TO_LEFT	The text is displayed right-to-left

Parameters:

value

Returns:

xbool DoesAlwaysShowValueSign ()

Returns:: Flag indicating whether to display the signum of numerical values in the InputPanel.

void SetAlwaysShowValueSign (xbool flag)

Sets flag indicating whether to display the signum of numerical values in the InputPanel.

Parameters:

flag

Returns:

xint GetAutoCompleteLength ()

Returns:: The minimum number of characters which must match before any text matching is carried out.

void SetAutoCompleteLength (xint value)

Sets the minimum number of characters which must match before any text matching is carried out.

Parameters:

value

Returns:

xint GetDigits ()

Returns:: The number of digits to be displayed if the contents are being treated as a number.
A value of 0 indicates that this attribute should be ignored when formatting the value.

void SetDigits (xint value)

Sets the number of digits to be displayed if the contents are being treated as a number.
A value of 0 indicates that this attribute should be ignored when formatting the value.

Parameters:

value

Returns:

xstring GetDoubleFormat ()

Returns:: The format of the contents of the InputPanel if they are being treated as a double.
The value of this attribute is a C formatting string which can handle the precision and value of the contents of the InputPanel.

void SetDoubleFormat (xrstring value)

Sets the format of the contents of the InputPanel if they are being treated as a double.
The value of this attribute is a C formatting string which can handle the precision and value of the contents of the InputPanel.

Parameters:

value

Returns:

xbool IsCaretVisible ()

Returns:: Flag indicating whether the input caret should be displayed when the InputPanel has the keyboard input focus.

void SetCaretVisible (xbool flag)

Sets flag indicating whether the input caret should be displayed when the InputPanel has the keyboard input focus.

Parameters:

flag

Returns:

xint GetTextValueMaximumLength ()

Returns:: The maximum length of the text contents of the InputPanel.

void SetTextValueMaximumLength (xint value)

Sets the maximum length of the text contents of the InputPanel.

Parameters:

value

Returns:

xbool IsSelectionVisible ()

Returns:: Flag indicating whether the selected text should be drawn highlighted when the InputPanel does not have the keyboard input focus.

void SetSelectionVisible (xbool flag)

Sets flag indicating whether the selected text should be drawn highlighted when the InputPanel does not have the keyboard input focus.

Parameters:

flag

Returns:

xbool CanRedraw ()

Returns:: Flag indicating whether redraws are permitted in the InputPanel.

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are permitted in the InputPanel.

Parameters:

flag

Returns:

xstringsequence_ptr GetAutoCompleteTextArray ()

Returns:: The array of values to use for text matching in the InputPanel.

void SetAutoCompleteTextArray (xstringsequence_ptr values)

Sets the array of values to use for text matching in the InputPanel.

Parameters:

values

Returns:

xreal GetMinimumDoubleValue ()

Returns:: The minimum double value of the contents of the InputPanel.

void SetMinimumDoubleValue (xreal value)

Sets the minimum double value of the contents of the InputPanel.

Parameters:

value

Returns:

xint GetPasswordCharacter ()

Returns:: The ASCII value of the character used for display when the InputPanel is being used for password entry.

void SetPasswordCharacter (xint value)

Sets the ASCII value of the character used for display when the InputPanel is being used for password entry.

Parameters:

value

Returns:

xbool IsAutoCompleteCaseSensitive ()

Returns:: Flag indicating whether text matching is case-sensitive (xtrue) or whether it is irrespective of case (xfalse).

void SetAutoCompleteCaseSensitive (xbool flag)

Sets flag indicating whether text matching is case-sensitive (xtrue) or whether it is irrespective of case (xfalse).

Parameters:

flag

Returns:

xint GetTextGravity ()

Returns:

The gravity of the InputPanel, which is used to determine where the caret should be placed after the contents are modified.

TEXT_GRAVITY_START	The caret is placed at the start of the text
TEXT_GRAVITY_END	The caret is placed at the end of the text

void SetTextGravity (xint value)

Sets the gravity of the InputPanel, which is used to determine where the caret should be placed after the contents are modified.

TEXT_GRAVITY_START	The caret is placed at the start of the text
TEXT_GRAVITY_END	The caret is placed at the end of the text

Parameters:

value

Returns:

xbool DoesAllowTabInput ()

Returns:: Flag indicating whether to allow TAB key presses to be ignored by the InputPanel itself and used for focus traversal (xfalse) or whether they should be inserted into the text as a tab character (xtrue).

void SetAllowTabInput (xbool flag)

Sets flag indicating whether to allow TAB key presses to be ignored by the InputPanel itself and used for focus traversal (xfalse) or whether they should be inserted into the text as a tab character (xtrue).

Parameters:

flag

Returns:

xstring GetWideStringValue ()

Returns:: The contents of the InputPanel as a wide-string.

void SetWideStringValue (xrstring value)

Sets the contents of the InputPanel as a wide-string.

Parameters:

value

Returns:

xbool DoesAutoCompleteReplace ()

Returns:: Flag indicating whether any matched text should be completely selected when a match occurs (xtrue) or whether only the appended text should be selected (xfalse).

void SetAutoCompleteReplace (xbool flag)

Sets flag indicating whether any matched text should be completely selected when a match occurs (xtrue) or whether only the appended text should be selected (xfalse).

Parameters:

flag

Returns:

xstring GetTextValue ()

Returns:: The text contents of the InputPanel.

void SetTextValue (xrstring value)

Sets the text contents of the InputPanel.

Parameters:

value

Returns:

void AddActionListener (uifcInputPanelListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcInputPanelAction action)

Parameters:

action

Returns:

void CreateTimer (uifcInputPanelTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

void StartTimer (xrstring timerName, xint duration)

Parameters:

timerName
duration

Returns:

void StopTimer (xrstring timerName)

Parameters:

timerName

Returns: