Protocol implemented by the "view" part of each processing. More...
#import <LynkeosProcessingView.h>
Instance Methods | |
| (id) | - initWithWindowController:document:configuration: |
| Initialize a processing view instance. More... | |
| (NSView *) | - getProcessingView |
| Access to the processing view. More... | |
| (LynkeosProcessingViewFrame_t) | - preferredDisplay |
| Prefered way of displaying the processing view. More... | |
| (Class) | - processingClass |
| What processing class is controlled by this processing view. More... | |
| (void) | - setActiveView: |
| Informs about activity of the view. | |
| (id< LynkeosProcessingParameter >) | - getCurrentParameters |
| Get the parameters being processed. More... | |
Class Methods | |
| (BOOL) | + isStandardProcessingViewController |
| Should the plugin controller auto-register that class. More... | |
| (ProcessingViewKind_t) | + processingViewKindForConfig: |
| Category to which this processing view controller belongs. More... | |
| (BOOL) | + isViewControllingProcess:withConfig: |
| Whether this view controls the given processing class. More... | |
| (void) | + getProcessingTitle:toolTitle:key:icon:tip:forConfig: |
| View characteristics. More... | |
| (unsigned int) | + allowedDisplaysForConfig: |
| Allowed ways of displaying the process view. More... | |
Detailed Description
Protocol implemented by the "view" part of each processing.
This protocol will be conformed to, by the classes which implements a view controling a kind of image or list processing.
The processing view class is instantiated by the main window controller when needed.
Remark: Each instance is attached to one document and window controller.
Method Documentation
| + (unsigned int) allowedDisplaysForConfig: | (id< NSObject >) | config |
Allowed ways of displaying the process view.
- Parameters
-
config The configuration for this processing class if any
- Returns
- Bitfield of the allowed displays (LynkeosProcessingViewFrame_t)
| - (id <LynkeosProcessingParameter>) getCurrentParameters |
Get the parameters being processed.
The image processing view shall allocate new parameters if applicable and it has no parameters yet. Other kind of processing need not return anything if they have no parameters or if their parameters are spread on the items of the list.
- Returns
- The current parameters.
| + (void) getProcessingTitle: | (NSString **) | title | |
| toolTitle: | (NSString **) | toolTitle | |
| key: | (NSString **) | key | |
| icon: | (NSImage **) | icon | |
| tip: | (NSString **) | tip | |
| forConfig: | (id< NSObject >) | config | |
View characteristics.
The values should be the same as those returned for the preferences pane, if any.
The plugin controller, at startup, scans for classes implenting this protocol, the toolbar and menu are built by calling this method.
- Parameters
-
title The (localized) name of the processing, used in the menu. toolTitle The (localized) name of the processing, used in the toolbar key A key shortcut for this item's menu. icon The processing icon, used in the toolbar. tip A tooltip for that processing config The optional configuration object
| - (NSView*) getProcessingView |
Access to the processing view.
- Returns
- The view which controls a processing
Referenced by MyProcessStackView(Private)::deleteProcessing:.
| - (id) initWithWindowController: | (id< LynkeosWindowController >) | window | |
| document: | (id< LynkeosViewDocument >) | document | |
| configuration: | (id< NSObject >) | config | |
Initialize a processing view instance.
- Parameters
-
window The window controller document The document config Optional configuration for customizing the view
- Returns
- The new initialized view
| + (BOOL) isStandardProcessingViewController |
Should the plugin controller auto-register that class.
The processing view is given here an opportunity to register some alternate view with the plugin controller. If it does so, it shall return "No" to avoid being registered the standard way.
Standard processing view controllers shall just return "Yes".
- Returns
- Whether to register as a standard processing controller
| + (BOOL) isViewControllingProcess: | (Class) | processingClass | |
| withConfig: | (id< NSObject > *) | config | |
Whether this view controls the given processing class.
This method is used only for "image processing" controllers. Other kind of processing controller shall return NO.
It is assumed that only one controller respond YES for any given processing class ; if not, the first in the scan will be taken.
- Parameters
-
processingClass The processing class which cotroller is looked for [out] config The config for this processing class if any
- Returns
- Whether this view controls the given processing class
| - (LynkeosProcessingViewFrame_t) preferredDisplay |
Prefered way of displaying the processing view.
This is not a class method to allow for "per document" customization
- Returns
- Preferred display
| - (Class) processingClass |
What processing class is controlled by this processing view.
- Returns
- The processing class controlled by this instance
Referenced by MyProcessStackView(Private)::addProcessing:.
| + (ProcessingViewKind_t) processingViewKindForConfig: | (id< NSObject >) | config |
Category to which this processing view controller belongs.
- Parameters
-
config The configuration for this processing class if any
- Returns
- The processing view kind
The documentation for this protocol was generated from the following file:
