Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various typos #547

Merged
merged 1 commit into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/ads_qt_marketplace_description.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If this flag is cleared, the widget resizing is deferred until the mouse button

### Opaque and non-opaque undocking

By default, opaque undocking is active. That means, as soon as you drag a dock widget or a dock area with a number of dock widgets it will be undocked and moved into a floating widget and then the floating widget will be dragged around. That means undocking will take place immediatelly. You can compare this with opaque splitter resizing. If the flag `OpaqueUndocking` is cleared, then non-opaque undocking is active. In this mode, undocking is more like a standard drag and drop operation. That means, the dragged dock widget or dock area is not undocked immediatelly. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.
By default, opaque undocking is active. That means, as soon as you drag a dock widget or a dock area with a number of dock widgets it will be undocked and moved into a floating widget and then the floating widget will be dragged around. That means undocking will take place immediately. You can compare this with opaque splitter resizing. If the flag `OpaqueUndocking` is cleared, then non-opaque undocking is active. In this mode, undocking is more like a standard drag and drop operation. That means, the dragged dock widget or dock area is not undocked immediately. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.

The drag preview widget can be configured by a number of global dock manager flags:

Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ Enabling this feature adds a button with a pin icon to each dock area.
![DockAreaHasAutoHideButton true](cfg_flag_DockAreaHasAutoHideButton.png)

By clicking this button, the current dock widget (or the complete area - depending on the
configuration flags) will be pinned to a certain border. The border is choosen
configuration flags) will be pinned to a certain border. The border is chosen
depending on the location of the dock area. If you click the pin button while
holding down the **Ctrl** key, the whole dock area will be pinned to a certain
border.
Expand Down
4 changes: 2 additions & 2 deletions sip/DockContainerWidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ namespace ads
* Container that manages a number of dock areas with single dock widgets
* or tabyfied dock widgets in each area.
* Each window that support docking has a DockContainerWidget. That means
* the main application window and all floating windows are ore contain
* an DockContainerWidget.
* the main application window and all floating windows contain a
* DockContainerWidget.
*/
class CDockContainerWidget : QFrame
{
Expand Down
6 changes: 3 additions & 3 deletions src/AutoHideDockContainer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ void CAutoHideDockContainer::addDockWidget(CDockWidget* DockWidget)
d->DockArea->addDockWidget(DockWidget);
updateSize();
// The dock area is not visible and will not update the size when updateSize()
// is called for this auto hide container. Therefore we explicitely resize
// is called for this auto hide container. Therefore we explicitly resize
// it here. As soon as it will become visible, it will get the right size
d->DockArea->resize(size());
}
Expand Down Expand Up @@ -693,8 +693,8 @@ void CAutoHideDockContainer::moveToNewSideBarLocation(SideBarLocation NewSideBar
auto SideBar = dockContainer()->autoHideSideBar(NewSideBarLocation);
SideBar->addAutoHideWidget(this, TabIndex);
// If we move a horizontal auto hide container to a vertical position
// then we resize it to the orginal dock widget size, to avoid
// an extremely streched dock widget after insertion
// then we resize it to the original dock widget size, to avoid
// an extremely stretched dock widget after insertion
if (SideBar->orientation() != OldOrientation)
{
resetToInitialDockWidgetSize();
Expand Down
8 changes: 4 additions & 4 deletions src/AutoHideDockContainer.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class ADS_EXPORT CAutoHideDockContainer : public QFrame
virtual ~CAutoHideDockContainer();

/**
* Get's the side tab bar
* Gets the side tab bar
*/
CAutoHideSideBar* autoHideSideBar() const;

Expand All @@ -101,7 +101,7 @@ class ADS_EXPORT CAutoHideDockContainer : public QFrame
CAutoHideTab* autoHideTab() const;

/**
* Get's the dock widget in this dock container
* Gets the dock widget in this dock container
*/
CDockWidget* dockWidget() const;

Expand Down Expand Up @@ -167,13 +167,13 @@ class ADS_EXPORT CAutoHideDockContainer : public QFrame

/**
* Use this instead of resize.
* Depending on the sidebar location this will set the width or heigth
* Depending on the sidebar location this will set the width or height
* of this auto hide container.
*/
void setSize(int Size);

/**
* Resets the with or hight to the initial dock widget size dependinng on
* Resets the width or height to the initial dock widget size dependinng on
* the orientation.
* If the orientation is Qt::Horizontal, then the height is reset to
* the initial size and if orientation is Qt::Vertical, then the width is
Expand Down
2 changes: 1 addition & 1 deletion src/AutoHideSideBar.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ class ADS_EXPORT CAutoHideSideBar : public QScrollArea
/**
* Overrides the minimumSizeHint() function of QScrollArea
* The minimumSizeHint() is bigger than the sizeHint () for the scroll
* area because even if the scrollbars are invisible, the required speace
* area because even if the scrollbars are invisible, the required space
* is reserved in the minimumSizeHint(). This override simply returns
* sizeHint();
*/
Expand Down
2 changes: 1 addition & 1 deletion src/DockAreaTabBar.h
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ private Q_SLOTS:
/**
* Overrides the minimumSizeHint() function of QScrollArea
* The minimumSizeHint() is bigger than the sizeHint () for the scroll
* area because even if the scrollbars are invisible, the required speace
* area because even if the scrollbars are invisible, the required space
* is reserved in the minimumSizeHint(). This override simply returns
* sizeHint();
*/
Expand Down
2 changes: 1 addition & 1 deletion src/DockAreaTitleBar.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ CTitleBarButton::CTitleBarButton(bool showInTitleBar, QWidget* parent)
//============================================================================
void CTitleBarButton::setVisible(bool visible)
{
// 'visible' can stay 'true' if and only if this button is configured to generaly visible:
// 'visible' can stay 'true' if and only if this button is configured to generally visible:
visible = visible && this->ShowInTitleBar;

// 'visible' can stay 'true' unless: this button is configured to be invisible when it is disabled and it is currently disabled:
Expand Down
10 changes: 5 additions & 5 deletions src/DockAreaWidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -317,12 +317,12 @@ struct DockAreaWidgetPrivate
}

/**
* Udpates the enable state of the close and detach button
* Updates the enable state of the close and detach button
*/
void updateTitleBarButtonStates();

/**
* Udpates the enable state of the close and detach button
* Updates the enable state of the close and detach button
*/
void updateTitleBarButtonVisibility(bool isTopLevel);

Expand Down Expand Up @@ -1283,17 +1283,17 @@ SideBarLocation CDockAreaWidget::calculateSideTabBarArea() const
case BorderHorizontalLeft: SideTab = SideBarLocation::SideBarLeft; break;
case BorderHorizontalRight: SideTab = SideBarLocation::SideBarRight; break;

// 3. Its touching horizontal or vertical borders
// 3. It's touching horizontal or vertical borders
case BorderVertical : SideTab = SideBarLocation::SideBarBottom; break;
case BorderHorizontal: SideTab = SideBarLocation::SideBarRight; break;

// 4. Its in a corner
// 4. It's in a corner
case BorderTopLeft : SideTab = HorizontalOrientation ? SideBarLocation::SideBarTop : SideBarLocation::SideBarLeft; break;
case BorderTopRight : SideTab = HorizontalOrientation ? SideBarLocation::SideBarTop : SideBarLocation::SideBarRight; break;
case BorderBottomLeft : SideTab = HorizontalOrientation ? SideBarLocation::SideBarBottom : SideBarLocation::SideBarLeft; break;
case BorderBottomRight : SideTab = HorizontalOrientation ? SideBarLocation::SideBarBottom : SideBarLocation::SideBarRight; break;

// 5 Ists touching only one border
// 5. It's touching only one border
case BorderLeft: SideTab = SideBarLocation::SideBarLeft; break;
case BorderRight: SideTab = SideBarLocation::SideBarRight; break;
case BorderTop: SideTab = SideBarLocation::SideBarTop; break;
Expand Down
2 changes: 1 addition & 1 deletion src/DockContainerWidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ class DockContainerWidgetPrivate
* \param[out] CreatedWidget The widget created from parsed data or 0 if
* the parsed widget was an empty splitter
* \param[in] Testing If Testing is true, only the stream data is
* parsed without modifiying anything.
* parsed without modifying anything.
*/
bool restoreChildNodes(CDockingStateReader& Stream, QWidget*& CreatedWidget,
bool Testing);
Expand Down
2 changes: 1 addition & 1 deletion src/DockFocusController.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ void CDockFocusController::onApplicationFocusChanged(QWidget* focusedOld, QWidge
Q_UNUSED(focusedOld);

// Ignore focus changes if we are restoring state, or if user clicked
// a tab wich in turn caused the focus change
// a tab which in turn caused the focus change
if (d->DockManager->isRestoringState() || d->TabPressed)
{
return;
Expand Down
2 changes: 1 addition & 1 deletion src/DockManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1285,7 +1285,7 @@ void CDockManager::hideManagerAndFloatingWidgets()
d->HiddenFloatingWidgets.push_back( FloatingWidget );
FloatingWidget->hide();

// hidding floating widget automatically marked contained CDockWidgets as hidden
// hiding floating widget automatically marked contained CDockWidgets as hidden
// but they must remain marked as visible as we want them to be restored visible
// when CDockManager will be shown back
for ( auto dockWidget : VisibleWidgets )
Expand Down
4 changes: 2 additions & 2 deletions src/DockManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public Q_SLOTS:
virtual void showEvent(QShowEvent *event) override;

/**
* Acces for the internal dock focus controller.
* Access for the internal dock focus controller.
* This function only returns a valid object, if the FocusHighlighting
* flag is set.
*/
Expand Down Expand Up @@ -541,7 +541,7 @@ public Q_SLOTS:
* The order defines how the actions are added to the view menu.
* The default insertion order is MenuAlphabeticallySorted to make it
* easier for users to find the menu entry for a certain dock widget.
* You need to call this function befor you insert the first menu item
* You need to call this function before you insert the first menu item
* into the view menu.
*/
void setViewMenuInsertionOrder(eViewMenuInsertionOrder Order);
Expand Down
2 changes: 1 addition & 1 deletion src/DockSplitter.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ struct DockSplitterPrivate;

/**
* Splitter used internally instead of QSplitter with some additional
* fuctionality.
* functionality.
*/
class ADS_EXPORT CDockSplitter : public QSplitter
{
Expand Down
4 changes: 2 additions & 2 deletions src/DockWidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ private Q_SLOTS:
* object name is required by the dock manager to properly save and restore
* the state of the dock widget. That means, the title needs to be unique.
* If your title is not unique or if you would like to change the title
* during runtime, you need to set a unique object name explicitely
* during runtime, you need to set a unique object name explicitly
* by calling setObjectName() after construction.
* Use the layoutFlags to configure the layout of the dock widget.
*/
Expand Down Expand Up @@ -445,7 +445,7 @@ private Q_SLOTS:

/**
* This function returns the dock widget top tool bar.
* If no toolbar is assigned, this function returns nullptr. To get a vaild
* If no toolbar is assigned, this function returns nullptr. To get a valid
* toolbar you either need to create a default empty toolbar via
* createDefaultToolBar() function or you need to assign your custom
* toolbar via setToolBar().
Expand Down
2 changes: 1 addition & 1 deletion src/DockWidgetTab.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ void CDockWidgetTab::mouseMoveEvent(QMouseEvent* ev)
else if (d->DockArea->openDockWidgetsCount() > 1
&& (internal::globalPositionOf(ev) - d->GlobalDragStartMousePosition).manhattanLength() >= QApplication::startDragDistance()) // Wait a few pixels before start moving
{
// If we start dragging the tab, we save its inital position to
// If we start dragging the tab, we save its initial position to
// restore it later
if (DraggingTab != d->DragState)
{
Expand Down
2 changes: 1 addition & 1 deletion src/DockWidgetTab.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ private Q_SLOTS:

/**
* Set an explicit icon size.
* If no icon size has been set explicitely, than the tab sets the icon size
* If no icon size has been set explicitly, than the tab sets the icon size
* depending on the style
*/
void setIconSize(const QSize& Size);
Expand Down
2 changes: 1 addition & 1 deletion src/FloatingDockContainer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ namespace ads
#ifdef Q_OS_WIN
#if 0 // set to 1 if you need this function for debugging
/**
* Just for debuging to convert windows message identifiers to strings
* Just for debugging to convert windows message identifiers to strings
*/
static const char* windowsMessageString(int MessageId)
{
Expand Down
2 changes: 1 addition & 1 deletion src/ads_globals.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ QString detectWindowManagerX11()
QString ret = xcb_get_prop_string(support_win, "_NET_WM_NAME");
if(ret.length() == 0)
{
ADS_PRINT("Empty WM name occured.");
ADS_PRINT("Empty WM name occurred.");
return "UNKNOWN";
}
return ret;
Expand Down
2 changes: 1 addition & 1 deletion src/ads_globals.h
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ void xcb_update_prop(bool set, WId window, const char *type, const char *prop, c
bool xcb_dump_props(WId window, const char *type);
/**
* Gets the active window manager from the X11 Server.
* Requires a EWMH conform window manager (Allmost all common used ones are).
* Requires a EWMH conform window manager (Almost all common used ones are).
* Returns "UNKNOWN" otherwise.
*/
QString windowManager();
Expand Down