Struct qt_gui::QFileOpenEvent

#[repr(C)]
pub struct QFileOpenEvent { /* private fields */ }

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

C++ class: QFileOpenEvent.

C++ documentation:

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

File open events will be sent to the QApplication::instance() when the operating system requests that a file or URL should be opened. This is a high-level event that can be caused by different user actions depending on the user's desktop environment; for example, double clicking on an file icon in the Finder on macOS.

This event is only used to notify the application of a request. It may be safely ignored.

Note: This class is currently supported for macOS only.

Implementations

impl QFileOpenEvent

pub unsafe fn copy_from( &self, other: impl CastInto<Ref<QFileOpenEvent>> ) -> Ref<QFileOpenEvent>

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

Calls C++ function: QFileOpenEvent& QFileOpenEvent::operator=(const QFileOpenEvent& other).

C++ documentation:

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

File open events will be sent to the QApplication::instance() when the operating system requests that a file or URL should be opened. This is a high-level event that can be caused by different user actions depending on the user's desktop environment; for example, double clicking on an file icon in the Finder on macOS.

This event is only used to notify the application of a request. It may be safely ignored.

Note: This class is currently supported for macOS only.

pub unsafe fn file(&self) -> CppBox<QString>

Returns the file that is being opened.

Calls C++ function: QString QFileOpenEvent::file() const.

C++ documentation:

Returns the file that is being opened.

pub unsafe fn from_q_string( file: impl CastInto<Ref<QString>> ) -> CppBox<QFileOpenEvent>

Calls C++ function: [constructor] void QFileOpenEvent::QFileOpenEvent(const QString& file).

pub unsafe fn from_q_url( url: impl CastInto<Ref<QUrl>> ) -> CppBox<QFileOpenEvent>

Calls C++ function: [constructor] void QFileOpenEvent::QFileOpenEvent(const QUrl& url).

pub unsafe fn new_copy( other: impl CastInto<Ref<QFileOpenEvent>> ) -> CppBox<QFileOpenEvent>

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

Calls C++ function: [constructor] void QFileOpenEvent::QFileOpenEvent(const QFileOpenEvent& other).

C++ documentation:

The QFileOpenEvent class provides an event that will be sent when there is a request to open a file or a URL.

File open events will be sent to the QApplication::instance() when the operating system requests that a file or URL should be opened. This is a high-level event that can be caused by different user actions depending on the user's desktop environment; for example, double clicking on an file icon in the Finder on macOS.

This event is only used to notify the application of a request. It may be safely ignored.

Note: This class is currently supported for macOS only.

pub unsafe fn open_file( &self, file: impl CastInto<Ref<QFile>>, flags: QFlags<OpenModeFlag> ) -> bool

Opens a QFile on the file referenced by this event in the mode specified by flags. Returns true if successful; otherwise returns false.

Calls C++ function: bool QFileOpenEvent::openFile(QFile& file, QFlags<QIODevice::OpenModeFlag> flags) const.

C++ documentation:

Opens a QFile on the file referenced by this event in the mode specified by flags. Returns true if successful; otherwise returns false.

This is necessary as some files cannot be opened by name, but require specific information stored in this event.

This function was introduced in Qt 4.8.

pub unsafe fn url(&self) -> CppBox<QUrl>

Returns the url that is being opened.

Calls C++ function: QUrl QFileOpenEvent::url() const.

C++ documentation:

Returns the url that is being opened.

This function was introduced in Qt 4.6.

Methods from Deref<Target = QEvent>

pub unsafe fn accept(&self)

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Calls C++ function: void QEvent::accept().

C++ documentation:

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget.

See also ignore().

pub unsafe fn copy_from(&self, other: impl CastInto<Ref<QEvent>>) -> Ref<QEvent>

Calls C++ function: QEvent& QEvent::operator=(const QEvent& other).

pub unsafe fn ignore(&self)

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Calls C++ function: void QEvent::ignore().

C++ documentation:

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Clearing the accept parameter indicates that the event receiver does not want the event. Unwanted events might be propagated to the parent widget.

See also accept().

pub unsafe fn is_accepted(&self) -> bool

the accept flag of the event object

Calls C++ function: bool QEvent::isAccepted() const.

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn set_accepted(&self, accepted: bool)

the accept flag of the event object

Calls C++ function: void QEvent::setAccepted(bool accepted).

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn spontaneous(&self) -> bool

Returns true if the event originated outside the application (a system event); otherwise returns false.

Calls C++ function: bool QEvent::spontaneous() const.

C++ documentation:

Returns true if the event originated outside the application (a system event); otherwise returns false.

The return value of this function is not defined for paint events.

pub unsafe fn type_(&self) -> Type

Returns the event type.

Calls C++ function: QEvent::Type QEvent::type() const.

C++ documentation:

Returns the event type.

Trait Implementations

impl CppDeletable for QFileOpenEvent

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void QFileOpenEvent::~QFileOpenEvent().

impl Deref for QFileOpenEvent

fn deref(&self) -> &QEvent

Calls C++ function: QEvent* static_cast<QEvent*>(QFileOpenEvent* ptr).

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QFileOpenEvent> for QEvent

unsafe fn dynamic_cast(ptr: Ptr<QEvent>) -> Ptr<QFileOpenEvent>

Calls C++ function: QFileOpenEvent* dynamic_cast<QFileOpenEvent*>(QEvent* ptr).

impl StaticDowncast<QFileOpenEvent> for QEvent

unsafe fn static_downcast(ptr: Ptr<QEvent>) -> Ptr<QFileOpenEvent>

Calls C++ function: QFileOpenEvent* static_cast<QFileOpenEvent*>(QEvent* ptr).

impl StaticUpcast<QEvent> for QFileOpenEvent

unsafe fn static_upcast(ptr: Ptr<QFileOpenEvent>) -> Ptr<QEvent>

Calls C++ function: QEvent* static_cast<QEvent*>(QFileOpenEvent* ptr).