FloatingTileContent Class Reference

The base class for all components that can be put into a floating panel. More...

Inheritance diagram for FloatingTileContent:

Public Types
enum	PanelPropertyId {   Type = 0, Title , ColourData, LayoutData,   Font, FontSize }

Public Member Functions
String	getBestTitle () const
	This returns the title that is supposed to be displayed. More...
String	getCustomTitle () const
	If you set a custom title, this will return it. More...
FloatingTile *	getParentShell ()
	Returns the parent shell. More...
void	setCustomTitle (String newCustomTitle)
	Set a custom title to the panel that will be displayed in tabs, etc. More...
void	setDynamicTitle (const String &newDynamicTitle)
	Sets a title that is supposed to change during runtime. More...
virtual bool	showTitleInPresentationMode () const
	Overwrite this method if your component should hide the "title" when not in layout mode. More...
virtual void	siblingAmountChanged ()
	Override this method when you want to be notified when the amount of siblings change. More...
Public Member Functions inherited from ObjectWithDefaultProperties
void	resetObject (DynamicObject *objectToClear)
	Clears the given object and sets all defaultable properties to their initial values. More...

Protected Member Functions
	FloatingTileContent (FloatingTile *parent_)
	Creates a new floating panel. More...
virtual int	getFixedHeight () const
	Overwrite this method if the component has a fixed height. More...
virtual int	getFixedWidth () const
	Overwrite this method if the component has a fixed width. More...

Detailed Description

The base class for all components that can be put into a floating panel.

In order to use it:

• Subclass this interface
• Use the macro SET_PANEL_NAME() to set it's unique ID
• register the class to the FloatingPanel::Factory
• add it to the popup menu

You can use the ValueTree methods to save / restore the state.

Description

Used base properties

ID	Description
ColourData::textColour	the text colour
ColourData::bgColour	the background colour
ColourData::itemColour1	the first item colour
Font	the font
FontSize	the font size

Example JSON

const var data = {%EXAMPLE_JSON};

Member Enumeration Documentation

enum PanelPropertyId

strong

Enumerator
Type	the ID of the panel that determines the actual type.
Title	can be used to show a better title in the popup
ColourData	an object that contains 5 basic colour IDs that can be used to customize the panel: bgColour, textColour, itemColour1, itemColour2 and itemColour3
LayoutData	this object contains information about the layout within its parent container. You usually don't need to change this via scripting.
Font	if the panel is rendering text, this can be used to change the font. For changing the font-style, append Bold or Italic at the font name.
FontSize	if the panel is rendering text, this can be used to change the font size.

Constructor & Destructor Documentation

FloatingTileContent ( FloatingTile *  parent_ )

inlineprotected

Creates a new floating panel.

You must supply a FloatingShellComponent at initialisation to prevent the requirement for lazy initialisation.

Member Function Documentation

String getBestTitle ( ) const

inline

This returns the title that is supposed to be displayed.

String getCustomTitle ( ) const

inline

If you set a custom title, this will return it.

virtual int getFixedHeight ( ) const

inlineprotectedvirtual

Overwrite this method if the component has a fixed height.

virtual int getFixedWidth ( ) const

inlineprotectedvirtual

Overwrite this method if the component has a fixed width.

FloatingTile* getParentShell ( )

inline

Returns the parent shell.

Unlike getParentComponent(), this always returns non nullptr, so you can use it in the constructor.

void setCustomTitle ( String  newCustomTitle )

inline

Set a custom title to the panel that will be displayed in tabs, etc.

void setDynamicTitle

(

const String &

newDynamicTitle

)

Sets a title that is supposed to change during runtime.

It will not be stored in the JSON data.

virtual bool showTitleInPresentationMode ( ) const

inlinevirtual

Overwrite this method if your component should hide the "title" when not in layout mode.

This will make the parent shell use the full area for this component so make sure it doesn't interfer with the shell buttons.

virtual void siblingAmountChanged ( )

inlinevirtual

Override this method when you want to be notified when the amount of siblings change.