OhWidget Service XML Definition - Revision history

Openhome: /* Glossary */

2012-03-01T15:34:39Z

Glossary

← Older revision		Revision as of 15:34, 1 March 2012
Line 488:		Line 488:
	ohApp - An application that runs inside ohOS.		ohApp - An application that runs inside ohOS.

-	ohNet - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.	+	[[ohNet\|ohNet]] - Library for discovering, eventing and controlling services on a network. Includes a full implementation of the UPnP stack.

-	~~ohOS~~ - The Openhome Operating System. Core software for Openhome systems that runs on Nodes.	+	[[ohOs\|ohOs]] - The Openhome Operating System. Core software for Openhome systems that runs on Nodes.

	PDLP - Proxy Device List Provider. The pattern used to represent the layers of UPnP in the Openhome code. All layers except the Presentation layer are represented in this pattern.		PDLP - Proxy Device List Provider. The pattern used to represent the layers of UPnP in the Openhome code. All layers except the Presentation layer are represented in this pattern.

2012-03-01T15:33:57Z

HTML and UI JavaScript

← Older revision		Revision as of 15:33, 1 March 2012
Line 378:		Line 378:

	The generated code used in the UI JavaScript and the HTML is based on the content of each of the elements		The generated code used in the UI JavaScript and the HTML is based on the content of each of the elements
-	you define in the XML.	+	you define in the XML.
-		+

	== Provider ==		== Provider ==

2012-03-01T15:33:45Z

Summary view UI

← Older revision		Revision as of 15:33, 1 March 2012
Line 372:		Line 372:

	Those details are stored in the Provider so that the Node can always access them and generate the summary view UI at run-time.		Those details are stored in the Provider so that the Node can always access them and generate the summary view UI at run-time.
-

	== Details view UI ==		== Details view UI ==

2012-03-01T15:33:00Z

propertylist

← Older revision		Revision as of 15:33, 1 March 2012
Line 156:		Line 156:

	{{Noteboxend}}		{{Noteboxend}}
-

	The propertylist element has the following child elements:		The propertylist element has the following child elements:
Line 171:		Line 170:
	XML must contain at least one property definition.		XML must contain at least one property definition.
	\|}		\|}
-

	== property ==		== property ==

2012-03-01T15:32:44Z

Table 3.3. version child elements description

← Older revision		Revision as of 15:32, 1 March 2012
Line 143:		Line 143:
	\|This element must appear once only and must contain the value 0.		\|This element must appear once only and must contain the value 0.
	\|}		\|}
-

	== propertylist ==		== propertylist ==

2012-03-01T15:29:53Z

Internal structure

← Older revision		Revision as of 15:29, 1 March 2012
Line 63:		Line 63:

	The structure of the XML is defined by OpenHome. You cannot change it and expect your Widget to operate on an OpenHome network. However, some of the files you generate from it can be customized.		The structure of the XML is defined by OpenHome. You cannot change it and expect your Widget to operate on an OpenHome network. However, some of the files you generate from it can be customized.
-

	== External document dependencies ==		== External document dependencies ==

2012-03-01T15:29:27Z

Introduction

← Older revision		Revision as of 15:29, 1 March 2012
Line 13:		Line 13:

	To help you produce your Widget Service XML file, this document provides descriptions of each element you can use in your own Widget Service XML file. A sample Widget Service XML file is used throughout the document.		To help you produce your Widget Service XML file, this document provides descriptions of each element you can use in your own Widget Service XML file. A sample Widget Service XML file is used throughout the document.
-

	== Prerequisites ==		== Prerequisites ==
Line 21:		Line 20:
	* technical details about the properties your Widget physically provides		* technical details about the properties your Widget physically provides
	* the OpenHome SDK, specifically the WidgetService.xsd file		* the OpenHome SDK, specifically the WidgetService.xsd file
-

	== Related documents ==		== Related documents ==
Line 28:		Line 26:
	to see how the XML is used:		to see how the XML is used:
	* [[ohWidget Driver Development\|OpenHome Widget Driver Development]]		* [[ohWidget Driver Development\|OpenHome Widget Driver Development]]
-

	= Widget Service XML =		= Widget Service XML =

2012-03-01T13:55:12Z

access

← Older revision		Revision as of 13:55, 1 March 2012
Line 447:		Line 447:

	If the access was defined as readOnly, a SetPropertyOn function is still generated, but is not accessible from the UI. The function remains in the auto-generated code so that the Widget can update the Node with the property's new state when it changes.		If the access was defined as readOnly, a SetPropertyOn function is still generated, but is not accessible from the UI. The function remains in the auto-generated code so that the Widget can update the Node with the property's new state when it changes.
		+
		+	{{Noteboxend}}

	=== dataType ===		=== dataType ===

2012-03-01T13:54:27Z

Naming rules

← Older revision		Revision as of 13:54, 1 March 2012
Line 366:		Line 366:

	The following sections explain how the XML you define affects the auto-generated output.		The following sections explain how the XML you define affects the auto-generated output.
-

	{{Notebox}}		{{Notebox}}
Line 460:		Line 459:

	The abstract SetOn function automatically takes a bool as the parameter used to set the new value of the property.		The abstract SetOn function automatically takes a bool as the parameter used to set the new value of the property.
-

	= Appendix A =		= Appendix A =

2012-03-01T13:54:06Z

Assigning the primary property