~ubuntu-branches/ubuntu/trusty/parole/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/plugin-api/tmpl/parole-provider-plugin.sgml

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

docs/plugin-api/tmpl/parole-provider-plugin.sgml

 

1

<!-- ##### SECTION Title ##### -->

 

2

ParoleProviderPlugin

 

3

 

 

4

<!-- ##### SECTION Short_Description ##### -->

 

5

The interface of the plugin type registration.

 

6

 

 

7

<!-- ##### SECTION Long_Description ##### -->

 

8

<para>

 

9

The methods of this interface should be overridden by the plugin, the Parole player

 

10

calls these methods to determine if the plugin is configurable, to ask the plugin to

 

11

open its configuration dialog or to set the #ParoleProviderPlayer that the plugin

 

12

can use to get access to various functionalities of the player.

 

13

</para>

 

14

 

 

15

<!-- ##### SECTION See_Also ##### -->

 

16

<para>

 

17

#ParoleProviderPlayer.

 

18

</para>

 

19

 

 

20

<!-- ##### SECTION Stability_Level ##### -->

 

21

 

 

22

 

 

23

<!-- ##### STRUCT ParoleProviderPluginIface ##### -->

 

24

<para>

 

25

 

 

26

</para>

 

27

 

 

28

@__parent__: 

 

29

@get_is_configurable: 

 

30

@configure: 

 

31

@set_player: 

 

32

 

 

33

<!-- ##### STRUCT ParoleProviderPlugin ##### -->

 

34

<para>

 

35

 

 

36

</para>

 

37

 

 

38

 

 

39

<!-- ##### FUNCTION parole_provider_plugin_get_is_configurable ##### -->

 

40

<para>

 

41

 

 

42

</para>

 

43

 

 

44

@provider: 

 

45

@Returns: 

 

46

 

 

47

 

 

48

<!-- ##### FUNCTION parole_provider_plugin_configure ##### -->

 

49

<para>

 

50

 

 

51

</para>

 

52

 

 

53

@provider: 

 

54

@parent: 

 

55

 

 

56

 

 

57

<!-- ##### FUNCTION parole_provider_plugin_set_player ##### -->

 

58

<para>

 

59

 

 

60

</para>

 

61

 

 

62

@provider: 

 

63

@player: 

 

64

 

 

65

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1