Trait ux::native::ActorManagerExt

pub trait ActorManagerExt: 'static {
    pub fn add_actor<P, Q>(&self, container: &P, actor: &Q) -> u64
    where
        P: Is<Actor>,
        Q: Is<Actor>;
    pub fn cancel_operation(&self, id: u64);
    pub fn cancel_operations<P>(&self, actor: &P)
    where
        P: Is<Actor>;
    pub fn get_n_operations(&self) -> u32;
    pub fn get_stage(&self) -> Option<Stage>;
    pub fn get_time_slice(&self) -> u32;
    pub fn remove_actor<P, Q>(&self, container: &P, actor: &Q) -> u64
    where
        P: Is<Actor>,
        Q: Is<Actor>;
    pub fn remove_container<P>(&self, container: &P)
    where
        P: Is<Actor>;
    pub fn set_time_slice(&self, msecs: u32);
    pub fn connect_actor_finished<F>(&self, f: F) -> SignalHandlerId
    where
        F: 'static + Fn(&Self, &Actor);
    pub fn connect_property_n_operations_notify<F>(
        &self, 
        f: F
    ) -> SignalHandlerId
    where
        F: 'static + Fn(&Self);
    pub fn connect_property_time_slice_notify<F>(&self, f: F) -> SignalHandlerId
    where
        F: 'static + Fn(&Self);
}

Required methods

pub fn add_actor<P, Q>(&self, container: &P, actor: &Q) -> u64 where
    P: Is<Actor>,
    Q: Is<Actor>, 

add_actor: @manager: A #ActorManager @container: A #Actor @actor: A #Actor

Adds @actor to @container. The actor may not be parented immediately, or at all, if the operation is cancelled.

On successful completion, the #ActorManager::actor_added signal will be fired.

Returns: The ID for this operation.

pub fn cancel_operation(&self, id: u64)

cancel_operation: @manager: A #ActorManager @id: An operation ID

Cancels the given operation, if it exists. The #ActorManager::operation_cancelled signal is fired whenever an operation is cancelled.

pub fn cancel_operations<P>(&self, actor: &P) where
    P: Is<Actor>, 

cancel_operations: @manager: A #ActorManager @actor: A #Actor

Cancels all operations associated with the given actor.

pub fn get_n_operations(&self) -> u32

create_actor: @manager: A #ActorManager @create_func: A #Actor creation function @userdata: data to be passed to the function, or %None @destroy_func: callback to invoke before the operation is removed

Creates a #Actor. The actor may not be created immediately, or at all, if the operation is cancelled.

On successful completion, the #ActorManager::actor_created signal will be fired.

Returns: The ID for this operation.

get_n_operations: @manager: A #ActorManager

Retrieves the amount of operations left in the queue.

Returns: Number of operations left to perform

pub fn get_stage(&self) -> Option<Stage>

get_stage: @manager: A #ActorManager

Gets the #Stage the actor manager is associated with.

Returns: (transfer none): The #Stage the actor is associated with.

pub fn get_time_slice(&self) -> u32

get_time_slice: @manager: A #ActorManager

Retrieves the current time slice being used for operations.

Returns: The time-slice being used, in milliseconds

pub fn remove_actor<P, Q>(&self, container: &P, actor: &Q) -> u64 where
    P: Is<Actor>,
    Q: Is<Actor>, 

remove_actor: @manager: A #ActorManager @container: A #Actor @actor: A #Actor

Removes @actor from @container.

On successful completion, the #ActorManager::actor_removed signal will be fired.

The actor may not be removed immediately, and thus you may want to set the actor’s opacity to 0 before calling this function.

Returns: The ID for this operation.

pub fn remove_container<P>(&self, container: &P) where
    P: Is<Actor>, 

remove_container: @manager: A #ActorManager @container: A #Actor

Removes the container. This is a utility function that works by first removing all the children of the container, then the children itself. This effectively spreads the load of removing a large container. All prior operations associated with this container will be cancelled.

The container may not be removed immediately, and thus you may want to set the container’s opacity to 0 before calling this function.

pub fn set_time_slice(&self, msecs: u32)

set_time_slice: @manager: A #ActorManager @msecs: A time, in milliseconds

Sets the amount of time the actor manager will spend performing operations, before yielding to allow any necessary redrawing to occur.

Lower times will lead to smoother performance, but will increase the amount of time it takes for operations to complete.

pub fn connect_actor_finished<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&Self, &Actor), 

pub fn connect_property_n_operations_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&Self), 

pub fn connect_property_time_slice_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&Self), 

Loading content...

Implementors

impl<O> ActorManagerExt for O where
    O: Is<ActorManager>, 

pub fn add_actor<P, Q>(&self, container: &P, actor: &Q) -> u64 where
    P: Is<Actor>,
    Q: Is<Actor>, 

add_actor: @manager: A #ActorManager @container: A #Actor @actor: A #Actor

Adds @actor to @container. The actor may not be parented immediately, or at all, if the operation is cancelled.

On successful completion, the #ActorManager::actor_added signal will be fired.

Returns: The ID for this operation.

pub fn cancel_operation(&self, id: u64)

cancel_operation: @manager: A #ActorManager @id: An operation ID

Cancels the given operation, if it exists. The #ActorManager::operation_cancelled signal is fired whenever an operation is cancelled.

pub fn cancel_operations<P>(&self, actor: &P) where
    P: Is<Actor>, 

cancel_operations: @manager: A #ActorManager @actor: A #Actor

Cancels all operations associated with the given actor.

pub fn get_n_operations(&self) -> u32

create_actor: @manager: A #ActorManager @create_func: A #Actor creation function @userdata: data to be passed to the function, or %None @destroy_func: callback to invoke before the operation is removed

Creates a #Actor. The actor may not be created immediately, or at all, if the operation is cancelled.

On successful completion, the #ActorManager::actor_created signal will be fired.

Returns: The ID for this operation.

get_n_operations: @manager: A #ActorManager

Retrieves the amount of operations left in the queue.

Returns: Number of operations left to perform

pub fn get_stage(&self) -> Option<Stage>

get_stage: @manager: A #ActorManager

Gets the #Stage the actor manager is associated with.

Returns: (transfer none): The #Stage the actor is associated with.

pub fn get_time_slice(&self) -> u32

get_time_slice: @manager: A #ActorManager

Retrieves the current time slice being used for operations.

Returns: The time-slice being used, in milliseconds

pub fn remove_actor<P, Q>(&self, container: &P, actor: &Q) -> u64 where
    P: Is<Actor>,
    Q: Is<Actor>, 

remove_actor: @manager: A #ActorManager @container: A #Actor @actor: A #Actor

Removes @actor from @container.

On successful completion, the #ActorManager::actor_removed signal will be fired.

The actor may not be removed immediately, and thus you may want to set the actor’s opacity to 0 before calling this function.

Returns: The ID for this operation.

pub fn remove_container<P>(&self, container: &P) where
    P: Is<Actor>, 

remove_container: @manager: A #ActorManager @container: A #Actor

Removes the container. This is a utility function that works by first removing all the children of the container, then the children itself. This effectively spreads the load of removing a large container. All prior operations associated with this container will be cancelled.

The container may not be removed immediately, and thus you may want to set the container’s opacity to 0 before calling this function.

pub fn set_time_slice(&self, msecs: u32)

set_time_slice: @manager: A #ActorManager @msecs: A time, in milliseconds

Sets the amount of time the actor manager will spend performing operations, before yielding to allow any necessary redrawing to occur.

Lower times will lead to smoother performance, but will increase the amount of time it takes for operations to complete.

pub fn connect_actor_finished<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O, &Actor), 

pub fn connect_property_n_operations_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O), 

pub fn connect_property_time_slice_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O), 

Loading content...