Public Types | Public Member Functions | List of all members
Note Class Reference

Type-ID: Note. More...

Inheritance diagram for Note:
FloatingTileContent ObjectWithDefaultProperties

Public Types

enum  SpecialPanelIds { Text = (int)FloatingTileContent::PanelPropertyId::numPropertyIds }
 
- Public Types inherited from FloatingTileContent
enum  PanelPropertyId {
  Type = 0, Title , ColourData, LayoutData,
  Font, FontSize
}
 

Public Member Functions

 SET_PANEL_NAME ("Note")
 Type-ID: TypeID More...
 
- Public Member Functions inherited from FloatingTileContent
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...
 

Additional Inherited Members

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

Detailed Description

Type-ID: Note.

Note Screenshot

A simple text editor that can be used to express thoughts / quick 'n dirty copy paste actions.

JSON Example:

const var data = {
"Type": "Note",
"Font": "Comic Sans MS",
"FontSize": 14,
"Text": "This is the content",
"ColourData": {
"textColour": "0xFFFF0000",
"bgColour": "0xFF222222"
}
}

Used base properties

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

Member Enumeration Documentation

Enumerator
Text 

the content of the text editor

Member Function Documentation

SET_PANEL_NAME ( "Note"  )

Type-ID: TypeID

Description

%TYPE% Screenshot

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};

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.