|
libyui
|
#include <YUI.h>
Abstract base class of a YaST2 user interface.
| YUI::YUI | ( | bool | withThreads | ) | [protected] |
Constructor.
| YUI::~YUI | ( | ) | [virtual] |
Destructor.
| YApplication * YUI::app | ( | ) | [static] |
Return the global YApplication object.
This will create the YApplication upon the first call and return a pointer to the one and only (singleton) YApplication upon each subsequent call. This may throw exceptions if the YApplication cannot be created.
| static YApplication* YUI::application | ( | ) | [inline, static] |
Aliases for YUI::app()
| virtual void YUI::blockEvents | ( | bool | block = true | ) | [inline, virtual] |
Block (or unblock) events. If events are blocked, any event sent should be ignored until events are unblocked again.
This default implementation keeps track of a simple internal flag that can be queried with eventsBlocked(), so if you reimplement blockEvents(), be sure to reimplement eventsBlocked() as well.
| YBuiltinCaller* YUI::builtinCaller | ( | ) | const [inline] |
Return the transparent inter-thread communication. This will return 0 until set from the outside.
| virtual YApplication* YUI::createApplication | ( | ) | [protected, pure virtual] |
Create the YApplication object that provides global methods.
Derived classes are required to implement this.
| virtual YOptionalWidgetFactory* YUI::createOptionalWidgetFactory | ( | ) | [protected, pure virtual] |
Create the widget factory that provides all the createXY() methods for optional ("special") widgets and the corresponding hasXYWidget() methods.
Derived classes are required to implement this.
| void YUI::createUIThread | ( | ) | [protected] |
Creates and launches the ui thread.
| virtual YWidgetFactory* YUI::createWidgetFactory | ( | ) | [protected, pure virtual] |
Create the widget factory that provides all the createXY() methods for standard (mandatory, i.e. non-optional) widgets.
Derived classes are required to implement this.
| virtual void YUI::deleteNotify | ( | YWidget * | widget | ) | [inline, virtual] |
Notification that a widget is being deleted. This is called from the YWidget destructor.
Derived classes can implement this for any clean-up actions such as deleting any events that might be pending for that widget.
| void YUI::ensureUICreated | ( | ) | [static] |
Make sure there is a UI (with a UI plug-in) created.
If there is none yet, this will use all-default parameters to load a UI plug-in and create a UI (without threads).
| virtual bool YUI::eventsBlocked | ( | ) | const [inline, virtual] |
Returns 'true' if events are currently blocked.
Reimplement this if you reimplement blockEvents().
| virtual void YUI::idleLoop | ( | int | fd_ycp | ) | [protected, pure virtual] |
This virtual method is called when threads are activated in case the execution control is currently on the side of the module. This means that no UserInput() or PollInput() is pending. The module just does some work. The UI <-> module protocol is in the "UI waits for the next command" state. The UI can override this method when it wants to react to user input or other external events such as repaint requests from the X server.
'fd_ycp' file descriptor that should be used to determine when to leave the idle loop. As soon as it is readable, the loop must be left. In order to avoid polling you can combine it with other ui-specific fds and do a common select() call.
| YOptionalWidgetFactory * YUI::optionalWidgetFactory | ( | ) | [static] |
Return the widget factory that provides all the createXY() methods for optional ("special") widgets and the corresponding hasXYWidget() methods.
This will create the factory upon the first call and return a pointer to the one and only (singleton) factory upon each subsequent call. This may throw exceptions if the factory cannot be created.
| bool YUI::runningWithThreads | ( | ) | const [inline] |
Running with threads?
UI-specific runPkgSelection method.
Derived classes are required to implement this.
The packageSelector's dialog will take care of the event and delete it when appropriate. The returned pointer is valid until the next call to YDialog::userInput(), YDialog::pollInput(), or YUI::runPkgSelection() or until the dialog with the packageSelector is destroyed.
| void YUI::setBuiltinCaller | ( | YBuiltinCaller * | caller | ) | [inline] |
Set the transparent inter-thread communication. Built-ins are only really called if there is a valid YBuiltinCaller set.
| void YUI::setButtonOrderFromEnvironment | ( | ) | [protected] |
Set the button order (in YButtonBox widgets) from environment variables:
$Y2_BUTTON_ORDER="KDE" $Y2_BUTTON_ORDER="Gnome"
(all case insensitive)
| void YUI::shutdownThreads | ( | ) |
Shut down multithreading. This needs to be called before the destructor if the UI was created with threads. If the UI was created without threads, this does nothing.
| void YUI::signalUIThread | ( | ) | [protected] |
Signals the ui thread by sending one byte through the pipe to it.
| void YUI::signalYCPThread | ( | ) | [protected] |
Signals the ycp thread by sending one byte through the pipe to it.
| void YUI::terminateUIThread | ( | ) | [protected] |
Tells the ui thread that it should terminate and waits until it does so.
| void YUI::topmostConstructorHasFinished | ( | ) |
Must be called after the constructor of the Qt/NCurses ui is ready. Starts the ui thread.
| YUI * YUI::ui | ( | ) | [static] |
Access the global UI.
| void YUI::uiThreadDestructor | ( | ) | [protected, virtual] |
Destructor for the UI thread. This will be called as the last thing the UI thread does.
Derived classes can overwrite this. In most cases it makes sense to call this base class method in the new implementation.
| void YUI::uiThreadMainLoop | ( | ) |
This method implements the UI thread in case it is existing. The loop consists of calling idleLoop, getting the next command from the YCPUIComponent, evaluating it, which possibly invovles calling userInput() or pollInput() and writes the answer back to the other thread where the request came from.
| void YUI::unblockEvents | ( | ) | [inline] |
Unblock events previously blocked. This is just an alias for blockEvents( false) for better readability.
Note: This method is intentionally not virtual.
| bool YUI::waitForUIThread | ( | ) | [protected] |
Waits for the ui thread to send one byte through the pipe to the ycp thread and reads this byte from the pipe.
| bool YUI::waitForYCPThread | ( | ) | [protected] |
Waits for the ycp thread to send one byte through the pipe to the ycp thread and reads this byte from the pipe.
| YWidgetFactory * YUI::widgetFactory | ( | ) | [static] |
Return the widget factory that provides all the createXY() methods for standard (mandatory, i.e. non-optional) widgets.
This will create the factory upon the first call and return a pointer to the one and only (singleton) factory upon each subsequent call. This may throw exceptions if the factory cannot be created.
YBuiltinCaller* YUI::_builtinCaller [protected] |
Inter-thread communication between the YCP thread and the UI thread: The YCP thread supplies data here and signals the UI thread, the UI thread picks up the data, executes the function, puts the result here and signals the YCP thread that waits until the result is available.
bool YUI::_eventsBlocked [protected] |
Flag that keeps track of blocked events. Never query this directly, use eventsBlocked() instead.
bool YUI::_terminate_ui_thread [protected] |
This is a flag that signals the ui thread that it should terminate. This is done by setting the flag to true. The ui thread replies by setting the flag back to false directly after terminating itself.
pthread_t YUI::_uiThread [protected] |
Handle to the ui thread.
bool YUI::_withThreads [protected] |
true if a seperate UI thread is created
int YUI::pipe_from_ui[2] [protected] |
Used to synchronize data transfer with the ui thread. It stores a pair of file descriptors of a pipe. For each YCP value we get from the ui thread, we read one aribrary byte from here.
int YUI::pipe_to_ui[2] [protected] |
Used to synchronize data transfer with the ui thread. It stores a pair of file descriptors of a pipe. For each YCP value we send to the ui thread, we write one aribrary byte here.
1.7.3
