#[repr(C)]pub struct QLineSeries { /* private fields */ }
Expand description
C++ class: QtCharts::QLineSeries
.
Implementations§
Source§impl QLineSeries
impl QLineSeries
Sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QtCharts::QLineSeries::metaObject() const
.
Sourcepub unsafe fn new_1a(parent: impl CastInto<Ptr<QObject>>) -> QBox<QLineSeries>
pub unsafe fn new_1a(parent: impl CastInto<Ptr<QObject>>) -> QBox<QLineSeries>
Calls C++ function: [constructor] void QtCharts::QLineSeries::QLineSeries(QObject* parent = …)
.
Sourcepub unsafe fn new_0a() -> QBox<QLineSeries>
pub unsafe fn new_0a() -> QBox<QLineSeries>
Calls C++ function: [constructor] void QtCharts::QLineSeries::QLineSeries()
.
Sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void,
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void, ) -> c_int
Calls C++ function: virtual int QtCharts::QLineSeries::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
Sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QtCharts::QLineSeries::qt_metacast(const char* arg1)
.
Sourcepub unsafe fn static_meta_object() -> Ref<QMetaObject>
pub unsafe fn static_meta_object() -> Ref<QMetaObject>
Returns a reference to the staticMetaObject
field.
Sourcepub unsafe fn tr(
s: *const c_char,
c: *const c_char,
n: c_int,
) -> CppBox<QString>
pub unsafe fn tr( s: *const c_char, c: *const c_char, n: c_int, ) -> CppBox<QString>
Calls C++ function: static QString QtCharts::QLineSeries::tr(const char* s, const char* c, int n)
.
Sourcepub unsafe fn tr_utf8(
s: *const c_char,
c: *const c_char,
n: c_int,
) -> CppBox<QString>
pub unsafe fn tr_utf8( s: *const c_char, c: *const c_char, n: c_int, ) -> CppBox<QString>
Calls C++ function: static QString QtCharts::QLineSeries::trUtf8(const char* s, const char* c, int n)
.
Sourcepub unsafe fn type_(&self) -> SeriesType
pub unsafe fn type_(&self) -> SeriesType
Reimplements: QAbstractSeries::type() const.
Calls C++ function: virtual QtCharts::QAbstractSeries::SeriesType QtCharts::QLineSeries::type() const
.
Reimplements: QAbstractSeries::type() const.
Methods from Deref<Target = QXYSeries>§
Sourcepub fn clicked(&self) -> Signal<(*const QPointF,)>
pub fn clicked(&self) -> Signal<(*const QPointF,)>
This signal is emitted when the user triggers a mouse event by clicking the point point in the chart.
Returns a built-in Qt signal QtCharts::QXYSeries::clicked
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the user triggers a mouse event by clicking the point point in the chart.
See also pressed(), released(), and doubleClicked().
Sourcepub fn hovered(&self) -> Signal<(*const QPointF, bool)>
pub fn hovered(&self) -> Signal<(*const QPointF, bool)>
This signal is emitted when a mouse is hovered over the point point in the chart. When the mouse moves over the point, state turns true
, and when the mouse moves away again, it turns false
.
Returns a built-in Qt signal QtCharts::QXYSeries::hovered
that can be passed to qt_core::Signal::connect
.
This signal is emitted when a mouse is hovered over the point point in the chart. When the mouse moves over the point, state turns true
, and when the mouse moves away again, it turns false
.
Sourcepub fn pressed(&self) -> Signal<(*const QPointF,)>
pub fn pressed(&self) -> Signal<(*const QPointF,)>
This signal is emitted when the user presses the data point point in the chart and holds down the mouse button.
Returns a built-in Qt signal QtCharts::QXYSeries::pressed
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the user presses the data point point in the chart and holds down the mouse button.
See also clicked(), released(), and doubleClicked().
Sourcepub fn released(&self) -> Signal<(*const QPointF,)>
pub fn released(&self) -> Signal<(*const QPointF,)>
This signal is emitted when the user releases the mouse press on the data point specified by point.
Returns a built-in Qt signal QtCharts::QXYSeries::released
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the user releases the mouse press on the data point specified by point.
See also pressed(), clicked(), and doubleClicked().
Sourcepub fn double_clicked(&self) -> Signal<(*const QPointF,)>
pub fn double_clicked(&self) -> Signal<(*const QPointF,)>
This signal is emitted when the user double-clicks the data point point in the chart. The point is the point where the first press was triggered.
Returns a built-in Qt signal QtCharts::QXYSeries::doubleClicked
that can be passed to qt_core::Signal::connect
.
Sourcepub fn point_replaced(&self) -> Signal<(c_int,)>
pub fn point_replaced(&self) -> Signal<(c_int,)>
This signal is emitted when a point is replaced at the position specified by index.
Returns a built-in Qt signal QtCharts::QXYSeries::pointReplaced
that can be passed to qt_core::Signal::connect
.
This signal is emitted when a point is replaced at the position specified by index.
See also replace().
Sourcepub fn point_removed(&self) -> Signal<(c_int,)>
pub fn point_removed(&self) -> Signal<(c_int,)>
This signal is emitted when a point is removed from the position specified by index.
Returns a built-in Qt signal QtCharts::QXYSeries::pointRemoved
that can be passed to qt_core::Signal::connect
.
This signal is emitted when a point is removed from the position specified by index.
See also remove().
Sourcepub fn point_added(&self) -> Signal<(c_int,)>
pub fn point_added(&self) -> Signal<(c_int,)>
This signal is emitted when a point is added at the position specified by index.
Returns a built-in Qt signal QtCharts::QXYSeries::pointAdded
that can be passed to qt_core::Signal::connect
.
Sourcepub fn color_changed(&self) -> Signal<(*const QColor,)>
pub fn color_changed(&self) -> Signal<(*const QColor,)>
This signal is emitted when the line (pen) color changes to color.
Returns a built-in Qt signal QtCharts::QXYSeries::colorChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the line (pen) color changes to color.
Note: Notifier signal for property color.
Sourcepub fn points_replaced(&self) -> Signal<()>
pub fn points_replaced(&self) -> Signal<()>
This signal is emitted when all points are replaced with other points.
Returns a built-in Qt signal QtCharts::QXYSeries::pointsReplaced
that can be passed to qt_core::Signal::connect
.
This signal is emitted when all points are replaced with other points.
See also replace().
Sourcepub fn point_labels_format_changed(&self) -> Signal<(*const QString,)>
pub fn point_labels_format_changed(&self) -> Signal<(*const QString,)>
This signal is emitted when the format of data point labels changes to format.
Returns a built-in Qt signal QtCharts::QXYSeries::pointLabelsFormatChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the format of data point labels changes to format.
Note: Notifier signal for property pointLabelsFormat.
Sourcepub fn point_labels_visibility_changed(&self) -> Signal<(bool,)>
pub fn point_labels_visibility_changed(&self) -> Signal<(bool,)>
This signal is emitted when the visibility of the data point labels changes to visible.
Returns a built-in Qt signal QtCharts::QXYSeries::pointLabelsVisibilityChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the visibility of the data point labels changes to visible.
Note: Notifier signal for property pointLabelsVisible.
Sourcepub fn point_labels_font_changed(&self) -> Signal<(*const QFont,)>
pub fn point_labels_font_changed(&self) -> Signal<(*const QFont,)>
This signal is emitted when the font used for data point labels changes to font.
Returns a built-in Qt signal QtCharts::QXYSeries::pointLabelsFontChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the font used for data point labels changes to font.
Note: Notifier signal for property pointLabelsFont.
Sourcepub fn point_labels_color_changed(&self) -> Signal<(*const QColor,)>
pub fn point_labels_color_changed(&self) -> Signal<(*const QColor,)>
This signal is emitted when the color used for data point labels changes to color.
Returns a built-in Qt signal QtCharts::QXYSeries::pointLabelsColorChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the color used for data point labels changes to color.
Note: Notifier signal for property pointLabelsColor.
Sourcepub fn point_labels_clipping_changed(&self) -> Signal<(bool,)>
pub fn point_labels_clipping_changed(&self) -> Signal<(bool,)>
This signal is emitted when the clipping of the data point labels changes to clipping.
Returns a built-in Qt signal QtCharts::QXYSeries::pointLabelsClippingChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the clipping of the data point labels changes to clipping.
Note: Notifier signal for property pointLabelsClipping.
Sourcepub fn points_removed(&self) -> Signal<(c_int, c_int)>
pub fn points_removed(&self) -> Signal<(c_int, c_int)>
This signal is emitted when the number of points specified by count is removed starting at the position specified by index.
Returns a built-in Qt signal QtCharts::QXYSeries::pointsRemoved
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the number of points specified by count is removed starting at the position specified by index.
See also removePoints() and clear().
Sourcepub fn pen_changed(&self) -> Signal<(*const QPen,)>
pub fn pen_changed(&self) -> Signal<(*const QPen,)>
This signal is emitted when the pen changes to pen.
Returns a built-in Qt signal QtCharts::QXYSeries::penChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the pen changes to pen.
Sourcepub unsafe fn append_2_double(&self, x: c_double, y: c_double)
pub unsafe fn append_2_double(&self, x: c_double, y: c_double)
Adds the data point with the coordinates x and y to the series.
Calls C++ function: void QtCharts::QXYSeries::append(double x, double y)
.
Adds the data point with the coordinates x and y to the series.
Sourcepub unsafe fn append_q_point_f(&self, point: impl CastInto<Ref<QPointF>>)
pub unsafe fn append_q_point_f(&self, point: impl CastInto<Ref<QPointF>>)
This is an overloaded function.
Calls C++ function: void QtCharts::QXYSeries::append(const QPointF& point)
.
This is an overloaded function.
Adds the data point point to the series.
Sourcepub unsafe fn append_q_list_of_q_point_f(
&self,
points: impl CastInto<Ref<QListOfQPointF>>,
)
pub unsafe fn append_q_list_of_q_point_f( &self, points: impl CastInto<Ref<QListOfQPointF>>, )
This is an overloaded function.
Calls C++ function: void QtCharts::QXYSeries::append(const QList<QPointF>& points)
.
This is an overloaded function.
Adds the list of data points specified by points to the series.
Sourcepub unsafe fn at(&self, index: c_int) -> Ref<QPointF>
pub unsafe fn at(&self, index: c_int) -> Ref<QPointF>
Returns the data point at the position specified by index in the internal points vector.
Calls C++ function: const QPointF& QtCharts::QXYSeries::at(int index) const
.
Returns the data point at the position specified by index in the internal points vector.
Sourcepub unsafe fn brush(&self) -> CppBox<QBrush>
pub unsafe fn brush(&self) -> CppBox<QBrush>
Returns the brush used to fill the data points for the series.
Calls C++ function: QBrush QtCharts::QXYSeries::brush() const
.
Returns the brush used to fill the data points for the series.
See also setBrush().
Sourcepub unsafe fn clear(&self)
pub unsafe fn clear(&self)
Removes all points from the series.
Calls C++ function: void QtCharts::QXYSeries::clear()
.
Removes all points from the series.
See also pointsRemoved().
Sourcepub unsafe fn color(&self) -> CppBox<QColor>
pub unsafe fn color(&self) -> CppBox<QColor>
This property holds the color of the series.
Calls C++ function: virtual QColor QtCharts::QXYSeries::color() const
.
This property holds the color of the series.
This is the line (pen) color in case of QLineSeries or QSplineSeries and the fill (brush) color in case of QScatterSeries or QAreaSeries.
Access functions:
virtual QColor | color() const |
virtual void | setColor(const QColor &color) |
Notifier signal:
void | colorChanged(QColor color) |
Sourcepub unsafe fn count(&self) -> c_int
pub unsafe fn count(&self) -> c_int
Returns the number of data points in a series.
Calls C++ function: int QtCharts::QXYSeries::count() const
.
Returns the number of data points in a series.
Sourcepub unsafe fn insert(&self, index: c_int, point: impl CastInto<Ref<QPointF>>)
pub unsafe fn insert(&self, index: c_int, point: impl CastInto<Ref<QPointF>>)
Inserts the data point point in the series at the position specified by index.
Calls C++ function: void QtCharts::QXYSeries::insert(int index, const QPointF& point)
.
Inserts the data point point in the series at the position specified by index.
See also pointAdded().
Sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QtCharts::QXYSeries::metaObject() const
.
Sourcepub unsafe fn pen(&self) -> CppBox<QPen>
pub unsafe fn pen(&self) -> CppBox<QPen>
Returns the pen used to draw the outline of the data points for the series.
Calls C++ function: QPen QtCharts::QXYSeries::pen() const
.
Returns the pen used to draw the outline of the data points for the series.
See also setPen().
Sourcepub unsafe fn point_labels_clipping(&self) -> bool
pub unsafe fn point_labels_clipping(&self) -> bool
This property holds the clipping for data point labels.
Calls C++ function: bool QtCharts::QXYSeries::pointLabelsClipping() const
.
This property holds the clipping for data point labels.
This property is true
by default. The labels on the edge of the plot area are cut when clipping is enabled.
Access functions:
bool | pointLabelsClipping() const |
void | setPointLabelsClipping(bool enabled = true) |
Notifier signal:
void | pointLabelsClippingChanged(bool clipping) |
See also pointLabelsVisible.
Sourcepub unsafe fn point_labels_color(&self) -> CppBox<QColor>
pub unsafe fn point_labels_color(&self) -> CppBox<QColor>
This property holds the color used for data point labels. By default, the color is the color of the brush defined in theme for labels.
Calls C++ function: QColor QtCharts::QXYSeries::pointLabelsColor() const
.
This property holds the color used for data point labels. By default, the color is the color of the brush defined in theme for labels.
Access functions:
QColor | pointLabelsColor() const |
void | setPointLabelsColor(const QColor &color) |
Notifier signal:
void | pointLabelsColorChanged(const QColor &color) |
See also pointLabelsFormat.
Sourcepub unsafe fn point_labels_font(&self) -> CppBox<QFont>
pub unsafe fn point_labels_font(&self) -> CppBox<QFont>
This property holds the font used for data point labels.
Calls C++ function: QFont QtCharts::QXYSeries::pointLabelsFont() const
.
This property holds the font used for data point labels.
Access functions:
QFont | pointLabelsFont() const |
void | setPointLabelsFont(const QFont &font) |
Notifier signal:
void | pointLabelsFontChanged(const QFont &font) |
See also pointLabelsFormat.
Sourcepub unsafe fn point_labels_format(&self) -> CppBox<QString>
pub unsafe fn point_labels_format(&self) -> CppBox<QString>
This property holds the format used for showing labels with data points.
Calls C++ function: QString QtCharts::QXYSeries::pointLabelsFormat() const
.
This property holds the format used for showing labels with data points.
QXYSeries supports the following format tags:
@xPoint | The x-coordinate of the data point. |
@yPoint | The y-coordinate of the data point. |
For example, the following usage of the format tags would produce labels that display the data point shown inside brackets separated by a comma (x, y):
series->setPointLabelsFormat(“(@xPoint, @yPoint)”);
By default, the labels' format is set to @xPoint, @yPoint
. The labels are shown on the plot area, and the labels on the edge of the plot area are cut. If the points are close to each other, the labels may overlap.
Access functions:
QString | pointLabelsFormat() const |
void | setPointLabelsFormat(const QString &format) |
Notifier signal:
void | pointLabelsFormatChanged(const QString &format) |
See also pointLabelsVisible, pointLabelsFont, and pointLabelsColor.
Sourcepub unsafe fn point_labels_visible(&self) -> bool
pub unsafe fn point_labels_visible(&self) -> bool
This property holds the visibility of data point labels.
Calls C++ function: bool QtCharts::QXYSeries::pointLabelsVisible() const
.
This property holds the visibility of data point labels.
This property is false
by default.
Access functions:
bool | pointLabelsVisible() const |
void | setPointLabelsVisible(bool visible = true) |
Notifier signal:
void | pointLabelsVisibilityChanged(bool visible) |
See also pointLabelsFormat and pointLabelsClipping.
Sourcepub unsafe fn points(&self) -> CppBox<QListOfQPointF>
pub unsafe fn points(&self) -> CppBox<QListOfQPointF>
Returns the points in the series as a list. Use pointsVector() for better performance.
Calls C++ function: QList<QPointF> QtCharts::QXYSeries::points() const
.
Returns the points in the series as a list. Use pointsVector() for better performance.
Sourcepub unsafe fn points_vector(&self) -> CppBox<QVectorOfQPointF>
pub unsafe fn points_vector(&self) -> CppBox<QVectorOfQPointF>
Sourcepub unsafe fn points_visible(&self) -> bool
pub unsafe fn points_visible(&self) -> bool
This property holds whether the data points are visible and should be drawn.
Calls C++ function: bool QtCharts::QXYSeries::pointsVisible() const
.
This property holds whether the data points are visible and should be drawn.
Access functions:
bool | pointsVisible() const |
void | setPointsVisible(bool visible = true) |
Sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void,
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void, ) -> c_int
Calls C++ function: virtual int QtCharts::QXYSeries::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
Sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QtCharts::QXYSeries::qt_metacast(const char* arg1)
.
Sourcepub unsafe fn remove_2_double(&self, x: c_double, y: c_double)
pub unsafe fn remove_2_double(&self, x: c_double, y: c_double)
Removes the point that has the coordinates x and y from the series.
Calls C++ function: void QtCharts::QXYSeries::remove(double x, double y)
.
Removes the point that has the coordinates x and y from the series.
See also pointRemoved().
Sourcepub unsafe fn remove_q_point_f(&self, point: impl CastInto<Ref<QPointF>>)
pub unsafe fn remove_q_point_f(&self, point: impl CastInto<Ref<QPointF>>)
Removes the data point point from the series.
Calls C++ function: void QtCharts::QXYSeries::remove(const QPointF& point)
.
Removes the data point point from the series.
See also pointRemoved().
Sourcepub unsafe fn remove_int(&self, index: c_int)
pub unsafe fn remove_int(&self, index: c_int)
Removes the point at the position specified by index from the series.
Calls C++ function: void QtCharts::QXYSeries::remove(int index)
.
Removes the point at the position specified by index from the series.
See also pointRemoved().
Sourcepub unsafe fn remove_points(&self, index: c_int, count: c_int)
pub unsafe fn remove_points(&self, index: c_int, count: c_int)
Removes the number of points specified by count from the series starting at the position specified by index.
Calls C++ function: void QtCharts::QXYSeries::removePoints(int index, int count)
.
Removes the number of points specified by count from the series starting at the position specified by index.
See also pointsRemoved().
Sourcepub unsafe fn replace_4_double(
&self,
old_x: c_double,
old_y: c_double,
new_x: c_double,
new_y: c_double,
)
pub unsafe fn replace_4_double( &self, old_x: c_double, old_y: c_double, new_x: c_double, new_y: c_double, )
Replaces the point with the coordinates oldX and oldY with the point with the coordinates newX and newY. Does nothing if the old point does not exist.
Calls C++ function: void QtCharts::QXYSeries::replace(double oldX, double oldY, double newX, double newY)
.
Replaces the point with the coordinates oldX and oldY with the point with the coordinates newX and newY. Does nothing if the old point does not exist.
See also pointReplaced().
Sourcepub unsafe fn replace_2_q_point_f(
&self,
old_point: impl CastInto<Ref<QPointF>>,
new_point: impl CastInto<Ref<QPointF>>,
)
pub unsafe fn replace_2_q_point_f( &self, old_point: impl CastInto<Ref<QPointF>>, new_point: impl CastInto<Ref<QPointF>>, )
Replaces the point specified by oldPoint with the one specified by newPoint.
Calls C++ function: void QtCharts::QXYSeries::replace(const QPointF& oldPoint, const QPointF& newPoint)
.
Replaces the point specified by oldPoint with the one specified by newPoint.
See also pointReplaced().
Sourcepub unsafe fn replace_int2_double(
&self,
index: c_int,
new_x: c_double,
new_y: c_double,
)
pub unsafe fn replace_int2_double( &self, index: c_int, new_x: c_double, new_y: c_double, )
Replaces the point at the position specified by index with the point that has the coordinates newX and newY.
Calls C++ function: void QtCharts::QXYSeries::replace(int index, double newX, double newY)
.
Replaces the point at the position specified by index with the point that has the coordinates newX and newY.
See also pointReplaced().
Sourcepub unsafe fn replace_int_q_point_f(
&self,
index: c_int,
new_point: impl CastInto<Ref<QPointF>>,
)
pub unsafe fn replace_int_q_point_f( &self, index: c_int, new_point: impl CastInto<Ref<QPointF>>, )
Replaces the point at the position specified by index with the point specified by newPoint.
Calls C++ function: void QtCharts::QXYSeries::replace(int index, const QPointF& newPoint)
.
Replaces the point at the position specified by index with the point specified by newPoint.
See also pointReplaced().
Sourcepub unsafe fn replace_q_list_of_q_point_f(
&self,
points: impl CastInto<Ref<QListOfQPointF>>,
)
pub unsafe fn replace_q_list_of_q_point_f( &self, points: impl CastInto<Ref<QListOfQPointF>>, )
Replaces the current points with the points specified by points.
Calls C++ function: void QtCharts::QXYSeries::replace(QList<QPointF> points)
.
Replaces the current points with the points specified by points.
Note: This is much faster than replacing data points one by one, or first clearing all data, and then appending the new data. Emits QXYSeries::pointsReplaced() when the points have been replaced. However, note that using the overload that takes QVector<QPointF>
as parameter is faster than using this overload.
See also pointsReplaced().
Sourcepub unsafe fn replace_q_vector_of_q_point_f(
&self,
points: impl CastInto<Ref<QVectorOfQPointF>>,
)
pub unsafe fn replace_q_vector_of_q_point_f( &self, points: impl CastInto<Ref<QVectorOfQPointF>>, )
Replaces the current points with the points specified by points.
Calls C++ function: void QtCharts::QXYSeries::replace(QVector<QPointF> points)
.
Replaces the current points with the points specified by points.
Note: This is much faster than replacing data points one by one, or first clearing all data, and then appending the new data. Emits QXYSeries::pointsReplaced() when the points have been replaced.
See also pointsReplaced().
Sourcepub unsafe fn set_brush(&self, brush: impl CastInto<Ref<QBrush>>)
pub unsafe fn set_brush(&self, brush: impl CastInto<Ref<QBrush>>)
Sets the brush used for drawing points on the chart to brush. If the brush is not defined, the brush from the chart theme setting is used.
Calls C++ function: virtual void QtCharts::QXYSeries::setBrush(const QBrush& brush)
.
Sets the brush used for drawing points on the chart to brush. If the brush is not defined, the brush from the chart theme setting is used.
See also brush() and QChart::setTheme().
Sourcepub unsafe fn set_color(&self, color: impl CastInto<Ref<QColor>>)
pub unsafe fn set_color(&self, color: impl CastInto<Ref<QColor>>)
This property holds the color of the series.
Calls C++ function: virtual void QtCharts::QXYSeries::setColor(const QColor& color)
.
This property holds the color of the series.
This is the line (pen) color in case of QLineSeries or QSplineSeries and the fill (brush) color in case of QScatterSeries or QAreaSeries.
Access functions:
virtual QColor | color() const |
virtual void | setColor(const QColor &color) |
Notifier signal:
void | colorChanged(QColor color) |
Sourcepub unsafe fn set_pen(&self, pen: impl CastInto<Ref<QPen>>)
pub unsafe fn set_pen(&self, pen: impl CastInto<Ref<QPen>>)
Sets the pen used for drawing points on the chart to pen. If the pen is not defined, the pen from the chart theme is used.
Calls C++ function: virtual void QtCharts::QXYSeries::setPen(const QPen& pen)
.
Sets the pen used for drawing points on the chart to pen. If the pen is not defined, the pen from the chart theme is used.
See also pen() and QChart::setTheme().
Sourcepub unsafe fn set_point_labels_clipping_1a(&self, enabled: bool)
pub unsafe fn set_point_labels_clipping_1a(&self, enabled: bool)
This property holds the clipping for data point labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsClipping(bool enabled = …)
.
This property holds the clipping for data point labels.
This property is true
by default. The labels on the edge of the plot area are cut when clipping is enabled.
Access functions:
bool | pointLabelsClipping() const |
void | setPointLabelsClipping(bool enabled = true) |
Notifier signal:
void | pointLabelsClippingChanged(bool clipping) |
See also pointLabelsVisible.
Sourcepub unsafe fn set_point_labels_clipping_0a(&self)
pub unsafe fn set_point_labels_clipping_0a(&self)
This property holds the clipping for data point labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsClipping()
.
This property holds the clipping for data point labels.
This property is true
by default. The labels on the edge of the plot area are cut when clipping is enabled.
Access functions:
bool | pointLabelsClipping() const |
void | setPointLabelsClipping(bool enabled = true) |
Notifier signal:
void | pointLabelsClippingChanged(bool clipping) |
See also pointLabelsVisible.
Sourcepub unsafe fn set_point_labels_color(&self, color: impl CastInto<Ref<QColor>>)
pub unsafe fn set_point_labels_color(&self, color: impl CastInto<Ref<QColor>>)
This property holds the color used for data point labels. By default, the color is the color of the brush defined in theme for labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsColor(const QColor& color)
.
This property holds the color used for data point labels. By default, the color is the color of the brush defined in theme for labels.
Access functions:
QColor | pointLabelsColor() const |
void | setPointLabelsColor(const QColor &color) |
Notifier signal:
void | pointLabelsColorChanged(const QColor &color) |
See also pointLabelsFormat.
Sourcepub unsafe fn set_point_labels_font(&self, font: impl CastInto<Ref<QFont>>)
pub unsafe fn set_point_labels_font(&self, font: impl CastInto<Ref<QFont>>)
This property holds the font used for data point labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsFont(const QFont& font)
.
This property holds the font used for data point labels.
Access functions:
QFont | pointLabelsFont() const |
void | setPointLabelsFont(const QFont &font) |
Notifier signal:
void | pointLabelsFontChanged(const QFont &font) |
See also pointLabelsFormat.
Sourcepub unsafe fn set_point_labels_format(
&self,
format: impl CastInto<Ref<QString>>,
)
pub unsafe fn set_point_labels_format( &self, format: impl CastInto<Ref<QString>>, )
This property holds the format used for showing labels with data points.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsFormat(const QString& format)
.
This property holds the format used for showing labels with data points.
QXYSeries supports the following format tags:
@xPoint | The x-coordinate of the data point. |
@yPoint | The y-coordinate of the data point. |
For example, the following usage of the format tags would produce labels that display the data point shown inside brackets separated by a comma (x, y):
series->setPointLabelsFormat(“(@xPoint, @yPoint)”);
By default, the labels' format is set to @xPoint, @yPoint
. The labels are shown on the plot area, and the labels on the edge of the plot area are cut. If the points are close to each other, the labels may overlap.
Access functions:
QString | pointLabelsFormat() const |
void | setPointLabelsFormat(const QString &format) |
Notifier signal:
void | pointLabelsFormatChanged(const QString &format) |
See also pointLabelsVisible, pointLabelsFont, and pointLabelsColor.
Sourcepub unsafe fn set_point_labels_visible_1a(&self, visible: bool)
pub unsafe fn set_point_labels_visible_1a(&self, visible: bool)
This property holds the visibility of data point labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsVisible(bool visible = …)
.
This property holds the visibility of data point labels.
This property is false
by default.
Access functions:
bool | pointLabelsVisible() const |
void | setPointLabelsVisible(bool visible = true) |
Notifier signal:
void | pointLabelsVisibilityChanged(bool visible) |
See also pointLabelsFormat and pointLabelsClipping.
Sourcepub unsafe fn set_point_labels_visible_0a(&self)
pub unsafe fn set_point_labels_visible_0a(&self)
This property holds the visibility of data point labels.
Calls C++ function: void QtCharts::QXYSeries::setPointLabelsVisible()
.
This property holds the visibility of data point labels.
This property is false
by default.
Access functions:
bool | pointLabelsVisible() const |
void | setPointLabelsVisible(bool visible = true) |
Notifier signal:
void | pointLabelsVisibilityChanged(bool visible) |
See also pointLabelsFormat and pointLabelsClipping.
Sourcepub unsafe fn set_points_visible_1a(&self, visible: bool)
pub unsafe fn set_points_visible_1a(&self, visible: bool)
This property holds whether the data points are visible and should be drawn.
Calls C++ function: void QtCharts::QXYSeries::setPointsVisible(bool visible = …)
.
This property holds whether the data points are visible and should be drawn.
Access functions:
bool | pointsVisible() const |
void | setPointsVisible(bool visible = true) |
Sourcepub unsafe fn set_points_visible_0a(&self)
pub unsafe fn set_points_visible_0a(&self)
This property holds whether the data points are visible and should be drawn.
Calls C++ function: void QtCharts::QXYSeries::setPointsVisible()
.
This property holds whether the data points are visible and should be drawn.
Access functions:
bool | pointsVisible() const |
void | setPointsVisible(bool visible = true) |
Methods from Deref<Target = QAbstractSeries>§
Sourcepub fn name_changed(&self) -> Signal<()>
pub fn name_changed(&self) -> Signal<()>
This signal is emitted when the series name changes.
Returns a built-in Qt signal QtCharts::QAbstractSeries::nameChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the series name changes.
Note: Notifier signal for property name.
Sourcepub fn visible_changed(&self) -> Signal<()>
pub fn visible_changed(&self) -> Signal<()>
This signal is emitted when the series visibility changes.
Returns a built-in Qt signal QtCharts::QAbstractSeries::visibleChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the series visibility changes.
Note: Notifier signal for property visible.
Sourcepub fn opacity_changed(&self) -> Signal<()>
pub fn opacity_changed(&self) -> Signal<()>
This signal is emitted when the opacity of the series changes.
Returns a built-in Qt signal QtCharts::QAbstractSeries::opacityChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when the opacity of the series changes.
Note: Notifier signal for property opacity.
Sourcepub fn use_opengl_changed(&self) -> Signal<()>
pub fn use_opengl_changed(&self) -> Signal<()>
This signal is emitted when accelerating the drawing of the series by using OpenGL is enabled or disabled.
Returns a built-in Qt signal QtCharts::QAbstractSeries::useOpenGLChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted when accelerating the drawing of the series by using OpenGL is enabled or disabled.
Note: Notifier signal for property useOpenGL.
Sourcepub unsafe fn attach_axis(
&self,
axis: impl CastInto<Ptr<QAbstractAxis>>,
) -> bool
pub unsafe fn attach_axis( &self, axis: impl CastInto<Ptr<QAbstractAxis>>, ) -> bool
Attaches the axis specified by axis to the series.
Calls C++ function: bool QtCharts::QAbstractSeries::attachAxis(QtCharts::QAbstractAxis* axis)
.
Attaches the axis specified by axis to the series.
Returns true
if the axis was attached successfully, false
otherwise.
Note: If multiple axes of the same orientation are attached to the same series, they will have the same minimum and maximum values.
See also QChart::addAxis() and QChart::createDefaultAxes().
Sourcepub unsafe fn attached_axes(&self) -> CppBox<QListOfQAbstractAxis>
pub unsafe fn attached_axes(&self) -> CppBox<QListOfQAbstractAxis>
Returns the list of axes attached to the series. Usually, an x-axis and a y-axis are attached to a series, except for QPieSeries, which does not have any axes attached.
Calls C++ function: QList<QtCharts::QAbstractAxis*> QtCharts::QAbstractSeries::attachedAxes()
.
Returns the list of axes attached to the series. Usually, an x-axis and a y-axis are attached to a series, except for QPieSeries, which does not have any axes attached.
See also attachAxis() and detachAxis().
Sourcepub unsafe fn chart(&self) -> QPtr<QChart>
pub unsafe fn chart(&self) -> QPtr<QChart>
Returns the chart that the series belongs to.
Calls C++ function: QtCharts::QChart* QtCharts::QAbstractSeries::chart() const
.
Returns the chart that the series belongs to.
Set automatically when the series is added to the chart, and unset when the series is removed from the chart.
Sourcepub unsafe fn detach_axis(
&self,
axis: impl CastInto<Ptr<QAbstractAxis>>,
) -> bool
pub unsafe fn detach_axis( &self, axis: impl CastInto<Ptr<QAbstractAxis>>, ) -> bool
Detaches the axis specified by axis from the series.
Calls C++ function: bool QtCharts::QAbstractSeries::detachAxis(QtCharts::QAbstractAxis* axis)
.
Detaches the axis specified by axis from the series.
Returns true
if the axis was detached successfully, false
otherwise.
See also QChart::removeAxis().
Sourcepub unsafe fn hide(&self)
pub unsafe fn hide(&self)
Sets the visibility of the series to false
.
Calls C++ function: void QtCharts::QAbstractSeries::hide()
.
Sets the visibility of the series to false
.
See also setVisible() and isVisible().
Sourcepub unsafe fn is_visible(&self) -> bool
pub unsafe fn is_visible(&self) -> bool
This property holds whether the series is visible or not.
Calls C++ function: bool QtCharts::QAbstractSeries::isVisible() const
.
This property holds whether the series is visible or not.
By default, true
.
Access functions:
bool | isVisible() const |
void | setVisible(bool visible = true) |
Notifier signal:
void | visibleChanged() |
Sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Calls C++ function: virtual const QMetaObject* QtCharts::QAbstractSeries::metaObject() const
.
Sourcepub unsafe fn name(&self) -> CppBox<QString>
pub unsafe fn name(&self) -> CppBox<QString>
This property holds the name of the series.
Calls C++ function: QString QtCharts::QAbstractSeries::name() const
.
This property holds the name of the series.
The name is displayed in the legend for the series and it supports HTML formatting.
Access functions:
QString | name() const |
void | setName(const QString &name) |
Notifier signal:
void | nameChanged() |
Sourcepub unsafe fn opacity(&self) -> c_double
pub unsafe fn opacity(&self) -> c_double
This property holds the opacity of the series.
Calls C++ function: double QtCharts::QAbstractSeries::opacity() const
.
This property holds the opacity of the series.
By default, the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque).
Access functions:
qreal | opacity() const |
void | setOpacity(qreal opacity) |
Notifier signal:
void | opacityChanged() |
Sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: c_int,
arg3: *mut *mut c_void,
) -> c_int
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: *mut *mut c_void, ) -> c_int
Calls C++ function: virtual int QtCharts::QAbstractSeries::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
Sourcepub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void
Calls C++ function: virtual void* QtCharts::QAbstractSeries::qt_metacast(const char* arg1)
.
Sourcepub unsafe fn set_name(&self, name: impl CastInto<Ref<QString>>)
pub unsafe fn set_name(&self, name: impl CastInto<Ref<QString>>)
This property holds the name of the series.
Calls C++ function: void QtCharts::QAbstractSeries::setName(const QString& name)
.
This property holds the name of the series.
The name is displayed in the legend for the series and it supports HTML formatting.
Access functions:
QString | name() const |
void | setName(const QString &name) |
Notifier signal:
void | nameChanged() |
Sourcepub unsafe fn set_opacity(&self, opacity: c_double)
pub unsafe fn set_opacity(&self, opacity: c_double)
This property holds the opacity of the series.
Calls C++ function: void QtCharts::QAbstractSeries::setOpacity(double opacity)
.
This property holds the opacity of the series.
By default, the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque).
Access functions:
qreal | opacity() const |
void | setOpacity(qreal opacity) |
Notifier signal:
void | opacityChanged() |
Sourcepub unsafe fn set_use_opengl_1a(&self, enable: bool)
pub unsafe fn set_use_opengl_1a(&self, enable: bool)
Specifies whether or not drawing the series is accelerated by using OpenGL.
Calls C++ function: void QtCharts::QAbstractSeries::setUseOpenGL(bool enable = …)
.
Specifies whether or not drawing the series is accelerated by using OpenGL.
Acceleration using OpenGL is supported only for QLineSeries and QScatterSeries. A line series used as an edge series for QAreaSeries cannot use OpenGL acceleration. When a chart contains any series that are drawn with OpenGL, a transparent QOpenGLWidget is created on top of the chart plot area. The accelerated series are not drawn on the underlying QGraphicsView, but are instead drawn on the created QOpenGLWidget.
Performance gained from using OpenGL to accelerate series drawing depends on the underlying hardware, but in most cases it is significant. For example, on a standard desktop computer, enabling OpenGL acceleration for a series typically allows rendering at least a hundred times more points without reduction on the frame rate. Chart size also has less effect on the frame rate.
The OpenGL acceleration of series drawing is meant for use cases that need fast drawing of large numbers of points. It is optimized for efficiency, and therefore the series using it lack support for many features available to non-accelerated series:
- Series animations are not supported for accelerated series.
- Point labels are not supported for accelerated series.
- Pen styles and marker shapes are ignored for accelerated series. Only solid lines and plain scatter dots are supported. The scatter dots may be circular or rectangular, depending on the underlying graphics hardware and drivers.
- Polar charts do not support accelerated series.
- Enabling chart drop shadow or using transparent chart background color is not recommended when using accelerated series, as that can slow the frame rate down significantly.
These additional restrictions stem from the fact that the accelerated series is drawn on a separate widget on top of the chart:
- If you draw any graphics items on top of a chart containing an accelerated series, the accelerated series is drawn over those items.
- To enable QOpenGLWidget to be partially transparent, it needs to be stacked on top of all other widgets. This means you cannot have other widgets partially covering the chart when using accelerated series.
- Accelerated series are not supported for use cases where the graphics scene has more than one graphics view attached to it.
- Accelerated series are not supported for use cases where the chart has non-default geometry. For example, adding transforms to the graphics view causes the accelerated series to be drawn in an incorrect position related to the chart.
The default value is false
.
Access functions:
bool | useOpenGL() const |
void | setUseOpenGL(bool enable = true) |
Notifier signal:
void | useOpenGLChanged() |
Sourcepub unsafe fn set_use_opengl_0a(&self)
pub unsafe fn set_use_opengl_0a(&self)
Specifies whether or not drawing the series is accelerated by using OpenGL.
Calls C++ function: void QtCharts::QAbstractSeries::setUseOpenGL()
.
Specifies whether or not drawing the series is accelerated by using OpenGL.
Acceleration using OpenGL is supported only for QLineSeries and QScatterSeries. A line series used as an edge series for QAreaSeries cannot use OpenGL acceleration. When a chart contains any series that are drawn with OpenGL, a transparent QOpenGLWidget is created on top of the chart plot area. The accelerated series are not drawn on the underlying QGraphicsView, but are instead drawn on the created QOpenGLWidget.
Performance gained from using OpenGL to accelerate series drawing depends on the underlying hardware, but in most cases it is significant. For example, on a standard desktop computer, enabling OpenGL acceleration for a series typically allows rendering at least a hundred times more points without reduction on the frame rate. Chart size also has less effect on the frame rate.
The OpenGL acceleration of series drawing is meant for use cases that need fast drawing of large numbers of points. It is optimized for efficiency, and therefore the series using it lack support for many features available to non-accelerated series:
- Series animations are not supported for accelerated series.
- Point labels are not supported for accelerated series.
- Pen styles and marker shapes are ignored for accelerated series. Only solid lines and plain scatter dots are supported. The scatter dots may be circular or rectangular, depending on the underlying graphics hardware and drivers.
- Polar charts do not support accelerated series.
- Enabling chart drop shadow or using transparent chart background color is not recommended when using accelerated series, as that can slow the frame rate down significantly.
These additional restrictions stem from the fact that the accelerated series is drawn on a separate widget on top of the chart:
- If you draw any graphics items on top of a chart containing an accelerated series, the accelerated series is drawn over those items.
- To enable QOpenGLWidget to be partially transparent, it needs to be stacked on top of all other widgets. This means you cannot have other widgets partially covering the chart when using accelerated series.
- Accelerated series are not supported for use cases where the graphics scene has more than one graphics view attached to it.
- Accelerated series are not supported for use cases where the chart has non-default geometry. For example, adding transforms to the graphics view causes the accelerated series to be drawn in an incorrect position related to the chart.
The default value is false
.
Access functions:
bool | useOpenGL() const |
void | setUseOpenGL(bool enable = true) |
Notifier signal:
void | useOpenGLChanged() |
Sourcepub unsafe fn set_visible_1a(&self, visible: bool)
pub unsafe fn set_visible_1a(&self, visible: bool)
This property holds whether the series is visible or not.
Calls C++ function: void QtCharts::QAbstractSeries::setVisible(bool visible = …)
.
This property holds whether the series is visible or not.
By default, true
.
Access functions:
bool | isVisible() const |
void | setVisible(bool visible = true) |
Notifier signal:
void | visibleChanged() |
Sourcepub unsafe fn set_visible_0a(&self)
pub unsafe fn set_visible_0a(&self)
This property holds whether the series is visible or not.
Calls C++ function: void QtCharts::QAbstractSeries::setVisible()
.
This property holds whether the series is visible or not.
By default, true
.
Access functions:
bool | isVisible() const |
void | setVisible(bool visible = true) |
Notifier signal:
void | visibleChanged() |
Sourcepub unsafe fn show(&self)
pub unsafe fn show(&self)
Sets the visibility of the series to true
.
Calls C++ function: void QtCharts::QAbstractSeries::show()
.
Sets the visibility of the series to true
.
See also setVisible() and isVisible().
Sourcepub unsafe fn type_(&self) -> SeriesType
pub unsafe fn type_(&self) -> SeriesType
This property holds the type of the series.
Calls C++ function: pure virtual QtCharts::QAbstractSeries::SeriesType QtCharts::QAbstractSeries::type() const
.
This property holds the type of the series.
Access functions:
virtual QAbstractSeries::SeriesType | type() const = 0 |
Sourcepub unsafe fn use_opengl(&self) -> bool
pub unsafe fn use_opengl(&self) -> bool
Specifies whether or not drawing the series is accelerated by using OpenGL.
Calls C++ function: bool QtCharts::QAbstractSeries::useOpenGL() const
.
Specifies whether or not drawing the series is accelerated by using OpenGL.
Acceleration using OpenGL is supported only for QLineSeries and QScatterSeries. A line series used as an edge series for QAreaSeries cannot use OpenGL acceleration. When a chart contains any series that are drawn with OpenGL, a transparent QOpenGLWidget is created on top of the chart plot area. The accelerated series are not drawn on the underlying QGraphicsView, but are instead drawn on the created QOpenGLWidget.
Performance gained from using OpenGL to accelerate series drawing depends on the underlying hardware, but in most cases it is significant. For example, on a standard desktop computer, enabling OpenGL acceleration for a series typically allows rendering at least a hundred times more points without reduction on the frame rate. Chart size also has less effect on the frame rate.
The OpenGL acceleration of series drawing is meant for use cases that need fast drawing of large numbers of points. It is optimized for efficiency, and therefore the series using it lack support for many features available to non-accelerated series:
- Series animations are not supported for accelerated series.
- Point labels are not supported for accelerated series.
- Pen styles and marker shapes are ignored for accelerated series. Only solid lines and plain scatter dots are supported. The scatter dots may be circular or rectangular, depending on the underlying graphics hardware and drivers.
- Polar charts do not support accelerated series.
- Enabling chart drop shadow or using transparent chart background color is not recommended when using accelerated series, as that can slow the frame rate down significantly.
These additional restrictions stem from the fact that the accelerated series is drawn on a separate widget on top of the chart:
- If you draw any graphics items on top of a chart containing an accelerated series, the accelerated series is drawn over those items.
- To enable QOpenGLWidget to be partially transparent, it needs to be stacked on top of all other widgets. This means you cannot have other widgets partially covering the chart when using accelerated series.
- Accelerated series are not supported for use cases where the graphics scene has more than one graphics view attached to it.
- Accelerated series are not supported for use cases where the chart has non-default geometry. For example, adding transforms to the graphics view causes the accelerated series to be drawn in an incorrect position related to the chart.
The default value is false
.
Access functions:
bool | useOpenGL() const |
void | setUseOpenGL(bool enable = true) |
Notifier signal:
void | useOpenGLChanged() |
Methods from Deref<Target = QObject>§
Sourcepub unsafe fn find_child<T>(
&self,
name: &str,
) -> Result<QPtr<T>, FindChildError>
pub unsafe fn find_child<T>( &self, name: &str, ) -> Result<QPtr<T>, FindChildError>
Finds a child of self
with the specified object name
and casts it to type T
.
The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.
Returns an error if there is no child object with object name name
or
the found object cannot be cast to T
.
Sourcepub fn destroyed(&self) -> Signal<(*mut QObject,)>
pub fn destroyed(&self) -> Signal<(*mut QObject,)>
This signal is emitted immediately before the object obj is destroyed, and can not be blocked.
Returns a built-in Qt signal QObject::destroyed
that can be passed to qt_core::Signal::connect
.
This signal is emitted immediately before the object obj is destroyed, and can not be blocked.
All the objects's children are destroyed immediately after this signal is emitted.
See also deleteLater() and QPointer.
Sourcepub fn object_name_changed(&self) -> Signal<(*const QString,)>
pub fn object_name_changed(&self) -> Signal<(*const QString,)>
This signal is emitted after the object's name has been changed. The new object name is passed as objectName.
Returns a built-in Qt signal QObject::objectNameChanged
that can be passed to qt_core::Signal::connect
.
This signal is emitted after the object’s name has been changed. The new object name is passed as objectName.
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
Note: Notifier signal for property objectName.
See also QObject::objectName.
Sourcepub fn slot_delete_later(&self) -> Receiver<()>
pub fn slot_delete_later(&self) -> Receiver<()>
Schedules this object for deletion.
Returns a built-in Qt slot QObject::deleteLater
that can be passed to qt_core::Signal::connect
.
Schedules this object for deletion.
The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.
Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.
Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.
Sourcepub unsafe fn block_signals(&self, b: bool) -> bool
pub unsafe fn block_signals(&self, b: bool) -> bool
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.
Calls C++ function: bool QObject::blockSignals(bool b)
.
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.
The return value is the previous value of signalsBlocked().
Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.
Signals emitted while being blocked are not buffered.
See also signalsBlocked() and QSignalBlocker.
Sourcepub unsafe fn children(&self) -> Ref<QListOfQObject>
pub unsafe fn children(&self) -> Ref<QListOfQObject>
Returns a list of child objects. The QObjectList class is defined in the <QObject>
header file as the following:
Calls C++ function: const QList<QObject*>& QObject::children() const
.
Returns a list of child objects. The QObjectList class is defined in the <QObject>
header file as the following:
typedef QList<QObject*> QObjectList;
The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.
Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.
See also findChild(), findChildren(), parent(), and setParent().
Sourcepub unsafe fn delete_later(&self)
pub unsafe fn delete_later(&self)
Schedules this object for deletion.
Calls C++ function: [slot] void QObject::deleteLater()
.
Schedules this object for deletion.
The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.
Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.
Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.
Sourcepub unsafe fn disconnect_char_q_object_char(
&self,
signal: *const i8,
receiver: impl CastInto<Ptr<QObject>>,
member: *const i8,
) -> bool
pub unsafe fn disconnect_char_q_object_char( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …, const char* member = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
Sourcepub unsafe fn disconnect_q_object_char(
&self,
receiver: impl CastInto<Ptr<QObject>>,
member: *const i8,
) -> bool
pub unsafe fn disconnect_q_object_char( &self, receiver: impl CastInto<Ptr<QObject>>, member: *const i8, ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const QObject* receiver, const char* member = …) const
.
This function overloads disconnect().
Disconnects all signals in this object from receiver's method.
A signal-slot connection is removed when either of the objects involved are destroyed.
Sourcepub unsafe fn disconnect_char_q_object(
&self,
signal: *const i8,
receiver: impl CastInto<Ptr<QObject>>,
) -> bool
pub unsafe fn disconnect_char_q_object( &self, signal: *const i8, receiver: impl CastInto<Ptr<QObject>>, ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …, const QObject* receiver = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
Sourcepub unsafe fn disconnect_char(&self, signal: *const i8) -> bool
pub unsafe fn disconnect_char(&self, signal: *const i8) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const char* signal = …) const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
Sourcepub unsafe fn disconnect(&self) -> bool
pub unsafe fn disconnect(&self) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect() const
.
This function overloads disconnect().
Disconnects signal from method of receiver.
A signal-slot connection is removed when either of the objects involved are destroyed.
Note: This function is thread-safe.
Sourcepub unsafe fn disconnect_q_object(
&self,
receiver: impl CastInto<Ptr<QObject>>,
) -> bool
pub unsafe fn disconnect_q_object( &self, receiver: impl CastInto<Ptr<QObject>>, ) -> bool
This function overloads disconnect().
Calls C++ function: bool QObject::disconnect(const QObject* receiver) const
.
This function overloads disconnect().
Disconnects all signals in this object from receiver's method.
A signal-slot connection is removed when either of the objects involved are destroyed.
Sourcepub unsafe fn dump_object_info_mut(&self)
pub unsafe fn dump_object_info_mut(&self)
Dumps information about signal connections, etc. for this object to the debug output.
Calls C++ function: void QObject::dumpObjectInfo()
.
Dumps information about signal connections, etc. for this object to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectTree().
Sourcepub unsafe fn dump_object_info(&self)
pub unsafe fn dump_object_info(&self)
Dumps information about signal connections, etc. for this object to the debug output.
Calls C++ function: void QObject::dumpObjectInfo() const
.
Dumps information about signal connections, etc. for this object to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectTree().
Sourcepub unsafe fn dump_object_tree_mut(&self)
pub unsafe fn dump_object_tree_mut(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree()
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
Sourcepub unsafe fn dump_object_tree(&self)
pub unsafe fn dump_object_tree(&self)
Dumps a tree of children to the debug output.
Calls C++ function: void QObject::dumpObjectTree() const
.
Dumps a tree of children to the debug output.
Note: before Qt 5.9, this function was not const.
See also dumpObjectInfo().
Sourcepub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>
pub unsafe fn dynamic_property_names(&self) -> CppBox<QListOfQByteArray>
Returns the names of all properties that were dynamically added to the object using setProperty().
Calls C++ function: QList<QByteArray> QObject::dynamicPropertyNames() const
.
Returns the names of all properties that were dynamically added to the object using setProperty().
This function was introduced in Qt 4.2.
Sourcepub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool
pub unsafe fn eq(&self, p: impl CastInto<Ref<QPointerOfQObject>>) -> bool
Returns true
if c1 and c2 are the same Unicode character; otherwise returns false
.
Calls C++ function: bool operator==(QObject* o, const QPointer<QObject>& p)
.
Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(QChar c1, QChar c2)
:
Returns true
if c1 and c2 are the same Unicode character; otherwise returns false
.
Sourcepub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool
pub unsafe fn event(&self, event: impl CastInto<Ptr<QEvent>>) -> bool
This virtual function receives events to an object and should return true if the event e was recognized and processed.
Calls C++ function: virtual bool QObject::event(QEvent* event)
.
This virtual function receives events to an object and should return true if the event e was recognized and processed.
The event() function can be reimplemented to customize the behavior of an object.
Make sure you call the parent event class implementation for all the events you did not handle.
Example:
class MyClass : public QWidget { Q_OBJECT
public: MyClass(QWidget *parent = 0); ~MyClass();
bool event(QEvent* ev) { if (ev->type() == QEvent::PolishRequest) { // overwrite handling of PolishRequest if any doThings(); return true; } else if (ev->type() == QEvent::Show) { // complement handling of Show if any doThings2(); QWidget::event(ev); return true; } // Make sure the rest of events are handled return QWidget::event(ev); } };
See also installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), and QCoreApplication::postEvent().
Sourcepub unsafe fn event_filter(
&self,
watched: impl CastInto<Ptr<QObject>>,
event: impl CastInto<Ptr<QEvent>>,
) -> bool
pub unsafe fn event_filter( &self, watched: impl CastInto<Ptr<QObject>>, event: impl CastInto<Ptr<QEvent>>, ) -> bool
Filters events if this object has been installed as an event filter for the watched object.
Calls C++ function: virtual bool QObject::eventFilter(QObject* watched, QEvent* event)
.
Filters events if this object has been installed as an event filter for the watched object.
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Example:
class MainWindow : public QMainWindow { public: MainWindow();
protected: bool eventFilter(QObject obj, QEvent ev);
private: QTextEdit *textEdit; };
MainWindow::MainWindow() { textEdit = new QTextEdit; setCentralWidget(textEdit);
textEdit->installEventFilter(this); }
bool MainWindow::eventFilter(QObject obj, QEvent event) { if (obj == textEdit) { if (event->type() == QEvent::KeyPress) { QKeyEvent keyEvent = static_cast<QKeyEvent>(event); qDebug() << “Ate key press” << keyEvent->key(); return true; } else { return false; } } else { // pass the event on to the parent class return QMainWindow::eventFilter(obj, event); } }
Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.
Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also installEventFilter().
Sourcepub unsafe fn find_child_q_object_2a(
&self,
a_name: impl CastInto<Ref<QString>>,
options: QFlags<FindChildOption>,
) -> QPtr<QObject>
pub unsafe fn find_child_q_object_2a( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
Sourcepub unsafe fn find_child_q_object_1a(
&self,
a_name: impl CastInto<Ref<QString>>,
) -> QPtr<QObject>
pub unsafe fn find_child_q_object_1a( &self, a_name: impl CastInto<Ref<QString>>, ) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>(const QString& aName = …) const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
Sourcepub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>
pub unsafe fn find_child_q_object_0a(&self) -> QPtr<QObject>
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QObject* QObject::findChild<QObject*>() const
.
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned. In that case, findChildren() should be used.
This example returns a child QPushButton
of parentWidget
named "button1"
, even if the button isn't a direct child of the parent:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”);
This example returns a QListWidget
child of parentWidget
:
QListWidget list = parentWidget->findChild<QListWidget >();
This example returns a child QPushButton
of parentWidget
(its direct parent) named "button1"
:
QPushButton button = parentWidget->findChild<QPushButton >(“button1”, Qt::FindDirectChildrenOnly);
This example returns a QListWidget
child of parentWidget
, its direct parent:
QListWidget list = parentWidget->findChild<QListWidget >(QString(), Qt::FindDirectChildrenOnly);
See also findChildren().
Sourcepub unsafe fn find_children_q_object_q_string_q_flags_find_child_option(
&self,
a_name: impl CastInto<Ref<QString>>,
options: QFlags<FindChildOption>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_string_q_flags_find_child_option( &self, a_name: impl CastInto<Ref<QString>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …, QFlags<Qt::FindChildOption> options = …) const
.
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
Sourcepub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option(
&self,
re: impl CastInto<Ref<QRegExp>>,
options: QFlags<FindChildOption>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_reg_exp_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegExp>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re, QFlags<Qt::FindChildOption> options = …) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Sourcepub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option(
&self,
re: impl CastInto<Ref<QRegularExpression>>,
options: QFlags<FindChildOption>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_regular_expression_q_flags_find_child_option( &self, re: impl CastInto<Ref<QRegularExpression>>, options: QFlags<FindChildOption>, ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re, QFlags<Qt::FindChildOption> options = …) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
This function was introduced in Qt 5.0.
Sourcepub unsafe fn find_children_q_object_q_string(
&self,
a_name: impl CastInto<Ref<QString>>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_string( &self, a_name: impl CastInto<Ref<QString>>, ) -> CppBox<QListOfQObject>
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QString& aName = …) const
.
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
Sourcepub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object(&self) -> CppBox<QListOfQObject>
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>() const
.
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. Omitting the name argument causes all object names to be matched. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
The following example shows how to find a list of child QWidget
s of the specified parentWidget
named widgetname
:
QList<QWidget > widgets = parentWidget.findChildren<QWidget >(“widgetname”);
This example returns all QPushButton
s that are children of parentWidget
:
QList<QPushButton > allPButtons = parentWidget.findChildren<QPushButton >();
This example returns all QPushButton
s that are immediate children of parentWidget
:
QList<QPushButton > childButtons = parentWidget.findChildren<QPushButton >(QString(), Qt::FindDirectChildrenOnly);
See also findChild().
Sourcepub unsafe fn find_children_q_object_q_reg_exp(
&self,
re: impl CastInto<Ref<QRegExp>>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_reg_exp( &self, re: impl CastInto<Ref<QRegExp>>, ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegExp& re) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression regExp, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
Sourcepub unsafe fn find_children_q_object_q_regular_expression(
&self,
re: impl CastInto<Ref<QRegularExpression>>,
) -> CppBox<QListOfQObject>
pub unsafe fn find_children_q_object_q_regular_expression( &self, re: impl CastInto<Ref<QRegularExpression>>, ) -> CppBox<QListOfQObject>
This function overloads findChildren().
Calls C++ function: QList<QObject*> QObject::findChildren<QObject*>(const QRegularExpression& re) const
.
This function overloads findChildren().
Returns the children of this object that can be cast to type T and that have names matching the regular expression re, or an empty list if there are no such objects. The search is performed recursively, unless options specifies the option FindDirectChildrenOnly.
This function was introduced in Qt 5.0.
Sourcepub unsafe fn inherits(&self, classname: *const i8) -> bool
pub unsafe fn inherits(&self, classname: *const i8) -> bool
Returns true
if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false
.
Calls C++ function: bool QObject::inherits(const char* classname) const
.
Returns true
if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false
.
A class is considered to inherit itself.
Example:
QTimer *timer = new QTimer; // QTimer inherits QObject timer->inherits(“QTimer”); // returns true timer->inherits(“QObject”); // returns true timer->inherits(“QAbstractButton”); // returns false
// QVBoxLayout inherits QObject and QLayoutItem QVBoxLayout *layout = new QVBoxLayout; layout->inherits(“QObject”); // returns true layout->inherits(“QLayoutItem”); // returns true (even though QLayoutItem is not a QObject)
If you need to determine whether an object is an instance of a particular class for the purpose of casting it, consider using qobject_cast<Type *>(object) instead.
See also metaObject() and qobject_cast().
Sourcepub unsafe fn install_event_filter(
&self,
filter_obj: impl CastInto<Ptr<QObject>>,
)
pub unsafe fn install_event_filter( &self, filter_obj: impl CastInto<Ptr<QObject>>, )
Installs an event filter filterObj on this object. For example:
Calls C++ function: void QObject::installEventFilter(QObject* filterObj)
.
Installs an event filter filterObj on this object. For example:
monitoredObj->installEventFilter(filterObj);
An event filter is an object that receives all events that are sent to this object. The filter can either stop the event or forward it to this object. The event filter filterObj receives events via its eventFilter() function. The eventFilter() function must return true if the event should be filtered, (i.e. stopped); otherwise it must return false.
If multiple event filters are installed on a single object, the filter that was installed last is activated first.
Here's a KeyPressEater
class that eats the key presses of its monitored objects:
class KeyPressEater : public QObject { Q_OBJECT ...
protected: bool eventFilter(QObject obj, QEvent event); };
bool KeyPressEater::eventFilter(QObject obj, QEvent event) { if (event->type() == QEvent::KeyPress) { QKeyEvent keyEvent = static_cast<QKeyEvent >(event); qDebug(“Ate key press %d”, keyEvent->key()); return true; } else { // standard event processing return QObject::eventFilter(obj, event); } }
And here's how to install it on two widgets:
KeyPressEater keyPressEater = new KeyPressEater(this); QPushButton pushButton = new QPushButton(this); QListView *listView = new QListView(this);
pushButton->installEventFilter(keyPressEater); listView->installEventFilter(keyPressEater);
The QShortcut class, for example, uses this technique to intercept shortcut key presses.
Warning: If you delete the receiver object in your eventFilter() function, be sure to return true. If you return false, Qt sends the event to the deleted object and the program will crash.
Note that the filtering object must be in the same thread as this object. If filterObj is in a different thread, this function does nothing. If either filterObj or this object are moved to a different thread after calling this function, the event filter will not be called until both objects have the same thread affinity again (it is not removed).
See also removeEventFilter(), eventFilter(), and event().
Sourcepub unsafe fn is_widget_type(&self) -> bool
pub unsafe fn is_widget_type(&self) -> bool
Returns true
if the object is a widget; otherwise returns false
.
Calls C++ function: bool QObject::isWidgetType() const
.
Returns true
if the object is a widget; otherwise returns false
.
Calling this function is equivalent to calling inherits("QWidget")
, except that it is much faster.
Sourcepub unsafe fn is_window_type(&self) -> bool
pub unsafe fn is_window_type(&self) -> bool
Returns true
if the object is a window; otherwise returns false
.
Calls C++ function: bool QObject::isWindowType() const
.
Returns true
if the object is a window; otherwise returns false
.
Calling this function is equivalent to calling inherits("QWindow")
, except that it is much faster.
Sourcepub unsafe fn kill_timer(&self, id: i32)
pub unsafe fn kill_timer(&self, id: i32)
Kills the timer with timer identifier, id.
Calls C++ function: void QObject::killTimer(int id)
.
Kills the timer with timer identifier, id.
The timer identifier is returned by startTimer() when a timer event is started.
See also timerEvent() and startTimer().
Sourcepub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>
Returns a pointer to the meta-object of this object.
Calls C++ function: virtual const QMetaObject* QObject::metaObject() const
.
Returns a pointer to the meta-object of this object.
A meta-object contains information about a class that inherits QObject, e.g. class name, superclass name, properties, signals and slots. Every QObject subclass that contains the Q_OBJECT macro will have a meta-object.
The meta-object information is required by the signal/slot connection mechanism and the property system. The inherits() function also makes use of the meta-object.
If you have no pointer to an actual object instance but still want to access the meta-object of a class, you can use staticMetaObject.
Example:
QObject *obj = new QPushButton; obj->metaObject()->className(); // returns “QPushButton”
QPushButton::staticMetaObject.className(); // returns “QPushButton”
See also staticMetaObject.
Sourcepub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)
pub unsafe fn move_to_thread(&self, thread: impl CastInto<Ptr<QThread>>)
Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.
Calls C++ function: void QObject::moveToThread(QThread* thread)
.
Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread.
To move an object to the main thread, use QApplication::instance() to retrieve a pointer to the current application, and then use QApplication::thread() to retrieve the thread in which the application lives. For example:
myObject->moveToThread(QApplication::instance()->thread());
If targetThread is zero, all event processing for this object and its children stops.
Note that all active timers for the object will be reset. The timers are first stopped in the current thread and restarted (with the same interval) in the targetThread. As a result, constantly moving an object between threads can postpone timer events indefinitely.
A QEvent::ThreadChange event is sent to this object just before the thread affinity is changed. You can handle this event to perform any special processing. Note that any new events that are posted to this object will be handled in the targetThread.
Warning: This function is not thread-safe; the current thread must be same as the current thread affinity. In other words, this function can only "push" an object from the current thread to another thread, it cannot "pull" an object from any arbitrary thread to the current thread.
See also thread().
Sourcepub unsafe fn object_name(&self) -> CppBox<QString>
pub unsafe fn object_name(&self) -> CppBox<QString>
This property holds the name of this object
Calls C++ function: QString QObject::objectName() const
.
This property holds the name of this object
You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().
qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”, qPrintable(objectName()), newPrecision);
By default, this property contains an empty string.
Access functions:
QString | objectName() const |
void | setObjectName(const QString &name) |
Notifier signal:
void | objectNameChanged(const QString &objectName) | [see note below] |
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
See also metaObject() and QMetaObject::className().
Sourcepub unsafe fn parent(&self) -> QPtr<QObject>
pub unsafe fn parent(&self) -> QPtr<QObject>
Returns a pointer to the parent object.
Calls C++ function: QObject* QObject::parent() const
.
Sourcepub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>
pub unsafe fn property(&self, name: *const i8) -> CppBox<QVariant>
Returns the value of the object's name property.
Calls C++ function: QVariant QObject::property(const char* name) const
.
Returns the value of the object’s name property.
If no such property exists, the returned variant is invalid.
Information about all available properties is provided through the metaObject() and dynamicPropertyNames().
See also setProperty(), QVariant::isValid(), metaObject(), and dynamicPropertyNames().
Sourcepub unsafe fn qt_metacall(
&self,
arg1: Call,
arg2: i32,
arg3: *mut *mut c_void,
) -> i32
pub unsafe fn qt_metacall( &self, arg1: Call, arg2: i32, arg3: *mut *mut c_void, ) -> i32
Calls C++ function: virtual int QObject::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3)
.
Sourcepub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void
pub unsafe fn qt_metacast(&self, arg1: *const i8) -> *mut c_void
Calls C++ function: virtual void* QObject::qt_metacast(const char* arg1)
.
Sourcepub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)
pub unsafe fn remove_event_filter(&self, obj: impl CastInto<Ptr<QObject>>)
Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.
Calls C++ function: void QObject::removeEventFilter(QObject* obj)
.
Removes an event filter object obj from this object. The request is ignored if such an event filter has not been installed.
All event filters for this object are automatically removed when this object is destroyed.
It is always safe to remove an event filter, even during event filter activation (i.e. from the eventFilter() function).
See also installEventFilter(), eventFilter(), and event().
Sourcepub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)
pub unsafe fn set_object_name(&self, name: impl CastInto<Ref<QString>>)
This property holds the name of this object
Calls C++ function: void QObject::setObjectName(const QString& name)
.
This property holds the name of this object
You can find an object by name (and type) using findChild(). You can find a set of objects with findChildren().
qDebug(“MyClass::setPrecision(): (%s) invalid precision %f”, qPrintable(objectName()), newPrecision);
By default, this property contains an empty string.
Access functions:
QString | objectName() const |
void | setObjectName(const QString &name) |
Notifier signal:
void | objectNameChanged(const QString &objectName) | [see note below] |
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
See also metaObject() and QMetaObject::className().
Sourcepub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)
pub unsafe fn set_parent(&self, parent: impl CastInto<Ptr<QObject>>)
Makes the object a child of parent.
Calls C++ function: void QObject::setParent(QObject* parent)
.
Sourcepub unsafe fn set_property(
&self,
name: *const i8,
value: impl CastInto<Ref<QVariant>>,
) -> bool
pub unsafe fn set_property( &self, name: *const i8, value: impl CastInto<Ref<QVariant>>, ) -> bool
Sets the value of the object's name property to value.
Calls C++ function: bool QObject::setProperty(const char* name, const QVariant& value)
.
Sets the value of the object’s name property to value.
If the property is defined in the class using Q_PROPERTY then true is returned on success and false otherwise. If the property is not defined using Q_PROPERTY, and therefore not listed in the meta-object, it is added as a dynamic property and false is returned.
Information about all available properties is provided through the metaObject() and dynamicPropertyNames().
Dynamic properties can be queried again using property() and can be removed by setting the property value to an invalid QVariant. Changing the value of a dynamic property causes a QDynamicPropertyChangeEvent to be sent to the object.
Note: Dynamic properties starting with "_q_" are reserved for internal purposes.
See also property(), metaObject(), dynamicPropertyNames(), and QMetaProperty::write().
Sourcepub unsafe fn signals_blocked(&self) -> bool
pub unsafe fn signals_blocked(&self) -> bool
Returns true
if signals are blocked; otherwise returns false
.
Calls C++ function: bool QObject::signalsBlocked() const
.
Returns true
if signals are blocked; otherwise returns false
.
Signals are not blocked by default.
See also blockSignals() and QSignalBlocker.
Sourcepub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32
pub unsafe fn start_timer_2a(&self, interval: i32, timer_type: TimerType) -> i32
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
Calls C++ function: int QObject::startTimer(int interval, Qt::TimerType timerType = …)
.
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.
The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.
If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.
Example:
class MyObject : public QObject { Q_OBJECT
public: MyObject(QObject *parent = 0);
protected: void timerEvent(QTimerEvent *event); };
MyObject::MyObject(QObject *parent) : QObject(parent) { startTimer(50); // 50-millisecond timer startTimer(1000); // 1-second timer startTimer(60000); // 1-minute timer
using namespace std::chrono; startTimer(milliseconds(50)); startTimer(seconds(1)); startTimer(minutes(1));
// since C++14 we can use std::chrono::duration literals, e.g.: startTimer(100ms); startTimer(5s); startTimer(2min); startTimer(1h); }
void MyObject::timerEvent(QTimerEvent *event) { qDebug() << “Timer ID:” << event->timerId(); }
Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.
The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.
See also timerEvent(), killTimer(), and QTimer::singleShot().
Sourcepub unsafe fn start_timer_1a(&self, interval: i32) -> i32
pub unsafe fn start_timer_1a(&self, interval: i32) -> i32
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
Calls C++ function: int QObject::startTimer(int interval)
.
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
A timer event will occur every interval milliseconds until killTimer() is called. If interval is 0, then the timer event occurs once every time there are no more window system events to process.
The virtual timerEvent() function is called with the QTimerEvent event parameter class when a timer event occurs. Reimplement this function to get timer events.
If multiple timers are running, the QTimerEvent::timerId() can be used to find out which timer was activated.
Example:
class MyObject : public QObject { Q_OBJECT
public: MyObject(QObject *parent = 0);
protected: void timerEvent(QTimerEvent *event); };
MyObject::MyObject(QObject *parent) : QObject(parent) { startTimer(50); // 50-millisecond timer startTimer(1000); // 1-second timer startTimer(60000); // 1-minute timer
using namespace std::chrono; startTimer(milliseconds(50)); startTimer(seconds(1)); startTimer(minutes(1));
// since C++14 we can use std::chrono::duration literals, e.g.: startTimer(100ms); startTimer(5s); startTimer(2min); startTimer(1h); }
void MyObject::timerEvent(QTimerEvent *event) { qDebug() << “Timer ID:” << event->timerId(); }
Note that QTimer's accuracy depends on the underlying operating system and hardware. The timerType argument allows you to customize the accuracy of the timer. See Qt::TimerType for information on the different timer types. Most platforms support an accuracy of 20 milliseconds; some provide more. If Qt is unable to deliver the requested number of timer events, it will silently discard some.
The QTimer class provides a high-level programming interface with single-shot timers and timer signals instead of events. There is also a QBasicTimer class that is more lightweight than QTimer and less clumsy than using timer IDs directly.
See also timerEvent(), killTimer(), and QTimer::singleShot().
Sourcepub unsafe fn thread(&self) -> QPtr<QThread>
pub unsafe fn thread(&self) -> QPtr<QThread>
Returns the thread in which the object lives.
Calls C++ function: QThread* QObject::thread() const
.
Returns the thread in which the object lives.
See also moveToThread().
Trait Implementations§
Source§impl CppDeletable for QLineSeries
impl CppDeletable for QLineSeries
Source§unsafe fn delete(&self)
unsafe fn delete(&self)
Destroys the object. Series added to QChartView or QChart instances are owned by the instances and deleted when the instances are destroyed.
Calls C++ function: virtual [destructor] void QtCharts::QLineSeries::~QLineSeries()
.
Destroys the object. Series added to QChartView or QChart instances are owned by the instances and deleted when the instances are destroyed.
Source§impl Deref for QLineSeries
impl Deref for QLineSeries
Source§impl DynamicCast<QLineSeries> for QAbstractSeries
impl DynamicCast<QLineSeries> for QAbstractSeries
Source§unsafe fn dynamic_cast(ptr: Ptr<QAbstractSeries>) -> Ptr<QLineSeries>
unsafe fn dynamic_cast(ptr: Ptr<QAbstractSeries>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* dynamic_cast<QtCharts::QLineSeries*>(QtCharts::QAbstractSeries* ptr)
.
Source§impl DynamicCast<QLineSeries> for QObject
impl DynamicCast<QLineSeries> for QObject
Source§unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QLineSeries>
unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* dynamic_cast<QtCharts::QLineSeries*>(QObject* ptr)
.
Source§impl DynamicCast<QLineSeries> for QXYSeries
impl DynamicCast<QLineSeries> for QXYSeries
Source§unsafe fn dynamic_cast(ptr: Ptr<QXYSeries>) -> Ptr<QLineSeries>
unsafe fn dynamic_cast(ptr: Ptr<QXYSeries>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* dynamic_cast<QtCharts::QLineSeries*>(QtCharts::QXYSeries* ptr)
.
Source§impl DynamicCast<QSplineSeries> for QLineSeries
impl DynamicCast<QSplineSeries> for QLineSeries
Source§unsafe fn dynamic_cast(ptr: Ptr<QLineSeries>) -> Ptr<QSplineSeries>
unsafe fn dynamic_cast(ptr: Ptr<QLineSeries>) -> Ptr<QSplineSeries>
Calls C++ function: QtCharts::QSplineSeries* dynamic_cast<QtCharts::QSplineSeries*>(QtCharts::QLineSeries* ptr)
.
Source§impl StaticDowncast<QLineSeries> for QAbstractSeries
impl StaticDowncast<QLineSeries> for QAbstractSeries
Source§unsafe fn static_downcast(ptr: Ptr<QAbstractSeries>) -> Ptr<QLineSeries>
unsafe fn static_downcast(ptr: Ptr<QAbstractSeries>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* static_cast<QtCharts::QLineSeries*>(QtCharts::QAbstractSeries* ptr)
.
Source§impl StaticDowncast<QLineSeries> for QObject
impl StaticDowncast<QLineSeries> for QObject
Source§unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QLineSeries>
unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* static_cast<QtCharts::QLineSeries*>(QObject* ptr)
.
Source§impl StaticDowncast<QLineSeries> for QXYSeries
impl StaticDowncast<QLineSeries> for QXYSeries
Source§unsafe fn static_downcast(ptr: Ptr<QXYSeries>) -> Ptr<QLineSeries>
unsafe fn static_downcast(ptr: Ptr<QXYSeries>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* static_cast<QtCharts::QLineSeries*>(QtCharts::QXYSeries* ptr)
.
Source§impl StaticDowncast<QSplineSeries> for QLineSeries
impl StaticDowncast<QSplineSeries> for QLineSeries
Source§unsafe fn static_downcast(ptr: Ptr<QLineSeries>) -> Ptr<QSplineSeries>
unsafe fn static_downcast(ptr: Ptr<QLineSeries>) -> Ptr<QSplineSeries>
Calls C++ function: QtCharts::QSplineSeries* static_cast<QtCharts::QSplineSeries*>(QtCharts::QLineSeries* ptr)
.
Source§impl StaticUpcast<QAbstractSeries> for QLineSeries
impl StaticUpcast<QAbstractSeries> for QLineSeries
Source§unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QAbstractSeries>
unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QAbstractSeries>
Calls C++ function: QtCharts::QAbstractSeries* static_cast<QtCharts::QAbstractSeries*>(QtCharts::QLineSeries* ptr)
.
Source§impl StaticUpcast<QLineSeries> for QSplineSeries
impl StaticUpcast<QLineSeries> for QSplineSeries
Source§unsafe fn static_upcast(ptr: Ptr<QSplineSeries>) -> Ptr<QLineSeries>
unsafe fn static_upcast(ptr: Ptr<QSplineSeries>) -> Ptr<QLineSeries>
Calls C++ function: QtCharts::QLineSeries* static_cast<QtCharts::QLineSeries*>(QtCharts::QSplineSeries* ptr)
.
Source§impl StaticUpcast<QObject> for QLineSeries
impl StaticUpcast<QObject> for QLineSeries
Source§unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QObject>
unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QObject>
Calls C++ function: QObject* static_cast<QObject*>(QtCharts::QLineSeries* ptr)
.
Source§impl StaticUpcast<QXYSeries> for QLineSeries
impl StaticUpcast<QXYSeries> for QLineSeries
Source§unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QXYSeries>
unsafe fn static_upcast(ptr: Ptr<QLineSeries>) -> Ptr<QXYSeries>
Calls C++ function: QtCharts::QXYSeries* static_cast<QtCharts::QXYSeries*>(QtCharts::QLineSeries* ptr)
.