Open 3D Engine AzQtComponents API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzQtComponents::LineEdit::Config Struct Reference

Style configuration for the LineEdit class. More...

#include <LineEdit.h>

Public Member Functions

int getLineWidth (const QStyleOption *option, bool hasError, bool dropTarget) const
 
QColor getBorderColor (const QStyleOption *option, bool hasError, bool dropTarget) const
 
QColor getBackgroundColor (const QStyleOption *option, bool hasError, bool isDropTarget, const QWidget *widget) const
 

Public Attributes

int borderRadius
 Border radius in pixels. All corners get the same border radius.
 
QColor borderColor
 
QColor placeHolderTextColor
 
QColor hoverBorderColor
 
QColor hoverBackgroundColor
 
int hoverLineWidth
 Border thickness for the hover state, in pixels.
 
QColor focusedBorderColor
 
int focusedLineWidth
 Border thickness for the focused state, in pixels.
 
QColor errorBorderColor
 
int errorLineWidth
 Border thickness for the error state, in pixels.
 
QString clearImage
 Path to the clear icon. Svg images recommended.
 
QString clearImageDisabled
 Path to the disabled clear icon. Svg images recommended.
 
QSize clearImageSize
 Size of the clear icon. Size must be proportional to the icon's ratio.
 
QString errorImage
 Path to the error icon. Svg images recommended.
 
QSize errorImageSize
 Size of the error icon. Size must be proportional to the icon's ratio.
 
int iconSpacing
 Spacing value for the icons, in pixels. All directions get the same spacing.
 
int iconMargin
 Margin value for the icons, in pixels. All directions get the same margin.
 
bool autoSelectAllOnClickFocus
 Determines if all the text is selected when the LineEdit gains focus.
 
int dropFrameOffset
 Offset around the frame drawn when the LineEdit is a drop target, in pixels.
 
int dropFrameRadius
 Radius of the frame drawn when the LineEdit is a drop target, in pixels.
 

Detailed Description

Style configuration for the LineEdit class.

Member Function Documentation

◆ getBackgroundColor()

QColor AzQtComponents::LineEdit::Config::getBackgroundColor ( const QStyleOption *  option,
bool  hasError,
bool  isDropTarget,
const QWidget *  widget 
) const

Returns the LineEdit background color.

Parameters
optionThe QStyleOption containing the style parameters for the LineEdit.
hasErrorWhether the LineEdit is in an error state.
isDropTargetWhether the LineEdit is currently a drop target.
widgetPointer to the LineEdit widget.

◆ getBorderColor()

QColor AzQtComponents::LineEdit::Config::getBorderColor ( const QStyleOption *  option,
bool  hasError,
bool  dropTarget 
) const

Returns the current LineEdit border color.

Parameters
optionThe QStyleOption containing the style parameters for the LineEdit.
hasErrorWhether the LineEdit is in an error state.
dropTargetWhether the LineEdit is currently a drop target.

◆ getLineWidth()

int AzQtComponents::LineEdit::Config::getLineWidth ( const QStyleOption *  option,
bool  hasError,
bool  dropTarget 
) const

Returns the current LineEdit border width.

Parameters
optionThe QStyleOption containing the style parameters for the LineEdit.
hasErrorWhether the LineEdit is in an error state.
dropTargetWhether the LineEdit is currently a drop target.

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