wex v24.04.0
Public Types | Public Member Functions | List of all members
wex::stc_file Class Reference

Adds file read and write to stc. More...

#include <wex/stc/file.h>

Inheritance diagram for wex::stc_file:
Inheritance graph
[legend]

Public Types

enum  { FILE_LOAD , FILE_LOAD_SYNC , FILE_SAVE , FILE_SAVE_AS }
 After loading / saving an event is sent to stc to update gui, this is the event number. More...
 

Public Member Functions

 stc_file (stc *stc, const wex::path &p=wex::path())
 Constructor.
 
 ~stc_file ()=default
 Destructor.
 
class ex_streamex_stream ()
 The ex stream (used if in ex mode), might be nullptr.
 
bool is_contents_changed () const override
 Returns whether contents have been changed.
 
void reset_contents_changed () override
 Resets contents changed.
 
- Public Member Functions inherited from wex::file
 file ()
 Default constructor.
 
 file (const path &p)
 Constructor taking a path.
 
 file (const char *filename)
 Constructor taking a filename.
 
 file (const path &p, std::ios_base::openmode mode)
 Constructor taking a path, opens the file.
 
 file (const char *filename, std::ios_base::openmode mode)
 Constructor taking a filename, opens the file.
 
 file (const file &rhs)
 Copy constructor.
 
virtual ~file ()=default
 Destructor.
 
fileoperator= (const file &f)
 Assignment operator.
 
bool check_sync ()
 Checks whether this file can be synced, and syncs (invokes do_file_load) the file if so.
 
bool close ()
 Closes the file.
 
bool file_load (const path &p)
 Sets the path, opens the file if asked for, invokes do_file_load, and closes the file again (unless use_stream was invoked).
 
bool file_new (const path &p)
 Sets the path and invokes do_file_new.
 
bool file_save (const wex::path &p=wex::path())
 Sets the path if path is ok, opens the file if asked for, invokes do_file_save, and closes the file again.
 
bool is_open () const
 Returns true if file is open.
 
bool is_written () const
 Returns true if file has been written.
 
bool open (std::ios_base::openmode mode=std::ios_base::in)
 Opens current path.
 
bool open (const path &p, std::ios_base::openmode mode=std::ios_base::in)
 Opens specified path.
 
const wex::pathpath () const
 Returns the path.
 
wex::pathpath ()
 Returns the path.
 
const std::string * read (std::streampos seek_position=0)
 Reads this file into a buffer.
 
std::fstream & stream ()
 Returns stream.
 
void use_stream (bool use=true)
 Default file is closed after loading, if you call this method, stream remains open.
 
bool write (std::span< const char > buffer)
 Writes file from buffer.
 
bool write (const std::string &s)
 Writes file from string.
 

Additional Inherited Members

Detailed Description

Adds file read and write to stc.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

After loading / saving an event is sent to stc to update gui, this is the event number.

Enumerator
FILE_LOAD 

file was loaded

FILE_LOAD_SYNC 

file was reloaded

FILE_SAVE 

file was saved

FILE_SAVE_AS 

file was saved as

Constructor & Destructor Documentation

◆ stc_file()

wex::stc_file::stc_file ( stc * stc,
const wex::path & p = wex::path() )

Constructor.

Parameters
stcthe stc component
pthe path to be assigned