JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::ContentSharer Class Reference

A singleton class responsible for sharing content between apps and devices. More...

#include <juce_ContentSharer.h>

Collaboration diagram for juce::ContentSharer:

Classes

struct  Pimpl
 

Public Member Functions

void shareData (const MemoryBlock &mb, std::function< void(bool, const String &)> callback)
 A convenience function to share arbitrary data. More...
 
void shareFiles (const Array< URL > &files, std::function< void(bool, const String &)> callback)
 Shares the given files. More...
 
void shareImages (const Array< Image > &images, std::function< void(bool, const String &)> callback, ImageFileFormat *imageFileFormatToUse=nullptr)
 A convenience function to share an image. More...
 
void shareText (const String &text, std::function< void(bool, const String &)> callback)
 Shares the given text. More...
 

Private Member Functions

 ContentSharer ()
 
 ~ContentSharer ()
 
PimplcreatePimpl ()
 
void deleteTemporaryFiles ()
 
void filesToSharePrepared ()
 
void sharingFinished (bool, const String &)
 
void startNewShare (std::function< void(bool, const String &)>)
 

Private Attributes

std::function< void(bool, String)> callback
 
std::unique_ptr< Pimplpimpl
 
std::unique_ptr< PrepareDataThreadprepareDataThread
 
std::unique_ptr< PrepareImagesThreadprepareImagesThread
 
Array< FiletemporaryFiles
 

Friends

class ContentSharerNativeImpl
 
class PrepareDataThread
 
class PrepareImagesThread
 

Detailed Description

A singleton class responsible for sharing content between apps and devices.

You can share text, images, files or an arbitrary data block.

{GUI}

Constructor & Destructor Documentation

◆ ContentSharer()

juce::ContentSharer::ContentSharer ( )
private

◆ ~ContentSharer()

juce::ContentSharer::~ContentSharer ( )
private

Member Function Documentation

◆ createPimpl()

Pimpl* juce::ContentSharer::createPimpl ( )
private

◆ deleteTemporaryFiles()

void juce::ContentSharer::deleteTemporaryFiles ( )
private

◆ filesToSharePrepared()

void juce::ContentSharer::filesToSharePrepared ( )
private

◆ shareData()

void juce::ContentSharer::shareData ( const MemoryBlock mb,
std::function< void(bool, const String &)>  callback 
)

A convenience function to share arbitrary data.

The data will be written to a temporary file and then that file will be shared. If you have your data stored on disk already, call shareFiles() instead.

Upon completion you will receive a callback with a sharing result. Note: Sadly on Android the returned success flag may be wrong as there is no standard way the sharing targets report if the sharing operation succeeded. Also, the optional error message is always empty on Android.

◆ shareFiles()

void juce::ContentSharer::shareFiles ( const Array< URL > &  files,
std::function< void(bool, const String &)>  callback 
)

Shares the given files.

Each URL should be either a full file path or it should point to a resource within the application bundle. For resources on iOS it should be something like "content/image.png" if you want to specify a file from application bundle located in "content" directory. On Android you should specify only a filename, without an extension.

Upon completion you will receive a callback with a sharing result. Note: Sadly on Android the returned success flag may be wrong as there is no standard way the sharing targets report if the sharing operation succeeded. Also, the optional error message is always empty on Android.

◆ shareImages()

void juce::ContentSharer::shareImages ( const Array< Image > &  images,
std::function< void(bool, const String &)>  callback,
ImageFileFormat imageFileFormatToUse = nullptr 
)

A convenience function to share an image.

This is useful when you have images loaded in memory. The images will be written to temporary files first, so if you have the images in question stored on disk already call shareFiles() instead. By default, images will be saved to PNG files, but you can supply a custom ImageFileFormat to override this. The custom file format will be owned and deleted by the sharer. e.g.

Graphics g (myImage);
g.setColour (Colours::green);
g.fillEllipse (20, 20, 300, 200);
Array<Image> images;
images.add (myImage);
ContentSharer::getInstance()->shareImages (images, myCallback);

Upon completion you will receive a callback with a sharing result. Note: Sadly on Android the returned success flag may be wrong as there is no standard way the sharing targets report if the sharing operation succeeded. Also, the optional error message is always empty on Android.

◆ shareText()

void juce::ContentSharer::shareText ( const String text,
std::function< void(bool, const String &)>  callback 
)

Shares the given text.

Upon completion you will receive a callback with a sharing result. Note: Sadly on Android the returned success flag may be wrong as there is no standard way the sharing targets report if the sharing operation succeeded. Also, the optional error message is always empty on Android.

◆ sharingFinished()

void juce::ContentSharer::sharingFinished ( bool  ,
const String  
)
private

◆ startNewShare()

void juce::ContentSharer::startNewShare ( std::function< void(bool, const String &)>  )
private

Friends And Related Function Documentation

◆ ContentSharerNativeImpl

friend class ContentSharerNativeImpl
friend

◆ PrepareDataThread

friend class PrepareDataThread
friend

◆ PrepareImagesThread

friend class PrepareImagesThread
friend

Member Data Documentation

◆ callback

std::function<void (bool, String)> juce::ContentSharer::callback
private

◆ pimpl

std::unique_ptr<Pimpl> juce::ContentSharer::pimpl
private

◆ prepareDataThread

std::unique_ptr<PrepareDataThread> juce::ContentSharer::prepareDataThread
private

◆ prepareImagesThread

std::unique_ptr<PrepareImagesThread> juce::ContentSharer::prepareImagesThread
private

◆ temporaryFiles

Array<File> juce::ContentSharer::temporaryFiles
private

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