Mercurial > pidgin.yaz
comparison libpurple/prpl.h @ 32479:2c58de59bd57
Hide PurpleAttentionType struct and remove attention @since tags.
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Fri, 02 Sep 2011 03:38:52 +0000 |
parents | 96e66fbe2881 |
children | cd1d9e04c587 |
comparison
equal
deleted
inserted
replaced
32478:91e8402106c1 | 32479:2c58de59bd57 |
---|---|
109 int min; /**< Minimum value in case of integer */ | 109 int min; /**< Minimum value in case of integer */ |
110 int max; /**< Maximum value in case of integer */ | 110 int max; /**< Maximum value in case of integer */ |
111 gboolean secret; /**< True if the entry is secret (password) */ | 111 gboolean secret; /**< True if the entry is secret (password) */ |
112 }; | 112 }; |
113 | 113 |
114 /** Represents "nudges" and "buzzes" that you may send to a buddy to attract | |
115 * their attention (or vice-versa). | |
116 */ | |
117 struct _PurpleAttentionType | |
118 { | |
119 const char *name; /**< Shown in GUI elements */ | |
120 const char *incoming_description; /**< Shown when sent */ | |
121 const char *outgoing_description; /**< Shown when receied */ | |
122 const char *icon_name; /**< Icon to display (optional) */ | |
123 const char *unlocalized_name; /**< Unlocalized name for UIs needing it */ | |
124 | |
125 /* Reserved fields for future purposes */ | |
126 gpointer _reserved2; | |
127 gpointer _reserved3; | |
128 gpointer _reserved4; | |
129 }; | |
130 | |
131 /** | 114 /** |
132 * Protocol options | 115 * Protocol options |
133 * | 116 * |
134 * These should all be stuff that some plugins can do and others can't. | 117 * These should all be stuff that some plugins can do and others can't. |
135 */ | 118 */ |
678 * without localization. | 661 * without localization. |
679 * @param name A localized string that the UI may display for the event. This | 662 * @param name A localized string that the UI may display for the event. This |
680 * should be the same string as @a ulname, with localization. | 663 * should be the same string as @a ulname, with localization. |
681 * @param inc_desc A localized description shown when the event is received. | 664 * @param inc_desc A localized description shown when the event is received. |
682 * @param out_desc A localized description shown when the event is sent. | 665 * @param out_desc A localized description shown when the event is sent. |
666 * | |
683 * @return A pointer to the new object. | 667 * @return A pointer to the new object. |
684 * @since 2.4.0 | |
685 */ | 668 */ |
686 PurpleAttentionType *purple_attention_type_new(const char *ulname, const char *name, | 669 PurpleAttentionType *purple_attention_type_new(const char *ulname, const char *name, |
687 const char *inc_desc, const char *out_desc); | 670 const char *inc_desc, const char *out_desc); |
688 | 671 |
689 /** | 672 /** |
691 * | 674 * |
692 * @param type The attention type. | 675 * @param type The attention type. |
693 * @param name The localized name that will be displayed by UIs. This should be | 676 * @param name The localized name that will be displayed by UIs. This should be |
694 * the same string given as the unlocalized name, but with | 677 * the same string given as the unlocalized name, but with |
695 * localization. | 678 * localization. |
696 * @since 2.4.0 | |
697 */ | 679 */ |
698 void purple_attention_type_set_name(PurpleAttentionType *type, const char *name); | 680 void purple_attention_type_set_name(PurpleAttentionType *type, const char *name); |
699 | 681 |
700 /** | 682 /** |
701 * Sets the description of the attention-demanding event shown in conversations | 683 * Sets the description of the attention-demanding event shown in conversations |
702 * when the event is received. | 684 * when the event is received. |
703 * | 685 * |
704 * @param type The attention type. | 686 * @param type The attention type. |
705 * @param desc The localized description for incoming events. | 687 * @param desc The localized description for incoming events. |
706 * @since 2.4.0 | |
707 */ | 688 */ |
708 void purple_attention_type_set_incoming_desc(PurpleAttentionType *type, const char *desc); | 689 void purple_attention_type_set_incoming_desc(PurpleAttentionType *type, const char *desc); |
709 | 690 |
710 /** | 691 /** |
711 * Sets the description of the attention-demanding event shown in conversations | 692 * Sets the description of the attention-demanding event shown in conversations |
712 * when the event is sent. | 693 * when the event is sent. |
713 * | 694 * |
714 * @param type The attention type. | 695 * @param type The attention type. |
715 * @param desc The localized description for outgoing events. | 696 * @param desc The localized description for outgoing events. |
716 * @since 2.4.0 | |
717 */ | 697 */ |
718 void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const char *desc); | 698 void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const char *desc); |
719 | 699 |
720 /** | 700 /** |
721 * Sets the name of the icon to display for the attention event; this is optional. | 701 * Sets the name of the icon to display for the attention event; this is optional. |
722 * | 702 * |
723 * @param type The attention type. | 703 * @param type The attention type. |
724 * @param name The icon's name. | 704 * @param name The icon's name. |
725 * @note Icons are optional for attention events. | 705 * @note Icons are optional for attention events. |
726 * @since 2.4.0 | |
727 */ | 706 */ |
728 void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name); | 707 void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name); |
729 | 708 |
730 /** | 709 /** |
731 * Sets the unlocalized name of the attention event; some UIs may need this, | 710 * Sets the unlocalized name of the attention event; some UIs may need this, |
732 * thus it is required. | 711 * thus it is required. |
733 * | 712 * |
734 * @param type The attention type. | 713 * @param type The attention type. |
735 * @param ulname The unlocalized name. This should be the same string given as | 714 * @param ulname The unlocalized name. This should be the same string given as |
736 * the localized name, but without localization. | 715 * the localized name, but without localization. |
737 * @since 2.4.0 | |
738 */ | 716 */ |
739 void purple_attention_type_set_unlocalized_name(PurpleAttentionType *type, const char *ulname); | 717 void purple_attention_type_set_unlocalized_name(PurpleAttentionType *type, const char *ulname); |
740 | 718 |
741 /** | 719 /** |
742 * Get the attention type's name as displayed by the UI. | 720 * Get the attention type's name as displayed by the UI. |
743 * | 721 * |
744 * @param type The attention type. | 722 * @param type The attention type. |
723 * | |
745 * @return The name. | 724 * @return The name. |
746 * @since 2.4.0 | |
747 */ | 725 */ |
748 const char *purple_attention_type_get_name(const PurpleAttentionType *type); | 726 const char *purple_attention_type_get_name(const PurpleAttentionType *type); |
749 | 727 |
750 /** | 728 /** |
751 * Get the attention type's description shown when the event is received. | 729 * Get the attention type's description shown when the event is received. |
752 * | 730 * |
753 * @param type The attention type. | 731 * @param type The attention type. |
754 * @return The description. | 732 * @return The description. |
755 * @since 2.4.0 | |
756 */ | 733 */ |
757 const char *purple_attention_type_get_incoming_desc(const PurpleAttentionType *type); | 734 const char *purple_attention_type_get_incoming_desc(const PurpleAttentionType *type); |
758 | 735 |
759 /** | 736 /** |
760 * Get the attention type's description shown when the event is sent. | 737 * Get the attention type's description shown when the event is sent. |
761 * | 738 * |
762 * @param type The attention type. | 739 * @param type The attention type. |
763 * @return The description. | 740 * @return The description. |
764 * @since 2.4.0 | |
765 */ | 741 */ |
766 const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *type); | 742 const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *type); |
767 | 743 |
768 /** | 744 /** |
769 * Get the attention type's icon name. | 745 * Get the attention type's icon name. |
770 * | 746 * |
771 * @param type The attention type. | 747 * @param type The attention type. |
772 * @return The icon name or @c NULL if unset/empty. | 748 * @return The icon name or @c NULL if unset/empty. |
773 * @note Icons are optional for attention events. | 749 * @note Icons are optional for attention events. |
774 * @since 2.4.0 | |
775 */ | 750 */ |
776 const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type); | 751 const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type); |
777 | 752 |
778 /** | 753 /** |
779 * Get the attention type's unlocalized name; this is useful for some UIs. | 754 * Get the attention type's unlocalized name; this is useful for some UIs. |
780 * | 755 * |
781 * @param type The attention type | 756 * @param type The attention type |
782 * @return The unlocalized name. | 757 * @return The unlocalized name. |
783 * @since 2.4.0 | |
784 */ | 758 */ |
785 const char *purple_attention_type_get_unlocalized_name(const PurpleAttentionType *type); | 759 const char *purple_attention_type_get_unlocalized_name(const PurpleAttentionType *type); |
786 | 760 |
787 /*@}*/ | 761 /*@}*/ |
788 | 762 |