Delta Chat Core C-API
Public Member Functions | Public Attributes | List of all members
mrpoortext_t Struct Reference

An object representing text with some attributes. More...

#include <mrpoortext.h>

Public Member Functions

void mrpoortext_unref (mrpoortext_t *poortext)
 Frees a poortext object. More...
 

Public Attributes

int m_text1_meaning
 Defines the meaning of the m_text1 string. More...
 
char * m_text1
 The meaning is defined by m_text1_meaning and by the creator of the object. More...
 
char * m_text2
 The meaning is defined by the creator of the object. More...
 
time_t m_timestamp
 Typically a message timestamp. More...
 
int m_state
 Typically a MR_MSG_STATE_* constant. More...
 

Detailed Description

An object representing text with some attributes.

A poortext object contains some strings together with their meaning and some attributes. Poortext objects are returned eg. from mrchatlist_get_summary() or mrmsg_get_summary().

Member Function Documentation

void mrpoortext_unref ( mrpoortext_t poortext)

Frees a poortext object.

Poortext objects are typically created by mrchatlist_get_summary() or by mrmsg_get_summary(). This also frees the strings objects.

Parameters
poortextThe mrpoortext_t object to free.
Returns
None

Member Data Documentation

int mrpoortext_t::m_state

Typically a MR_MSG_STATE_* constant.

May be 0.

char* mrpoortext_t::m_text1

The meaning is defined by m_text1_meaning and by the creator of the object.

May be NULL.

int mrpoortext_t::m_text1_meaning

Defines the meaning of the m_text1 string.

  • MR_TEXT1_NORMAL (0) = m_text1 is a normal text field.
  • MR_TEXT1_DRAFT = m_text1 is the string "Draft", typically, this is shown in another color.
  • MR_TEXT1_USERNAME = m_text1 is a username, typically, this is shown in another color.
  • MR_TEXT1_SELF = m_text1 is the string "Me", typically, this is shown in another color.
char* mrpoortext_t::m_text2

The meaning is defined by the creator of the object.

May be NULL.

time_t mrpoortext_t::m_timestamp

Typically a message timestamp.

The concrete meaning is defined by the creator of the object. May be 0.


The documentation for this struct was generated from the following files: