Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject - Revision history

Aseigo: /* Geometry */

2013-02-07T09:46:31Z

‎Geometry

2012-11-21T00:30:18Z

fonts

2012-11-21T00:29:05Z

start toolbox docs

2012-09-20T15:30:09Z

‎PopupApplet specific

2012-09-13T11:28:45Z

‎Context menu

2012-09-13T11:27:48Z

‎Context menu

2012-08-22T10:39:58Z

‎PopupApplet specific

2012-08-22T10:39:22Z

‎Containment specific

2012-08-22T10:38:00Z

‎PopupApplet specific

2012-08-22T10:36:30Z

‎PopupApplet specific

@@ Line 128: / Line 128: @@
 Functions:
-* '''resize(width, height)'''
+* '''resize(width, height)''' - must not be called on widget creation (that will break external resizing; e.g. user interaction), and should only be called as a last resort during runtime. Almost always content should scale to the size of the plasmoid.
-* '''setMinimumSize(width, height)'''
+* '''setMinimumSize(width, height)''' - Not to be used from QML, where top level minimumWidth and minimumHeight properties are used instead
-* '''setPreferredSize(width, height)'''
+* '''setPreferredSize(width, height)''' - Not to be used from QML
 * '''setBackgroundHints(background)''' - use '''NoBackground''' as value if you want to remove the default plasmoid background box.
 * '''popupIcon(QIcon("some icon"))''' - set icon to show when the plasmoid is added to the taskbar. NOTE if the plasmoid is made in QML, you MUST specify a default size for the main Item. This size will be used for the plasmoid when added to the taskbar

@@ Line 116: / Line 116: @@
 The following API is only available from declarative containments.
-* "ToolBox" "toolBox()": The toolbox of the Containment. The ToolBox is rendered as a separate item on the scene and provides access to the following properties:
+* ''ToolBox'' '''toolBox()''': The toolbox of the Containment. The ToolBox is rendered as a separate item on the scene and provides access to the following properties:
-** "Array(QAction)" "actions": A list of actions provided by the Containment.
+** ''Array(QAction)'' '''actions''': A list of actions provided by the Containment.
 = Geometry  =

@@ Line 114: / Line 114: @@
 * ''string'' '''activityName''': The name of the activity this containment belongs to.
 * ''string'' '''activityId''': The id of the activity this containment belongs to.
 = Geometry  =

← Older revision		Revision as of 15:30, 20 September 2012
Line 99:		Line 99:

	* ''bool'' '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close		* ''bool'' '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close
		+
		+	* ''bool'' '''popupShowing''': true when the popupapplet is iconified and its popup is open

	== Containment specific ==		== Containment specific ==

@@ Line 187: / Line 187: @@
 * '''setAction(String name, String text, String icon, String shortcut)''': adds an item to the context menu with the given text and icon;
   In pure JavaScript plasmoids you need to define '''plasmoid.action_<name>''' function, where <name> is the first argument for setAction call, and this function will be called each time user clicks the item.
-  Similarly in QML plasmoids you must devine a function '''action_<name>''' in the root qml item that will handle the action click.
+  Similarly in QML plasmoids you must define a function '''action_<name>''' in the root qml item that will handle the action click.
 * '''setActionSeparator(String name)''': (API v5) adds a separator item to the context menu
 * '''removeAction(String name)''': removes the item with <name>

@@ Line 84: / Line 84: @@
 == PopupApplet specific ==
-* QIcon '''popupIcon''': it will be used instead of the applet content when the applet is in a panel
+* ''QIcon'' '''popupIcon''': it will be used instead of the applet content when the applet is in a panel
-* Object '''popupIconToolTip''': it contains the icon, mainText and subtext for the tooltip the applet will have when collapsed in an icon, properties:
+* ''Object'' '''popupIconToolTip''': it contains the icon, mainText and subtext for the tooltip the applet will have when collapsed in an icon, properties:
-** variant '''image''': the icon, it may be an icon name, an image path, a QIcon, QImage or a QPixmap
+** ''variant'' '''image''': the icon, it may be an icon name, an image path, a QIcon, QImage or a QPixmap
-** String '''mainText''': the tooltip title
+** ''String'' '''mainText''': the tooltip title
-** Strng '''subText''': the tooltip descriptive subtext
+** ''String'' '''subText''': the tooltip descriptive subtext
    <syntaxhighlight lang="javascript">
@@ Line 98: / Line 98: @@
    </syntaxhighlight>
-* bool '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close
+* ''bool'' '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close
 == Containment specific ==

@@ Line 101: / Line 101: @@
 == Containment specific ==
-* ''applets'': Array(Object). List of all applets in the containment
+* ''Array(Object)'' '''applets''': List of all applets in the containment
-* ''drawWallpaper'': bool. Enable/disable the wallpaper painting by the containment
+* ''bool'' '''drawWallpaper''': Enable/disable the wallpaper painting by the containment
-* ''containmentType'': one of
+* ''enum'' '''containmentType''': one of
 ** ''DesktopContainment'': A desktop containment
 ** ''PanelContainment'': A desktop panel
@@ Line 109: / Line 109: @@
 ** ''CustomPanelContainment'': A customized desktop panel
-* ''screen'': int. Number of the screen this containment is in
+* ''int'' '''screen''': Number of the screen this containment is in
-* ''activityName'': string. The name of the activity this containment belongs to.
+* ''string'' '''activityName''': The name of the activity this containment belongs to.
-* ''activityId'': string. The id of the activity this containment belongs to.
+* ''string'' '''activityId''': The id of the activity this containment belongs to.
 = Geometry  =

← Older revision		Revision as of 10:36, 22 August 2012
Line 99:		Line 99:

	* ''passivePopup'': bool, if true when the popup is opened other windows can gain focus and the popup won't close		* ''passivePopup'': bool, if true when the popup is opened other windows can gain focus and the popup won't close
		+
		+	== Containment specific ==
		+	* ''applets'': Array(Object). List of all applets in the containment
		+	* ''drawWallpaper'': bool. Enable/disable the wallpaper painting by the containment
		+	* ''containmentType'': one of
		+	** ''DesktopContainment'': A desktop containment
		+	** ''PanelContainment'': A desktop panel
		+	** ''CustomContainment'': A containment that is neither a desktop nor a panel but something application specific
		+	** ''CustomPanelContainment'': A customized desktop panel
		+
		+	* ''screen'': int. Number of the screen this containment is in
		+	* ''activityName'': string. The name of the activity this containment belongs to.
		+	* ''activityId'': string. The id of the activity this containment belongs to.

	= Geometry =		= Geometry =