Murl::Addons::Filepanel::IControl Interface Referenceabstract

The Filepanel IControl interface. More...

#include "murl_addons_filepanel_i_control.h"

Inherited by Murl::Addons::Filepanel::Osx::Control, and Murl::Addons::Filepanel::Win32::Control.

Public Member Functions

virtual Bool Load (const String &fileExtension=String())=0
 Open a file panel for loading. More...
 
virtual Bool Save (const String &fileExtension=String())=0
 Open a file panel for saving. More...
 
virtual Bool IsActive () const =0
 Check if the file panel is active. More...
 
virtual Bool WasActive ()=0
 Check if the file panel was active in the most recent tick. More...
 
virtual const StringGetFileName () const =0
 Get the selected filename from the last Load() or Save() operation when the file panel is no longer active. More...
 

Detailed Description

The Filepanel IControl interface.

Member Function Documentation

◆ Load()

virtual Bool Murl::Addons::Filepanel::IControl::Load ( const String fileExtension = String())
pure virtual

Open a file panel for loading.

Parameters
fileExtensionA string to filter for file extensions.
Returns
true if successful.

◆ Save()

virtual Bool Murl::Addons::Filepanel::IControl::Save ( const String fileExtension = String())
pure virtual

Open a file panel for saving.

Parameters
fileExtensionA string to filter for file extensions.
Returns
true if successful.

◆ IsActive()

virtual Bool Murl::Addons::Filepanel::IControl::IsActive ( ) const
pure virtual

Check if the file panel is active.

Returns
true if the file panel is active.

◆ WasActive()

virtual Bool Murl::Addons::Filepanel::IControl::WasActive ( )
pure virtual

Check if the file panel was active in the most recent tick.

Returns
true if the file panel was active in the most recent tick.

◆ GetFileName()

virtual const String& Murl::Addons::Filepanel::IControl::GetFileName ( ) const
pure virtual

Get the selected filename from the last Load() or Save() operation when the file panel is no longer active.

Returns
The selected filename or an empty string if cancelled.

The documentation for this interface was generated from the following file:
  • murl_addons_filepanel_i_control.h


Copyright © 2011-2018 Spraylight GmbH.