first steps documentation changes

This commit is contained in:
Markus Gans 2020-08-23 14:00:53 +02:00
parent 147e213e07
commit 28080abb3e
10 changed files with 21 additions and 21 deletions

View File

@ -609,7 +609,7 @@ With `delCallback(...)` you can remove a connection to a signal handler
or a widget instance. Alternatively, you can use `delCallbacks()` to or a widget instance. Alternatively, you can use `delCallbacks()` to
remove all existing callbacks from an object. remove all existing callbacks from an object.
To delete functions or static methods callbacks via a pointer:(4) (1) To delete functions or static methods callbacks via a pointer:
```cpp ```cpp
template<typename FunctionPtr template<typename FunctionPtr
@ -618,7 +618,7 @@ void FWidget::delCallback (FunctionPtr&& cb_func_ptr)
{...} {...}
``` ```
To delete functions or static methods callbacks via a reference:(5) (2) To delete functions or static methods callbacks via a reference:
```cpp ```cpp
template<typename Function template<typename Function
@ -627,7 +627,7 @@ void FWidget::delCallback (Function& cb_function)
{...} {...}
``` ```
To delete all callbacks from a specific instance:(1) (3) To delete all callbacks from a specific instance:
```cpp ```cpp
template<typename Object template<typename Object
@ -636,14 +636,14 @@ void FWidget::delCallback (Object&& cb_instance)
{...} {...}
``` ```
To delete all callbacks of a signal:(2) (4) To delete all callbacks of a signal:
```cpp ```cpp
void delCallback (const FString& cb_signal) void delCallback (const FString& cb_signal)
{...} {...}
``` ```
To delete all callbacks of a signal and specific instance:(3) (5) To delete all callbacks of a signal and specific instance:
```cpp ```cpp
template<typename Object template<typename Object
@ -652,7 +652,7 @@ void delCallback (const FString& cb_signal, Object&& cb_instance)
{...} {...}
``` ```
To delete all callbacks from a widget:(6) (6) To delete all callbacks from a widget:
```cpp ```cpp
void delCallback() void delCallback()

View File

@ -197,7 +197,7 @@ class Window final : public finalcut::FDialog
// Method // Method
void configureFileMenuItems(); void configureFileMenuItems();
void configureDialogButtons(); void configureDialogButtons();
void activateWindow (finalcut::FDialog*); void activateWindow (finalcut::FDialog*) const;
void adjustSize() override; void adjustSize() override;
template<typename InstanceT, typename CallbackT, typename... Args> template<typename InstanceT, typename CallbackT, typename... Args>
void addClickedCallback ( finalcut::FWidget* void addClickedCallback ( finalcut::FWidget*
@ -330,7 +330,7 @@ void Window::configureDialogButtons()
} }
//---------------------------------------------------------------------- //----------------------------------------------------------------------
void Window::activateWindow (finalcut::FDialog* win) void Window::activateWindow (finalcut::FDialog* win) const
{ {
if ( ! win || win->isWindowHidden() || win->isWindowActive() ) if ( ! win || win->isWindowHidden() || win->isWindowActive() )
return; return;

View File

@ -353,7 +353,7 @@ void FButton::onAccel (FAccelEvent* ev)
if ( ! hasFocus() ) if ( ! hasFocus() )
{ {
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget()); auto focused_widget = ev->focusedWidget();
if ( focused_widget && focused_widget->isWidget() ) if ( focused_widget && focused_widget->isWidget() )
{ {

View File

@ -221,7 +221,7 @@ void FLabel::onAccel (FAccelEvent* ev)
if ( ! accel_widget->hasFocus() ) if ( ! accel_widget->hasFocus() )
{ {
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget()); auto focused_widget = ev->focusedWidget();
if ( focused_widget && focused_widget->isWidget() ) if ( focused_widget && focused_widget->isWidget() )
{ {

View File

@ -544,7 +544,7 @@ void FLineEdit::onAccel (FAccelEvent* ev)
if ( ! hasFocus() ) if ( ! hasFocus() )
{ {
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget()); auto focused_widget = ev->focusedWidget();
if ( focused_widget && focused_widget->isWidget() ) if ( focused_widget && focused_widget->isWidget() )
{ {

View File

@ -225,7 +225,7 @@ void FMenuItem::delAccelerator (FWidget* obj)
} }
//---------------------------------------------------------------------- //----------------------------------------------------------------------
void FMenuItem::openMenu() void FMenuItem::openMenu() const
{ {
if ( ! hasMenu() ) if ( ! hasMenu() )
return; return;
@ -402,7 +402,7 @@ void FMenuItem::onAccel (FAccelEvent* ev)
setSelected(); setSelected();
mbar->setSelectedItem(this); mbar->setSelectedItem(this);
openMenu(); openMenu();
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget()); auto focused_widget = ev->focusedWidget();
menu->unselectItem(); menu->unselectItem();
menu->selectFirstItem(); menu->selectFirstItem();

View File

@ -273,7 +273,7 @@ void FToggleButton::onAccel (FAccelEvent* ev)
if ( ! hasFocus() ) if ( ! hasFocus() )
{ {
auto focused_widget = static_cast<FWidget*>(ev->focusedWidget()); auto focused_widget = ev->focusedWidget();
if ( focused_widget && focused_widget->isWidget() ) if ( focused_widget && focused_widget->isWidget() )
{ {

View File

@ -153,7 +153,7 @@ void FVTerm::setTermXY (int x, int y) const
} }
//---------------------------------------------------------------------- //----------------------------------------------------------------------
void FVTerm::setTerminalUpdates (terminal_update refresh_state) void FVTerm::setTerminalUpdates (terminal_update refresh_state) const
{ {
if ( refresh_state == stop_terminal_updates ) if ( refresh_state == stop_terminal_updates )
{ {
@ -240,7 +240,7 @@ void FVTerm::resizeVTerm (const FSize& size) const
} }
//---------------------------------------------------------------------- //----------------------------------------------------------------------
void FVTerm::putVTerm() void FVTerm::putVTerm() const
{ {
for (int i{0}; i < vterm->height; i++) for (int i{0}; i < vterm->height; i++)
{ {
@ -1311,7 +1311,7 @@ void FVTerm::clearArea (FTermArea* area, int fillchar) const
} }
//---------------------------------------------------------------------- //----------------------------------------------------------------------
void FVTerm::processTerminalUpdate() void FVTerm::processTerminalUpdate() const
{ {
// Retains terminal updates if there are unprocessed inputs // Retains terminal updates if there are unprocessed inputs
static constexpr int max_skip = 8; static constexpr int max_skip = 8;

View File

@ -125,7 +125,7 @@ class FMenuItem : public FWidget
// Methods // Methods
void addAccelerator (FKey, FWidget*) override; void addAccelerator (FKey, FWidget*) override;
void delAccelerator (FWidget*) override; void delAccelerator (FWidget*) override;
void openMenu(); void openMenu() const;
// Event handlers // Event handlers
void onKeyPress (FKeyEvent*) override; void onKeyPress (FKeyEvent*) override;

View File

@ -152,7 +152,7 @@ class FVTerm
// Mutators // Mutators
void setTermXY (int, int) const; void setTermXY (int, int) const;
void setTerminalUpdates (terminal_update); void setTerminalUpdates (terminal_update) const;
void hideCursor (bool) const; void hideCursor (bool) const;
void hideCursor() const; void hideCursor() const;
void showCursor() const; void showCursor() const;
@ -252,7 +252,7 @@ class FVTerm
virtual void clearArea (int = ' '); virtual void clearArea (int = ' ');
void createVTerm (const FSize&); void createVTerm (const FSize&);
void resizeVTerm (const FSize&) const; void resizeVTerm (const FSize&) const;
void putVTerm(); void putVTerm() const;
void updateTerminal() const; void updateTerminal() const;
virtual void addPreprocessingHandler ( const FVTerm* virtual void addPreprocessingHandler ( const FVTerm*
, const FPreprocessingFunction& ); , const FPreprocessingFunction& );
@ -314,7 +314,7 @@ class FVTerm
void scrollAreaForward (FTermArea*) const; void scrollAreaForward (FTermArea*) const;
void scrollAreaReverse (FTermArea*) const; void scrollAreaReverse (FTermArea*) const;
void clearArea (FTermArea*, int = ' ') const; void clearArea (FTermArea*, int = ' ') const;
void processTerminalUpdate(); void processTerminalUpdate() const;
static void startTerminalUpdate(); static void startTerminalUpdate();
static void finishTerminalUpdate(); static void finishTerminalUpdate();
virtual void initTerminal(); virtual void initTerminal();