openshot-audio  0.1.7
Public Member Functions | List of all members
juce::PreferencesPanel Class Referenceabstract

#include <juce_gui_extra.h>

Inheritance diagram for juce::PreferencesPanel:
juce::Button::Listener

Public Member Functions

 PreferencesPanel ()
 
 ~PreferencesPanel ()
 
void addSettingsPage (const String &pageTitle, const Drawable *normalIcon, const Drawable *overIcon, const Drawable *downIcon)
 
void addSettingsPage (const String &pageTitle, const void *imageData, int imageDataSize)
 
void showInDialogBox (const String &dialogTitle, int dialogWidth, int dialogHeight, Colour backgroundColour=Colours::white)
 
virtual ComponentcreateComponentForPage (const String &pageName)=0
 
void setCurrentPage (const String &pageName)
 
int getButtonSize () const noexcept
 
void setButtonSize (int newSize)
 
void resized () override
 
void paint (Graphics &) override
 
void buttonClicked (Button *) override
 

Detailed Description

A component with a set of buttons at the top for changing between pages of preferences.

This is just a handy way of writing a Mac-style preferences panel where you have a row of buttons along the top for the different preference categories, each button having an icon above its name. Clicking these will show an appropriate prefs page below it.

You can either put one of these inside your own component, or just use the showInDialogBox() method to show it in a window and run it modally.

To use it, just add a set of named pages with the addSettingsPage() method, and implement the createComponentForPage() method to create suitable components for each of these pages.

Constructor & Destructor Documentation

PreferencesPanel::PreferencesPanel ( )

Creates an empty panel.

Use addSettingsPage() to add some pages to it in your constructor.

PreferencesPanel::~PreferencesPanel ( )

Destructor.

Member Function Documentation

void PreferencesPanel::addSettingsPage ( const String pageTitle,
const Drawable normalIcon,
const Drawable overIcon,
const Drawable downIcon 
)

Creates a page using a set of drawables to define the page's icon.

Note that the other version of this method is much easier if you're using an image instead of a custom drawable.

Parameters
pageTitlethe name of this preferences page - you'll need to make sure your createComponentForPage() method creates a suitable component when it is passed this name
normalIconthe drawable to display in the page's button normally
overIconthe drawable to display in the page's button when the mouse is over
downIconthe drawable to display in the page's button when the button is down
See Also
DrawableButton
void PreferencesPanel::addSettingsPage ( const String pageTitle,
const void *  imageData,
int  imageDataSize 
)

Creates a page using a set of drawables to define the page's icon.

The other version of this method gives you more control over the icon, but this one is much easier if you're just loading it from a file.

Parameters
pageTitlethe name of this preferences page - you'll need to make sure your createComponentForPage() method creates a suitable component when it is passed this name
imageDataa block of data containing an image file, e.g. a jpeg, png or gif. For this to look good, you'll probably want to use a nice transparent png file.
imageDataSizethe size of the image data, in bytes
void PreferencesPanel::buttonClicked ( Button )
overridevirtual

Called when the button is clicked.

Implements juce::Button::Listener.

virtual Component* juce::PreferencesPanel::createComponentForPage ( const String pageName)
pure virtual

Subclasses must override this to return a component for each preferences page.

The subclass should return a pointer to a new component representing the named page, which the panel will then display.

The panel will delete the component later when the user goes to another page or deletes the panel.

int PreferencesPanel::getButtonSize ( ) const
noexcept

Returns the size of the buttons shown along the top.

void PreferencesPanel::paint ( Graphics g)
override
void PreferencesPanel::resized ( )
override
void PreferencesPanel::setButtonSize ( int  newSize)

Changes the size of the buttons shown along the top.

void PreferencesPanel::setCurrentPage ( const String pageName)

Changes the current page being displayed.

void PreferencesPanel::showInDialogBox ( const String dialogTitle,
int  dialogWidth,
int  dialogHeight,
Colour  backgroundColour = Colours::white 
)

Utility method to display this panel in a DialogWindow.

Calling this will create a DialogWindow containing this panel with the given size and title, and will run it modally, returning when the user closes the dialog box.


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