GeditMessage: gedit Reference Manual

## GeditMessage GeditMessage — message bus message object |

## Functions

const gchar * | gedit_message_get_object_path ()
const gchar * | gedit_message_get_method ()
gboolean | gedit_message_type_has ()
gboolean | gedit_message_type_check ()
gboolean | gedit_message_has ()
gboolean | gedit_message_is_valid_object_path ()
gchar * | gedit_message_type_identifier ()

## Properties

char * | method | Read / Write / Construct
char * | object-path | Read / Write / Construct

## Types and Values

struct | GeditMessage

## Object Hierarchy

        GObject
        ╰── GeditMessage

## Includes

    #include <gedit/gedit-message.h>

## Description

Communication on a GeditMessageBus is done through messages. Messages are sent over the bus and received by connecting callbacks on the message bus. A GeditMessage is an instantiation of a GeditMessageType, containing values for the arguments as specified in the message type.

A message can be seen as a method call, or signal emission depending on who is the sender and who is the receiver. There is no explicit distinction between methods and signals.

## Functions

### gedit_message_get_object_path ()

    const gchar *
    gedit_message_get_object_path (GeditMessage *message);

Get the message object path.

#### Parameters

message | the GeditMessage |

#### Returns

the message object path

### gedit_message_get_method ()

    const gchar *
    gedit_message_get_method (GeditMessage *message);

Get the message method.

#### Parameters

message | the GeditMessage |

#### Returns

the message method

### gedit_message_type_has ()

    gboolean
    gedit_message_type_has (GType gtype,
                            const gchar *propname);

### gedit_message_type_check ()

    gboolean
    gedit_message_type_check (GType gtype,
                              const gchar *propname,
                              GType value_type);

### gedit_message_has ()

    gboolean
    gedit_message_has (GeditMessage *message,
                       const gchar *propname);

Check if a message has a certain property.

#### Parameters

message | the GeditMessage |
propname | the property name |

#### Returns

`TRUE` if message has `propname` , `FALSE` otherwise

### gedit_message_is_valid_object_path ()

    gboolean
    gedit_message_is_valid_object_path (const gchar *object_path);

Returns whether `object_path` is a valid object path

#### Parameters

object_path | the object path. | [allow-none]

#### Returns

`TRUE` if `object_path` is a valid object path

### gedit_message_type_identifier ()

    gchar *
    gedit_message_type_identifier (const gchar *object_path,
                                   const gchar *method);

Get the string identifier for `method` at `object_path` .

#### Parameters

object_path | the object path. | [allow-none]
method | the method. | [allow-none]

#### Returns

the identifier for `method` at `object_path`

## Types and Values

### struct GeditMessage

    struct GeditMessage;

## Property Details

### The `“method”` property

      “method”                   char *

The messages method.

Owner: GeditMessage

Flags: Read / Write / Construct

Default value: NULL

### The `“object-path”` property

      “object-path”              char *

The message object path.

Owner: GeditMessage

Flags: Read / Write / Construct

Default value: NULL