matecomponent-property-control

## matecomponent-property-control matecomponent-property-control |

## Synopsis

    struct              MateComponentPropertyControl;
                        MateComponentPropertyControlPrivate;
    #define             MATECOMPONENT_PROPERTY_CONTROL_CHANGED
    MateComponentControl *     (*MateComponentPropertyControlGetControlFn)
                                                            (MateComponentPropertyControl *control,
                                                             int page_number,
                                                             void *closure);
                        MateComponentPropertyControlClass;
    MateComponentPropertyControl * matecomponent_property_control_construct
                                                            (MateComponentPropertyControl *property_control,
                                                             MateComponentEventSource *event_source,
                                                             MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             void *closure);
    MateComponentPropertyControl * matecomponent_property_control_new_full
                                                            (MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             MateComponentEventSource *event_source,
                                                             void *closure);
    MateComponentPropertyControl * matecomponent_property_control_new     (MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             void *closure);
    void                matecomponent_property_control_changed     (MateComponentPropertyControl *property_control,
                                                             CORBA_Environment *opt_ev);
    MateComponentEventSource * matecomponent_property_control_get_event_source
                                                            (MateComponentPropertyControl *property_control);

## Object Hierarchy

      GObject
       +----MateComponentObject
             +----MateComponentPropertyControl

## Signals

      "action"                                         : Run First

## Description

## Details

### struct MateComponentPropertyControl

    struct MateComponentPropertyControl;

### MateComponentPropertyControlPrivate

    typedef struct _MateComponentPropertyControlPrivate MateComponentPropertyControlPrivate;

### MATECOMPONENT_PROPERTY_CONTROL_CHANGED

    #define MATECOMPONENT_PROPERTY_CONTROL_CHANGED "MateComponent::PropertyControl_changed"

### MateComponentPropertyControlGetControlFn ()

    MateComponentControl *     (*MateComponentPropertyControlGetControlFn)
                                                            (MateComponentPropertyControl *control,
                                                             int page_number,
                                                             void *closure);

`control` : |
`page_number` : |
`closure` : |
Returns : |

### MateComponentPropertyControlClass

    typedef struct {
    	MateComponentObjectClass parent_class;

    	POA_MateComponent_PropertyControl__epv epv;

    	gpointer dummy[4];

    	void (* action) (MateComponentPropertyControl *property_control,
    			 MateComponent_PropertyControl_Action action);
    } MateComponentPropertyControlClass;

### matecomponent_property_control_construct ()

    MateComponentPropertyControl * matecomponent_property_control_construct
                                                            (MateComponentPropertyControl *property_control,
                                                             MateComponentEventSource *event_source,
                                                             MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             void *closure);

Initialises the MateComponentPropertyControl object.

`property_control` : | A MateComponentPropertyControl object.
`event_source` : | A MateComponentEventSource object that will be aggregated onto the property control.
`get_fn` : | Creation routine.
`num_pages` : |
`closure` : | Data passed to closure routine.
Returns : | The newly constructed MateComponentPropertyControl.

### matecomponent_property_control_new_full ()

    MateComponentPropertyControl * matecomponent_property_control_new_full
                                                            (MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             MateComponentEventSource *event_source,
                                                             void *closure);

Creates a MateComponentPropertyControl object.

`get_fn` : | The function to be called when the getControl method is called.
`num_pages` : | The number of pages this property control has.
`event_source` : | The event source to use to emit events on.
`closure` : | The data to be passed into the `get_fn` routine.
Returns : | A pointer to a newly created MateComponentPropertyControl object.

### matecomponent_property_control_new ()

    MateComponentPropertyControl * matecomponent_property_control_new     (MateComponentPropertyControlGetControlFn get_fn,
                                                             int num_pages,
                                                             void *closure);

Creates a MateComponentPropertyControl object.

`get_fn` : | The function to be called when the getControl method is called.
`num_pages` : | The number of pages this property control has.
`closure` : | The data to be passed into the `get_fn` routine
Returns : | A pointer to a newly created MateComponentPropertyControl object.

### matecomponent_property_control_changed ()

    void                matecomponent_property_control_changed     (MateComponentPropertyControl *property_control,
                                                             CORBA_Environment *opt_ev);

Tells the server that a value in the property control has been changed, and that it should indicate this somehow.

`property_control` : | The MateComponentPropertyControl that has changed.
`opt_ev` : | An optional CORBA_Environment for exception handling.

### matecomponent_property_control_get_event_source ()

    MateComponentEventSource * matecomponent_property_control_get_event_source
                                                            (MateComponentPropertyControl *property_control);

Returns the MateComponentEventSource that `property_control` uses.

`property_control` : | The MateComponentPropertyControl.
Returns : | A MateComponentEventSource.

## Signal Details

### The `"action"` signal

    void                user_function                      (MateComponentPropertyControl *matecomponentpropertycontrol,
                                                            gint                   arg1,
                                                            gint                   arg2,
                                                            gpointer               user_data)                  : Run First

`matecomponentpropertycontrol` : | the object which received the signal.
`arg1` : |
`arg2` : |
`user_data` : | user data set when the signal handler was connected.